Share via

Read-SCLoadBalancerVIP

  • Reference
Module:
VirtualMachineManager

Refreshes load balancer VIP information in the VMM console.

Syntax

Read-SCLoadBalancerVIP
    [-VMMServer <ServerConnection>]
    [-LoadBalancerVIP] <LoadBalancerVIP>
    [-RunAsynchronously]
    [-PROTipID <Guid>]
    [-JobVariable <String>]
    [<CommonParameters>]

Description

The Read-SCLoadBalancerVIP cmdlet refreshes load balancer virtual IP (VIP) information and reflects the updates in the Virtual Machine Manager (VMM) console.

Examples

Example 1: Refresh a specific load balancer virtual IP

PS C:\> $LoadBalancer = Get-SCLoadBalancer -LoadBalancerAddress "LB01.Contoso.com" 
PS C:\> $VIP = Get-SCLoadBalancerVIP -LoadBalancer $LoadBalancer -IPAddress "10.0.0.1" 
PS C:\> Read-SCLoadBalancerVIP -LoadBalancerVIP $VIP

The first command gets the load balancer object with the address LB01.Contoso.com and stores the object in the $LoadBalancer variable.

The second command gets the load balancer VIP for the load balancer stored in $LoadBalancer with the IP address of 10.0.0.1.

The last command refreshes the load balancer VIP stored in $VIP.

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

-LoadBalancerVIP

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

Type:LoadBalancerVIP
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

LoadBalancerVIP

This cmdlet returns a LoadBalancerVIP object.