xfailovercluster

Module containing DSC resources for deployment and configuration of Windows Server Failover Cluster.

9,754 downloads

498 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.16.1-0-0 (latest)
  • 1.16.0-0-0
  • 1.15.0-0-0
  • 1.14.1-0-3
  • 1.14.1-0-2
  • 1.14.1-0-1
  • 1.14.1-0-0
  • 1.14.0-0-3
  • 1.14.0-0-2
  • 1.14.0-0-1
  • 1.14.0-0-0
  • 1.13.0-0-3
  • 1.13.0-0-2
  • 1.13.0-0-1
  • 1.13.0-0-0
  • 1.12.0-0-3
  • 1.12.0-0-2
  • 1.12.0-0-1
  • 1.12.0-0-0
  • 1.11.0-0-3
  • 1.11.0-0-2
  • 1.11.0-0-1
  • 1.11.0-0-0
  • 1.10.0-0-3
  • 1.10.0-0-2
  • 1.10.0-0-1
  • 1.10.0-0-0
  • 1.9.0-0-3
  • 1.9.0-0-2
  • 1.9.0-0-1
  • 1.9.0-0-0
  • 1.8.0-0-3
  • 1.8.0-0-2
  • 1.8.0-0-1
  • 1.8.0-0-0
  • 1.7.0-0-3
  • 1.7.0-0-2
  • 1.7.0-0-1
  • 1.7.0-0-0
  • 1.6.0-0-3
  • 1.6.0-0-2
  • 1.6.0-0-1
  • 1.6.0-0-0
  • 1.5.0-0-3
  • 1.5.0-0-2
  • 1.5.0-0-1
  • 1.5.0-0-0
  • 1.4.0-0-3
  • 1.4.0-0-2
  • 1.4.0-0-1
  • 1.4.0-0-0
released Sep 7th 2022
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
  • Puppet >= 6.0.0 < 8.0.0

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'dsc-xfailovercluster', '1.16.1-0-0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add dsc-xfailovercluster
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install dsc-xfailovercluster --version 1.16.1-0-0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

dsc/xfailovercluster — version 1.16.1-0-0 Sep 7th 2022

Reference

Table of Contents

Resource types

  • dsc_xcluster: The DSC xCluster resource type. Automatically generated from version 1.16.1
  • dsc_xclusterdisk: The DSC xClusterDisk resource type. Automatically generated from version 1.16.1
  • dsc_xclusternetwork: The DSC xClusterNetwork resource type. Automatically generated from version 1.16.1
  • dsc_xclusterpreferredowner: The DSC xClusterPreferredOwner resource type. Automatically generated from version 1.16.1
  • dsc_xclusterproperty: The DSC xClusterProperty resource type. Automatically generated from version 1.16.1
  • dsc_xclusterquorum: The DSC xClusterQuorum resource type. Automatically generated from version 1.16.1
  • dsc_xwaitforcluster: The DSC xWaitForCluster resource type. Automatically generated from version 1.16.1

Resource types

dsc_xcluster

The DSC xCluster resource type. Automatically generated from version 1.16.1

Properties

The following properties are available in the dsc_xcluster type.

dsc_ignorenetwork

Data type: Optional[Array[String]]

One or more networks to ignore when creating the cluster. Only networks using Static IP can be ignored, networks that are assigned an IP address through DHCP cannot be ignored, and are added for cluster communication. To remove networks assigned an IP address through DHCP use the resource xClusterNetwork to change the role of the network. This parameter is only used during the creation of the cluster and is not monitored after.

dsc_staticipaddress

Data type: Optional[String]

StaticIPAddress of the Cluster

Parameters

The following parameters are available in the dsc_xcluster type.

dsc_domainadministratorcredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

Credential to create the cluster

dsc_name

namevar

Data type: String

Name of the Cluster

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_xclusterdisk

The DSC xClusterDisk resource type. Automatically generated from version 1.16.1

Properties

The following properties are available in the dsc_xclusterdisk type.

dsc_ensure

Data type: Optional[Enum['Present', 'Absent']]

Define if the cluster disk should be added (Present) or removed (Absent). Default value is 'Present'.

dsc_label

Data type: Optional[String]

The disk label that should be assigned to the disk on the Failover Cluster disk resource.

Parameters

The following parameters are available in the dsc_xclusterdisk type.

dsc_number

namevar

Data type: String

The disk number of the cluster disk.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_xclusternetwork

The DSC xClusterNetwork resource type. Automatically generated from version 1.16.1

Properties

The following properties are available in the dsc_xclusternetwork type.

dsc_metric

Data type: Optional[String]

The metric number for the cluster network. If the cluster network metric number is not in desired state it will be changed to match this metric number.

dsc_name

Data type: Optional[String]

The name of the cluster network. If the cluster network name is not in desired state it will be renamed to match this name.

dsc_role

Data type: Optional[Enum['0', '1', '3']]

he role of the cluster network. If the cluster network role is not in desired state it will change to match this role.

Parameters

The following parameters are available in the dsc_xclusternetwork type.

dsc_address

namevar

Data type: String

The address for the cluster network in the format '10.0.0.0'.

dsc_addressmask

namevar

Data type: String

The address mask for the cluster network in the format '255.255.255.0'.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_xclusterpreferredowner

The DSC xClusterPreferredOwner resource type. Automatically generated from version 1.16.1

Properties

The following properties are available in the dsc_xclusterpreferredowner type.

dsc_clusterresources

Data type: Optional[Array[String]]

he resources to set preferred owners on.

dsc_ensure

Data type: Optional[Enum['Present', 'Absent']]

If the preferred owners should be present or absent. Default value is 'Present'.

dsc_nodes

Data type: Array[String]

The nodes to set as owners.

Parameters

The following parameters are available in the dsc_xclusterpreferredowner type.

dsc_clustergroup

namevar

Data type: String

Name of the cluster group.

dsc_clustername

namevar

Data type: String

Name of the cluster.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_xclusterproperty

The DSC xClusterProperty resource type. Automatically generated from version 1.16.1

Properties

The following properties are available in the dsc_xclusterproperty type.

dsc_addevictdelay

Data type: Optional[Integer[0, 4294967295]]

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

dsc_blockcachesize

Data type: Optional[Integer[0, 4294967295]]

Controls the size of the Cluster Shared Volume Memory Cache in MB.

dsc_clusterloglevel

Data type: Optional[Integer[0, 4294967295]]

Controls the level of cluster logging.

dsc_clusterlogsize

Data type: Optional[Integer[0, 4294967295]]

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

dsc_crosssitedelay

Data type: Optional[Integer[0, 4294967295]]

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

dsc_crosssitethreshold

Data type: Optional[Integer[0, 4294967295]]

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

dsc_crosssubnetdelay

Data type: Optional[Integer[0, 4294967295]]

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

dsc_crosssubnetthreshold

Data type: Optional[Integer[0, 4294967295]]

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

dsc_databasereadwritemode

Data type: Optional[Integer[0, 4294967295]]

Specifies the read/write mode for the cluster database.

dsc_defaultnetworkrole

Data type: Optional[Integer[0, 4294967295]]

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

dsc_description

Data type: Optional[String]

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

dsc_drainonshutdown

Data type: Optional[Integer[0, 4294967295]]

Specifies whether to enable Node Drain for a cluster.

dsc_dynamicquorum

Data type: Optional[Integer[0, 4294967295]]

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

dsc_netftipsecenabled

Data type: Optional[Integer[0, 4294967295]]

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

dsc_preferredsite

Data type: Optional[String]

Specifies the preferred site for a site-aware cluster.

dsc_quarantineduration

Data type: Optional[Integer[0, 4294967295]]

Specifies the quarantine duration for a node, in seconds.

dsc_quarantinethreshold

Data type: Optional[Integer[0, 4294967295]]

Specifies the quarantine threshold for a node, in minutes.

dsc_samesubnetdelay

Data type: Optional[Integer[0, 4294967295]]

Controls the delay, in milliseconds, between netft heartbeats.

dsc_samesubnetthreshold

Data type: Optional[Integer[0, 4294967295]]

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

dsc_shutdowntimeoutinminutes

Data type: Optional[Integer[0, 4294967295]]

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

Parameters

The following parameters are available in the dsc_xclusterproperty type.

dsc_name

namevar

Data type: String

Name of the cluster.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_xclusterquorum

The DSC xClusterQuorum resource type. Automatically generated from version 1.16.1

Properties

The following properties are available in the dsc_xclusterquorum type.

dsc_resource

Data type: Optional[String]

The name of the disk, file share or Azure storage account resource to use as witness. This parameter is optional if the quorum type is set to NodeMajority.

dsc_storageaccountaccesskey

Data type: Optional[String]

The access key of the Azure storage account to use as witness. This parameter is required if the quorum type is set to NodeAndCloudMajority. The key is currently not updated if the resource is already set.

dsc_type

Data type: Optional[Enum['NodeMajority', 'NodeAndDiskMajority', 'NodeAndFileShareMajority', 'NodeAndCloudMajority', 'DiskOnly']]

Quorum type to use. Can be set to either NodeMajority, NodeAndDiskMajority, NodeAndFileShareMajority, NodeAndCloudMajority or DiskOnly.

Parameters

The following parameters are available in the dsc_xclusterquorum type.

dsc_issingleinstance

namevar

Data type: Enum['Yes']

Specifies the resource is a single instance, the value must be 'Yes'.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property

dsc_xwaitforcluster

The DSC xWaitForCluster resource type. Automatically generated from version 1.16.1

Properties

The following properties are available in the dsc_xwaitforcluster type.

dsc_retrycount

Data type: Optional[Integer[0, 4294967295]]

Maximum number of retries to check for cluster existence. Default value is 50 retries.

dsc_retryintervalsec

Data type: Optional[Integer[0, 18446744073709551615]]

Interval to check for cluster existence. Default values is 10 seconds.

Parameters

The following parameters are available in the dsc_xwaitforcluster type.

dsc_name

namevar

Data type: String

Name of the cluster to wait for.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Default value: property