Get-SmaJob
Get-SmaJob
Gets a runbook job.
構文
Parameter Set: GetAll
Get-SmaJob -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]
Parameter Set: ByJobContextId
Get-SmaJob -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-ContextId <String[]> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]
Parameter Set: ByJobId
Get-SmaJob -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Id <String[]> ] [-Port <Int32> ] [ <CommonParameters>]
Parameter Set: ByRunbookId
Get-SmaJob -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [-RunbookId <String[]> ] [ <CommonParameters>]
Parameter Set: ByRunbookName
Get-SmaJob -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [-RunbookName <String[]> ] [ <CommonParameters>]
詳細説明
The Get-SmaJob cmdlet gets one or more runbook jobs in . 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.
パラメーター
-AuthenticationType<String>
Specifies the authentication type. Valid values are: Basic, Windows.
Windows is the default value. If you use Basic authentication, you must provide credentials by using the Credential parameter.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
Windows |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-ContextId<String[]>
Specifies an array of context IDs.
エイリアス |
JobContextId |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Credential<PSCredential>
Specifies user credentials, as a PSCredential object, to use for the connection to the web service. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Id<String[]>
Specifies an array of job IDs.
エイリアス |
JobId |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue) |
ワイルドカード文字を許可する |
false |
-Port<Int32>
Specifies the port number of the web service.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-RunbookId<String[]>
Specifies an array of IDs, as strings, of a runbook.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-RunbookName<String[]>
Specifies an array of runbook names.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WebServiceEndpoint<String>
Specifies the endpoint, as a URL, of the web service. Include the protocol, for example, http:// or https://.
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
例
Example 1: Get a runbook job
This command gets the job with the specified GUID.
PS C:\> Get-SmaJob -WebServiceEndpoint "https://localhost" -JobId "2989b069-24fe-40b9-b3bd-cb7e5eac4b647"