MicrosoftNLB_Node class

The MicrosoftNLB_Node WMI class represents an instance of a node within 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_Node : CIM_UnitaryComputerSystem
{
  string   Caption;
  string   ComputerName;
  string   CreationClassName;
  string   DedicatedIPAddress;
  string   Description;
  uint32   HostPriority;
  datetime InstallDate;
  string   LastLoadInfo;
  string   Name;
  string   NameFormat;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  uint16   PowerState;
  string   PrimaryOwnerContact;
  string   PrimaryOwnerName;
  uint16   ResetCapability;
  string   Roles[];
  string   Status;
  uint32   StatusCode;
};

Members

The MicrosoftNLB_Node class has these types of members:

• Methods
• Properties

Methods

The MicrosoftNLB_Node class has these methods.

Properties

The MicrosoftNLB_Node class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

The Caption property is a short textual description (one-line string) of the object.

This property is inherited from CIM_ManagedSystemElement.

ComputerName

Data type: string

Access type: Read-only

Returns the computer name in the form of a Fully Qualified Domain Name (FQDN), unless the FQDN exceeds 100 characters, in which case only the host name is returned. An empty string will be returned in the case of a failure.

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.

DedicatedIPAddress

Data type: string

Access type: Read-only

Specifies this node's unique IP address used for network traffic not associated with the cluster (for example, Telnet access to a specific node within the cluster).

Description

Data type: string

Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

HostPriority

Data type: uint32

Access type: Read-only

Specifies the host priority of the node. Each node within the cluster must specify a unique host priority, ranging from 1 (indicates the highest priority) to n (lowest priority), where n is the number of nodes in the cluster. The node with the highest priority receives all network traffic not handled by port rules.

InstallDate

Data type: datetime

Access type: Read-only

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

The InstallDate property is a datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

LastLoadInfo

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrSystemInitialLoadDevice", "MIB.IETF|HOST-RESOURCES-MIB.hrSystemInitialLoadParameters")

The array entry of the InitialLoadInfo property, that holds the data corresponding to booting the currently loaded operating system.

This property is inherited from CIM_UnitaryComputerSystem.

Name

Data type: string

Access type: Read-only

Qualifiers: Override ("Name")

Identifies the node by a combination of the cluster IP address and the node's host priority. The name is formatted as (cluster IP address)(colon)(host priority). For example: "172.150.35.12:1".

Note

When configuring new clusters, all of the cluster IP addresses may initially be set to zero (0.0.0.0). In this case the name format changes to "0.0.0.x:id" where x is a unique index and id is the host priority of the node.

NameFormat

Data type: string

Access type: Read-only

Qualifiers: Override ("NameFormat")

Specifies the process by which the Name property is generated.

("Other")

("IP")

("Dial")

("HID")

("NWA")

("HWA")

("X25")

("ISDN")

("IPX")

("DCC")

("ICD")

("E.164")

("SNA")

("OID/OSI")

Remarks

The MicrosoftNLB_Node class is derived from the CIM_UnitaryComputerSystem class.

All methods except SetPowerState (which is not used) will fail if called on an instance of a MicrosoftNLB_Node object that represents a remote node.

Examples

For an example that demonstrates the MicrosoftNLB_Node class, see Enumerating Remote Nodes.

Requirements

See also

CIM_UnitaryComputerSystem

Network Load Balancing WMI Classes

CIM_UnitaryComputerSystem