Get-SmaRunbookWorkerDeployment

Gets all runbook workers in the SMA deployment.

Syntax

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.

Required Parameters

-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
Accept pipeline input:False
Accept wildcard characters:False

Optional 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.

Type:String
Parameter Sets:Basic, Windows
Position:Named
Default value:None
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
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
Accept pipeline input:False
Accept wildcard characters:False