Get-NlbClusterNode
Get-NlbClusterNode
Retrieves information about a node object or the Network Load Balancing (NLB) cluster object that is queried by the caller.
Syntax
Parameter Set: NonPipeline
Get-NlbClusterNode [[-NodeName] <String> ] [-HostName <String> ] [-InterfaceName <String> ] [ <CommonParameters>]
Parameter Set: Pipeline
Get-NlbClusterNode [[-NodeName] <String> ] -InputObject <Cluster> [-HostName <String> ] [ <CommonParameters>]
Detailed Description
The Get-NlbClusterNode cmdlet retrieves information about a node in the Network Load Balancing (NLB) cluster. The information includes the properties, or attributes, that define the node 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? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<Cluster>
Specifies the cluster for which the nodes are 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 |
-NodeName<String>
Specifies the cluster node name to retrieve.
Aliases |
nn |
Required? |
false |
Position? |
1 |
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.Node
Examples
EXAMPLE 1
This example lists nodes that are part of the local cluster. It also shows the state of the nodes and the interface to which NLB is bound on each node.
PS C:\> Get-NlbClusterNode
EXAMPLE 2
This example gets details about cluster node named node1.
PS C:\> Get-NlbClusterNode -NodeName node1 | Format-List *