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 cmdlet 获取一个或多个 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
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Credential

为连接到 SMA Web 服务指定 PSCredential 对象。 若要获取凭据对象,请使用 Get-Credential cmdlet。 有关详细信息,请键入 Get-Help Get-Credential

类型:PSCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Id

指定此 cmdlet 从中获取 Runbook 定义的 Runbook ID 数组。

类型:String[]
别名:RunbookId
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-Name

指定此 cmdlet 从中获取 Runbook 定义的 Runbook 名称数组。

类型:String[]
别名:RunbookName
Position:0
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-Port

指定 SMA Web 服务的端口号。

类型:Int32
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Type

指定 Runbook 版本类型。 有效值为:

  • 发表
  • 草案
类型:RunbookVersionType
接受的值:Published, Draft
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-VersionId

指定 Runbook 版本 ID 的数组。

类型:String[]
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-WebServiceEndpoint

将终结点指定为 SMA Web 服务的 URL。 必须包括协议,例如,http:// 或 https://。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False