< Back

Find-AemSoftwareInstance

Sat Jul 18, 2020 3:57 pm

NAME
Find-AemSoftwareInstance

SYNOPSIS


SYNTAX
Find-AemSoftwareInstance [-Application] <String> [-AccessToken] <String> [[-SiteName] <String>] [[-ApiUrl] <String>] [[-EventLogSource] <String>] [[-LogPath] <String>] [<CommonParameters>]


DESCRIPTION
Accepts an application name and optional device group, and returns a list of all devices where the application is installed.


PARAMETERS
-Application <String>
Represents the name of an application, for which to search.

Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

-AccessToken <String>
Represents the token returned once successful authentication to the API is achieved. Use New-AemApiAccessToken to obtain the token.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-SiteName <String>
When included, search for the specified application on machines from this site. If not included, search on machines in all sites (except Deleted Devices).

Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ApiUrl <String>
Default value is 'https://zinfandel-api.centrastage.net'. Represents the URL to AutoTask's AEM API, for the desired instance.

Required? false
Position? 4
Default value https://zinfandel-api.centrastage.net
Accept pipeline input? false
Accept wildcard characters? false

-EventLogSource <String>
When included, (and when LogPath is null), represents the event log source for the Application log. If no event log source or path are provided, output is sent only to the host.

Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false

-LogPath <String>
When included (when EventLogSource is null), represents the file, to which the cmdlet will output will be logged. If no path or event log source are provided, output is sent only to the host.

Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES


V1.0.0.0 date: 17 August 2018
- Initial release.
V1.0.0.1 date: 25 March 2019
- Added support for rate-limiting response.
- Updated loop and properties.
V1.0.0.2 date: 28 March 2019
- Added support for 403, 401, and 400 responses.
V1.0.0.3 date: 29 March 2019
- Added support for 404 response.
V1.0.0.4 date: 5 December 2019
V1.0.0.5 date: 11 December 2019

-------------------------- EXAMPLE 1 --------------------------

PS C:\>Find-AemSoftwareInstance -Application "CentraStage" -AccessToken <token> -Verbose

In this example, the function will search the audit data of devices in all sites (except Deleted Devices), for CentraStage. Output will be written to the event log and host. Verbose output is sent to
the host.




-------------------------- EXAMPLE 2 --------------------------

PS C:\>Find-AemSoftwareInstance -Application "CentraStage" -AccessToken <token> -SiteName <site name>

In this example, the function will search the audit data of devices in <site name> for CentraStage. Output will be written to the event log and host




-------------------------- EXAMPLE 3 --------------------------

PS C:\>Find-AemSoftwareInstance -Application "CentraStage" -AccessToken <token> -ApiUrl https://merlot.centrastage.net -BlockLogging

In this example, the function will search the audit data of devices in all sites (except Deleted Devices), for CentraStage. Output will be written to the event log and host.
In this example, the AEM instance is located in the "merlot" region.





RELATED LINKS
https://github.com/wetling23/Public.AEM ... hellModule