Share via

Set-SCLoadBalancer

  • Reference
Module:
VirtualMachineManager

Modifies the properties of a load balancer.

Syntax

Set-SCLoadBalancer
   [-VMMServer <ServerConnection>]
   [-LoadBalancer] <LoadBalancer>
   [-LoadBalancerAddress <String>]
   [-Port <UInt16>]
   [-Manufacturer <String>]
   [-Model <String>]
   [-RunAsAccount <RunAsAccount>]
   [-ConfigurationProvider <ConfigurationProvider>]
   [-AddVMHostGroup <HostGroup[]>]
   [-RemoveVMHostGroup <HostGroup[]>]
   [-AddLogicalNetworkVIP <LogicalNetwork[]>]
   [-RemoveLogicalNetworkVIP <LogicalNetwork[]>]
   [-AddLogicalNetworkDedicatedIP <LogicalNetwork[]>]
   [-RemoveLogicalNetworkDedicatedIP <LogicalNetwork[]>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

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

Examples

Example 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.

Parameters

-AddLogicalNetworkDedicatedIP

Specifies the logical network from which this cmdlet assigns an IP address to a virtual machine in a service tier as the back-end address for a service.

Type:LogicalNetwork[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AddLogicalNetworkVIP

Specifies the logical network from which this cmdlet assigns a virtual IP (VIP) address to a load balancer VIP as the front-end address for a service.

Type:LogicalNetwork[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AddVMHostGroup

Specifies an array of host groups that this cmdlet adds to an existing host group array or private cloud.

Type:HostGroup[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConfigurationProvider

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 is not added.

Type:ConfigurationProvider
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LoadBalancerAddress

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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Manufacturer

Specifies the name of the company that manufactured a physical device. Valid characters include:

  • Letters (a-z)
  • Numbers (0-9)
  • Underscore (_)
  • Hyphen (-)
  • Dot (.)
  • Single quote (')
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Model

Specifies the model of a physical device.

Type:String
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:UInt16
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

-RemoveLogicalNetworkDedicatedIP

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 is now removed.

Type:LogicalNetwork[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveLogicalNetworkVIP

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 is now removed.

Type:LogicalNetwork[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveVMHostGroup

Specifies an array of host groups that this cmdlet removes from a host group array or private cloud.

Type:HostGroup[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsAccount

Specifies a Run As account that contains credentials with permission to perform this action.

Type:RunAsAccount
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

-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Outputs

LoadBalancer

This cmdlet returns a LoadBalancer object.