Share via

Disable-SCLoadBalancerVIPMember

  • Reference
Module:
VirtualMachineManager

Disables a member of a load balancer VIP.

Syntax

Disable-SCLoadBalancerVIPMember
       [-VMMServer <ServerConnection>]
       [-LoadBalancerVIPMember] <LoadBalancerVIPMember>
       [-RunAsynchronously]
       [-PROTipID <Guid>]
       [-JobVariable <String>]
       [<CommonParameters>]

Description

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.

Examples

Example 1: Disable a member of a load balancer virtual IP

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

The first command gets the load balancer object with the address of LB01.Contoso.com and 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 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 stores the object in the $VIPMember variable.

The last command disables the VIP member stored in $VIPMember and displays information about the VIP member to the user.

Parameters

-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

-LoadBalancerVIPMember

Specifies a member of a virtual IP (VIP) in a load balancer.

Type:LoadBalancerVIPMember
Position:0
Default value:None
Required:True
Accept pipeline input:True
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

Outputs

LoadBalancerVIPMember

This cmdlet returns a LoadBalancerVIPMember object.