Start-SmaRunbook

启动 Runbook 作业。

语法

Start-SmaRunbook
     [-Name <String>]
     [-Parameters <IDictionary>]
     [-ScheduleName <String>]
     -WebServiceEndpoint <String>
     [-Port <Int32>]
     [-AuthenticationType <String>]
     [-Credential <PSCredential>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-SmaRunbook
     [-Id <String>]
     [-Parameters <IDictionary>]
     [-ScheduleName <String>]
     -WebServiceEndpoint <String>
     [-Port <Int32>]
     [-AuthenticationType <String>]
     [-Credential <PSCredential>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

说明

Start-SmaRunbook cmdlet 启动 Runbook 作业。 指定 Runbook 和 Web 服务终结点的 ID 或名称。 如有必要,请指定 Service Management Automation (SMA) Web 服务的端口。

示例

示例 1:启动 Runbook 作业

PS C:\> Start-SmaRunbook -WebServiceEndpoint https://localhost -Name "Runbk01" -Parameters @{"StringParam"="Value"; "IntParam"=2}

此命令启动名为 Runbk01 的 Runbook,并指定 Runbook 作业的参数。

参数

-AuthenticationType

指定身份验证类型。 有效值为:

  • 基本
  • Windows

此参数的默认值为 Windows。 如果使用基本身份验证,则必须使用 Credential 参数提供 凭据

Type:String
Accepted values:Basic, Windows
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

指定连接到 SMA Web 服务的 PSCredential 对象。 若要获取凭据对象,请使用 Get-Credential cmdlet。 要了解详情,请键入 Get-Help Get-Credential

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Id

指定 Runbook 的 ID。

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

-Name

指定 Runbook 的名称。

Type:String
Aliases:RunbookName
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Parameters

指定键和值对的哈希表。 哈希表中的键是 Runbook 参数名称。 哈希表中的值是 Runbook 参数值。

Type:IDictionary
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Port

指定 SMA Web 服务的端口号。

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-ScheduleName

指定要启动 Runbook 的作业计划的名称。 若要在 SMA 中创建计划,请使用 Set-SmaSchedule cmdlet。

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-WebServiceEndpoint

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

显示在此 cmdlet 运行的情况下将会发生什么。 此 cmdlet 未运行。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False