Get-AemDevice

NAME
Get-AemDevice

SYNOPSIS


SYNTAX
Get-AemDevice [-AccessToken <String>] [-ApiUrl <String>] [-EventLogSource <String>] [-LogPath <String>] [<CommonParameters>]

Get-AemDevice [-AccessToken <String>] [-DeviceUID <String>] [-ApiUrl <String>] [-EventLogSource <String>] [-LogPath <String>] [<CommonParameters>]

Get-AemDevice [-AccessToken <String>] [-DeviceId <Int32>] [-ApiUrl <String>] [-EventLogSource <String>] [-LogPath <String>] [<CommonParameters>]


DESCRIPTION
Retrieves either individual devices by ID or UID, or all devices from AutoTask Endpoint Management.


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

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

-DeviceId <Int32>
Represents the ID number (e.g. 23423) of the desired device.

Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false

-DeviceUID <String>
Represents the UID (31fcea20-3924-c976-0a59-52ec4a2bbf6f) of the desired device.

Required? false
Position? named
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? named
Default value https://zinfandel-api.centrastage.net
Accept pipeline input? false
Accept wildcard characters? false

-EventLogSource <String>
Default value is 'AemPowerShellModule'. This parameter is used to specify the event source, that script/modules will use for logging.

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

-LogPath <String>

Required? false
Position? named
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


Author: Mike Hashemi
V1.0.0.0 date: 16 June 2018
- Initial release.
V1.0.0.1 date: 17 June 2018
- Fixed typo in help.
- Changed return to filter out duplicate devices based on the Id field.
V1.0.0.2 date: 17 June 2018
- Removed uniqueness filter from return statement.
V1.0.0.3 date: 16 August 2018
- Updated white space.
V1.0.0.4 date: 18 November 2018
- Konstantin Kaminskiy renamed to Get-AemDevice, added ability to get device by UID.
V1.0.0.5 date: 21 November 2018
- Updated white space.
V1.0.0.6 date: 25 March 2019
- Added support for rate-limiting response.
V1.0.0.7 date: 8 April 2019
- Added alias for Get-AemDevices.
V1.0.0.8 date: 5 December 2019
V1.0.0.9 date: 11 December 2019

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

PS C:\>Get-AemDevice -AccessToken $token -Verbose

This will return all devices. Verbose output is sent to the host.




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

PS C:\>Get-AemDevice -AccessToken $token -DeviceId $id

This will return the device matching the specified id.




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

PS C:\>Get-AemDevice -AccessToken $token -DeviceUID $UID

This will return the device matching the specified UID.





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