Get-SmaRunbookDefinition

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

Get-SmaRunbookDefinition

Gets a runbook definition.

構文

Parameter Set: All
Get-SmaRunbookDefinition -Type <RunbookVersionType> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]

Parameter Set: ByRunbookId
Get-SmaRunbookDefinition -Id <String[]> -Type <RunbookVersionType> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]

Parameter Set: ByRunbookName
Get-SmaRunbookDefinition [-Name] <String[]> -Type <RunbookVersionType> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]

Parameter Set: ByVersionId
Get-SmaRunbookDefinition -VersionId <String[]> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]

詳細説明

The Get-SmaRunbookDefinition cmdlet gets one or more runbooks. By default, all runbook definitions of the specifies version type are returned. To get a specific runbook, specify its name or ID.

パラメーター

-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 an array of runbook IDs.

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

-Name<String[]>

Specifies an array of runbook names.

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

-Port<Int32>

Specifies the port number of the web service.

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

-Type<RunbookVersionType>

Specifies a runbook version type. Valid values are: Published, Draft.

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

-VersionId<String[]>

Specifies an array of runbook version IDs.

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

<CommonParameters>

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

入力

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

出力

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

例

Example 1: Get a runbook definition by Name

This command gets the draft runbook definition of the runbook with the name RunbookDef01.

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

Get-SmaRunbookDefinition