Set-SCLoadBalancerConfiguration

Set-SCLoadBalancerConfiguration

Updates a load balancer configuration object for a computer tier.

Syntax

Parameter Set: Default
Set-SCLoadBalancerConfiguration -LoadBalancerConfiguration <LoadBalancerConfiguration> [-JobVariable <String> ] [-LoadBalancer <LoadBalancer> ] [-LoadBalancerVIP <String> ] [-PinLoadBalancer <Boolean> ] [-PinVIPAddressPool <Boolean> ] [-Port <Int32> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-UseExistingVIPAddress <Boolean> ] [-VIPAddressPool <StaticIPAddressPool> ] [ <CommonParameters>]

Detailed Description

The Set-SCLoadBalancerConfiguration cmdlet updates a load balancer configuration object for a computer tier.

Parameters

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LoadBalancer<LoadBalancer>

Specifies a load balancer object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LoadBalancerConfiguration<LoadBalancerConfiguration>

Specifies a load balancer configuration object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-LoadBalancerVIP<String>

Specifies a virtual IP (VIP) in a load balancer.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PinLoadBalancer<Boolean>

Indicates whether the load balancer chosen by the user is retained during service deployment configuration.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PinVIPAddressPool<Boolean>

Indicates whether the virtual IP (VIP) address pool chosen by the user is retained during service deployment configuration.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Port<Int32>

Specifies the network port to use when adding an object or creating a connection. Valid values are: 1 to 4095.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UseExistingVIPAddress<Boolean>

Indicates that the existing virtual IP (VIP) address is used, if one has been assigned.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VIPAddressPool<StaticIPAddressPool>

Specifies a static IP address pool.

Aliases

none

Required?

false

Position?

named

Default Value

none

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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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.

  • LoadBalancerConfiguration

Examples

Example 1: Set the properties of a load balancer configuration

The first command gets the service configuration object named Service01, and then stores the object in the $ServiceConfig variable.

The second command gets the computer tier configuration for the service configuration stored in $ServiceConfig, and then stores the object in the $TierConfig variable.

The third command gets the load balancer configuration for the computer tier configuration stored in $TierConfig, and then stores the object in the $LBConfig variable.

The fourth command gets the load balancer with the address of LB01.Contoso.com, and then stores the object in the $LB variable.

The last command set the properties of the load balancer configuration object stored in $LB.

PS C:\> $ServiceConfig = Get-SCServiceConfiguration -Name "Service01"
PS C:\> $TierConfig = Get-SCComputerTierConfiguration -ServiceConfiguration $ServiceConfig
PS C:\> $LBConfig = Get-SCLoadBalancerConfiguration -ComputerTierConfiguration $TierConfig
PS C:\> $LB = Get-SCLoadBalancer -LoadBalancerAddress "LB01.Contoso.com"
PS C:\> Set-SCLoadBalancerConfiguration -LoadBalancerConfiguration $LBConfig -LoadBalancer $LB

Get-SCLoadBalancerConfiguration

Get-SCServiceConfiguration

Get-SCComputerTierConfiguration

Get-SCLoadBalancer