Share via

Publish-SmaRunbook

  • Reference
Module:
Microsoft.SystemCenter.ServiceManagementAutomation

Publishes a runbook in SMA.

Syntax

Publish-SmaRunbook
       [-Name <String>]
       -WebServiceEndpoint <String>
       [-Port <Int32>]
       [-AuthenticationType <String>]
       [-Credential <PSCredential>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Publish-SmaRunbook
       [-Id <String>]
       -WebServiceEndpoint <String>
       [-Port <Int32>]
       [-AuthenticationType <String>]
       [-Credential <PSCredential>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Publish-SmaRunbook cmdlet publishes a runbook into the production environment of Service Management Automation (SMA). Specify the ID or name of a runbook and the web service endpoint.

Examples

Example 1: Publish a runbook

PS C:\> Publish-SmaRunbook -Name "Runbk01" -WebServiceEndpoint "https://contoso.com/app01"

This command publishes the runbook named Runbk01.

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
Accepted values:Basic, Windows
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Credential

Specifies a PSCredential object for the connection to the 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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Specifies the ID of a runbook.

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

-Name

Specifies the name of a runbook.

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

-Port

Specifies the port number of the SMA web service.

Type:Int32
Position:Named
Default value:None
Required:False
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
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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