Get-SmaRunbook

Gets an SMA runbook.

Syntax

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

Description

The Get-SmaRunbook cmdlet gets one or more Service Management Automation (SMA) runbooks. By default, all runbooks are returned. To get a specific runbook, specify its name or ID.

Examples

Example 1: Get a runbook by its name

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

This command gets the runbook named Runbk01 from the SMA web service that has endpoint URL https://contoso.com/app01.

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
-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 an array of runbook IDs that this cmdlet gets.

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

Specifies an array of runbook names that this cmdlet gets.

Type:String[]
Aliases:RunbookName
Required:False
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