Set-SCLoadBalancer

Modifies the properties of a load balancer.

Description

The Set-SCLoadBalancer cmdlet modifies the properties of a load balancer.

For more information about Set-SCLoadBalancer, type: "Get-Help Set-SCLoadBalancer -online".

Parameters

LoadBalancer

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0
Specifies a load balancer object.

AddLogicalNetworkDedicatedIP

Required? false
Accept Pipeline Input? false
Position? named
Specifies the logical network from which an IP address should be assigned to a virtual machine in a service tier as the back-end address for a service.

AddLogicalNetworkVIP

Required? false
Accept Pipeline Input? false
Position? named
Specifies the logical network from which a virtual IP (VIP) address should be assigned to a load balancer VIP as the front-end address for a service.

AddVMHostGroup

Required? false
Accept Pipeline Input? false
Position? named
Adds one or more host groups to an existing host group array or private cloud.

ConfigurationProvider

Required? false
Accept Pipeline Input? false
Position? named
Specifies a configuration provider object. A configuration provider is a plug-in to VMM that translates VMM PowerShell commands to API calls that are specific to a type of load balancer. If no configuration provider is specified, VMM uses the Manufacturer and Model information to choose an available configuration provider. If no configuration provider is found, the load balancer will not be added.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

LoadBalancerAddress

Required? false
Accept Pipeline Input? false
Position? named
Specifies the fully qualified domain name (FQDN) or IP address of a load balancer. Usual formats are FQDN, IPv4 or IPv6 addresses, but check with the load balancer manufacturer for the valid format for your load balancer.

Manufacturer

Required? false
Accept Pipeline Input? false
Position? named
Specifies the name of the company that manufactured a physical device.

Valid characters include: letters (a-z), numbers (0-9), underscore (_), hyphen(-), dot(.), and single quote(').

Model

Required? false
Accept Pipeline Input? false
Position? named
Specifies the model of a physical device.

Port

Required? false
Accept Pipeline Input? false
Position? named
Specifies the network port to use when adding an object or creating a connection. Valid values are: 1 to 4095.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RemoveLogicalNetworkDedicatedIP

Required? false
Accept Pipeline Input? false
Position? named
Specifies the logical network from which an IP address was assigned to a virtual machine in a service tier as the front-end address for a service, and should now be removed.

RemoveLogicalNetworkVIP

Required? false
Accept Pipeline Input? false
Position? named
Specifies the logical network from which a virtual IP (VIP) address was assigned to a load balancer as the front-end address for a service, and should now be removed.

RemoveVMHostGroup

Required? false
Accept Pipeline Input? false
Position? named
Removes one or more host groups from a host group array or private cloud.

RunAsAccount

Required? false
Accept Pipeline Input? false
Position? named
Specifies a Run As account that contains credentials with permission to perform this action.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named
Specifies a VMM server object.

Examples

1: Change the configuration provider for a load balancer.
PS C:\> $LoadBalancer = Get-SCLoadBalancer -LoadBalancerAddress "LB01.Contoso.com"
PS C:\> $NewProvider = Get-SCConfigurationProvider | where { $_.Type -eq "LoadBalancer" -and $_.Manufacturer -eq "LB Manufacturer 2" -and $_.Model -eq "LB02"} 
PS C:\> Set-SCLoadBalancer -LoadBalancer $LoadBalancer -ConfigurationProvider $NewProvider -Manufacturer "LB Manufacturer 2" -Model "LB02"
The first command gets the load balancer object with the address of LB01.Contoso.com and stores the object in the $LoadBalancer variable.

The second command gets the configuration provider with the Manufacturer of LB Manufacturer 2 and the model of LB02.

The third command updates the configuration provider for the load balancer stored in $LoadBalancer to the configuration provider stored in $NewProvider.

See Also