Share via

MicrosoftNLB_Node class

  • Article

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

The MicrosoftNLB_Node class has these methods.

Method Description
Disable Disables a range of ports on the node.
DisableEx Disables ports specified by virtual IP address and range.
Drain Drains a range of ports on the node.
DrainEx Drains ports specified by virtual IP address and range.
DrainStop Drains all ports, then stops cluster operations on the node.
Enable Enables ports that have been disabled on the node.
EnableEx Enables ports specified by virtual IP address and range.
Resume Resumes all suspended ports on the node.
SetPowerState Not used. Inherited from CIM_UnitaryComputerSystem.
Start Starts cluster operations on the node.
Stop Stops cluster operations on the node.
Suspend Suspends cluster operations on the node.

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")

PowerManagementCapabilities

Data type: uint16 array

Access type: Read-only

Indicates the specific power management capabilities of the node as an array of any of the following values that apply.

For more information, see SetPowerState.

This property inherits from CIM_UnitaryComputerSystem.

Unknown (0)

The power management capabilities of the node cannot be determined.

Not Supported (1)

If the PowerManagementSupported property is FALSE, this should be the only value in the array.

Disabled (2)

The power management capabilities of the node are turned off.

Enabled (3)

The power management features are currently enabled, but the exact feature set is unknown, or the information is unavailable.

Power Saving Modes Entered Automatically (4)

The node can change its power state based on usage or other criteria.

Power State Settable (5)

The SetPowerState method is supported.

Power Cycling Supported (6)

The SetPowerState method can be invoked with the PowerState input variable set to 5 (Power Cycle).

Timed Power On Supported (7)

As 6 (Power Cycling Supported), but also allows the Time parameter to specify a power-on time.

PowerManagementSupported

Data type: boolean

Access type: Read-only

Boolean indicating that the computer system, with its running operating system, support power management. This boolean does not indicate that power management features are currently enabled, only that the system is capable of power management.

This property is inherited from CIM_UnitaryComputerSystem.

PowerState

Data type: uint16

Access type: Read-only

Indicates the current power state of the node as one of the following values.

This property inherits from CIM_UnitaryComputerSystem.

Unknown (0)

The node's power state cannot be determined.

Full Power (1)

The node is operating at full power.

Power Save - Low Power Mode (2)

The node is in a power save state and is available, but its performance may be degraded.

Power Save - Standby (3)

The node is in a power save state and is unavailable but can be powered up quickly.

Power Save - Unknown (4)

The node is in an unrecognized power save state.

Power Cycle (5)

The node is changing power states.

Power Off (6)

The node is powered off and unavailable.

Power Save - Warning (7)

The node is in a low power state and is generating a warning (for example, a low battery warning from a laptop).

PrimaryOwnerContact

Data type: string

Access type: Read-only

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

A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...).

This property is inherited 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.

ResetCapability

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|System Hardware Security|001.4")

Describes the ability of the node to be reset.

This property inherits from CIM_UnitaryComputerSystem.

Other (1)

The node has some other reset capability.

Unknown (2)

Reset capacity is unknown.

Disabled (3)

Hardware reset is not allowed.

Enabled (4)

The unitary computer system can be reset via hardware (e.g. the power and reset buttons).

Not Implemented (5)

Reset capability has not been implemented.

Roles

Data type: string array

Access type: Read-only

A collection of strings that specify the roles this system plays in the IT-environment.

This property is inherited from CIM_System.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10)

Indicates the current status of the node as one of the following values.

This property inherits from CIM_UnitaryComputerSystem.

OK

The node is operational.

Error

No status information is available due to an unknown error.

Unknown

The node returned unrecognized state information.

StatusCode

Data type: uint32

Access type: Read-only

Indicates the current status of the node as one of the following values.

For an example that demonstrates the StatusCode property, see Enumerating Remote Nodes.

0

Node is remote. The StatusCode value cannot be retrieved.

WLBS_STOPPED (1005)

Cluster operations have stopped on at least one node.

WLBS_CONVERGING (1006)

The cluster is converging.

WLBS_CONVERGED (1007)

The cluster has converged successfully.

WLBS_DEFAULT (1008)

The specified node has converged as the default host.

WLBS_DRAINING (1009)

One or more nodes are draining.

WLBS_SUSPENDED (1013)

Cluster operations have been suspended on one or more nodes.

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
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2008
Namespace
 Root\MicrosoftNLB
MOF
WlbsProv.mof
DLL
WlbsProv.dll

See also

CIM_UnitaryComputerSystem

Network Load Balancing WMI Classes

CIM_UnitaryComputerSystem