Set-SmaRunbookConfiguration
修改 Runbook 的配置。
语法
Set-SmaRunbookConfiguration
[-LogDebug <Boolean>]
[-LogVerbose <Boolean>]
[-LogProgress <Boolean>]
[-Description <String>]
[-RunbookWorker <String>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>]
Set-SmaRunbookConfiguration
-Id <String>
[-LogDebug <Boolean>]
[-LogVerbose <Boolean>]
[-LogProgress <Boolean>]
[-Description <String>]
[-RunbookWorker <String>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>]
Set-SmaRunbookConfiguration
-Name <String>
[-LogDebug <Boolean>]
[-LogVerbose <Boolean>]
[-LogProgress <Boolean>]
[-Description <String>]
[-RunbookWorker <String>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>]
说明
Set-SmaRunbookConfiguration cmdlet 修改 Runbook 的配置。
示例
示例 1:更新 Runbook 配置
PS C:\>Set-SmaRunbookConfiguration -Name "Runbook01" -WebServiceEndpoint "https://localhost" -Description "First runbook" -LogDebug $True -LogProgress $True -LogVerbose $True
此命令向名为 Runbook01 的 Runbook 添加说明,并启用所有日志记录选项。
参数
-AuthenticationType
指定身份验证类型。 有效值为:
- 基本
- 窗户
此参数的默认值为 Windows。 如果使用基本身份验证,则必须使用 Credential 参数提供凭据。
类型: | String |
接受的值: | Basic, Windows |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Credential
指定连接到 Service Management Automation (SMA) Web 服务的 PSCredential 对象。
若要获取凭据对象,请使用 Get-Credential cmdlet。
有关详细信息,请键入 Get-Help Get-Credential
。
类型: | PSCredential |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Description
提供 Runbook 的说明。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Id
指定 Runbook 的 ID。
类型: | String |
别名: | RunbookId |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-LogDebug
指示此 cmdlet 是否记录调试输出。
类型: | Boolean |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-LogProgress
指示此 cmdlet 是否记录进度输出。
类型: | Boolean |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-LogVerbose
指示此 cmdlet 是否记录详细输出。
类型: | Boolean |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Name
指定 Runbook 的名称。
类型: | String |
别名: | RunbookName |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-Port
指定 SMA Web 服务的端口号。
类型: | Int32 |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-RunbookWorker
指定 Runbook 的指定 Runbook 辅助角色。 可以在当前 SMA 部署中指定现有的 Runbook 辅助角色。 使用 Get-SmaRunbookWorkerDeployment cmdlet 获取当前 SMA 部署中的 Runbook 辅助角色列表。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-WebServiceEndpoint
将终结点指定为 SMA Web 服务的 URL。 必须包括协议,例如 http:// 或 https://。
类型: | String |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |