Cluster Common Properties

Cluster common properties are stored in the cluster database and apply to the cluster as a whole.

In this section

AddEvictDelay

Specifies how many seconds after a node is evicted that the failover cluster service will wait before adding a new node.

AdminAccessPoint

Management point type.

AdminExtensions

This property is not supported.

AutoBalancerLevel

Specifies the auto balancer level.

AutoBalancerMode

The auto balancer mode.

BackupInProgress

Indicates whether or not a Volume Shadow Copy Service Task is currently in progress for a specific volume on the cluster.

BlockCacheSize

Specifies the cache size of a cluster shared volume (CSV), in megabytes.

ClusSvcHangTimeout

Controls the amount of time, in seconds, that the cluster network driver waits between Failover Cluster Service heartbeats before it determines that the Failover Cluster Service has stopped responding.

ClusSvcHeartbeatTimeout

This property is not supported.

ClusSvcRegroupOpeningTimeout

Controls the amount of time, in seconds, that a node waits on other nodes in the opening stage before deciding that they have failed.

ClusSvcRegroupPruningTimeout

Controls the amount of time, in seconds, that the membership leader waits to reach full connectivity between cluster nodes.

ClusSvcRegroupStageTimeout

Controls the amount of time, in seconds, that a node waits on other nodes in a membership stage before deciding that they have failed.

ClusSvcRegroupTickInMilliseconds

Controls the interval of time, in milliseconds, that the membership algorithm waits between issuances of periodic membership messages.

ClusterEnforcedAntiAffinity

Prevents multiple cluster groups from running on the same cluster node when they contain the same AntiAffinityClassNames property value.

ClusterFunctionalLevel

The major version of the OS on a cluster during a rolling upgrade.

ClusterGroupWaitDelay

Specifies the 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.

ClusterLogLevel

Controls the level of cluster logging.

ClusterLogSize

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

ClusterUpgradeVersion

CrossSiteDelay

Controls the time interval, in milliseconds, that the cluster network driver waits between sending Cluster Service heartbeats across sites.

CrossSiteThreshold

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

CrossSubnetDelay

Controls the time interval, in milliseconds, that the cluster network driver waits between sending Cluster Service heartbeats across subnets.

CrossSubnetThreshold

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

DatabaseReadWriteMode

Specifies the read/write mode for the cluster database.

DefaultNetworkRole

Specifies the role that the cluster automatically assigns to any newly discovered or created network.

Description

Stores administrative comments about the cluster. The following table summarizes the attributes of the Description property.

DisableGroupPreferredOwnerRandomization

This property is not supported.

DrainOnShutdown

Specifies whether to enable Node Drain for a cluster.

DumpPolicy

Dump policy.

Attribute Value
Data type
DWORD
Access
Read/write
Structure
CLUSPROP_ULARGE_INTEGER
Minimum
0
Maximum
0
Default
( DWORD_PTR ) &ClusterDumpPolicyDefaults

DynamicQuorum

Enables the cluster to change the required number of nodes that need to participate in quorum when nodes shut down or crash.

EnableEventDeltaGeneration

Controls whether a time delta event is logged when a set of event log entries are replicated to nodes across the entire cluster.

EnableEventLogReplication

Controls whether the system, application, and security event log entries of all the node's are replicated across the entire cluster.

EnableResourceDllDeadlockDetection

This property is not supported.

EnableSharedVolumes

Not supported. This property cannot be set and always evaluates to TRUE (1).

FixQuorum

Specifies if the cluster is in a fix quorum state.

GroupDependencyTimeout

The group dependency timeout, in seconds.

HangRecoveryAction

Specifies the recovery action taken by the cluster service in response to a heartbeat countdown timeout.

IgnorePersistentStateOnStartup

Specifies whether the cluster will bring online groups that were online when the cluster was shut down.

LogResourceControls

Controls the logging of resource controls.

MessageBufferLength

Specifies the number of characters in a message buffer.

MinimumNeverPreemptPriority

Specifies the lowest priority group that cannot be preempted.

MinimumPreemptorPriority

Specifies the lowest priority group that can preempt other groups.

NetftIPSecEnabled

Specifies whether Internet Protocol Security (IPSec) encryption is enabled for inter-node cluster communication.

PlacementOptions

Options for placing the cluster.

PlumbAllCrossSubnetRoutes

Plumbs all possible cross subnet routes to all nodes.

