Start-SmaRunbook

  • リファレンス
モジュール:
Microsoft.SystemCenter.ServiceManagementAutomation

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}

このコマンドは、Runbk01 という名前の Runbook を起動し、Runbook ジョブのパラメーターを指定します。

パラメーター

-AuthenticationType

認証の種類を指定します。 有効な値は次のとおりです。

  • Basic
  • Windows

このパラメーターの既定値は Windows です。 基本認証を使用する場合は、 Credential パラメーターを使用して資格情報を指定する必要があります。

Type:String
Accepted values:Basic, Windows
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

SMA Web サービスへの接続の PSCredential オブジェクトを指定します。 資格情報オブジェクトを取得するには、Get-Credential コマンドレットを使用します。 詳細を表示するには「Get-Help Get-Credential」を入力します。

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Runbook の ID を指定します。

Type:String
Aliases:RunbookId
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Runbook の名前を指定します。

Type:String
Aliases:RunbookName
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Parameters

キーと値のペアのハッシュ テーブルを指定します。 ハッシュ テーブルのキーは Runbook パラメーター名です。 ハッシュ テーブルの値は Runbook パラメーターの値です。

Type:IDictionary
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Port

SMA Web サービスのポート番号を指定します。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScheduleName

Runbook を開始するジョブ スケジュールの名前を指定します。 SMA でスケジュールを作成するには、Set-SmaSchedule コマンドレットを使用します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WebServiceEndpoint

SMA Web サービスのエンドポイントを URL として指定します。 プロトコル (http:// や https:// など) を含める必要があります。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False