New-SCLoadBalancerVIPTemplate

New-SCLoadBalancerVIPTemplate

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

Syntax

Parameter Set: Generic
New-SCLoadBalancerVIPTemplate -LoadBalancerPort <UInt16> -LoadBalancerProtocol <LoadBalancerProtocol> -LoadBalancingMethod <LoadBalancingMethod> -Name <String> [-Description <String> ] [-JobVariable <String> ] [-LoadBalancerConnectionPersistence <LoadBalancerConnectionPersistence> ] [-LoadBalancerHealthMonitor <LoadBalancerHealthMonitor[]> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

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

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

Parameters

-Description<String>

States a description for the specified object.

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

-LoadBalancerConnectionPersistence<LoadBalancerConnectionPersistence>

Specifies a load balancer connection persistence object.

-LoadBalancerHealthMonitor<LoadBalancerHealthMonitor[]>

Specifies a load balancer health monitor object or objects.

-LoadBalancerManufacturer<String>

Specifies the name of the company that manufactured a load balancer.

Valid characters are:

-- letters (a-z)
-- numbers (0-9)
-- underscore (_)
-- hyphen (-)
-- dot (.)
-- and single quote (')

-LoadBalancerModel<String>

Specifies the model of a load balancer.

-LoadBalancerPort<UInt16>

Specifies the port to use when configuring a virtual IP (VIP) in a load balancer.

-LoadBalancerProtocol<LoadBalancerProtocol>

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

-LoadBalancingMethod<LoadBalancingMethod>

Specifies the load balancing method to use. Valid values 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 the following command: (Get-SCLoadBalancer)[0].AvailableLoadBalancingMethods

-Name<String>

Specifies the name of a VMM object.

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

-VMMServer<ServerConnection>

Specifies a VMM server object.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example Example 1: Create a "specific" load balancer virtual IP (VIP) template.

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

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

Related topics

Get-SCLoadBalancerVIPTemplate

New-SCLoadBalancerVIP

Remove-SCLoadBalancerVIPTemplate

Set-SCLoadBalancerVIPTemplate

New-SCLoadBalancerProtocol

New-SCLoadBalancerConnectionPersistence

New-SCLoadBalancerHealthMonitor

New-SCLoadBalancingMethod