Start-SmaRunbook
啟動 Runbook 作業。
Syntax
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>]
Description
Start-SmaRunbook Cmdlet 會啟動 Runbook 作業。 指定 Runbook 和 Web 服務端點的識別碼或名稱。 如有必要,請指定服務管理自動化 (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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
在執行 Cmdlet 前提示您確認。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | 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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Id
指定 Runbook 的識別碼。
Type: | String |
Aliases: | RunbookId |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
指定 Runbook 的名稱。
Type: | String |
Aliases: | RunbookName |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Parameters
指定索引鍵和值組的雜湊表。 雜湊表中的索引鍵是 Runbook 參數名稱。 雜湊表中的值是 Runbook 參數值。
Type: | IDictionary |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Port
指定 SMA Web 服務的埠號碼。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ScheduleName
指定要啟動 Runbook 的作業排程名稱。 若要在 SMA 中建立排程,請使用 Set-SmaSchedule Cmdlet。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WebServiceEndpoint
指定 SMA Web 服務的端點作為 URL。 例如,您必須包含通訊協定,HTTP:// 或 HTTPs://。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
顯示執行 Cmdlet 後會發生的情況。 Cmdlet 並不會執行。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |