Skip to content

ClusterProperty

dscbot edited this page Jun 11, 2022 · 2 revisions

ClusterProperty

Parameters

Parameter Attribute DataType Description Allowed Values
Name Key String Name of the cluster.
AddEvictDelay Write UInt32 Specifies how many seconds after a node is evicted that the failover cluster service will wait before adding a new node.
BlockCacheSize Write UInt32 Controls the size of the Cluster Shared Volume Memory Cache in MB.
ClusterLogLevel Write UInt32 Controls the level of cluster logging.
ClusterLogSize Write UInt32 Controls the maximum size of the cluster log files on each of the nodes.
CrossSiteDelay Write UInt32 Controls the time interval, in milliseconds, that the cluster network driver waits between sending Cluster Service heartbeats across sites.
CrossSiteThreshold Write UInt32 Controls how many Cluster Service heartbeats that can be missed across sites before it determines that Cluster Service has stopped responding.
CrossSubnetDelay Write UInt32 Controls the time interval, in milliseconds, that the cluster network driver waits between sending Cluster Service heartbeats across subnets.
CrossSubnetThreshold Write UInt32 Controls how many Cluster Service heartbeats that can be missed across subnets before it determines that Cluster Service has stopped responding.
DatabaseReadWriteMode Write UInt32 Specifies the read/write mode for the cluster database.
DefaultNetworkRole Write UInt32 Specifies the role that the cluster automatically assigns to any newly discovered or created network.
Description Write String Stores administrative comments about the cluster.
DrainOnShutdown Write UInt32 Specifies whether to enable Node Drain for a cluster.
DynamicQuorum Write UInt32 Enables the cluster to change the required number of nodes that need to participate in quorum when nodes shut down or crash.
NetftIPSecEnabled Write UInt32 Specifies whether Internet Protocol Security (IPSec) encryption is enabled for inter-node cluster communication.
PreferredSite Write String Specifies the preferred site for a site-aware cluster.
QuarantineDuration Write UInt32 Specifies the quarantine duration for a node, in seconds.
QuarantineThreshold Write UInt32 Specifies the quarantine threshold for a node, in minutes.
SameSubnetDelay Write UInt32 Controls the delay, in milliseconds, between netft heartbeats.
SameSubnetThreshold Write UInt32 Controls how many heartbeats can be missed on the same subnet before the route is declared as unreachable.
ShutdownTimeoutInMinutes Write UInt32 Specifies how many minutes after a system shutdown is initiated that the failover cluster service will wait for resources to go offline.

Description

Configures cluster properties on a failover cluster.

Requirements

  • Target machine must be running Windows Server 2008 R2 or later.

Examples

Example 1

This example shows how to set a number of failover cluster properties.

.NOTES This example assumes the failover cluster is already present.

Configuration ClusterProperty_SetClusterPropertiesConfig
{
    Import-DscResource -ModuleName FailoverClusterDsc

    node localhost
    {
        ClusterProperty SetProperties
        {
            Name = 'Cluster1'
            AddEvictDelay = 60
            ClusterLogSize = 300
            Description = ''
            SameSubnetDelay = 1000
            SameSubnetThreshold = 5
        }
    }
}