< Back
Get-AemJob
Post
NAME
Get-AemJob
SYNOPSIS
SYNTAX
Get-AemJob [-AccessToken] <String> [-JobUid] <String> [[-ApiUrl] <String>] [[-EventLogSource] <String>] [[-LogPath] <String>] [<CommonParameters>]
DESCRIPTION
Accepts a Datto RMM job unique ID and returns the job's status.
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? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-JobUid <String>
Represents the unique ID (e.g. 44e7a880-8c4b-44cf-8133-b1d17a9aea5e) of the desired job. A job's UID is available in the Actvity Log (Setup -> Activity Log).
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
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? 3
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? 4
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? 5
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: 29 October 2019
- Initial release.
V1.0.0.1 date: 5 December 2019
V1.0.0.2 date: 11 December 2019
-------------------------- EXAMPLE 1 --------------------------
PS C:>Get-AemJob -AccessToken '<access token>' -JobUid '44e7a880-8c4b-44cf-8133-b1d17a9aea5e' -Verbose
In this example, the cmdlet retrieves the status of the job with unique ID '44e7a880-8c4b-44cf-8133-b1d17a9aea5e'. Verbose output is sent to the host.
-------------------------- EXAMPLE 2 --------------------------
PS C:>Get-AemJob -AccessToken (New-AemApiAccessToken -ApiKey <api public key> -ApiUrl <api private key>) -JobUid '44e7a880-8c4b-44cf-8133-b1d17a9aea5e'
In this example, the cmdlet retrieves the status of the job with unique ID '44e7a880-8c4b-44cf-8133-b1d17a9aea5e'. The cmdlet's output is written to the host and to the Windows Application log.
RELATED LINKS
https://github.com/wetling23/Public.AEM ... hellModule
Get-AemJob
SYNOPSIS
SYNTAX
Get-AemJob [-AccessToken] <String> [-JobUid] <String> [[-ApiUrl] <String>] [[-EventLogSource] <String>] [[-LogPath] <String>] [<CommonParameters>]
DESCRIPTION
Accepts a Datto RMM job unique ID and returns the job's status.
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? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-JobUid <String>
Represents the unique ID (e.g. 44e7a880-8c4b-44cf-8133-b1d17a9aea5e) of the desired job. A job's UID is available in the Actvity Log (Setup -> Activity Log).
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
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? 3
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? 4
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? 5
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: 29 October 2019
- Initial release.
V1.0.0.1 date: 5 December 2019
V1.0.0.2 date: 11 December 2019
-------------------------- EXAMPLE 1 --------------------------
PS C:>Get-AemJob -AccessToken '<access token>' -JobUid '44e7a880-8c4b-44cf-8133-b1d17a9aea5e' -Verbose
In this example, the cmdlet retrieves the status of the job with unique ID '44e7a880-8c4b-44cf-8133-b1d17a9aea5e'. Verbose output is sent to the host.
-------------------------- EXAMPLE 2 --------------------------
PS C:>Get-AemJob -AccessToken (New-AemApiAccessToken -ApiKey <api public key> -ApiUrl <api private key>) -JobUid '44e7a880-8c4b-44cf-8133-b1d17a9aea5e'
In this example, the cmdlet retrieves the status of the job with unique ID '44e7a880-8c4b-44cf-8133-b1d17a9aea5e'. The cmdlet's output is written to the host and to the Windows Application log.
RELATED LINKS
https://github.com/wetling23/Public.AEM ... hellModule