Get-SmaRunbookDefinition

Runbook 定義を取得します。

構文

Get-SmaRunbookDefinition
   -Type <RunbookVersionType>
   -WebServiceEndpoint <String>
   [-Port <Int32>]
   [-AuthenticationType <String>]
   [-Credential <PSCredential>]
   [<CommonParameters>]
Get-SmaRunbookDefinition
   -Id <String[]>
   -Type <RunbookVersionType>
   -WebServiceEndpoint <String>
   [-Port <Int32>]
   [-AuthenticationType <String>]
   [-Credential <PSCredential>]
   [<CommonParameters>]
Get-SmaRunbookDefinition
   [-Name] <String[]>
   -Type <RunbookVersionType>
   -WebServiceEndpoint <String>
   [-Port <Int32>]
   [-AuthenticationType <String>]
   [-Credential <PSCredential>]
   [<CommonParameters>]
Get-SmaRunbookDefinition
   -VersionId <String[]>
   -WebServiceEndpoint <String>
   [-Port <Int32>]
   [-AuthenticationType <String>]
   [-Credential <PSCredential>]
   [<CommonParameters>]

説明

Get-SmaRunbookDefinition コマンドレットは、1 つ以上の Runbook を取得します。 既定では、指定したバージョンの種類のすべての Runbook 定義が返されます。 特定の Runbook を取得するには、その名前または ID を指定します。

例 1: 名前で Runbook 定義を取得する

PS C:\>Get-SmaRunbookDefinition -WebServiceEndpoint "https://localhost" -Name "RunbookDef01" -Type "Draft"

このコマンドは、RunbookDef01 という名前の 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

-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 定義を取得する Runbook ID の配列を指定します。

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

-Name

このコマンドレットが Runbook 定義を取得する Runbook 名の配列を指定します。

Type:String[]
Aliases:RunbookName
Position:0
Default value:None
Required:True
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

-Type

Runbook のバージョンの種類を指定します。 有効な値は次のとおりです。

  • 公開済み
  • ドラフト
Type:RunbookVersionType
Accepted values:Published, Draft
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VersionId

Runbook バージョン ID の配列を指定します。

Type:String[]
Position:Named
Default value:None
Required:True
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