MSCluster_Cluster class

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

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

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}"), AMENDMENT]
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             Fqdn;
  string             Description;
  uint32             QuorumLogFileSize;
  uint8              Security[];
  string             NetworkInterfaceAdminExtensions[];
  string             NetworkAdminExtensions[];
  string             ResourceTypeAdminExtensions[];
  string             ResourceAdminExtensions[];
  string             NodeAdminExtensions[];
  string             GroupAdminExtensions[];
  string             AdminExtensions[];
  string             MaintenanceFile;
  string             QuorumType;
  string             QuorumPath;
  uint32             QuorumTypeValue;
  string             NetworkPriorities[];
  uint32             DefaultNetworkRole;
  uint8              Security_Descriptor[];
  uint32             QuorumArbitrationTimeMax;
  uint32             QuorumArbitrationTimeMin;
  uint32             DisableGroupPreferredOwnerRandomization;
  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             CrossSiteDelay;
  uint32             SameSubnetThreshold;
  uint32             CrossSubnetThreshold;
  uint32             CrossSiteThreshold;
  uint32             BackupInProgress;
  uint32             RequestReplyTimeout;
  MSCluster_Property PrivateProperties;
  uint32             WitnessRestartInterval;
  uint32             SecurityLevel;
  uint32             WitnessDatabaseWriteTimeout;
  uint32             AddEvictDelay = 60;
  uint32             FixQuorum = 0;
  uint32             PreventQuorum;
  uint32             IgnorePersistentStateOnStartup = 0;
  string             SharedVolumesRoot;
  uint32             WitnessDynamicWeight;
  uint32             AdminAccessPoint;
  uint32             ClusterFunctionalLevel;
  uint32             ClusterUpgradeVersion;
  uint32             ResiliencyLevel;
  uint32             ResiliencyDefaultPeriod;
  uint32             GroupDependencyTimeout;
  uint32             GracePeriodEnabled;
  uint32             GracePeriodTimeout;
  uint32             QuarantineDuration;
  uint32             AutoAssignedNodeSite;
  string             PreferredSite;
  uint32             PlacementOptions;
  uint32             QuarantineThreshold;
  uint32             AutoAssignNodeSite;
  uint32             AutoBalancerLevel;
  uint32             AutoBalancerMode;
  uint32             EnableSharedVolumes;
  uint32             BlockCacheSize;
  uint32             ClusterEnforcedAntiAffinity;
  uint32             SharedVolumeVssWriterOperationTimeout;
  uint32             UseClientAccessNetworksForSharedVolumes;
  string             SharedVolumeCompatibleFilters[];
  string             SharedVolumeIncompatibleFilters[];
  uint32             ClusterGroupWaitDelay;
  uint32             MinimumPreemptorPriority;
  uint32             MinimumNeverPreemptPriority;
  uint32             ShutdownTimeoutInMinutes;
  uint32             RootMemoryReserved;
  uint8              SharedVolumeSecurityDescriptor[];
  uint32             RouteHistoryLength;
  uint64             DumpPolicy;
  uint32             DynamicQuorumEnabled;
  string             RecentEventsResetTime;
  uint32             DrainOnShutdown;
  uint32             DatabaseReadWriteMode;
  uint32             NetftIPSecEnabled;
  uint32             CsvBalancer;
  uint32             MessageBufferLength;
  uint32             S2DEnabled;
  uint32             S2DBusTypes;
  uint32             S2DOptimizations;
  uint32             S2DIOLatencyThreshold;
  uint32             S2DCacheDesiredState;
  string             S2DCacheDeviceModel[];
  uint64             S2DCacheMetadataReserveBytes;
  uint32             S2DCachePageSizeKBytes;
  uint32             S2DCacheFlashReservePercent;
  uint64             S2DCacheBehavior;
  uint32             LowerQuorumPriorityNodeId;
  uint32             VirtualStorageArrayNotificationInterval;
  uint32             VirtualStorageArrayIOLatencyThreshold;
  uint32             VirtualStorageArrayStorageOptFlags;
  uint32             VirtualStorageArrayStorageBusTypes;
  uint32             VirtualStorageArrayEnabled;
};