PreferredSite

Specifies the preferred site for a site-aware cluster.

PreventQuorum

Specifies whether to prevent a cluster node from achieving a quorum.

QuarantineDuration

Specifies the quarantine duration for a node, in seconds.

Attribute Value
Data type
DWORD
Access
Read/write
Structure
CLUSPROP_DWORD
Minimum
0
Maximum
0xFFFFFFFF
Default
0

QuarantineThreshold

Specifies the quarantine threshold for a node, in minutes.

QuorumArbitrationTimeMax

Specifies the maximum number of seconds a node is allowed to spend arbitrating for the quorum resource in a cluster.

QuorumArbitrationTimeMin

This property is not supported.

RequestReplyTimeout

Describes the length of time a request from a node with a cluster state update will wait for replies from the other healthy nodes before the request times out.

ResiliencyDefaultPeriod

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

Attribute Value
Data type
DWORD
Access
Read/write
Structure
CLUSPROP_DWORD
Minimum
0
Maximum
0xFFFFFFFF
Default
240

ResiliencyLevel

Specifies the resiliency level for the cluster.

Attribute Value
Data type
DWORD
Access
Read/write
Structure
CLUSPROP_DWORD
Minimum
1
Maximum
2
Default
1

ResourceDllDeadlockPeriod

This property is not supported.

ResourceDllDeadlockThreshold

This property is not supported.

ResourceDllDeadlockTimeout

This property is not supported.

RootMemoryReserved

Not supported.

RouteHistoryLength

The number of heartbeats to log after a cluster network failure.

S2DBusTypes

Specifies the bus types for Storage Spaces Direct (2SD).

S2DCacheBehavior

Specifies the cache behavior for Storage Spaces Direct (2SD).

S2DCacheDesiredState

Specifies the desired cache state for Storage Spaces Direct (2SD).

S2DCacheFlashReservePercent

The percent of disk space, to reserve for the cache of a flash drive when using Storage Spaces Direct (2SD).

S2DCacheMetadataReserveBytes

The amount of disk space, in bytes, to reserve for the cache of a flash drive when using Storage Spaces Direct (2SD).

S2DCachePageSizeKBytes

Page size in KB used by S2D cache.

S2DEnabled

Enables Storage Spaces Direct (2SD).

Attribute Value
Data type
DWORD
Access
Read/write
Structure
CLUSPROP_DWORD
Minimum
0
Maximum
1
Default
0

S2DIOLatencyThreshold

Specifies the IO latency threshold for Storage Spaces Direct (2SD).

S2DOptimizations

Specifies the optimization flags for Storage Spaces Direct (2SD).

SameSubnetDelay

Controls the delay, in milliseconds, between netft heartbeats.

SameSubnetThreshold

Controls how many heartbeats can be missed on the same subnet before the route is declared as unreachable.

Security Descriptor

Stores the security descriptor of a cluster. The following table summarizes the attributes of the Security Descriptor property.

SecurityLevel

Controls the level of security that applies to intracluster messages.

SharedVolumeBlockCacheSizeInMB

Specifies the cache size of a cluster shared volume (CSV), in megabytes.

SharedVolumeCompatibleFilters

Overrides cluster service determination of filters as incompatible.

SharedVolumeIncompatibleFilters

Adds filters to be deemed as incompatible for direct I/O.

SharedVolumeSecurityDescriptor

Specifies the security descriptor for a cluster shared volume (CSV).

SharedVolumesRoot

Specifies the root directory from which the cluster shared volumes (CSVs) are linked.

ShutdownTimeoutInMinutes

Specifies how many minutes after a system shutdown is initiated that the failover cluster service will wait for resources to go offline.

UseClientAccessNetworksForSharedVolumes

Enables or disables the use of client access networks for cluster shared volumes (CSV) used by the cluster.

UseNetftForSharedVolumes

Specifies whether to enable Network Fault-Tolerance (NETFT) for cluster shared volumes.

WitnessDatabaseWriteTimeout

Specifies the maximum amount of time, in seconds, that a cluster database write to a witness can take before the write is abandoned.

WitnessDynamicWeight

Specifies the weight of a file share quorum witness for dynamic quorum.

WitnessRestartInterval

specifies how long (in minutes) the system will wait before attempting to restart a failed file share witness resource.

Cluster Object Common Properties

Getting Cluster Information