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
認証の種類を指定します。 有効な値は次のとおりです。
- 基本的な
- ウィンドウズ
既定値は Windows です。 基本認証を使用する場合は、Credential パラメーターを使用して資格情報を指定する必要があります。
型: | String |
指定可能な値: | Basic, Windows |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Credential
SMA Web サービスへの接続 PSCredential オブジェクトを指定します。
資格情報オブジェクトを取得するには、Get-Credential コマンドレットを使用します。
詳細については、「Get-Help Get-Credential
」と入力します。
型: | PSCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Id
このコマンドレットが Runbook 定義を取得する Runbook ID の配列を指定します。
型: | String[] |
Aliases: | RunbookId |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
このコマンドレットが Runbook 定義を取得する Runbook 名の配列を指定します。
型: | String[] |
Aliases: | RunbookName |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Port
SMA Web サービスのポート番号を指定します。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Type
Runbook のバージョンの種類を指定します。 有効な値は次のとおりです。
- 公開
- ドラフト
型: | RunbookVersionType |
指定可能な値: | Published, Draft |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-VersionId
Runbook バージョン ID の配列を指定します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WebServiceEndpoint
SMA Web サービスのエンドポイントを URL として指定します。 プロトコル (たとえば、http:// や https://) を含める必要があります。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |