The xFailOverCluster module contains DSC resources for deployment and configuration of Failover Clustering.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
This is the branch containing the latest release - no contributions should be made directly to this branch.
This is the development branch to which contributions should be proposed by contributors as pull requests. This development branch will periodically be merged to the master branch, and be released to PowerShell Gallery.
Please check out common DSC Resources contributing guidelines.
A full list of changes in each version can be found in the change log.
- xCluster Ensures that a group of machines form a cluster.
- xClusterDisk Configures shared disks in a cluster.
- xClusterNetwork Configures as cluster network in a failover cluster.
- xClusterPreferredOwner Configures preferred owner of a cluster group in a cluster.
- xClusterQuorum Configures quorum in a cluster.
- xWaitForCluster Ensures that a node waits for a remote cluster is created.
Used to configure a failover cluster. If the cluster does not exist, it will be created in the domain and the static IP address will be assigned to the cluster. When the cluster exist (either it was created or already existed), it will add the target node ($env:COMPUTERNAME) to the cluster.
- Target machine must be running Windows Server 2008 R2 or later.
[String]Name (Key): Name of the failover cluster.[String]StaticIPAddress (Required): Static IP Address of the failover cluster.[String]DomainAdministratorCredential (Required): Credential used to create the failover cluster in Active Directory.
- Create first node of a failover cluster
- Join additional node to a failover cluster
- Create failover cluster with two nodes
Configures shared disks in a cluster.
- Target machine must be running Windows Server 2008 R2 or later.
[String]Number (Key): The disk number of the cluster disk.[String]Ensure (Write): Define if the cluster disk should be added (Present) or removed (Absent). Default value is 'Present'. { Present | Absent }[String]Label (Write): The disk label that should be assigned to the disk on the Failover Cluster disk resource.
Configures a cluster network in a failover cluster.
This resource is only able to change properties on cluster networks. To add or remove networks from the cluster, add or remove them from the cluster members. By adding a new subnet on one of the cluster nodes, the network will be added to the cluster, and metadata can be set using the xClusterNetwork module.
- Target machine must be running Windows Server 2008 R2 or later.
[String]Address (Key): The address for the cluster network in the format '10.0.0.0'.[String]AddressMask (Key): The address mask for the cluster network in the format '255.255.255.0'.[String]Name (Write): The name of the cluster network. If the cluster network name is not in desired state it will be renamed to match this name.[String]Role (Write): The role of the cluster network. If the cluster network role is not in desired state it will changed to match this role. { 0 | 1 | 3 }.[String]Metric (Write): 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.
This parameter sets the role of the cluster network. If the cluster network role is not in desired state it will change to match this role.
The cluster network role can be set to either the value 0, 1 or 3.
0 = Do not allow cluster network communication 1 = Allow cluster network communication only 3 = Allow cluster network communication and client connectivity
See this article for more information about cluster network role values; Configuring Windows Failover Cluster Networks
Configures preferred owners of a cluster group and cluster resources in a failover cluster.
- Target machine must be running Windows Server 2008 R2 or later.
[String]ClusterGroup (Key): Name of the cluster group.[String]ClusterName (Key): Name of the cluster.[String[]]Nodes (Required): The nodes to set as owners.[String[]]ClusterResources (Write): The resources to set preferred owners on.[String]Ensure (Write): If the preferred owners should be present or absent. Default value is 'Present'. { Present | Absent }
- Add preferred owners to a cluster group and cluster resources
- Remove preferred owners from a cluster group and cluster resources
Configures quorum in a cluster.
- Target machine must be running Windows Server 2008 R2 or later.
[String]IsSingleInstance (Key): Specifies the resource is a single instance, the value must be 'Yes'.[String]Type (Write): Quorum type to use. { NodeMajority | NodeAndDiskMajority | NodeAndFileShareMajority, DiskOnly }.[String]Resource (Write): The name of the disk or file share resource to use as witness. This parameter is optional if the quorum type is set to NodeMajority.
- Set quorum to node majority
- Set quorum to node and disk majority
- Set quorum to node and file share majority
- Set quorum to disk only
Ensures that a node waits for a remote cluster is created.
- Target machine must be running Windows Server 2008 R2 or later.
[String]Name (Key): Name of the cluster to wait for.[UInt64]RetryIntervalSec (Write): Interval to check for cluster existence. Default values is 10 seconds.[UInt32]RetryCount (Write): Maximum number of retries to check for cluster existence. Default value is 50 retries.