MicrosoftNLB_ClusterSetting class

  • Article

The MicrosoftNLB_ClusterSetting WMI class represents data that identifies the Network Load Balancing (NLB) cluster to which a node belongs.

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

Syntax

[Dynamic, Provider("Microsoft|NLB_Provider|V1.0"), AMENDMENT]
class MicrosoftNLB_ClusterSetting : CIM_Setting
{
  string  SettingID;
  string  Caption;
  string  Description;
  string  Name;
  string  ClusterName;
  string  ClusterIPAddress;
  string  ClusterNetworkMask;
  string  ClusterMACAddress;
  Boolean MulticastSupportEnabled;
  Boolean RemoteControlEnabled;
  Boolean IGMPSupport;
  Boolean ClusterIPToMulticastIP;
  string  MulticastIPAddress;
  string  AdapterGuid;
  Boolean BDATeamActive;
  string  BDATeamId;
  Boolean BDATeamMaster;
  Boolean BDAReverseHash;
  Boolean IdentityHeartbeatEnabled;
  Boolean UnicastInterHostCommSupportEnabled;
};

Members

The MicrosoftNLB_ClusterSetting class has these types of members:

Methods

The MicrosoftNLB_ClusterSetting class has these methods.

Method Description
AccessNLBRegParam This method gets or sets instance-specific or global NLB registry parameters.
LoadAllSettings Propagates all current settings (cluster, node, and port rules) to the NLB driver.
SetDefaults Resets all of the properties of the MicrosoftNLB_ClusterSetting class to their default values.
SetPassword This method is no longer available.

Properties

The MicrosoftNLB_ClusterSetting class has these properties.

AdapterGuid

Data type: string

Access type: Read-only

The GUID of the adapter to which NLB is bound.

BDAReverseHash

Data type: Boolean

Access type: Read-only

Indicates whether bi-directional affinity (BDA) will reverse hash on the cluster that this network adapter is a part of. For more information on BDA, please see online help.

BDATeamActive

Data type: Boolean

Access type: Read-only

Indicates whether BDA is enabled on the cluster that this network adapter is a part of.

BDATeamId

Data type: string

Access type: Read-only

The BDA team identifier of the cluster that this network adapter is a part of. The value of this property must be a GUID.

BDATeamMaster

Data type: Boolean

Access type: Read-only

Indicates whether the cluster that this network adapter is a part of is the BDA master cluster.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

Not used.

This property inherits from CIM_Setting.

ClusterIPAddress

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Cluster.InterconnectAddress")

The cluster's primary IP address in standard dotted decimal notation ("xxx.xxx.xxx.xxx").

ClusterIPToMulticastIP

Data type: Boolean

Access type: Read-only

Qualifiers: DEPRECATED

This property is no longer in use.

ClusterMACAddress

Data type: string

Access type: Read-only

The media access control (MAC) address of the cluster.

ClusterName

Data type: string

Access type: Read-only

The full Internet name for the NLB cluster (for example, "cluster.domain.com"). This name is used for the cluster as a whole and should be the same for all nodes in the cluster.

ClusterNetworkMask

Data type: string

Access type: Read-only

The subnet mask.

Description

Data type: string

Access type: Read-only

Not used.

This property inherits from CIM_Setting.

IdentityHeartbeatEnabled

Data type: Boolean

Access type: Read-only

Qualifiers: DEPRECATED

This property is no longer in use.

IGMPSupport

Data type: Boolean

Access type: Read-only

Determines how multicast traffic is handled as follows.

FALSE

Default. NLB does not send IGMP join messages. Switches send all traffic (including multicast packets) to all switch ports.

TRUE

NLB sends IGMP join messages. Switches to send multicast traffic to specific ports rather than to all ports.

MulticastIPAddress

Data type: string

Access type: Read-only

The multicast IP address used to derive the cluster's MAC address if ClusterIPToMulticastIP is FALSE. A multicast IP group address should not interfere with other traffic or hinder any multicast applications that may be running on nodes that are part of the subnet on which the NLB cluster resides.

MulticastSupportEnabled

Data type: Boolean

Access type: Read-only

Indicates whether a multicast MAC address should be used for cluster operations. If this option is enabled, NLB converts the cluster MAC address belonging to the cluster adapter into a multicast address. It also ensures that the cluster's primary IP address resolves to this multicast address as part of the ARP protocol. At the same time, the adapter can now use its original, built-in MAC address, which, in unicast mode, was disabled.

Name

Data type: string

Access type: Read-only

Qualifiers: Key

The name of the node to which these settings apply. This is the name stored in the MicrosoftNLB_Node Name property.

RemoteControlEnabled

Data type: Boolean

Access type: Read-only

Qualifiers: DEPRECATED

This property is no longer in use. To access a remote node's settings or to perform actions such as enabling or disabling a port rule, you must connect to each node individually using WMI. For an example, see Making Direct Connections.

SettingID

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256)

Not used.

This property inherits from CIM_Setting.

UnicastInterHostCommSupportEnabled

Data type: Boolean

Access type: Read-only

This property enables inter-host communication in a unicast cluster.

Remarks

Enumerating the MicrosoftNLB_ClusterSetting class always returns one instance only. This instance represents the cluster settings for the provider node.

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

The MicrosoftNLB_ClusterSetting 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

See also

CIM_Setting

MicrosoftNLB_NodeSetting