Share via

Set-SCLoadBalancerVIPTemplate

  • Reference
Module:
VirtualMachineManager

Modifies the properties of a load balancer VIP template.

Syntax

Set-SCLoadBalancerVIPTemplate
   [-VMMServer <ServerConnection>]
   [-LoadBalancerVIPTemplate] <LoadBalancerVIPTemplate>
   [-Name <String>]
   [-Description <String>]
   [-LoadBalancerManufacturer <String>]
   [-LoadBalancerModel <String>]
   [-LoadBalancerConnectionPersistence <LoadBalancerConnectionPersistence>]
   [-LoadBalancerHealthMonitor <LoadBalancerHealthMonitor[]>]
   [-LoadBalancerProtocol <LoadBalancerProtocol>]
   [-LoadBalancerPort <UInt16>]
   [-LoadBalancerBackEndPort <UInt16>]
   [-LoadBalancingMethod <LoadBalancingMethod>]
   [-DisableLoadBalancerConnectionPersistence]
   [-MakeGeneric]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

The Set-SCLoadBalancerVIPTemplate cmdlet modifies the properties of a load balancer virtual IP (VIP) template.

Examples

Example 1: Change the load balancing method in a load balancer virtual IP template

PS C:\> $VIPTemplate = Get-SCLoadBalancerVIPTemplate -Manufacturer "LB Manufacturer" -Model "LB01" -Name "VIPTemplate01"
PS C:\> $LBMethod = New-SCLoadBalancingMethod -Name "RoundRobin"
PS C:\> Set-SCLoadBalancerVIPTemplate -LoadBalancerVIPTemplate $VIPTemplate -LoadBalancingMethod $LBMethod

The first command gets the VIP template object named VIPTemplate01 and stores the object in the $VIPTemplate variable.

The second command creates a new load balancing method object with the name Round Robin and stores the object in the $LBMethod variable.

The last command changes the load balancing method for the VIP template stored in $VIPTemplate to the method stored in $LBMethod, which is Round Robin.

Parameters

-Description

Specifies a description for the VIP template.

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

-DisableLoadBalancerConnectionPersistence

Indicates that the load balancer connection persistence in a VIP profile is disabled.

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

-LoadBalancerBackEndPort

Specifies the port on which the backend service is running which is being load balanced.

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

-LoadBalancerConnectionPersistence

Specifies a load balancer connection persistence object.

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

-LoadBalancerHealthMonitor

Specifies an array of load balancer health monitor objects.

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

-LoadBalancerManufacturer

Specifies the name of the company that manufactured a load balancer. The acceptable values for this parameter are:

  • 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

-LoadBalancerModel

Specifies the model of a load balancer.

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

-LoadBalancerPort

Specifies the port to use when configuring a VIP in a load balancer.

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

-LoadBalancerProtocol

Specifies the protocol to use when connecting to a load balancer, or a load balancer protocol object.

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

-LoadBalancerVIPTemplate

Specifies a load balancer VIP template.

Type:LoadBalancerVIPTemplate
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LoadBalancingMethod

Specifies the load balancing method to use. The acceptable values for this parameter are:

  • RoundRobin
  • LeastConnectionsmember
  • Observedmember
  • Predictivemember
  • Ratiomember
  • Fastestmember
  • LeastConnections
  • Observednode
  • Predictivenode
  • Rationode
  • FastestResponseTime
  • LeastSessions
  • None

To determine the available methods for a specific load balancer, use this command: (Get-SCLoadBalancer)[0].AvailableLoadBalancingMethods

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

-MakeGeneric

Indicates that a VIP profile is able to apply generic load balancer settings.

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

-Name

Specifies the name of a Virtual Machine Manager (VMM) object.

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

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