Get-NlbClusterVip
Get-NlbClusterVip
Retrieves virtual IP addresses that are queried by the caller.
Syntax
Parameter Set: NonPipeline
Get-NlbClusterVip [[-IP] <IPAddress> ] [-HostName <String> ] [-InterfaceName <String> ] [ <CommonParameters>]
Parameter Set: Pipeline
Get-NlbClusterVip [[-IP] <IPAddress> ] -InputObject <Cluster> [ <CommonParameters>]
Detailed Description
The Get-NlbClusterVIP cmdlet retrieves 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.
Parameters
-HostName<String>
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.
Aliases |
hn |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IP<IPAddress>
Specifies the IP address of the cluster for which the virtual IP address is enumerated.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<Cluster>
Specifies the cluster for which the virtual IP address is enumerated.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-InterfaceName<String>
Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
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).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterVip
Examples
EXAMPLE 1
This example lists all the virtual IP addresses on the local cluster.
PS C:\> Get-NlbClusterVip
EXAMPLE 2
This example gets the specified virtual IP addresses on the local cluster.
PS C:\> Get-NlbClusterVip -IP fe80::a20f:cca:4cd2:7ea0