Export (0) Print
Expand All

MSCluster_Cluster class

The MSCluster_Cluster class is a dynamic WMI class that represents a cluster.

Note  The following object is available for use in Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, and Windows Server 2012 R2. It may be altered or unavailable in subsequent versions.

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

Syntax

[Dynamic, Provider ("MS_CLUSTER_PROVIDER"), UUID ("{9EB9A2F9-0751-4dcf-AB59-F8341D0F60B2}")]class MSCluster_Cluster : CIM_Cluster
{
  string             Caption;
  datetime           InstallDate;
  string             Status;
  string             CreationClassName;
  string             PrimaryOwnerContact;
  string             PrimaryOwnerName;
  string             Roles[];
  string             NameFormat;
  string             OtherIdentifyingInfo[];
  string             IdentifyingDescriptions[];
  uint16             Dedicated[];
  uint32             MaxNumberOfNodes;
  string             Name;
  string             Description;
  string             MaintenanceFile;
  string             AdminExtensions[];
  string             GroupAdminExtensions[];
  string             NodeAdminExtensions[];
  string             ResourceAdminExtensions[];
  string             ResourceTypeAdminExtensions[];
  string             NetworkAdminExtensions[];
  string             NetworkInterfaceAdminExtensions[];
  uint8              Security[];
  uint32             QuorumLogFileSize;
  string             QuorumType;
  string             QuorumPath;
  string             NetworkPriorities[];
  uint32             DefaultNetworkRole;
  uint32             EnableEventLogReplication;
  uint8              Security_Descriptor[];
  uint32             QuorumArbitrationTimeMax;
  uint32             QuorumArbitrationTimeMin;
  uint32             ResourceDllDeadlockPeriod;
  uint32             ClusSvcHangTimeout;
  uint32             ClusSvcRegroupOpeningTimeout;
  uint32             PlumbAllCrossSubnetRoutes;
  uint32             ClusSvcRegroupStageTimeout;
  uint32             ClusSvcRegroupPruningTimeout;
  uint32             ClusSvcRegroupTickInMilliseconds;
  uint32             ClusterLogSize;
  uint32             ClusterLogLevel;
  uint32             LogResourceControls;
  uint32             HangRecoveryAction;
  uint32             SameSubnetDelay;
  uint32             CrossSubnetDelay;
  uint32             SameSubnetThreshold;
  uint32             CrossSubnetThreshold;
  uint32             BackupInProgress;
  uint32             RequestReplyTimeout;
  MSCluster_Property PrivateProperties;
  uint32             WitnessRestartInterval;
  uint32             SecurityLevel;
  uint32             WitnessDatabaseWriteTimeout;
  uint32             AddEvictDelay = 60;
  uint32             FixQuorum = 0;
  uint32             IgnorePersistentStateOnStartup = 0;
  string             SharedVolumesRoot;
  uint32             EnableSharedVolumes;
  string             SharedVolumeCompatibleFilters[];
  string             SharedVolumeIncompatibleFilters[];
  uint32             ClusterGroupWaitDelay;
  uint32             ShutdownTimeoutInMinutes = 10;
  uint32             RootMemoryReserved;
};

Members

The MSCluster_Cluster class has these types of members:

Methods

The MSCluster_Cluster class has these methods.

MethodDescription
AddNode

Adds a node to a cluster.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

AddResourceToClusterSharedVolumes

Adds storage to Cluster Shared Volumes.

Windows Server 2008 and Windows Server 2003:  

This method is not supported before Windows Server 2008 R2.

AddVirtualMachine

Adds an existing virtual machine to the cluster.

Windows Server 2008 R2, Windows Server 2008, and Windows Server 2003:  

This method is not supported before Windows Server 2012.

CreateCluster

Creates a cluster.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

DestroyCluster

Removes the cluster.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

EvictNode

Removes a specified node from the cluster.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

ExecuteClusterControl

Executes a control code on the cluster.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

ForceCleanup

Forces a node to be cleaned up.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

GenerateValidationStatus

Creates an MSCluster_ValidationStatus bound to the cluster.

Windows Server 2008 and Windows Server 2003:  

This method is not supported before Windows Server 2008 R2.

GetNodeClusterState

Determines whether the Cluster service is installed and running on a node.

RemoveResourceFromClusterSharedVolumes

Removes storage from Cluster Shared Volumes.

Windows Server 2008 and Windows Server 2003:  

This method is not supported before Windows Server 2008 R2.

Rename

Renames the cluster.

SetDiskQuorum

Sets the quorum behavior to not be a majority and to use the passed-in disk as the quorum resource.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

SetMajorityQuorum

Sets the quorom to a majority quorum and uses the passed-in resource as the quorum witness resource.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

SetNodeMajorityQuorum

Sets the cluster to not have a node majority quorum.

Windows Server 2003:  

This method is not supported before Windows Server 2008.

SetQuorumResource

This method is not supported.

Windows Server 2003:  

Designates the quorum resource for the cluster.

 

Properties

The MSCluster_Cluster class has these properties.

AddEvictDelay
Data type: uint32
Access type: Read/write

Provides access to the cluster's AddEvictDelay property, which is the number a seconds that a new node is delayed after an eviction of another node.

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

ValueMeaning
60

Default

0–600

Valid range.

 

AdminExtensions
Data type: string array
Access type: Read/write

This property is not supported.

Windows Server 2003:  

Provides the class identifiers (CLSIDs) for the Cluster Administrator extension DLLs associated with the cluster.

BackupInProgress
Data type: uint32
Access type: Read/write

Indicates whether a backup is in progress.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

Caption
Data type: string
Access type: Read-only

Provides a short textual description of the cluster.

Inherited from CIM_Cluster.

ClusSvcHangTimeout
Data type: uint32
Access type: Read-only

Controls how long the cluster network driver waits between Failover Cluster Service heartbeats before it determines that the Failover Cluster Service has stopped responding.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

ClusSvcRegroupOpeningTimeout
Data type: uint32
Access type: Read-only

Controls how long a node will wait on other nodes in the opening stage before deciding that they failed.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

Windows Server 2012:  

This property is not supported and may be altered or unavailable in the future.

ClusSvcRegroupPruningTimeout
Data type: uint32
Access type: Read-only

Controls how long the membership leader will wait to reach full connectivity between cluster nodes.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

Windows Server 2012:  

This property is not supported and may be altered or unavailable in the future.

ClusSvcRegroupStageTimeout
Data type: uint32
Access type: Read-only

Controls how long a node will wait on other nodes in a membership stage before deciding that they failed.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

ClusSvcRegroupTickInMilliseconds
Data type: uint32
Access type: Read-only

Controls how frequently the membership algorithm is sending periodic membership messages.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

ClusterGroupWaitDelay
Data type: uint32
Access type: Read/write

Maximum time in seconds that a group waits for its preferred node to come online during cluster startup before coming online on a different node.

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

ClusterLogLevel
Data type: uint32
Access type: Read/write

Controls the level of cluster logging.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

ClusterLogSize
Data type: uint32
Access type: Read/write

Controls the maximum size of the cluster log files on each of the nodes.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

CreationClassName
Data type: string
Access type: Read-only

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.

Inherited from CIM_Cluster.

CrossSubnetDelay
Data type: uint32
Access type: Read/write

Controls how long the cluster network driver waits in milliseconds between sending Cluster Service heartbeats across subnets.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

CrossSubnetThreshold
Data type: uint32
Access type: Read/write

Controls how many Cluster Service heartbeats can be missed across subnets before it determines that Cluster Service has stopped responding.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

Dedicated
Data type: uint16 array
Access type: Read-only

Indicates whether the cluster is a special-purpose cluster.

Inherited from CIM_Cluster.

DefaultNetworkRole
Data type: uint32
Access type: Read/write

Provides access to the cluster's DefaultNetworkRole property.

Description
Data type: string
Access type: Read/write

Provides access to the cluster's Description property.

EnableEventLogReplication
Data type: uint32
Access type: Read/write

This property is not supported.

Windows Server 2003:  

Controls whether a node's system, application, and security event log entries are replicated in the event logs of all other cluster nodes.

EnableSharedVolumes
Data type: uint32
Access type: Read/write

Enables or disables cluster shared volumes on this cluster.

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

Disabled (0)
Enabled (1)
FixQuorum
Data type: uint32
Access type: Read-only

Provides access to the cluster's FixQuorum property, which specifies if the cluster is in a fix quorum state.

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

ValueMeaning
0

The cluster is not in a fix quorum state. This is the default value.

1

The cluster is in a fix quorum state.

 

GroupAdminExtensions
Data type: string array
Access type: Read/write

This property is not supported.

Windows Server 2003:  

Provides access to the AdminExtensions property for groups.

HangRecoveryAction
Data type: uint32
Access type: Read/write

Controls the action to take if the user-mode processes have stopped responding.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

IdentifyingDescriptions
Data type: string array
Access type: Read-only

Provides explanations and details of the entries in the OtherIdentifyingInfo property array. Each entry of this array is related to the entry in the OtherIdentifyingInfo property that is located at the same index.

Inherited from CIM_Cluster.

IgnorePersistentStateOnStartup
Data type: uint32
Access type: Read-only

Provides access to the cluster's IgnorePersistentStateOnStartup property, which specifies whether the cluster will bring online groups that were online when the cluster was shut down.

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

ValueMeaning
0

On startup groups that were online when the cluster was shut down will be brought online. This is the default value.

1

On startup all groups will remain offline.

 

InstallDate
Data type: datetime
Access type: Read-only

Indicates when the cluster was installed. A lack of a value does not indicate that the cluster is not installed.

Inherited from CIM_Cluster.

LogResourceControls
Data type: uint32
Access type: Read/write

Controls the logging of resource controls.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

MaintenanceFile
Data type: string
Access type: Read/write

This property is not supported.

Windows Server 2003:  

Indicates the location of a maintenance file.

MaxNumberOfNodes
Data type: uint32
Access type: Read-only

Indicates the maximum number of nodes that can participate in a cluster. A value of zero indicates that an unlimited number of nodes can participate in the cluster.

Inherited from CIM_Cluster.

Name
Data type: string
Access type: Read-only

Specifies the name of the cluster.

NameFormat
Data type: string
Access type: Read-only

Identifies the manner in which the system name was created.

Inherited from CIM_Cluster.

NetworkAdminExtensions
Data type: string array
Access type: Read/write

This property is not supported.

Windows Server 2003:  

Provides access to the AdminExtensions property for networks.

NetworkInterfaceAdminExtensions
Data type: string array
Access type: Read/write

This property is not supported.

Windows Server 2003:  

Provides access to the AdminExtensions property for network interfaces.

NetworkPriorities
Data type: string array
Access type: Read/write
Qualifiers: ArrayType ("Ordered")

This property is not supported.

Windows Server 2003:  

Lists networks in priority order. The first in the array has the highest priority.

NodeAdminExtensions
Data type: string array
Access type: Read/write

This property is not supported.

Windows Server 2003:  

Provides access to the AdminExtensions property for nodes.

OtherIdentifyingInfo
Data type: string array
Access type: Read-only

Captures additional data, beyond system name information, that can be used to identify a cluster.

Inherited from CIM_Cluster.

PlumbAllCrossSubnetRoutes
Data type: uint32
Access type: Read/write

Plumbs all possible cross subnet routes to all nodes.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

PrimaryOwnerContact
Data type: string
Access type: Read-only

Provides information on how the primary system owner can be reached.

Inherited from CIM_Cluster.

PrimaryOwnerName
Data type: string
Access type: Read-only

The name of the primary system owner.

Inherited from CIM_Cluster.

PrivateProperties
Data type: MSCluster_Property
Access type: Read/write

Controls private properties of the cluster.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

QuorumArbitrationTimeMax
Data type: uint32
Access type: Read/write

Controls the maximum time necessary to decide the Quorum owner node.

QuorumArbitrationTimeMin
Data type: uint32
Access type: Read/write

Controls the minimum time necessary to decide the Quorum owner node.

QuorumLogFileSize
Data type: uint32
Access type: Read/write

This property is not supported.

Windows Server 2003:  

Sets or retrieves the size of the quorum log file.

QuorumPath
Data type: string
Access type: Read-only

Maintains quorum files.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

QuorumType
Data type: string
Access type: Read-only

Gets the current quorum type.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

The following are the possible values:

"Majority"

"No Majority"

RequestReplyTimeout
Data type: uint32
Access type: Read/write

Controls the request reply time-out period.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

ResourceAdminExtensions
Data type: string array
Access type: Read/write

This property is not supported.

Windows Server 2003:  

Provides access to the AdminExtensions property for resources.

ResourceDllDeadlockPeriod
Data type: uint32
Access type: Read-only

This property is not supported.

Windows Server 2003:  

Specifies the overall time period (in seconds) used to determine if a resource access deadlock condition has occurred. See ResourceDllDeadlockPeriod.

ResourceTypeAdminExtensions
Data type: string array
Access type: Read/write

This property is not supported.

Windows Server 2003:  

Provides access to the AdminExtensions property for resource types.

Roles
Data type: string array
Access type: Read-only

Specifies the roles the cluster plays in the IT environment.

Inherited from CIM_Cluster.

RootMemoryReserved
Data type: uint32
Access type: Read/write

Controls the amount of memory reserved for the parent partition on all cluster nodes.

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

SameSubnetDelay
Data type: uint32
Access type: Read/write

Controls how long the cluster network driver waits in milliseconds between sending Cluster Service heartbeats on the same subnet.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

SameSubnetThreshold
Data type: uint32
Access type: Read/write

Controls how many Cluster Service heartbeats can be missed on the same subnet before it determines that Cluster Service has stopped responding.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

Security
Data type: uint8 array
Access type: Read/write

Not supported; use the Security Descriptor property.

Security_Descriptor
Data type: uint8 array
Access type: Read/write

Provides access to the cluster's Security Descriptor property.

SecurityLevel
Data type: uint32
Access type: Read-only

Controls the level of security that should apply to intracluster messages.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

The following are the possible values.

Clear Text (0)
Sign (1)
Encrypt (2)
SharedVolumeCompatibleFilters
Data type: string array
Access type: Read/write

Certain classes of filter drivers may be flagged as incompatible with the direct I/O mode of shared volumes. This property is used to override cluster service determination of filters as incompatible. Compatible filter driver names are specified without the .sys extension.

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

SharedVolumeIncompatibleFilters
Data type: string array
Access type: Read/write

Certain classes of filter drivers may be incompatible with the direct I/O mode of shared volumes. This property is used to add filters to be deemed as incompatible for direct I/O. Incompatible filter driver names are specified without the .sys extension.

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

SharedVolumesRoot
Data type: string
Access type: Read-only

Root directory from which the cluster shared volumes are linked.

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

ShutdownTimeoutInMinutes
Data type: uint32
Access type: Read/write

Provides access to the cluster's ShutdownTimeoutInMinutes property, which is the maximum time in minutes allowed for cluster resources to come offline during cluster service shutdown.

Windows Server 2008 and Windows Server 2003:  

This property is not supported before Windows Server 2008 R2.

ValueMeaning
10

Default

0–1440

Valid range.

 

Status
Data type: string
Access type: Read-only

Indicates the current status of the cluster.

Inherited from CIM_Cluster.

Values include the following:

"OK"

"Error"

"Degraded"

"Unknown"

"Pred Fail"

"Starting"

"Stopping"

"Service"

"Stressed"

"NonRecover"

"No Contact"

"Lost Comm"

WitnessDatabaseWriteTimeout
Data type: uint32
Access type: Read/write

Controls the maximum time in seconds that a cluster database write to a witness can take before the write is abandoned.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

WitnessRestartInterval
Data type: uint32
Access type: Read/write

Controls the witness restart interval.

Windows Server 2003:  

This property is not supported before Windows Server 2008.

Remarks

The MSCluster_Cluster class is derived from the CIM_Cluster class.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2003 Datacenter, Windows Server 2003 Enterprise

Namespace

\\.\Root\MSCluster

MOF

ClusWmi.mof

See also

Failover Cluster Provider Reference

 

 

Show:
© 2014 Microsoft