Set-SmaRunbookConfiguration

Modifies the configuration of a runbook.

Syntax

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>]

Description

The Set-SmaRunbookConfiguration cmdlet modifies the configuration of a runbook.

Examples

Example 1: Update a runbook configuration

PS C:\>Set-SmaRunbookConfiguration -Name "Runbook01" -WebServiceEndpoint "https://localhost" -Description "First runbook" -LogDebug $True -LogProgress $True -LogVerbose $True

This command adds a description to the runbook named Runbook01 and enables all logging options.

Required Parameters

-Id

Specifies the ID of a runbook.

Type:String
Aliases:RunbookId
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

Specifies the name of a runbook.

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

Specifies the endpoint, as a URL, of the SMA web service. You must include the protocol, for example, http:// or https://.

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

Optional Parameters

-AuthenticationType

Specifies the authentication type. Valid values are:

  • Basic
  • Windows

The default value for this parameter is Windows. If you use Basic authentication, you must provide credentials by using the Credential parameter.

Type:String
Parameter Sets:Basic, Windows
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies a PSCredential object for the connection to the Service Management Automation (SMA) web service. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

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

Provides a description for a runbook.

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

Indicates whether this cmdlet logs debug output.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LogProgress

Indicates whether this cmdlet logs progress output.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LogVerbose

Indicates whether this cmdlet logs verbose output.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Port

Specifies the port number of the SMA web service.

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

Specifies a designated runbook worker for the runbook. You can specify an existing runbook worker in the current SMA deployment. Use the Get-SmaRunbookWorkerDeployment cmdlet to get a list of runbook workers in the current SMA deployment.

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