Get-NlbClusterDriverInfo

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

Syntax

Get-NlbClusterDriverInfo
   [-InterfaceName <String>]
   [-Params]
Get-NlbClusterDriverInfo
   [-ClientPort <Int32>]
   [-Flags <Flags>]
   [-InterfaceName <String>]
   [-ServerPort <Int32>]
   -ClientIP <IPAddress>
   -Filter <Protocol>
   -ServerIP <IPAddress>
Get-NlbClusterDriverInfo
   [-InterfaceName <String>]
   [-ConvergenceHistory]
Get-NlbClusterDriverInfo
   [-InterfaceName <String>]
   [-ExtendedAffinityExceptionList]
Get-NlbClusterDriverInfo
   [-InterfaceName <String>]
   [-ExtendedAffinityList]
Get-NlbClusterDriverInfo
   [-InterfaceName <String>]
   [-OpenConnections]

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.

Examples

EXAMPLE 1

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

This example gets information about the NLB driver configuration.

EXAMPLE 2

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

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

EXAMPLE 3

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

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

EXAMPLE 4

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

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.

EXAMPLE 5

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

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.

EXAMPLE 6

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

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.

Required Parameters

-ClientIP

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

Type:IPAddress
Aliases:cip
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ConvergenceHistory

Gets the history of convergences between the cluster nodes.

Type:SwitchParameter
Aliases:history
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ExtendedAffinityExceptionList

Gets the extended affinity exception list on this cluster node.

Type:SwitchParameter
Aliases:exceptionlist
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ExtendedAffinityList

Gets the extended affinity list on this cluster node.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Filter

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.

Type:Protocol
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OpenConnections

Gets the list of open connections to the cluster.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ServerIP

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

Type:IPAddress
Aliases:sip
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-ClientPort

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.

Type:Int32
Aliases:cpt
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-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.

Type:Flags
Aliases:fg
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InterfaceName

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

Type:String
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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ServerPort

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.

Type:Int32
Aliases:spt
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClientExceptionRecord

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.ClusterSettings

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.ConvergenceHistoryRecord

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.DescriptorRecord

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.DriverInfo

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.ExtendedAffinityRecord