Get-SmaRunbookDefinition

Module:

Microsoft.SystemCenter.ServiceManagementAutomation Module

Gets a runbook definition.

Syntax

All (Default)

Get-SmaRunbookDefinition
    -Type <RunbookVersionType>
    -WebServiceEndpoint <String>
    [-Port <Int32>]
    [-AuthenticationType <String>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

ByRunbookId

Get-SmaRunbookDefinition
    -Id <String[]>
    -Type <RunbookVersionType>
    -WebServiceEndpoint <String>
    [-Port <Int32>]
    [-AuthenticationType <String>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

ByRunbookName

Get-SmaRunbookDefinition
    [-Name] <String[]>
    -Type <RunbookVersionType>
    -WebServiceEndpoint <String>
    [-Port <Int32>]
    [-AuthenticationType <String>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

ByVersionId

Get-SmaRunbookDefinition
    -VersionId <String[]>
    -WebServiceEndpoint <String>
    [-Port <Int32>]
    [-AuthenticationType <String>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Description

The Get-SmaRunbookDefinition cmdlet gets one or more runbooks. By default, all runbook definitions of the specified version type are returned. To get a specific runbook, specify its name or ID.

Examples

Example 1: Get a runbook definition by name

PS C:\>Get-SmaRunbookDefinition -WebServiceEndpoint "https://localhost" -Name "RunbookDef01" -Type "Draft"

This command gets the draft runbook definition of the runbook with the name RunbookDef01.

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.

Parameter properties

Type:	String
Default value:	None
Accepted values:	Basic, Windows
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

Type:	PSCredential
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Id

Specifies an array of runbook IDs that this cmdlet gets runbook definitions from.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	RunbookId

Parameter sets

ByRunbookId

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Specifies an array of runbook names that this cmdlet gets runbook definitions from.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	RunbookName

Parameter sets

ByRunbookName

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Port

Specifies the port number of the SMA web service.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Type

Specifies a runbook version type. Valid values are:

• Published
• Draft

Parameter properties

Type:	RunbookVersionType
Default value:	None
Accepted values:	Published, Draft
Supports wildcards:	False
DontShow:	False

Parameter sets

All

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByRunbookId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByRunbookName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VersionId

Specifies an array of runbook version IDs.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByVersionId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WebServiceEndpoint

Specifies the endpoint, as a URL, of the SMA web service. You must include the protocol, for instance, http:// or https://.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Related Links

• Get-SmaRunbook