Export (0) Print
Expand All

Set-SmaRunbookConfiguration

System Center 2012 R2

Updated: November 1, 2013

Applies To: System Center 2012 R2 Orchestrator, Windows Azure Pack for Windows Server

Set-SmaRunbookConfiguration

Modifies the configuration of a runbook.

Syntax

Parameter Set: All
Set-SmaRunbookConfiguration -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Description <String> ] [-LogDebug <Boolean> ] [-LogProgress <Boolean> ] [-LogVerbose <Boolean> ] [-Port <Int32> ] [ <CommonParameters>]

Parameter Set: ByRunbookId
Set-SmaRunbookConfiguration -Id <String> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Description <String> ] [-LogDebug <Boolean> ] [-LogProgress <Boolean> ] [-LogVerbose <Boolean> ] [-Port <Int32> ] [ <CommonParameters>]

Parameter Set: ByRunbookName
Set-SmaRunbookConfiguration -Name <String> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Description <String> ] [-LogDebug <Boolean> ] [-LogProgress <Boolean> ] [-LogVerbose <Boolean> ] [-Port <Int32> ] [ <CommonParameters>]




Detailed Description

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

Parameters

-AuthenticationType<String>

Specifies the authentication type. Valid values are: Basic, Windows.

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


Aliases

none

Required?

false

Position?

named

Default Value

Windows

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Credential<PSCredential>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

Provides a description for a runbook.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Id<String>

Specifies the ID of a runbook.


Aliases

RunbookId

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-LogDebug<Boolean>

Indicates whether debug output is logged.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LogProgress<Boolean>

Indicates whether log progress output is logged.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LogVerbose<Boolean>

Indicates whether verbose output is logged.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a runbook.


Aliases

RunbookName

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Port<Int32>

Specifies the port number of the Service Management Automation web service.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WebServiceEndpoint<String>

Specifies the endpoint, as a URL, of the Service Management Automation web service. Include the protocol, for example, http:// or https://.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Update a runbook configuration

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


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

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft