Get-SmaJob
Gets a runbook job.
Syntax
Get-SmaJob
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>] Get-SmaJob
[-Id <String[]>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>] Get-SmaJob
[-ContextId <String[]>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>] Get-SmaJob
[-RunbookId <String[]>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>] Get-SmaJob
[-RunbookName <String[]>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>] Description
The Get-SmaJob cmdlet gets one or more runbook jobs in Service Management Automation (SMA). Specify the web service endpoint and, if necessary, a port. By default, all jobs are returned. To get a specific job, specify the JobId, JobContext, RunbookId, or RunbookName parameter.
Examples
Example 1: Get a runbook job
PS C:\> Get-SmaJob -WebServiceEndpoint "https://localhost" -JobId "2989b069-24fe-40b9-b3bd-cb7e5eac4b647"This command gets the job with the Job ID named 2989b069-24fe-40b9-b3bd-cb7e5eac4b647.
Parameters
-AuthenticationType
Specifies the authentication type. Valid values are:
- Basic
- Windows
The default value is Windows. If you use Basic authentication, you must provide credentials by using the Credential parameter.
| Type: | String |
| Accepted values: | Basic, Windows |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ContextId
Specifies an array of context IDs.
| Type: | String[] |
| Aliases: | JobContextId |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Specifies a PSCredential object for the connection to the SMA web service.
To obtain a credential object, use the Get-Credential cmdlet.
For more information, type Get-Help Get-Credential.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
Specifies an array of job IDs.
| Type: | String[] |
| Aliases: | JobId |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Port
Specifies the port number of the SMA web service.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunbookId
Specifies an array of IDs, as strings, of a runbook.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunbookName
Specifies an array of runbook names.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WebServiceEndpoint
Specifies the endpoint, as a URL, of the SMA web service. You must include the protocol, for example, http:// or https://.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |