Export (0) Print
Expand All

Get-NlbClusterDriverInfo

Updated: August 15, 2012

Applies To: Windows Server 2012

Get-NlbClusterDriverInfo

Retrieves information about the Network Load Balancing (NLB) driver on the local machine.

Syntax

Parameter Set: Params
Get-NlbClusterDriverInfo [-InterfaceName <String> ] [-Params] [ <CommonParameters>]

Parameter Set: ConvergenceHistory
Get-NlbClusterDriverInfo -ConvergenceHistory [-InterfaceName <String> ] [ <CommonParameters>]

Parameter Set: ExtendedAffinityExceptionList
Get-NlbClusterDriverInfo -ExtendedAffinityExceptionList [-InterfaceName <String> ] [ <CommonParameters>]

Parameter Set: ExtendedAffinityList
Get-NlbClusterDriverInfo -ExtendedAffinityList [-InterfaceName <String> ] [ <CommonParameters>]

Parameter Set: Filter
Get-NlbClusterDriverInfo -ClientIP <IPAddress> -Filter <Protocol> -ServerIP <IPAddress> [-ClientPort <Int32> ] [-Flags <Flags> ] [-InterfaceName <String> ] [-ServerPort <Int32> ] [ <CommonParameters>]

Parameter Set: OpenConnections
Get-NlbClusterDriverInfo -OpenConnections [-InterfaceName <String> ] [ <CommonParameters>]




Detailed Description

The Get-NlbClusterDriverInfo cmdlet retrieves information about the Network Load Balancing (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.


Aliases

cip

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ClientPort<Int32>

Specifies the connection tuple client port that is used to check whether the current cluster node accepts or drops the traffic. The acceptable values for this parameter are: 0 through 65535.


Aliases

cpt

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ConvergenceHistory

Gets the history of convergences between the cluster nodes.


Aliases

history

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ExtendedAffinityExceptionList

Gets the extended affinity exception list on this cluster node.


Aliases

exceptionlist

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ExtendedAffinityList

Gets the extended affinity list on this cluster node.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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. The acceptable values for this parameter are: TCP or UDP.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Flags<Flags>

Specifies the type of packet that is used to check whether the current cluster node accepts or drops the traffic. The acceptable values for this parameter are: SYN FIN or RST.


Aliases

fg

Required?

false

Position?

named

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?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OpenConnections

Gets the list of open connections to the cluster.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Params

Gets the list information about the NLB driver on this node.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ServerIP<IPAddress>

Specifies the connection tuple server IP address used to check whether the current cluster node accepts or drops the traffic.


Aliases

sip

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ServerPort<Int32>

Specifies the connection tuple server port used to check whether the current cluster node accepts or drops the traffic. The acceptable values for this parameter are: 0 through 65535.


Aliases

spt

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.

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.ClientExceptionRecord
  • Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterSettings
  • Microsoft.NetworkLoadBalancingClusters.PowerShell.ConvergenceHistoryRecord
  • Microsoft.NetworkLoadBalancingClusters.PowerShell.DescriptorRecord
  • Microsoft.NetworkLoadBalancingClusters.PowerShell.DriverInfo
  • Microsoft.NetworkLoadBalancingClusters.PowerShell.ExtendedAffinityRecord

Examples

EXAMPLE 1

This example gets information about the NLB driver configuration.


PS C:\> 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 

EXAMPLE 2

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


PS C:\> 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 

EXAMPLE 3

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


PS C:\> Get-NlbClusterDriverInfo -Filter TCP -ServerIP 2.53.4.222 -ServerPort 5001 -ClientIP 2.53.4.5 -ClientPort 5001
Result 
------ 
ACCEPT_UNCONDITIONAL_OWNERSHIP 

EXAMPLE 4

This example 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 cmdlet also displays the number of active connections for each client.


PS C:\> 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 

EXAMPLE 5

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


PS C:\> Get-NlbClusterDriverInfo -ExtendedAffinityExceptionList
IPAddress           HostId              VirtualIPAddress    StartPort 
---------           ------              ----------------    --------- 
2.53.4.6            2                   All                 0 

EXAMPLE 6

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


PS C:\> Get-NlbClusterDriverInfo -OpenConnections
SourceIPAddress     SourcePort          DestinationIPAddres DestinationPorts

---------------     ----------          ------------------- --------------- 
2.53.4.5            64945               2.53.4.222          5001 
2.53.4.15           64854               2.53.4.222          80 

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft