MicrosoftNLB_NodeSetting class

Article
05/31/2018

The MicrosoftNLB_NodeSetting WMI class represents the configuration data specific to a node.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

[Dynamic, Provider("Microsoft|NLB_Provider|V1.0"), AMENDMENT]
class MicrosoftNLB_NodeSetting : CIM_Setting
{
  string  SettingID;
  string  Caption;
  string  Description;
  string  Name;
  string  DedicatedIPAddress;
  string  DedicatedIPAddresses[];
  string  DedicatedNetworkMask;
  string  DedicatedNetworkMasks[];
  uint32  NumberOfRules;
  uint32  HostPriority;
  uint32  AliveMessagePeriod;
  uint32  AliveMessageTolerance;
  Boolean ClusterModeOnStart;
  Boolean ClusterModeSuspendOnStart;
  Boolean PersistSuspendOnReboot;
  uint32  RemoteControlUDPPort;
  Boolean MaskSourceMAC;
  uint32  MaxConnectionDescriptors;
  uint32  DescriptorsPerAlloc;
  uint32  MaxDescriptorsPerAlloc;
  uint32  FilterIcmp;
  uint32  TcpDescriptorTimeout;
  uint32  IpSecDescriptorTimeout;
  uint32  NumActions;
  uint32  NumPackets;
  uint32  NumAliveMessages;
  string  AdapterGuid;
};

Members

The MicrosoftNLB_NodeSetting class has these types of members:

Methods
Properties

Methods

The MicrosoftNLB_NodeSetting class has these methods.

Method	Description
GetPortRule	Qualifier: Implemented This method retrieves the port rule associated with a port number.
GetPortRuleEx	Qualifier: Implemented This method retrieves the port rule associated with a virtual IP address and port number.
LoadAllSettings	Qualifier: Implemented Propagates all current settings (cluster, node, and port rule) to the Network Load Balancing driver
SetDefaults	Qualifier: Implemented Resets all of the properties of the MicrosoftNLB_NodeSetting class to their default values.

Properties

The MicrosoftNLB_NodeSetting class has these properties.

AdapterGuid

Data type: string
Access type: Read-only

The GUID of the adapter to which Network Load Balancing is bound.

AliveMessagePeriod

Data type: uint32
Access type: Read-only

The message exchange period in milliseconds. You should pick this number based on your failover requirements. A longer message exchange period will reduce the networking overhead needed to maintain fault tolerance, but it will increase the failover delay.

AliveMessageTolerance

Data type: uint32
Access type: Read-only

The number of exchanged messages from a node that can be missed before the cluster initiates convergence. You should adjust this number based on your availability requirements. Increasing the number of message exchanges before convergence will reduce the number of unnecessary convergence initiations due to transient network congestion, but it will also increase the failover delay.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Not used.

This property inherits from CIM_Setting.

ClusterModeOnStart

Data type: Boolean
Access type: Read-only

Indicates whether the node should join the cluster on boot. If set to TRUE, the node will join the cluster on boot, unless both of the following are true:

PersistSuspendOnReboot is TRUE

The node was shut down while in a suspended state.

ClusterModeSuspendOnStart

Data type: Boolean
Access type: Read-only

Indicates whether the node should boot with cluster operations suspended. If set to TRUE, the node will not join the cluster and remain in the WLBS_SUSPENDED state until a resume operation is performed. The value of this property is ignored if the ClusterModeOnStart property is set to TRUE.

DedicatedIPAddress

Data type: string
Access type: Read-only
Qualifiers: DEPRECATED, ModelCorrespondence ("MicrosoftNLB_Node.DedicatedIPAddress")

This property is no longer supported. Use the DedicatedIPAddress property of the MicrosoftNLB_Node class instead.

DedicatedIPAddresses

Data type: string array
Access type: Read-only

The nodes unique IP addresses used for network traffic not associated with the cluster (for example, Telnet access to a specific node within the cluster).