Members

The MSCluster_Cluster class has these types of members:

Methods

The MSCluster_Cluster class has these methods.

MethodDescription
AddClusterNameAccount

Creates a cluster name account in Active Directory Domain Services.

AddNode

Adds a node to a cluster.

AddResourceToClusterSharedVolumes

Adds storage to Cluster Shared Volumes.

Windows Server 2008:  

This method is not supported before Windows Server 2008 R2.

AddVirtualMachine

Adds an existing virtual machine to the cluster.

Windows Server 2008 R2 and Windows Server 2008:  

This method is not supported before Windows Server 2012.

CreateCluster

Creates a cluster.

DestroyCluster

Removes the cluster.

EvictNode

Removes a specified node from the cluster.

ExecuteClusterControl

Executes a control code on the cluster.

ForceCleanup

Forces a node to be cleaned up.

GenerateValidationStatus

Creates an MSCluster_ValidationStatus object bound to the cluster.

Windows Server 2008:  

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:  

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.

SetMajorityQuorum

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

SetNodeMajorityQuorum

Sets the cluster to not have a node majority quorum.

VerifyPath

Verifies if the path is valid cluster storage for the resource group.

Windows Server 2008 R2 and Windows Server 2008:  

This method is not supported before Windows Server 2012.

 

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:  

This property is not supported before Windows Server 2008 R2.

60

Default

0–600

Valid range.

AdminAccessPoint
Data type: uint32
Access type: Read-only

The type of the cluster administrative access point.

Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2012 R2.

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

This property is obsolete.

AutoAssignedNodeSite
Data type: uint32
Access type: Read/write

Determines whether or not the cluster will attempt to automatically assign nodes to sites based on networks and Active Directory Site information.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

AutoAssignNodeSite
Data type: uint32
Access type: Read/write

Determines whether or not the cluster will attempt to automatically assign nodes to sites based on networks and Active Directory Site information

AutoBalancerLevel
Data type: uint32
Access type: Read/write

Determines the level of aggressiveness of AutoBalancer.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

AutoBalancerMode
Data type: uint32
Access type: Read/write

Determines whether or not the auto balancer is enabled.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

BackupInProgress
Data type: uint32
Access type: Read/write

Indicates whether a backup is in progress.

BlockCacheSize
Data type: uint32
Access type: Read/write

CSV BlockCache Size in MB.

Windows Server 2008:  

This property is not supported before Windows Server 2008 R2.

Windows Server 2008 R2:  

This property is named SharedVolumeBlockCacheSizeInMB in Windows Server 2008 R2.

Disabled (0)

Enabled (1)

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

A short textual description (one-line string) of the cluster.

This property is inherited from CIM_ManagedSystemElement.

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.

ClusSvcRegroupOpeningTimeout
Data type: uint32
Access type: Read-only

This property is not supported.

Windows Server 2008 R2 and Windows Server 2008:  

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

ClusSvcRegroupPruningTimeout
Data type: uint32
Access type: Read-only

This property is not supported.

Windows Server 2008 R2 and Windows Server 2008:  

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

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.

ClusSvcRegroupTickInMilliseconds
Data type: uint32
Access type: Read-only

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

ClusterEnforcedAntiAffinity
Data type: uint32
Access type: Read/write

Enables or disables hard enforcement of group anti-affinity classes.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

The possible values are.

Disabled (0)

Enabled (1)

ClusterFunctionalLevel
Data type: uint32
Access type: Read-only

The functional level the cluster is currently running in.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

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:  

This property is not supported before Windows Server 2008 R2.

ClusterLogLevel
Data type: uint32
Access type: Read/write

Controls the level of cluster logging.

ClusterLogSize
Data type: uint32
Access type: Read/write

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

ClusterUpgradeVersion
Data type: uint32
Access type: Read-only

