MicrosoftNLB_Cluster class

[Only Windows Server 2003 nodes that have remote control enabled contribute to the ClusterState property as reported in this class and respond to the methods invoked from this class. Support for the MicrosoftNLB_Cluster methods was removed in Windows Server 2008. You should use the methods of the MicrosoftNLB_Node class instead.]

The MicrosoftNLB_Cluster WMI class represents an instance of a Network Load Balancing cluster.

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

Syntax

[Dynamic, Provider("Microsoft|NLB_Provider|V1.0"), AMENDMENT]
class MicrosoftNLB_Cluster : CIM_Cluster
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Status;
  string   CreationClassName;
  string   PrimaryOwnerContact;
  string   PrimaryOwnerName;
  string   Roles[];
  string   NameFormat;
  string   Interconnect;
  uint16   Types[];
  uint32   MaxNumberOfNodes;
  uint16   ClusterState;
  string   InterconnectAddress;
  string   Name;
};

Members

The MicrosoftNLB_Cluster class has these types of members:

• Methods
• Properties

Methods

The MicrosoftNLB_Cluster class has these methods.

Method	Description
Disable	Not supported. Use the Disable or DisableEx method of the MicrosoftNLB_Node class. Windows Server 2003:  Disables a range of ports on all nodes that have remote control enabled.
Drain	Not supported. Use the Drain or DrainEx method of the MicrosoftNLB_Node class. Windows Server 2003:  Drains a range of ports on all nodes that have remote control enabled.
DrainStop	Not supported. Use the DrainStop method of the MicrosoftNLB_Node class. Windows Server 2003:  Drains all ports on all nodes that have remote control enabled, then stops cluster operation on all nodes.
Enable	Not supported. Use the Enable or EnableEx method of the MicrosoftNLB_Node class. Windows Server 2003:  On all nodes that have remote control enabled, enables ports that have been disabled.
Resume	Not supported. Use the Resume method of the MicrosoftNLB_Node class. Windows Server 2003:  Resumes all suspended nodes that have remote control enabled.
Start	Not supported. Use the Start method of the MicrosoftNLB_Node class. Windows Server 2003:  Starts cluster operations on all nodes.
Stop	Not supported. Use the Stop method of the MicrosoftNLB_Node class. Windows Server 2003:  Stops cluster operations on all nodes that have remote control enabled.
Suspend	Not supported. Use the Suspend method of the MicrosoftNLB_Node class. Windows Server 2003:  Suspends cluster operation on all nodes that have remote control enabled.

 

Properties

The MicrosoftNLB_Cluster class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

Not used.

This property inherits from CIM_ManagedSystemElement.

ClusterState

Data type: uint16

Access type: Read-only

Qualifiers: Override ("ClusterState")

Summarizes the state of all cluster nodes that have remote control enabled. Nodes that do not have remote control enabled do not report their status.

Value	Meaning
1–21	Indicates the number of converged nodes in the cluster that have the MicrosoftNLB_ClusterSetting RemoteControlled property set to true.
WLBS_SUSPENDED 1013	Cluster operations have been suspended on one or more nodes.
WLBS_STOPPED 1005	Cluster operations have stopped on at least one node.
WLBS_DRAINING 1009	One or more nodes are draining.
WLBS_CONVERGING 1006	The cluster is converging.

 

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: CIM_Key, MaxLen (256)

The CreationClassName property indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

This property is inherited from CIM_System.

Description

Data type: string

Access type: Read-only

Not used.

This property inherits from CIM_ManagedSystemElement.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

Not used.

This property inherits from CIM_ManagedSystemElement.

Interconnect

Data type: string

Access type: Read-only

Not used.

This property inherits from CIM_Cluster.

InterconnectAddress

Data type: string

Access type: Read-only

Qualifiers: Override ("InterconnectAddress")

InterconnectAddress displays the IP address of the cluster.

MaxNumberOfNodes

Data type: uint32

Access type: Read-only

Indicates the maximum number of nodes that may participate in the cluster. If unlimited, enter 0.

This property is inherited from CIM_Cluster.

Name

Data type: string

Access type: Read-only

Qualifiers: Override ("Name") , MaxLen (256)

The cluster IP address is used in this property to uniquely identify the cluster.

NameFormat

Data type: string

Access type: Read-only

Qualifiers: Override ("NameFormat")

Not used.

This property inherits from CIM_ComputerSystem.

PrimaryOwnerContact

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256) , MappingStrings ("MIF.DMTF|General Information|001.3")

Not used.

This property inherits from CIM_System.

PrimaryOwnerName

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64) , MappingStrings ("MIF.DMTF|General Information|001.4")

The name of the primary system owner.

This property is inherited from CIM_System.

Roles

Data type: string array

Access type: Read-only

Not used.

This property inherits from CIM_System.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10)

Do not use this property. The Network Load Balancing provider uses the ClusterState property to indicate the status of the cluster.

This property inherits from CIM_ComputerSystem.

Types

Data type: uint16 array

Access type: Read-only

Not used.

This property inherits from CIM_Cluster.

Unknown (0)

Other (1)

Failover (2)

Performance (3)

Distributed OS (4)

Node Grouping (5)

Remarks

The MicrosoftNLB_Cluster class cannot be enumerated. Many of the methods and properties in MicrosoftNLB_Cluster have equivalents in MicrosoftNLB_Node. See Enumerating remote nodes for an example.

Windows Server 2003: The MicrosoftNLB_Cluster class cannot be enumerated if no nodes in the cluster have remote control enabled.

The MicrosoftNLB_Cluster class is derived from the CIM_Cluster class.

Requirements

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