Get-SmaRunbook
Get-SmaRunbook
Gets a runbook.
Syntax
Parameter Set: GetAll
Get-SmaRunbook -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]
Parameter Set: ByRunbookId
Get-SmaRunbook -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Id <String[]> ] [-Port <Int32> ] [ <CommonParameters>]
Parameter Set: ByRunbookName
Get-SmaRunbook -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Name <String[]> ] [-Port <Int32> ] [ <CommonParameters>]
Detaillierte Beschreibung
The Get-SmaRunbook cmdlet gets one or more runbooks. By default, all runbooks are returned. To get a specific runbook, specify its name or ID.
Parameter
-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.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Windows |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
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.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Current User |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-Id<String[]>
Specifies an array of runbook IDs.
Aliasse |
RunbookId |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByValue) |
Platzhalterzeichen akzeptieren? |
false |
-Name<String[]>
Specifies an array of runbook names.
Aliasse |
RunbookName |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-Port<Int32>
Specifies the port number of the web service.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
9090 |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-WebServiceEndpoint<String>
Specifies the endpoint, as a URL, of the web service. Include the protocol, for example, http:// or https://.
Aliasse |
Keiner |
Erforderlich? |
true |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
<CommonParameters>
Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Eingaben
Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können.
Ausgaben
Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.
Beispiele
Example 1: Get a runbook by its name
This command gets the runbook named Runbk01 from the web service that has endpoint URL https://contoso.com/app01.
PS C:\> Get-SmaRunbook -Name "Runbk01" -WebServiceEndpoint "https://contoso.com/app01"