Get-SmaRunbookDefinition
Gets a runbook definition.
Syntax
Get-SmaRunbookDefinition
-Type <RunbookVersionType>
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>] Get-SmaRunbookDefinition
-Id <String[]>
-Type <RunbookVersionType>
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>] Get-SmaRunbookDefinition
[-Name] <String[]>
-Type <RunbookVersionType>
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>] 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.
| Type: | String |
| Accepted values: | Basic, Windows |
| Position: | Named |
| Default value: | None |
| 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 an array of runbook IDs that this cmdlet gets runbook definitions from.
| Type: | String[] |
| Aliases: | RunbookId |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies an array of runbook names that this cmdlet gets runbook definitions from.
| Type: | String[] |
| Aliases: | RunbookName |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| 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 |
-Type
Specifies a runbook version type. Valid values are:
- Published
- Draft
| Type: | RunbookVersionType |
| Accepted values: | Published, Draft |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VersionId
Specifies an array of runbook version IDs.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |