Edit

Share via


Get-NlbClusterVip

Gets virtual IP addresses that are queried by the caller.

Syntax

NonPipeline (Default)

Get-NlbClusterVip
    [[-IP] <IPAddress>]
    [-HostName <String>]
    [-InterfaceName <String>]
    [<CommonParameters>]

Pipeline

Get-NlbClusterVip
    [[-IP] <IPAddress>]
    -InputObject <Cluster[]>
    [<CommonParameters>]

Description

The Get-NlbClusterVIP cmdlet gets the virtual IP addresses that are queried by the caller. This IP address is used to address the cluster as a whole, and is the IP address that maps to the full Internet name that you specify for the Network Load Balancing (NLB) cluster.

Examples

Example 1: List all virtual IP addresses on the local cluster

PS C:\>Get-NlbClusterVip
IPAddress                               SubnetMask
---------                               ----------
3.53.100.100                            255.0.0.0
3.53.100.101                            255.0.0.0
3.53.100.102                            255.0.0.0
fe80::b349:6945:9449:d03c               ::

This command lists all the virtual IP addresses on the local cluster.

Example 2: Get the specified virtual IP address on the local cluster

PS C:\>Get-NlbClusterVip -IP fe80::a20f:cca:4cd2:7ea0
IPAddress                               SubnetMask
---------                               ----------
fe80::a20f:cca:4cd2:7ea0               ::

This command gets the specified virtual IP addresses on the local cluster.

Parameters

-HostName

Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or a value of . is entered, then the local cluster is assumed.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Host, HN, H

Parameter sets

NonPipeline
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies the cluster for which this cmdlet enumerates virtual IP addresses.

Parameter properties

Type:

Cluster[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Pipeline
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-InterfaceName

Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Interface, IN, I

Parameter sets

NonPipeline
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IP

Specifies the IP address of the cluster for which this cmdlet enumerates virtual IP addresses.

Parameter properties

Type:IPAddress
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip