Disable-SCLoadBalancerVIPMember
Disables a member of a load balancer VIP.
Parameter Set: SingleInstance
Disable-SCLoadBalancerVIPMember [-LoadBalancerVIPMember] <LoadBalancerVIPMember> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
The Disable-SCLoadBalancerVIPMember cmdlet disables a member of a load balancer virtual IP (VIP), and places the member in a Desired Status of Down.
To enable a load balancer VIP member, use the Enable-SCLoadBalancerVIPMember cmdlet.
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 |
Specifies a member of a virtual IP (VIP) in a load balancer.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
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 |
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 |
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
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).
The input type is the type of the objects that you can pipe to the cmdlet.
The output type is the type of the objects that the cmdlet emits.
- LoadBalancerVIPMember
The first command gets the load balancer object with the address of LB01.Contoso.com, and then stores the object in the $LoadBalancer variable.
The second command gets the load balancer VIP with the IP address 192.168.0.1 for the load balancer stored in $LoadBalancer, and then stores the object in the $VIP variable.
The third command gets the VIP member for the load balancer VIP stored in $VIP with the address of 192.168.0.1, and then stores the object in the $VIPMember variable.
The last command disables the VIP member stored in $VIPMember and displays information about the VIP member.
PS C:\> $LoadBalancer = Get-SCLoadBalancer -LoadBalancerAddress "LB01.Contoso.com"
PS C:\> $VIP = Get-SCLoadBalancerVIP -LoadBalancer $LoadBalancer -IPAddress "192.168.0.1"
PS C:\> $VIPMember = Get-SCLoadBalancerVIPMember -LoadBalancerVIP $VIP -IPAddress "192.168.0.1"
PS C:\> Disable-SCLoadBalancerVIPMember -LoadBalancerVIPMember $VIPMember
Enable-SCLoadBalancerVIPMember