Remove-SmaRunbook

Removes a runbook from SMA.

Syntax

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

Description

The Remove-SmaRunbook cmdlet removes a runbook from Service Management Automation (SMA).

Examples

Example 1: Remove a runbook

PS C:\> Remove-SmaRunbook -WebServiceEndpoint https://localhost -Name "MyRunbook"

This command removes the runbook named MyRunbook.

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
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
-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 example, 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