Specifies the upgrade version the cluster is currently running in.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: CIM_KEY, MaxLen (256)

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.

CrossSiteDelay
Data type: uint32
Access type: Read/write

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

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

CrossSiteThreshold
Data type: uint32
Access type: Read/write

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

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

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.

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.

CsvBalancer
Data type: uint32
Access type: Read/write

Whether automatic balancing for CSV is enabled."

Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2012 R2.

DatabaseReadWriteMode
Data type: uint32
Access type: Read/write

Sets the database read and write mode.

Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2012 R2.

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

Indicates whether the cluster is a special-purpose cluster.

This property is inherited from CIM_ComputerSystem.

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)

DefaultNetworkRole
Data type: uint32
Access type: Read/write

Provides access to the cluster's DefaultNetworkRole property.

Description
Data type: string
Access type: Read/write
Qualifiers: Override (Description)

Provides access to the cluster's Description property.

DisableGroupPreferredOwnerRandomization
Data type: uint32
Access type: Read/write

This property is not supported.

DrainOnShutdown
Data type: uint32
Access type: Read/write

Whether to drain the node when cluster service is being stopped.

Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2012 R2.

DumpPolicy
Data type: uint64
Access type: Read/write

Controls the cluster dump collection policy.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

DynamicQuorumEnabled
Data type: uint32
Access type: Read/write

Allows cluster service to adjust node weights as needed to increase availability.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

EnableSharedVolumes
Data type: uint32
Access type: Read/write

Enables or disables cluster shared volumes on this cluster.

Windows Server 2008:  

This property is not supported before Windows Server 2008 R2.

The possible values are.

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:  

This property is not supported before Windows Server 2008 R2.

0

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

1

The cluster is in a fix quorum state.

Fqdn
Data type: string
Access type: Read-only

The fully qualified domain name of the cluster.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

GracePeriodEnabled
Data type: uint32
Access type: Read/write

Whether the node grace period feature of this cluster is enabled.

Disabled (0)

Enabled (1)

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

GracePeriodTimeout
Data type: uint32
Access type: Read/write

The grace period timeout in milliseconds.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

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

This property is obsolete.

GroupDependencyTimeout
Data type: uint32
Access type: Read/write

The timeout after which a group will be brought online despite unsatisfied dependencies

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

HangRecoveryAction
Data type: uint32
Access type: Read/write

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

IdentifyingDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ComputerSystem.OtherIdentifyingInfo")

An array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.

This property is inherited from CIM_ComputerSystem.

IgnorePersistentStateOnStartup
Data type: uint32
Access type: Read/write

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 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2008 R2, and is read-only until Windows Server 2016 Technical Preview.

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
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

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

This property is inherited from CIM_ManagedSystemElement.

LogResourceControls
Data type: uint32
Access type: Read/write

Controls the logging of resource controls.

LowerQuorumPriorityNodeId
Data type: uint32
Access type: Read/write

Specifies the Node ID that has a lower priority when voting for quorum is performed. If the quorum vote is split 50/50%, the specified node's vote would be ignored to break the tie. If this is not set then the cluster will pick a node at random to break the tie.

Note  The LowerQuorumPriorityNodeId property is available for use in Windows Server 2012 R2. It may be altered or unavailable in subsequent versions of Windows Server.
 
MaintenanceFile
Data type: string
Access type: Read/write

This property is obsolete.

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.

MessageBufferLength
Data type: uint32
Access type: Read/write

The maximum unacknowledged message count for GEM.

Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2012 R2.

MinimumNeverPreemptPriority
Data type: uint32
Access type: Read/write

Groups with this priority or higher cannot be preempted.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

MinimumPreemptorPriority
Data type: uint32
Access type: Read/write

Minimum priority a cluster group must have to be able to preempt another group.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

Name
Data type: string
Access type: Read-only
Qualifiers: Override (Name)

Specifies the name of the cluster.

NameFormat
Data type: string
Access type: Read-only

Identifies how the system name is generated.

This property is inherited from CIM_ComputerSystem.

("Other")

("IP")

("Dial")

("HID")

("NWA")

("HWA")

("X25")

("ISDN")

("IPX")

("DCC")

("ICD")

("E.164")

("SNA")

("OID/OSI")

NetftIPSecEnabled
Data type: uint32
Access type: Read/write

Whether IPSec is enabled for cluster internal traffic.

Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2012 R2.

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

This property is obsolete.

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

This property is obsolete.

NetworkPriorities
Data type: string array
Access type: Read-only
Qualifiers: Arraytype ("Ordered")

This property is obsolete.

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

This property is obsolete.

OtherIdentifyingInfo
Data type: string array
Access type: Read-only
Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_ComputerSystem.IdentifyingDescriptions")

Captures additional data, beyond System Name information, that could be used to identify a cluster.

This property is inherited from CIM_ComputerSystem.

PlacementOptions
Data type: uint32
Access type: Read/write

Various option flags to modify default placement behavior.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

PlumbAllCrossSubnetRoutes
Data type: uint32
Access type: Read/write

Plumbs all possible cross subnet routes to all nodes.

PreferredSite
Data type: string
Access type: Read/write

Specifies the site whose nodes will be given preference during regroup and node weight adjustment.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This method is not supported before Windows Server 2016 Technical Preview.

PreventQuorum
Data type: uint32
Access type: Read-only

Whether the cluster will ignore group persistent state on startup.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

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.

PrivateProperties
Data type: MSCluster_Property
Access type: Read/write

Controls private properties of the cluster.

QuarantineDuration
Data type: uint32
Access type: Read/write

The quarantine period timeout in milliseconds.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

QuarantineThreshold
Data type: uint32
Access type: Read/write

Number of node failures before it will be quarantined.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This method is not supported before Windows Server 2016 Technical Preview.

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 obsolete.

QuorumPath
Data type: string
Access type: Read-only

Maintains quorum files.

QuorumType
Data type: string
Access type: Read-only

Gets the current quorum type.

The following are the possible values:

"Majority"

"No Majority"

QuorumTypeValue
Data type: uint32
Access type: Read-only

Get the current quorum type value.

Possible values are.

Unknown (-1)

Node (1)

FileShareWitness (2)

Storage (3)

None (4)

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

RecentEventsResetTime
Data type: string
Access type: Read/write

Allows cluster to reset the last events displayed to clients.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

RequestReplyTimeout
Data type: uint32
Access type: Read/write

Controls the request reply time-out period.

ResiliencyDefaultPeriod
Data type: uint32
Access type: Read/write

The default resiliency period, in seconds, for the cluster.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

ResiliencyLevel
Data type: uint32
Access type: Read/write
Qualifiers: Min (1), Max (2)

The resiliency level for the cluster.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

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

This property is obsolete.

ResourceDllDeadlockPeriod
Data type: uint32
Access type: Read-only

This property is obsolete.

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

This property is obsolete.

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

An array (bag) of strings that specify the roles this cluster plays in the IT-environment.

This property is inherited from CIM_System.

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:  

This property is not supported before Windows Server 2008 R2.

RouteHistoryLength
Data type: uint32
Access type: Read/write

The history length for routes to help finding network issues.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

S2DBusTypes
Data type: uint32
Access type: Read/write

Bus types for storage spaces direct.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

S2DCacheBehavior
Data type: uint64
Access type: Read/write

Flags that affect the behavior of the storage spaces direct mode cache.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This method is not supported before Windows Server 2016 Technical Preview.

S2DCacheDesiredState
Data type: uint32
Access type: Read/write

Desired state of the storage spaces direct cache.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This method is not supported before Windows Server 2016 Technical Preview.

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

Use this property to override the default selection of physical disks to be used for S2D cache.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

S2DCacheFlashReservePercent
Data type: uint32
Access type: Read/write

Percentage of allocated flash space to utilize when caching.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This method is not supported before Windows Server 2016 Technical Preview.

S2DCacheMetadataReserveBytes
Data type: uint64
Access type: Read/write

Bytes to reserve on flash devices for metadata.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This method is not supported before Windows Server 2016 Technical Preview.

S2DCachePageSizeKBytes
Data type: uint32
Access type: Read/write

Page size in KB used by S2D cache.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

S2DEnabled
Data type: uint32
Access type: Read/write

Whether direct attached storage (DAS) is enabled.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

S2DIOLatencyThreshold
Data type: uint32
Access type: Read/write

The I/O latency threshold for storage spaces direct.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

S2DOptimizations
Data type: uint32
Access type: Read/write

Optimization flags for storage spaces direct.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2016 Technical Preview.

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.

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.

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

This property is obsolete.

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/write

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

Windows Server 2008 R2 and Windows Server 2008:  

This property is read-only before Windows Server 2012.

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:  

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:  

This property is not supported before Windows Server 2008 R2.

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

Controls access to the CSV Meta Data Server volume for the user mode applications.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

SharedVolumesRoot
Data type: string
Access type: Read-only

Root directory from which the cluster shared volumes are linked.

Windows Server 2008:  

This property is not supported before Windows Server 2008 R2.

SharedVolumeVssWriterOperationTimeout
Data type: uint32
Access type: Read/write

CSV VSS Writer operation timeout in seconds.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

ShutdownTimeoutInMinutes
Data type: uint32
Access type: Read/write

The maximum time in minutes allowed for cluster resources to come offline during cluster service shutdown.

Windows Server 2008:  

This property is not supported before Windows Server 2008 R2.

This property can have the following values.

Range: 0–1440

Status
Data type: string
Access type: Read-only
Qualifiers: MaxLen (10)

A string indicating the current status of the cluster. Various operational and non-operational statuses are defined. Operational statuses are "OK", "Degraded", "Stressed" and "Pred Fail". "Stressed" indicates that the Element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc. The condition "Pred Fail" (failure predicted) indicates that an Element is functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are "Error", "NonRecover", "Starting", "Stopping" and "Service". "NonRecover" indicates that a non-recoverable error has occurred. "Service" describes an Element being configured, maintained or cleaned, or otherwise administered. This status could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative task. Not all such work is on-line, yet the Element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

UseClientAccessNetworksForSharedVolumes
Data type: uint32
Access type: Read/write

Whether the use of client access networks for cluster shared volumes feature of this cluster is enabled.

Possible values are.

Disabled (0)

Enabled (1)

Auto (2)

Windows Server 2012 R2 and Windows Server 2012:  

This value is not supported before Windows Server 2016 Technical Preview.

Windows Server 2008 R2 and Windows Server 2008:  

This property is not supported before Windows Server 2012.

VirtualStorageArrayEnabled
Data type: uint32
Access type: Read/write

Not supported.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is only supported in Windows Server 2012 R2.

VirtualStorageArrayIOLatencyThreshold
Data type: uint32
Access type: Read/write

Not supported.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is only supported in Windows Server 2012 R2.

VirtualStorageArrayNotificationInterval
Data type: uint32
Access type: Read/write

Not supported.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is only supported in Windows Server 2012 R2.

VirtualStorageArrayStorageBusTypes
Data type: uint32
Access type: Read/write

Not supported.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is only supported in Windows Server 2012 R2.

VirtualStorageArrayStorageOptFlags
Data type: uint32
Access type: Read/write

Not supported.

Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is only supported in Windows Server 2012 R2.

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.

WitnessDynamicWeight
Data type: uint32
Access type: Read-only

The weight of the configured witness.

Windows Server 2012, Windows Server 2008 R2, and Windows Server 2008:  

This property is not supported before Windows Server 2012 R2.

WitnessRestartInterval
Data type: uint32
Access type: Read/write

Controls the witness restart interval.

Remarks

The MSCluster_Cluster class is derived from the CIM_Cluster class.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Namespace

Root\MSCluster

MOF

ClusWmi.mof

DLL

ClusWMI.dll

See also

CIM_Cluster
Failover Cluster Provider Reference

 

 

Show: