Skip to content

Commit

Permalink
Changes to xFailOverCluster
Browse files Browse the repository at this point in the history
  - Added the resource xClusterPreferredOwner to README.md (issue dsccommunity#51).
  - Added the resource xClusterNetwork to README.md (issue dsccommunity#56).
  • Loading branch information
johlju committed Jun 14, 2017
1 parent 529939e commit 7b996c1
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 23 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
- Removed 'Unreleased' "tag" from the resources xClusterQuorum and xClusterDisk (issue #36)
- Added new sections to each resource (Requirements, Parameters and Examples) in the README.md. Some does not yet have any examples, so they are set to 'None.'.
- Added GitHub templates PULL\_REQUEST\_TEMPLATE, ISSUE_TEMPLATE and CONTRIBUTING.md (issue #45).
- Split the change log from README.md to a seperate file CHANGELOG.md.
- Split the change log from README.md to a seperate file CHANGELOG.md (issue #48).
- Added the resource xClusterPreferredOwner to README.md (issue #51).
- Added the resource xClusterNetwork to README.md (issue #56).

### 1.6.0.0

Expand Down
85 changes: 63 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ A full list of changes in each version can be found in the [change log](CHANGELO
## Resources

* [**xCluster**](#xcluster) Ensures that a group of machines form a cluster.
* [**xClusterQuorum**](#xclusterquorum) Configures quorum in a cluster.
* [**xClusterDisk**](#xclusterdisk) Configures shared disks in a cluster.
* [**xClusterPreferredOwner**](#xclusterpreferredowner) Configures preferred owner of a cluster group in a cluster.
* [**xClusterQuorum**](#xclusterquorum) Configures quorum in a cluster.
* [**xWaitForCluster**](#xwaitforcluster) Ensures that a node waits for a remote cluster is created.

### xCluster
Expand All @@ -40,49 +41,89 @@ Ensures that a group of machines form a cluster.

#### Requirements

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

#### Parameters

* **Name**: Name of the cluster
* **StaticIPAddress**: Static IP Address of the cluster
* **DomainAdministratorCredential**: Credential used to create the cluster
* **Name**: Name of the cluster.
* **StaticIPAddress**: Static IP Address of the cluster.
* **DomainAdministratorCredential**: Credential used to create the cluster.

#### Examples

[Cluster example](#clusterexample)

### xClusterQuorum
### xClusterDisk

Configures quorum in a cluster.
Configures shared disks in a cluster.

#### Requirements

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

#### Parameters

* **IsSingleInstance** Always set to `Yes` to prevent multiple quorum settings per cluster.
* **Type** Quorum type to use: *NodeMajority*, *NodeAndDiskMajority*, *NodeAndFileShareMajority*, *DiskOnly*
* **Resource** The name of the disk or file share resource to use as witness. Is optional with *NodeMajority* type.
* **Number**: Number of the cluster disk.
* **Ensure**: Define if the cluster disk should be added (Present) or removed (Absent).
* **Label**: The disk label inside the Failover Cluster.

#### Examples

None.

### xClusterDisk
### xClusterNetwork

Configures shared disks in a cluster.
Configures preferred owners of a cluster group in a cluster.

#### Requirements

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

#### Parameters

* **[String] Address** _(Key)_: None.
* **[String] AddressMask** _(Key)_: None.
* **[String] Name** _(Write)_: None.
* **[String] Role** _(Write)_: None. { 0 | 1 | 3 }
* **[String] Metric** _(Write)_: None.

#### Examples

None.

### xClusterPreferredOwner

Configures preferred owners of a cluster group in a cluster.

#### Requirements

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

#### Parameters

* **Number**: Number of the cluster disk
* **Ensure**: Define if the cluster disk should be added (Present) or removed (Absent)
* **Label**: The disk label inside the Failover Cluster
* **[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 owner on.
* **[String] Ensure** _(Write)_: If the preferred owners should be present or absent. { *Present* | Absent }

#### Examples

None.

### xClusterQuorum

Configures quorum in a cluster.

#### Requirements

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

#### Parameters

* **IsSingleInstance** Always set to `Yes` to prevent multiple quorum settings per cluster.
* **Type** Quorum type to use: *NodeMajority*, *NodeAndDiskMajority*, *NodeAndFileShareMajority*, *DiskOnly*.
* **Resource** The name of the disk or file share resource to use as witness. Is optional with *NodeMajority* type.

#### Examples

Expand All @@ -94,14 +135,14 @@ Ensures that a node waits for a remote cluster is created.

#### Requirements

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

#### Parameters

* **Name**: Name of the cluster to wait for
* **RetryIntervalSec**: Interval to check for cluster existence
* **RetryCount**: Maximum number of retries to check for cluster existance
* **Credential**: Credential used to join or leave domain
* **Name**: Name of the cluster to wait for.
* **RetryIntervalSec**: Interval to check for cluster existence.
* **RetryCount**: Maximum number of retries to check for cluster existence.
* **Credential**: Credential used to join or leave domain.

#### Examples

Expand Down

0 comments on commit 7b996c1

Please sign in to comment.