Set-SCLoadBalancerTemplate
Set-SCLoadBalancerTemplate
Configures the properties of a load balancer template.
Syntax
Parameter Set: Default
Set-SCLoadBalancerTemplate -LoadBalancerTemplate <LoadBalancerTemplate> [-JobVariable <String> ] [-LoadBalancerVIPTemplate <LoadBalancerVIPTemplate> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-VMNetworkServiceSetting <String> ] [-VMNetworkVIP <VMNetwork> ] [ <CommonParameters>]
Parameter Set: LogicalNetworkVIP
Set-SCLoadBalancerTemplate -LoadBalancerTemplate <LoadBalancerTemplate> [-JobVariable <String> ] [-LoadBalancerVIPTemplate <LoadBalancerVIPTemplate> ] [-LogicalNetworkVIP <LogicalNetwork> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-VMNetworkServiceSetting <String> ] [-VMNetworkVIP <VMNetwork> ] [ <CommonParameters>]
Detailed Description
The Set-SCLoadBalancerTemplate cmdlet configures the properties of a load balancer template.
Parameters
-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 |
-LoadBalancerTemplate<LoadBalancerTemplate>
Specifies a load balancer template object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-LoadBalancerVIPTemplate<LoadBalancerVIPTemplate>
Specifies a load balancer virtual IP (VIP) template.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LogicalNetworkVIP<LogicalNetwork>
Specifies the logical networks from which the front-end IP address for the load balancer should be assigned (the front-end logical network affinity).
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 |
-VMNetworkServiceSetting<String>
Specifies a VM network service setting.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMNetworkVIP<VMNetwork>
Specifies a VM Network object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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.
Examples
Example 1: Configure a load balancer template
The first command gets the service template object named ServiceTemplate01, and then stores the object in the $ServiceTemplate variable.
The second command gets the computer tier template for the service template stored in $ServiceTemplate, and then stores the object in the $TierTemplate variable.
The third command gets the load balancer template for the computer tier stored in $TierTemplate, and then stores the object in the $LoadBalancerTemplate variable.
The last command sets the properties for the load balancer template stored in $LoadBalancerTemplate.
PS C:\> $ServiceTemplate = Get-SCServiceTemplate -Name "ServiceTemplate01"
PS C:\> $TierTemplate = Get-SCComputerTierTemplate -ServiceTemplate $ServiceTemplate
PS C:\> $LoadBalancerTemplate = Get-SCLoadBalancerTemplate -ComputerTierTemplate $TierTemplate
PS C:\> Set-SCLoadBalancerTemplate -LoadBalancerTemplate $LoadBalancerTemplate