Get-NlbCluster
Get-NlbCluster
Retrieves information about the Network Load Balancing (NLB) cluster object that is queried by the caller.
Syntax
Parameter Set: Default
Get-NlbCluster [[-HostName] <String> ] [[-InterfaceName] <String> ] [ <CommonParameters>]
Detailed Description
The Get-NlbCluster cmdlet retrieves information about the Network Load Balancing (NLB) cluster. The information includes the properties, or attributes, that define the cluster and its status.
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? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
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? |
2 |
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.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster
Examples
EXAMPLE 1
This example gets the cluster object for the local NLB cluster, that is, the cluster that this node is a part.
PS C:\> Get-NlbCluster
EXAMPLE 2
This example gets the cluster object for the NLB cluster that node named node1 is a part.
PS C:\> Get-NlbCluster -HostName node1
EXAMPLE 3
This example gets the cluster object for the NLB cluster that node named node1 (with the interface named vlan-2) is a part.
PS C:\> Get-NlbCluster -HostName node1 -InterfaceName vlan-2