Set-SCLoadBalancerConfiguration
Updates a load balancer configuration object for a computer tier.
Syntax
Set-SCLoadBalancerConfiguration
[-LoadBalancerVIP <String>]
[-Port <Int32>]
[-LoadBalancer <LoadBalancer>]
[-PinLoadBalancer <Boolean>]
[-UseExistingVIPAddress <Boolean>]
[-VIPAddressPool <StaticIPAddressPool>]
[-PinVIPAddressPool <Boolean>]
-LoadBalancerConfiguration <LoadBalancerConfiguration>
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>] Description
The Set-SCLoadBalancerConfiguration cmdlet updates a load balancer configuration object for a computer tier.
Examples
Example 1: Set the properties of a load balancer configuration
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 $LBThe first command gets the service configuration object named Service01 and stores the object in the $ServiceConfig variable.
The second command gets the computer tier configuration for the service configuration stored in $ServiceConfig and stores the object in the $TierConfig variable.
The third command gets the load balancer configuration for the computer tier configuration stored in $TierConfig and stores the object in the $LBConfig variable.
The fourth command gets the load balancer with the address of LB01.Contoso.com and stores the object in the $LB variable.
The last command set the properties of the load balancer configuration object stored in $LB.
Parameters
-JobVariable
Specifies that job progress is tracked and stored in the variable named by this parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoadBalancer
Specifies a load balancer object.
| Type: | LoadBalancer |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoadBalancerConfiguration
Specifies a load balancer configuration object.
| Type: | LoadBalancerConfiguration |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LoadBalancerVIP
Specifies a virtual IP (VIP) in a load balancer.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PinLoadBalancer
Indicates whether the load balancer chosen by the user is retained during service deployment configuration.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PinVIPAddressPool
Indicates whether the virtual IP (VIP) address pool chosen by the user is retained during service deployment configuration.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Port
Specifies the network port to use when adding an object or creating a connection. Valid values are: 1 to 4095.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PROTipID
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseExistingVIPAddress
Indicates whether the existing virtual IP (VIP) address is used, if one has been assigned.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VIPAddressPool
Specifies a static IP address pool.
| Type: | StaticIPAddressPool |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
LoadBalancerConfiguration
This cmdlet returns a LoadBalancerConfiguration object.