MSCluster_Node class
A dynamic WMI class that represents a cluster node.
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.
Syntax
[Dynamic, Provider("MS_CLUSTER_PROVIDER"), UUID("{C306EBED-0654-4360-AA70-DE912C5FC364}"), AMENDMENT]
class MSCluster_Node : CIM_UnitaryComputerSystem
{
string Caption;
string CreationClassName;
string InitialLoadInfo[];
datetime InstallDate;
string LastLoadInfo;
string Name;
string NameFormat;
string OtherIdentifyingInfo[];
string IdentifyingDescriptions[];
uint16 Dedicated[];
uint16 PowerManagementCapabilities[];
boolean PowerManagementSupported;
uint16 PowerState;
string PrimaryOwnerContact;
string PrimaryOwnerName;
uint16 ResetCapability;
string Roles[];
string Status;
string Description;
uint32 NodeWeight;
uint32 DynamicWeight;
uint32 NodeHighestVersion;
uint32 NodeLowestVersion;
uint32 MajorVersion;
uint32 MinorVersion;
uint32 BuildNumber;
uint32 CSDVersion;
string Id;
string NodeInstanceID;
uint32 NodeDrainStatus;
string NodeDrainTarget;
uint32 State;
uint32 Flags;
uint32 Characteristics;
uint32 NeedsPreventQuorum;
string FaultDomainId;
uint32 StatusInformation;
string FaultDomain[];
MSCluster_Property PrivateProperties;
};
Members
The MSCluster_Node class has these types of members:
Methods
The MSCluster_Node class has these methods.
| Method | Description |
|---|---|
| ExecuteNodeControl | Executes a control code on the node. |
| Pause | Pauses the cluster activity on a node. |
| Resume | Resumes the cluster activity on a node. |
| SetPowerState | Defines the desired power state for a logical device and when a device should be put into that state. Not implemented by WMI. Inherited from CIM_UnitaryComputerSystem. |
| WillEvictLoseQuorum | Checks if evicting the node will cause the cluster to lose quorum. Windows Server 2008 R2 and Windows Server 2008: This method is not supported before Windows Server 2012. |
| WillOfflineLoseQuorum | Checks if the taking the node offline will cause the cluster to lose quorum. Windows Server 2008 R2 and Windows Server 2008: This method is not supported before Windows Server 2012. |
Properties
The MSCluster_Node class has these properties.
-
BuildNumber
-
-
Data type: uint32
-
Access type: Read-only
Provides access to the node's BuildNumber property.
-
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
Provides a short textual description (one-line string) of the node.
Inherited from CIM_UnitaryComputerSystem.
-
-
Characteristics
-
-
Data type: uint32
-
Access type: Read-only
Provides access to the characteristics set for the node. For a list of possible characteristics, see CLUSCTL_NODE_GET_CHARACTERISTICS.
-
-
CreationClassName
-
Indicates the name of the class or the subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified.
Inherited from CIM_UnitaryComputerSystem.
-
CSDVersion
-
-
Data type: uint32
-
Access type: Read-only
Provides access to the node's CSDVersion property, which specifies the most recent service pack installed on the node, if any.
-
-
Dedicated
-
-
Data type: uint16 array
-
Access type: Read-only
Indicates whether the node is a special-purpose node.
Inherited from CIM_UnitaryComputerSystem.
-
-
"Not Dedicated" (0)
-
"Unknown" (1)
-
"Other" (2)
-
"Storage" (3)
-
"Router" (4)
-
"Switch" (5)
-
"Layer 3 Switch" (6)
-
"Central Office Switch" (7)
-
"Hub" (8)
-
"Access Server" (9)
-
"Firewall" (10)
-
"Print" (11)
-
"I/O" (12)
-
"Web Caching" (13)
-
Web Caching
Description
-
Data type: string
-
Access type: Read/write
Provides access to the node's Description property, which has comments about the node.
DynamicWeight
-
Data type: uint32
-
Access type: Read-only
The dynamic vote weight of the node adjusted by dynamic quorum feature.
**Windows Server 2008 R2 and Windows Server 2008: **
This property is not supported before Windows Server 2012.
FaultDomain
-
Data type: string array
-
Access type: Read-only
Fault domain hierarchy of this node.
**Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2 and Windows Server 2008: **
This property is not supported before Windows Server 2016.
FaultDomainId
-
Data type: string
-
Access type: Read-only
The fault domain id of the node.
**Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2 and Windows Server 2008: **
This property is not supported before Windows Server 2016.
Flags
-
Data type: uint32
-
Access type: Read/write
Provides access to the flags set for the node. For a list of possible characteristics, see CLUSCTL_NODE_GET_FLAGS.
Id
-
Data type: string
-
Access type: Read-only
The Id of the node.
**Windows Server 2008 R2 and Windows Server 2008: **
This property is not supported before Windows Server 2012.
IdentifyingDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ComputerSystem.OtherIdentifyingInfo")
Provides explanations and details of the entries in the OtherIdentifyingInfo array. Each entry of this array is related to the entry in OtherIdentifyingInfo is located at the same index.
Inherited from CIM_UnitaryComputerSystem.
InitialLoadInfo
-
Data type: string array
-
Access type: Read-only
Contains the data needed to find either the initial load device (its key) or the boot service to request the operating system to start up. In addition, the load parameters (a path and parameters) may also be specified.
Inherited from CIM_UnitaryComputerSystem.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
Indicates when the node was installed. The lack of a value does not indicate that the node is not installed.
Inherited from CIM_UnitaryComputerSystem.
LastLoadInfo
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrSystemInitialLoadDevice", "MIB.IETF|HOST-RESOURCES-MIB.hrSystemInitialLoadParameters")
Contains the data identifying either the initial load device (its key) or the boot service that requested the last operating system load. In addition, the load parameters (a path and parameters) may also be specified.
Inherited from CIM_UnitaryComputerSystem.
MajorVersion
-
Data type: uint32
-
Access type: Read-only
Provides access to the node's MajorVersion property, which specifies the major portion of the Windows version installed.
MinorVersion
-
Data type: uint32
-
Access type: Read-only
Provides access to the node's MinorVersion property, which specifies the minor portion of the Windows version installed.
Name
Defines the label by which the node is known.
Inherited from CIM_UnitaryComputerSystem.
NameFormat
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Override ("NameFormat")
Identifies how the node Name property is generated, using a heuristic. This property identifies how the system name was generated by using the subclass heuristic. The heuristic is outlined in the CIM V2 Common Model specification and assumes that the documented rules are traversed to determine and assign a name. The NameFormat values list defines the precedence order for assigning the system name with several rules mapping to the same value.
Inherited from CIM_UnitaryComputerSystem.
Values include the following:
"IP"
"Dial"
"HID"
"NWA"
"HWA"
"X25"
"ISDN"
"IPX"
"DCC"
"ICD"
"E.164"
"SNA"
"OID/OSI"
"Other"
NeedsPreventQuorum
-
Data type: uint32
-
Access type: Read-only
Whether the cluster service on that node should be started with prevent quorum flag.
**Windows Server 2008 R2 and Windows Server 2008: **
This property is not supported before Windows Server 2012.
NodeDrainStatus
-
Data type: uint32
-
Access type: Read-only
The current node drain status of a node.
**Windows Server 2008 R2 and Windows Server 2008: **
This property is not supported before Windows Server 2012.
The possible values are.
Not Initiated (0)
**Windows Server 2012, Windows Server 2008 R2 and Windows Server 2008: **
This value is NotInitiated before Windows Server 2012 R2 .
In Progress (1)
**Windows Server 2012, Windows Server 2008 R2 and Windows Server 2008: **
This value is InProgress before Windows Server 2012 R2 .
Completed (2)
Failed (3)
NodeDrainTarget
-
Data type: string
-
Access type: Read-only
The target specified for the node drain.
**Windows Server 2008 R2 and Windows Server 2008: **
This property is not supported before Windows Server 2012.
NodeHighestVersion
-
Data type: uint32
-
Access type: Read-only
Provides access to the node's NodeHighestVersion property, which specifies the highest possible version of the cluster service with which the node can join or communicate.
NodeInstanceID
-
Data type: string
-
Access type: Read-only
Identifies the instance of the node.
NodeLowestVersion
-
Data type: uint32
-
Access type: Read-only
Provides access to the node's NodeLowestVersion property, which specifies the lowest possible version of the cluster service with which the node can join or communicate.
NodeWeight
-
Data type: uint32
-
Access type: Read/write
The vote weight of the node.
**Windows Server 2008 R2 and Windows Server 2008: **
This property is not supported before Windows Server 2012.
OtherIdentifyingInfo
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_ComputerSystem.IdentifyingDescriptions")
Contains additional data, beyond the Name property, that can be used to identify a node.
Inherited from CIM_UnitaryComputerSystem.
PowerManagementCapabilities
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|System Power Controls|001.2")
Indicates the specific power-related capabilities of a node and its associated running operating system.
Inherited from CIM_UnitaryComputerSystem.
Unknown (0)
The power management features are currently unknown.
Not Supported (1)
The power management features are currently not supported.
Disabled (2)
The power management features are currently disabled.
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 device can change its power state based on usage or other criteria.
Power State Settable (5)
The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.
Power Cycling Supported (6)
The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle).
Timed Power On Supported (7)
The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle) and Time set to a specific date and time, or interval, for power-on.
Timed Power On Supported
PowerManagementSupported
-
Data type: boolean
-
Access type: Read-only
If TRUE, the node, with its running operating system, supports power management. If FALSE, the integer value 1 ("Not Supported") should be the only entry in the PowerManagementCapabilities array. This boolean does not indicate that power management features are currently enabled, or if enabled, what features are supported. For more information, see the PowerManagementCapabilities array.
Inherited from CIM_UnitaryComputerSystem.
PowerState
-
Data type: uint16
-
Access type: Read-only
Indicates the current power state of the node and its associated operating system.
Inherited from CIM_UnitaryComputerSystem.
Unknown (0)
System power state is unknown.
Full power (1)
System is in a full power state.
Power Save - Low Power Mode (2)
System is in a power-save state and still functioning but may exhibit degraded performance.
Power Save - Standby (3)
System is not functioning but could be brought to full power quickly.
Power Save - Unknown (4)
System is known to be in a power-save mode but its exact status is unknown.
Power Cycle (5)
System power is being cycled.
Power Off (6)
System power is off.
Power Save - Warning (7)
System is in a warning state and also in a power-save mode.
Power Save - Hibernate (8)
System is in a hibernate state and also in a power-save mode.
Power Save - Soft Off (9)
System is in a soft off power state and also in a power-save mode.
Power Save - Warning
PrimaryOwnerContact
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (256), MappingStrings ("MIF.DMTF|General Information|001.3")
Provides information on how the primary system owner can be reached.
Inherited from CIM_UnitaryComputerSystem.
PrimaryOwnerName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|General Information|001.4")
Contains the name of the primary node owner.
Inherited from CIM_UnitaryComputerSystem.
PrivateProperties
-
Data type: MSCluster_Property
-
Access type: Read/write
An instance of the MSCluster_Property class representing the private properties of the node.
ResetCapability
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|System Hardware Security|001.4")
Determines whether the node can be reset with the power and reset buttons.
Inherited from CIM_UnitaryComputerSystem.
Other (1)
Unknown (2)
Disabled (3)
Enabled (4)
Not Implemented (5)
Roles
-
Data type: string array
-
Access type: Read-only
An array of strings that specify the roles this node plays in the IT-environment.
Inherited from CIM_UnitaryComputerSystem.
State
-
Data type: uint32
-
Access type: Read-only
Returns the current state of a node. For a list of possible state values, see GetClusterNodeState or the CLUSTER_NODE_STATE enumeration.
Unknown (-1)
Windows Server 2012 and Windows Server 2008 R2: This value was StateUnknown before Windows Server 2012 R2.
Up (0)
Down (1)
Paused (2)
Joining (3)
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (10)
Inherited from CIM_UnitaryComputerSystem.
Values include the following:
"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
StatusInformation
-
Data type: uint32
-
Access type: Read-only
The isolation or quarantine status of the node.
**Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2 and Windows Server 2008: **
This property is not supported before Windows Server 2016.
This property can have the following values.
Normal (0)
Isolated (1)
Quarantined (2)
Remarks
The MSCluster_Node class is derived from the CIM_UnitaryComputerSystem class.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 |
| Namespace |
Root\MSCluster |
| MOF |
|
| DLL |
|