Get-SmaRunbook

Get-SmaRunbook

Gets a runbook.

構文

Parameter Set: GetAll
Get-SmaRunbook -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]

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

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




詳細説明

The Get-SmaRunbook cmdlet gets one or more runbooks. By default, all runbooks 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

既定値

Current User

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Id<String[]>

Specifies an array of runbook IDs.


エイリアス

RunbookId

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByValue)

ワイルドカード文字を許可する

false

-Name<String[]>

Specifies an array of runbook names.


エイリアス

RunbookName

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Port<Int32>

Specifies the port number of the web service.


エイリアス

なし

必須?

false

位置は?

named

既定値

9090

パイプライン入力を許可する

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 (http://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

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

出力

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

Example 1: Get a runbook by its name

This command gets the runbook named Runbk01 from the web service that has endpoint URL https://contoso.com/app01.


PS C:\> Get-SmaRunbook -Name "Runbk01" -WebServiceEndpoint "https://contoso.com/app01"

関連トピック

コミュニティの追加

追加
表示: