Get-SmaRunbookDefinition
Get-SmaRunbookDefinition
Gets a runbook definition.
Sintaxe
Parameter Set: All
Get-SmaRunbookDefinition -Type <RunbookVersionType> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]
Parameter Set: ByRunbookId
Get-SmaRunbookDefinition -Id <String[]> -Type <RunbookVersionType> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]
Parameter Set: ByRunbookName
Get-SmaRunbookDefinition [-Name] <String[]> -Type <RunbookVersionType> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]
Parameter Set: ByVersionId
Get-SmaRunbookDefinition -VersionId <String[]> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]
Descrição detalhada
The Get-SmaRunbookDefinition cmdlet gets one or more runbooks. By default, all runbook definitions of the specifies version type are returned. To get a specific runbook, specify its name or ID.
Parâmetros
-AuthenticationType<String>
Specifies the authentication type. Valid values are: Basic, Windows.
Windows is the default value. If you use Basic authentication, you must provide credentials by using the Credential parameter.
Aliases |
nenhuma |
Necessário? |
false |
Posição? |
named |
Valor padrão |
Windows |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Credential<PSCredential>
Specifies user credentials, as a PSCredential object, to use for the connection to the web service. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.
Aliases |
nenhuma |
Necessário? |
false |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Id<String[]>
Specifies an array of runbook IDs.
Aliases |
RunbookId |
Necessário? |
true |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
True (ByValue) |
Aceitar caracteres curinga? |
false |
-Name<String[]>
Specifies an array of runbook names.
Aliases |
RunbookName |
Necessário? |
true |
Posição? |
1 |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Port<Int32>
Specifies the port number of the web service.
Aliases |
nenhuma |
Necessário? |
false |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Type<RunbookVersionType>
Specifies a runbook version type. Valid values are: Published, Draft.
Aliases |
nenhuma |
Necessário? |
true |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-VersionId<String[]>
Specifies an array of runbook version IDs.
Aliases |
nenhuma |
Necessário? |
true |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-WebServiceEndpoint<String>
Specifies the endpoint, as a URL, of the web service. Include the protocol, for example, http:// or https://.
Aliases |
nenhuma |
Necessário? |
true |
Posição? |
named |
Valor padrão |
nenhuma |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet dá suporte a parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Entradas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet.
Saídas
O tipo de saída é o tipo de objeto emitido pelo cmdlet.
Exemplos
Example 1: Get a runbook definition by Name
This command gets the draft runbook definition of the runbook with the name RunbookDef01.
PS C:\> Get-SmaRunbookDefinition -WebServiceEndpoint "https://localhost" -Name "RunbookDef01" -Type "Draft"