Start-SmaRunbook
Runbook ジョブを開始します。
構文
Start-SmaRunbook
[-Name <String>]
[-Parameters <IDictionary>]
[-ScheduleName <String>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-SmaRunbook
[-Id <String>]
[-Parameters <IDictionary>]
[-ScheduleName <String>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Start-SmaRunbook コマンドレットは、Runbook ジョブを開始します。 Runbook と Web サービス エンドポイントの ID または名前を指定します。 必要に応じて、Service Management Automation (SMA) Web サービスのポートを指定します。
例
例 1: Runbook ジョブを開始する
PS C:\> Start-SmaRunbook -WebServiceEndpoint https://localhost -Name "Runbk01" -Parameters @{"StringParam"="Value"; "IntParam"=2}このコマンドは、Runbook ジョブのパラメーターを指定して、Runbk01 という名前の Runbook を開始します。
パラメーター
-AuthenticationType
認証の種類を指定します。 有効な値は次のとおりです。
- 基本的な
- ウィンドウズ
このパラメーターの既定値は Windows です。 基本認証を使用する場合は、Credential パラメーターを使用して資格情報を指定する必要があります。
| 型: | String |
| 指定可能な値: | Basic, Windows |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Credential
SMA Web サービスへの接続 PSCredential オブジェクトを指定します。
資格情報オブジェクトを取得するには、Get-Credential コマンドレットを使用します。
詳細については、「Get-Help Get-Credential」と入力します。
| 型: | PSCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Id
Runbook の ID を指定します。
| 型: | String |
| Aliases: | RunbookId |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Name
Runbook の名前を指定します。
| 型: | String |
| Aliases: | RunbookName |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Parameters
キーと値のペアのハッシュ テーブルを指定します。 ハッシュ テーブル内のキーは、Runbook パラメーター名です。 ハッシュ テーブルの値は、Runbook パラメーターの値です。
| 型: | IDictionary |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Port
SMA Web サービスのポート番号を指定します。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ScheduleName
Runbook を開始するジョブ スケジュールの名前を指定します。 SMA でスケジュールを作成するには、Set-SmaSchedule コマンドレットを使用します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WebServiceEndpoint
SMA Web サービスのエンドポイントを URL として指定します。 プロトコル (http:// や https:// など) を含める必要があります。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |