Share via

New-SCLoadBalancerVIPTemplate

  • Reference
Module:
VirtualMachineManager

Creates a load balancer VIP template used to create a load balancer VIP.

Syntax

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

Description

The New-SCLoadBalancerVIPTemplate cmdlet creates a load balancer virtual IP (VIP) template used to create a load balancer VIP.

For information about creating a load balancer VIP, type Get-Help New-SCLoadBalancerVIP -Detailed.

Examples

Example 1: Create a specific load balancer virtual IP template

PS C:\> $LBProtocol = New-SCLoadBalancerProtocol -Name "HTTPS" -HTTPSCertificate "C=US,ST=WA,L=Redmond,O=Contoso,OU=Test,CN=www.contoso.com/emailAddress=contoso@contoso.com" -HTTPSReencryptconnection $True -TerminateHTTPS $True
PS C:\> $LBConnectionPersistence = New-SCLoadBalancerConnectionPersistence -Name "Source IP" -Value "255.255.255.0"
PS C:\> $LBHealthMonitor = New-SCLoadBalancerHealthMonitor -Name "HTTPMonitor" -ProtocolName "HTTP" -Request "Get /Index.html HTTP/1.1" -Response 200 -IntervalSeconds 15 -TimeoutSeconds 20
PS C:\> $LBMethod = New-SCLoadBalancingMethod -Name "Least Connections"
PS C:\> New-SCLoadBalancerVIPTemplate -Name "VIPTemplate01" -Description "Specific virtual IP Template" -LoadBalancerManufacturer "LB Manufacturer" -LoadBalancerModel "LB01" -LoadBalancerPort "123" -LoadBalancerConnectionPersistence $LBConnectionPersistence -LoadBalancerProtocol $LBProtocol -LoadBalancingMethod $LBMethod  -LoadBalancerHealthMonitor $LBHealthMonitor

The first command creates a load balancer protocol object specifying that the HTTPS connection terminates at the load balancer, and then the connection is re-encrypted with the server. The command then stores the object in the $LBProtocol variable.

The second command creates a load balancer connection presistence object with a value of 255.255.255.0, and then stores the object in the $LBConnectionPersistence variable.

The third command creates a load balancer health monitor object specifying the load balancer protocol, the response, the interval in seconds, and the timeout in seconds. The command then stores the object in the $LBHealthMonitor variable.

The fourth command creates a load balancer method object with the value of LeastConnections and stores the object in the $LBMethod variable.

The last command creates a load balancer VIP template named VIPTemplate01 that is specific to the load balancer model LB01 manufactured by LB Manufacturer using the values for the objects stored in the $LBConnectionPersistence, $LBProtocol, $LBMethod, and $LBHealthMonitor created in the previous commands.

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

-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 a load balancer health monitor object.

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:True
Accept pipeline input:False
Accept wildcard characters:False

-LoadBalancerModel

Specifies the model of a load balancer

Type:String
Position:Named
Default value:None
Required:True
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:True
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:True
Accept pipeline input:False
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:True
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:True
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