Edit-SmaRunbook

Updates the draft field of a runbook.

Syntax

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

Description

The Edit-SmaRunbook updates the draft field of a runbook. Provide a Windows PowerShell script (.ps1) file that contains a runbook which becomes the draft runbook. If a draft already exists, use the Overwrite parameter to force the cmdlet to overwrite the existing draft.

To edit a specific type of runbook (Windows PowerShell script or workflow), you must create a new runbook of that type.

Examples

Example 1: Overwrite an existing draft runbook

PS C:\> Edit-SmaRunbook -Name "Runbk01" -WebServiceEndpoint "https://contoso.com" -Path "App01.ps1" -Overwrite

This command overwrites the existing draft runbook.

Parameters

-AuthenticationType

Specifies the authentication type. Valid values are:

- Basic

  • Windows

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

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

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Required:False
Position:Named
Default value: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
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Id

Specifies the ID of a runbook.

Type:String
Aliases:RunbookId
Required:False
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
Required:False
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Overwrite

Indicates that the new draft runbook overwrites the existing draft, if one exists.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Path

Specifies a path to the new draft runbook.

Type:String
Aliases:RunbookPath
Required:True
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
Required:False
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 instance, http:// or https://.

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