< Back
Start-AemQuickJob
Post
NAME
Start-AemQuickJob
SYNOPSIS
SYNTAX
Start-AemQuickJob [-AccessToken] <String> [-DeviceUID] <String> [-JobName] <String> [-ComponentGuid] <String> [[-Variables] <Hashtable>] [[-ApiUrl] <String>] [[-EventLogSource] <String>] [[-LogPath]
<String>] [<CommonParameters>]
DESCRIPTION
Accepts a device unique ID and a component unique ID to trigger the quick job to run.
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? true (ByValue)
Accept wildcard characters? false
-DeviceUID <String>
Represents the UID (31fcea20-3924-c976-0a59-52ec4a2bbf6f) of the desired device.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-JobName <String>
Represents the name of the job, once it is created.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ComponentGuid <String>
Unique ID of the component, which will be run. As of 24 October 2019, this value is only available in the UI (on the component definition page), not via the API.
Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Variables <Hashtable>
Optional hashtable of variables (name and value) to pass into the component.
Required? false
Position? 5
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? 6
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? 7
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? 8
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: 24 October 2019
- Initial release.
V1.0.0.1 date: 29 October 2019
V1.0.0.2 date: 30 October 2019
V1.0.0.3 date: 5 December 2019
V1.0.0.4 date: 11 December 2019
-------------------------- EXAMPLE 1 --------------------------
PS C:>Start-AemQuickJob -AccessToken (New-AemApiAccessToken -ApiKey <api public key> -ApiUrl <api private key>) -DeviceUID 894cc30a-ad10-57f5-82e7-5a3eac72b61f -JobName TestJob -ComponentGuid
377ffb75-9bbc-4c99-9fac-8966292a429b -Verbose
In this example, the cmdlet will start the generate a new access token and will start a job called "TestJob" to run component with ID 377ffb75-9bbc-4c99-9fac-8966292a429b, on the device with UID
894cc30a-ad10-57f5-82e7-5a3eac72b61f. Verbose output is sent to the host.
-------------------------- EXAMPLE 2 --------------------------
PS C:>Start-AemQuickJob -AccessToken (New-AemApiAccessToken -ApiKey <api public key> -ApiUrl <api private key>) -DeviceUID 894cc30a-ad10-57f5-82e7-5a3eac72b61f -JobName TestJob -ComponentGuid
377ffb75-9bbc-4c99-9fac-8966292a429b -Variables @{name='licensekey';value='xxxxx-xxxxx-xxxxx-xxxxx-xxxxx'}
In this example, the cmdlet will start the generate a new access token and will start a job called "TestJob" to run component with ID 377ffb75-9bbc-4c99-9fac-8966292a429b, on the device with UID
894cc30a-ad10-57f5-82e7-5a3eac72b61f. In this case, the licensekey variable and value are passed to the component.
RELATED LINKS
https://github.com/wetling23/Public.AEM ... hellModule
Start-AemQuickJob
SYNOPSIS
SYNTAX
Start-AemQuickJob [-AccessToken] <String> [-DeviceUID] <String> [-JobName] <String> [-ComponentGuid] <String> [[-Variables] <Hashtable>] [[-ApiUrl] <String>] [[-EventLogSource] <String>] [[-LogPath]
<String>] [<CommonParameters>]
DESCRIPTION
Accepts a device unique ID and a component unique ID to trigger the quick job to run.
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? true (ByValue)
Accept wildcard characters? false
-DeviceUID <String>
Represents the UID (31fcea20-3924-c976-0a59-52ec4a2bbf6f) of the desired device.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-JobName <String>
Represents the name of the job, once it is created.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ComponentGuid <String>
Unique ID of the component, which will be run. As of 24 October 2019, this value is only available in the UI (on the component definition page), not via the API.
Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Variables <Hashtable>
Optional hashtable of variables (name and value) to pass into the component.
Required? false
Position? 5
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? 6
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? 7
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? 8
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: 24 October 2019
- Initial release.
V1.0.0.1 date: 29 October 2019
V1.0.0.2 date: 30 October 2019
V1.0.0.3 date: 5 December 2019
V1.0.0.4 date: 11 December 2019
-------------------------- EXAMPLE 1 --------------------------
PS C:>Start-AemQuickJob -AccessToken (New-AemApiAccessToken -ApiKey <api public key> -ApiUrl <api private key>) -DeviceUID 894cc30a-ad10-57f5-82e7-5a3eac72b61f -JobName TestJob -ComponentGuid
377ffb75-9bbc-4c99-9fac-8966292a429b -Verbose
In this example, the cmdlet will start the generate a new access token and will start a job called "TestJob" to run component with ID 377ffb75-9bbc-4c99-9fac-8966292a429b, on the device with UID
894cc30a-ad10-57f5-82e7-5a3eac72b61f. Verbose output is sent to the host.
-------------------------- EXAMPLE 2 --------------------------
PS C:>Start-AemQuickJob -AccessToken (New-AemApiAccessToken -ApiKey <api public key> -ApiUrl <api private key>) -DeviceUID 894cc30a-ad10-57f5-82e7-5a3eac72b61f -JobName TestJob -ComponentGuid
377ffb75-9bbc-4c99-9fac-8966292a429b -Variables @{name='licensekey';value='xxxxx-xxxxx-xxxxx-xxxxx-xxxxx'}
In this example, the cmdlet will start the generate a new access token and will start a job called "TestJob" to run component with ID 377ffb75-9bbc-4c99-9fac-8966292a429b, on the device with UID
894cc30a-ad10-57f5-82e7-5a3eac72b61f. In this case, the licensekey variable and value are passed to the component.
RELATED LINKS
https://github.com/wetling23/Public.AEM ... hellModule