New-SmaRunbookWorkerDeployment

Applies To: System Center 2012 R2 Orchestrator, Windows Azure Pack for Windows Server

New-SmaRunbookWorkerDeployment

Changes the runbook worker deployment in Service Management Automation.

Syntax

Parameter Set: ByComputerName
New-SmaRunbookWorkerDeployment [-ComputerName] <String[]> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Force] [-Port <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByRunbookWorkers
New-SmaRunbookWorkerDeployment -RunbookWorkers <SmaRunbookWorkerDeploymentInfo[]> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Force] [-Port <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The New-SmaRunbookWorkerDeployment cmdlet changes the runbook worker deployment in Service Management Automation. Runbook workers are processes configured to pick up and process runbook jobs.

Parameters

-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

none

Required?

false

Position?

named

Default Value

Windows

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String[]>

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.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies user credentials, as a PSCredential object, to use for the connection to the Service Management Automation web service. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Creates the runbook worker deployment without prompting you for confirmation. By default, the cmdlet prompts you for confirmation before it proceeds.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Port<Int32>

Specifies the port number of the Service Management Automation web service.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunbookWorkers<SmaRunbookWorkerDeploymentInfo[]>

Specifies the runbook workers to include in the new deployment.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WebServiceEndpoint<String>

Specifies the endpoint, as a URL, of the Service Management Automation web service. Include the protocol, for example, http:// or https://.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before executing the command.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Create runbook workers

This command creates a runbook worker deployment that contains the computers named RWcomputer01 and RWComputer02 for the specified web service endpoint.

PS C:\> New-SmaRunbookWorkerDeployment -WebServiceEndpoint "https://contoso.com/app01" -ComputerName "RWcomputer01", "RWComputer02"

Get-SmaRunbookWorkerDeployment

about_SMA_Runbook_Worker_Deployment