Set-SCLoadBalancerVIPTemplate
Set-SCLoadBalancerVIPTemplate
Modifies the properties of a load balancer VIP template.
Syntax
Parameter Set: Default
Set-SCLoadBalancerVIPTemplate [-LoadBalancerVIPTemplate] <LoadBalancerVIPTemplate> [-Description <String> ] [-DisableLoadBalancerConnectionPersistence] [-JobVariable <String> ] [-LoadBalancerConnectionPersistence <LoadBalancerConnectionPersistence> ] [-LoadBalancerHealthMonitor <LoadBalancerHealthMonitor[]> ] [-LoadBalancerManufacturer <String> ] [-LoadBalancerModel <String> ] [-LoadBalancerPort <UInt16]> ] [-LoadBalancerProtocol <LoadBalancerProtocol> ] [-LoadBalancingMethod <LoadBalancingMethod> ] [-MakeGeneric] [-Name <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Set-SCLoadBalancerVIPTemplate cmdlet modifies the properties of a load balancer virtual IP (VIP) template.
Parameters
-Description<String>
States a description for the specified object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DisableLoadBalancerConnectionPersistence
Indicates whether load balancer connection persistence in a virtual IP (VIP) profile is disabled.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LoadBalancerConnectionPersistence<LoadBalancerConnectionPersistence>
Specifies a load balancer connection persistence object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LoadBalancerHealthMonitor<LoadBalancerHealthMonitor[]>
Specifies one or more load balancer health monitor objects.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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 (.)
-- single quote (')
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LoadBalancerModel<String>
Specifies the model of a load balancer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LoadBalancerPort<UInt16]>
Specifies the port to use when configuring a virtual IP (VIP) in a load balancer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LoadBalancerProtocol<LoadBalancerProtocol>
Specifies the protocol to use when connecting to a load balancer, or a load balancer protocol object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LoadBalancerVIPTemplate<LoadBalancerVIPTemplate>
Specifies a load balancer virtual IP (VIP) template.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-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
.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MakeGeneric
Indicates that a virtual IP (VIP) profile is able to apply generic load balancer settings.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a VMM object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<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.
- LoadBalancer
Examples
Example Example 1: Change the load balancing method in a load balancer virtual IP (VIP) template.
The first command gets the VIP template object named VIPTemplate01, and then stores the object in the $VIPTemplate variable.
The second command creates a new load balancing method object named RoundRobin, and then 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 RoundRobin.
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