DedicatedNetworkMask

Data type: string
Access type: Read-only
Qualifiers: DEPRECATED

This property is no longer in supported. Use the DedicatedNetworkMasks property instead.

DedicatedNetworkMasks

Data type: string array
Access type: Read-only

This property denotes the subnet masks for the dedicated IP addresses.

Description

Data type: string
Access type: Read-only

Not used.

This property inherits from CIM_Setting.

DescriptorsPerAlloc

Data type: uint32
Access type: Read-only
Qualifiers: DEPRECATED

This property is no longer supported. Use the MaxConnectionDescriptors property instead.

FilterIcmp

Data type: uint32
Access type: Read-only

If set to TRUE, all ICMP traffic will be filtered by the cluster and accepted by only a single host. If set to FALSE, all hosts in the cluster will accept all ICMP traffic (this is the default behavior.)

HostPriority

Data type: uint32
Access type: Read-only
Qualifiers: ModelCorrespondence ("MicrosoftNLB_Node.HostPriority")

A node's unique priority for handling default network traffic for TCP and UDP ports that are not otherwise specified in the port rules tab of the Network Load Balancing Properties dialog box. It is used in case a node within the cluster goes offline, and it determines which node within the cluster will take over handling this traffic if required. The allowed values for a node's host priority range from 1 to the maximum number of nodes. Lower values indicate higher priorities (where 1 is the highest priority). Each node within the cluster must specify a unique host priority.

IpSecDescriptorTimeout

Data type: uint32
Access type: Read-only
Qualifiers: DEPRECATED

This property is no longer in use.

MaskSourceMAC

Data type: Boolean
Access type: Read-only

If TRUE, mangle source MAC address to prevent switch learning. Use a value of FALSE if the cluster is on a hub; this value optimizes switch performance by re-enabling learning.

MaxConnectionDescriptors

Data type: uint32
Access type: Read-only

The maximum number of connection-tracking descriptors that can be allocated at any time.

MaxDescriptorsPerAlloc

Data type: uint32
Access type: Read-only
Qualifiers: DEPRECATED

This property is no longer supported. Use the MaxConnectionDescriptors property instead.

Name

Data type: string
Access type: Read-only
Qualifiers: Key

The name of the node that owns this set of cluster configuration data. This is the name stored in the MicrosoftNLB_Node Name property.

NumActions

Data type: uint32
Access type: Read-only
Qualifiers: DEPRECATED

This property is no longer in use.

NumAliveMessages

Data type: uint32
Access type: Read-only
Qualifiers: DEPRECATED

This property is no longer in use.

NumberOfRules

Data type: uint32
Access type: Read-only

The number of defined port rules.

NumPackets

Data type: uint32
Access type: Read-only
Qualifiers: DEPRECATED

This property is no longer in use.

PersistSuspendOnReboot

Data type: Boolean
Access type: Read-only

Indicates whether a WLBS_SUSPENDED state should persist after a reboot. If set to TRUE, a node that is in a suspended state when shut down will remain suspended when rebooted, regardless of the ClusterModeOnStart setting.

RemoteControlUDPPort

Data type: uint32
Access type: Read-only
Qualifiers: DEPRECATED

This property is no longer in use.

SettingID

Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

Not used.

This property inherits from CIM_Setting.

TcpDescriptorTimeout

Data type: uint32
Access type: Read-only
Qualifiers: DEPRECATED

This property is no longer in use.

Remarks

After changing any MicrosoftNLB_ClusterSetting properties, you must call LoadAllSettings to bring the new values into effect. For more information, see LoadAllSettings.

The MicrosoftNLB_NodeSetting class is derived from the CIM_Setting class.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2008
Namespace	Root\MicrosoftNLB
MOF	WlbsProv.mof
DLL	WlbsProv.dll

MicrosoftNLB_NodeSetting class

Syntax

Members

Methods

Properties

Remarks

Requirements

See also

Additional resources