Start-SmaRunbook

[アーティクル]
11/16/2015

Start-SmaRunbook

Starts a runbook job.

構文

Parameter Set: ByRunbookName
Start-SmaRunbook -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Name <String> ] [-Parameters <IDictionary> ] [-Port <Int32> ] [-ScheduleName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByRunbookId
Start-SmaRunbook -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Id <String> ] [-Parameters <IDictionary> ] [-Port <Int32> ] [-ScheduleName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Start-SmaRunbook cmdlet starts a runbook job. Specify the ID or name of a runbook and the web service endpoint. If necessary, specify the port of the web service.

パラメーター

-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

-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 the ID of a runbook.

エイリアス	RunbookId
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-Name<String>

Specifies the name of a runbook.

エイリアス	RunbookName
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-Parameters<IDictionary>

Specifies a hash table of key/value pairs. The keys in the hash table are the runbook parameter names. The values in the hash table are the runbook parameter values.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Port<Int32>

Specifies the port number of the web service.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-ScheduleName<String>

Specifies the name of a job schedule on which to start the runbook. To create a schedule in , use the Set-SmaSchedule cmdlet.

エイリアス	なし
必須?	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

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

必須?	false
位置は?	named
既定値	false
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

必須?	false
位置は?	named
既定値	false
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

例

Example 1: Start a runbook job

This command starts the runbook named Runbk01, specifying the parameters for the runbook job.

PS C:\> Start-SmaRunbook -WebServiceEndpoint https://localhost -Name "Runbk01" -Parameters @{"StringParam"="Value"; "IntParam"=2}

Start-SmaRunbook