Get-SCLoadBalancerVIP

  • Reference
Module:
VirtualMachineManager

Gets a load balancer VIP object.

Syntax

Get-SCLoadBalancerVIP
   [-VMMServer <ServerConnection>]
   [[-Name] <String>]
   [-IPAddress <String>]
   [-LoadBalancer <LoadBalancer>]
   [<CommonParameters>]
Get-SCLoadBalancerVIP
   [-VMMServer <ServerConnection>]
   -ID <Guid>
   [<CommonParameters>]

Description

The Get-SCLoadBalancerVIP cmdlet gets one or more load balancer virtual IP (VIP) objects.

Examples

Example 1: Get a load balancer virtual IP for a specific load balancer

PS C:\> $LoadBalancer = Get-SCLoadBalancer -LoadBalancerAddress "LB01.Contoso.com"
PS C:\> Get-SCLoadBalancerVIP -LoadBalancer $LoadBalancer -IPAddress "192.168.0.1"

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 an IP address of 192.168.0.1.

Parameters

-ID

Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-IPAddress

Specifies an IPv4 or IPv6 address.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LoadBalancer

Specifies a load balancer object.

Type:LoadBalancer
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of a Virtual Machine Manager (VMM) object.

Type:String
Position:0
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.