New-SmaRunbookWorkerDeployment
Changes the runbook worker deployment in SMA.
Syntax
New-SmaRunbookWorkerDeployment
[-ComputerName] <String[]>
[-Force]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-SmaRunbookWorkerDeployment
-RunbookWorkers <SmaRunbookWorkerDeploymentInfo[]>
[-Force]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-SmaRunbookWorkerDeployment cmdlet changes the runbook worker deployment in Service Management Automation (SMA). Runbook workers are processes configured to pick up and process runbook jobs.
Examples
Example 1: Create runbook workers
PS C:\> New-SmaRunbookWorkerDeployment -WebServiceEndpoint "https://contoso.com/app01" -ComputerName "RWComputer01", "RWComputer02"
This command creates a runbook worker deployment that contains the computers named RWcomputer01 and RWComputer02 for the specified web service endpoint.
Parameters
-AuthenticationType
Specifies the authentication type. Valid values are:
- Basic
- Windows
The default value for this parameter 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 |
-ComputerName
Specifies an array of names for computers that host runbooks. You can use NetBIOS names, IP addresses, or fully qualified domain names (FQDNs). If you do not specify this parameter, the cmdlet uses the local computer.
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
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 |
-Force
Forces the command to run without asking for user confirmation.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
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 |
-RunbookWorkers
Specifies the runbook workers to include in the new deployment.
Type: | SmaRunbookWorkerDeploymentInfo[] |
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 example, http:// or https://.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |