Get-SmaRunbookWorkerDeployment
Gets all runbook workers in the SMA deployment.
Syntax
Default (Default)
Get-SmaRunbookWorkerDeployment
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>]
Description
The Get-SmaRunbookWorkerDeployment cmdlet gets all runbook workers in the Service Management Automation (SMA) deployment. Specify the web service endpoint and optionally, a port. Runbook workers in the SMA deployment are workers configured to pick up and process runbook jobs.
Examples
Example 1: Get runbook workers in the Service Management Automation deployment
PS C:\> Get-SmaRunbookWorkerDeployment -WebServiceEndpoint "https://contoso.com/app01"
This command gets all runbook workers from the SMA web service that has the endpoint URL https://contoso.com/app01.
Parameters
-AuthenticationType
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.
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 |
-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 |
-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.