Get-NlbClusterDriverInfo

Article
03/11/2010

Get-NlbClusterDriverInfo

Retrieves information about the NLB driver on the local machine.

Syntax

Get-NlbClusterDriverInfo -ConvergenceHistory [-InterfaceName <string>] [<CommonParameters>]


Get-NlbClusterDriverInfo -ExtendedAffinityExceptionList [-InterfaceName <string>] [<CommonParameters>]


Get-NlbClusterDriverInfo -ExtendedAffinityList [-InterfaceName <string>] [<CommonParameters>]


Get-NlbClusterDriverInfo -ClientIP <IPAddress> -Filter <Protocol> -ServerIP <IPAddress> [-ClientPort <int>] [-Flags <Flags>] [-ServerPort <int>] [-InterfaceName <string>] [<CommonParameters>]


Get-NlbClusterDriverInfo -OpenConnections [-InterfaceName <string>] [<CommonParameters>]


Get-NlbClusterDriverInfo [-Params] [-InterfaceName <string>] [<CommonParameters>]

Detailed Description

The Get-NlbClusterDriverInfo cmdlet retrieves information about the NLB driver on the local machine. This includes information about IP addresses, ports, convergence history, connections, extended affinity status, and protocols.

Parameters

-ClientIP <IPAddress>

Specifies the connection client IP address that is used to check whether the current cluster node accepts or drops the traffic. [Alias: cip]

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-ClientPort <int>

Specifies the connection tuple client port that is used to check whether the current cluster node accepts or drops the traffic. The valid range is from 0 to 65535. [Alias: cpt]

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-ConvergenceHistory <SwitchParameter>

Gets the history of convergences between the cluster nodes. [Alias: history]

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-ExtendedAffinityExceptionList <SwitchParameter>

Gets the extended affinity exception list on this cluster node. [Alias: exceptionlist]

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-ExtendedAffinityList <SwitchParameter>

Gets the extended affinity list on this cluster node.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-Filter <Protocol>

Determines whether or not a certain traffic pattern will be picked by this cluster node. The parameter specifies the protocol that is used to check whether the current cluster node accepts or drops the traffic. This can be one of: TCP or UDP.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-Flags <Flags>

Specifies the type of packet that is used to check whether the current cluster node accepts or drops the traffic. Acceptable values are: SYN FIN or RST. [Alias: fg]

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-InterfaceName <string>

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

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-OpenConnections <SwitchParameter>

Causes the cmdlet to get the list of open connections to the cluster.

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-Params <SwitchParameter>

Causes the cmdlet to get the list information about the NLB driver on this node.

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-ServerIP <IPAddress>

Specifies the connection tuple server IP address used to check whether the current cluster node accepts or drops the traffic. [Alias: sip]

Attributes

Name	Value
Required?	true
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-ServerPort <int>

Specifies the connection tuple server port used to check whether the current cluster node accepts or drops the traffic. The valid range is from 0 to 65535. [Alias: spt]

Attributes

Name	Value
Required?	false
Accept wildcard characters?	false
Accept Pipeline Input?	false
Position?	named

-CommonParameter

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

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Examples

EXAMPLE 1

C:\PS>

Get-NlbClusterDriverInfo



FullyQualifiedDomainName : cluster1.contoso.com

ParametersVersion        : 6

EffectiveNlbVersion      : 513

HostId                   : 2

ClusterName              : cluster1

ClusterIPAddress         : 2001:4898:e8:3018:bd82:dde1:6615:7b0

ClusterMacAddress        : 02-BF-FB-7E-A2-D1

AliveMsgPeriod           : 1000

MaxConnectionDescriptors : 262144

IcmpFilteringEnabled     : False

InitialHostState         : Started

CurrentHostState         : Started

PersistedHostStates      : True

Description

-----------

This command gets information about the NLB driver configuration.

EXAMPLE 2

C:\PS>

Get-NlbClusterDriverInfo -ConvergenceHistory



Time                       FromState                  ToState

----                       ---------                  -------

11/5/2008 10:55:27 PM      StablePhase2               Converged

11/5/2008 10:55:26 PM      ConvergingPhase2           StablePhase2

11/5/2008 10:55:26 PM      StablePhase1               ConvergingPhase2

11/5/2008 10:55:20 PM      ConvergingPhase1           StablePhase1

11/5/2008 10:55:17 PM      Unknown                    ConvergingPhase1

Description

-----------

This command gets the history of convergence for the local node.

EXAMPLE 3

C:\PS>

Get-NlbClusterDriverInfo -Filter tcp -ServerIP 2.53.4.222 -ServerPort 5001 -ClientIP 2.53.4.5 -ClientPort 5001



Result

------

ACCEPT_UNCONDITIONAL_OWNERSHIP

Description

-----------

This command declares whether traffic in the given pattern will be accepted on the local node or not.

EXAMPLE 4

C:\PS>

Get-NlbClusterDriverInfo -ExtendedAffinityList



IPAddress           References          VirtualIPAddress    StartPort

---------           ----------          ----------------    ---------

2.53.4.5            0                   All                 0

2.53.4.6            0                   All                 0

2.53.4.7            1                   All                 0

Description

-----------

This command will enumerate the client IP addresses that are on the extended affinity list on this cluster node. This applies to port rules that have extended affinity timeout enabled. The command also displays the number of active connections for each client.

EXAMPLE 5

C:\PS>

Get-NlbClusterDriverInfo -ExtendedAffinityExceptionList



IPAddress           HostId              VirtualIPAddress    StartPort

---------           ------              ----------------    ---------

2.53.4.6            2                   All                 0

Description

-----------

This command will enumerate the client IP addresses that are on the extended affinity exception list. This applies to port rules that have extended affinity timeout enabled. Traffic from clients on this list will be picked up by another cluster node that has the host ID listed.

EXAMPLE 6

C:\PS>

Get-NlbClusterDriverInfo -OpenConnections



SourceIPAddress     SourcePort          DestinationIPAddres DestinationPort

                                        s

---------------     ----------          ------------------- ---------------

2.53.4.5            64945               2.53.4.222          5001

2.53.4.15           64854               2.53.4.222          80

Description

-----------

This command enumerates all open connections on this cluster node. This is useful to run when the draining operation takes a long time and the administrator wants to know which connections are on the node.

Get-NlbClusterDriverInfo