Edit

Share via


Get-NlbClusterNode

Gets information about a node object or the NLB cluster object that is queried by the caller.

Syntax

NonPipeline (Default)

Get-NlbClusterNode
    [[-NodeName] <String>]
    [-HostName <String>]
    [-InterfaceName <String>]
    [<CommonParameters>]

Pipeline

Get-NlbClusterNode
    [[-NodeName] <String>]
    -InputObject <Cluster[]>
    [-HostName <String>]
    [<CommonParameters>]

Description

The Get-NlbClusterNode cmdlet gets 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.

Examples

Example 1: List nodes that belong to the local cluster

PS C:\>Get-NlbClusterNode
Name                State               Interface           HostID
----                -----               ---------           ------
node1               Converged(default)  vlan-3              1
node2               Converged           vlan-3              2

This command 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.

Example 2: Get details about a cluster node

PS C:\>Get-NlbClusterNode -NodeName "Node01" | Format-List *
Cluster                   : mycluster
Name                      : Node01
InterfaceName             : vlan-3
Host                      :
State                     : Converged
HostPriority              : 2
AdapterGuid               : {}
InitialHostState          : Started
PersistSuspendOnReboot    : True
MaskSourceMac             : True
FilterIcmp                : 0
GreDescriptorTimeout      : 10

This command gets details about cluster node named Node01.

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

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

-InputObject

Specifies an array of clusters for which this cmdlet enumerates the nodes.

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

-NodeName

Specifies the cluster node name that this cmdlet gets.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Name, NN

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.Node