xfailovercluster
Version information
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
Add this module to your Puppetfile:
mod 'dsc-xfailovercluster', '1.7.0-0-1'
Learn more about managing modules with a PuppetfileDocumentation
Table of Contents
Description
This is an auto-generated module, using the Puppet DSC Builder to vendor and expose the PowerShell module's DSC resources as Puppet resources. The functionality of this module comes entirely from the vendored PowerShell resources, which are pinned at v1.7.0.0. The PowerShell module describes itself like this:
Module containing DSC resources used to configure Failover Clusters.
For information on troubleshooting to determine whether any encountered problems are with the Puppet wrapper or the DSC resource, see the troubleshooting section below.
Requirements
This module, like all auto-generated Puppetized DSC modules, relies on two important technologies in the Puppet stack: the Puppet Resource API and the puppetlabs/pwshlib Puppet module.
The Resource API provides a simplified option for writing types and providers and is responsible for how this module is structured. The Resource API ships inside of Puppet starting with version 6. While it is technically possible to add the Resource API functionality to Puppet 5.5.x, the DSC functionality has not been tested in this setup. For more information on the Resource API, review the documentation.
The module also depends on the pwshlib module. This Puppet module includes two important things: the ruby-pwsh library for running PowerShell code from ruby and the base provider for DSC resources, which this module leverages.
All of the actual work being done to call the DSC resources vendored with this module is in this file from the pwshlib module. This is important for troubleshooting and bug reporting, but doesn't impact your use of the module except that the end result will be that nothing works, as the dependency is not installed alongside this module!
Usage
You can specify any of the DSC resources from this module like a normal Puppet resource in your manifests. The examples below use DSC resources from from the PowerShellGet repository, regardless of what module you're looking at here; the syntax, not the specifics, is what's important.
For reference documentation about the DSC resources exposed in this module, see the Reference Forge tab, or the REFERENCE.md file.
# Include a meaningful title for your resource declaration
dsc_psrepository { 'Add team module repo':
dsc_name => 'foo',
dsc_ensure => present,
# This location is nonsense, can be any valid folder on your
# machine or in a share, any location the SourceLocation param
# for the DSC resource will accept.
dsc_sourcelocation => 'C:\Program Files',
# You must always pass an enum fully lower-cased;
# Puppet is case sensitive even when PowerShell isn't
dsc_installationpolicy => untrusted,
}
dsc_psrepository { 'Trust public gallery':
dsc_name => 'PSGallery',
dsc_ensure => present,
dsc_installationpolicy => trusted,
}
dsc_psmodule { 'Make Ruby manageable via uru':
dsc_name => 'RubyInstaller',
dsc_ensure => present,
}
For more information about using a built module, check out our narrative documentation.
Properties
Note that the only properties specified in a resource declaration which are passed to Invoke-Dsc are all prepended with dsc.
If a property does _not start with dsc_ it is used to control how Puppet interacts with DSC/other Puppet resources - for example,
specifying a unique name for the resource for Puppet to distinguish between declarations or Puppet metaparameters (notifies,
before, etc).
Troubleshooting
In general, there are three broad categories of problems:
- Problems with the way the underlying DSC resource works.
- Problems with the type definition, where you can't specify a valid set of properties for the DSC resource
- Problems with calling the underlying DSC resource - the parameters aren't being passed correctly or the resource can't be found
Unfortunately, problems with the way the underlying DSC resource works are something we can't help directly with. You'll need to file an issue with the upstream maintainers for the PowerShell module.
Problems with the type definition are when a value that should be valid according to the DSC resource's documentation and code is not accepted by the Puppet wrapper. If and when you run across one of these, please file an issue with the Puppet DSC Builder; this is where the conversion happens and once we know of a problem we can fix it and regenerate the Puppet modules. To help us identify the issue, please specify the DSC module, version, resource, property and values that are giving you issues. Once a fix is available we will regenerate and release updated versions of this Puppet wrapper.
Problems with calling the underlying DSC resource become apparent by comparing <value passed in in puppet>
with <value received by DSC>
.
In this case, please file an issue with the puppetlabs/pwshlib module, which is where the DSC base provider actually lives.
We'll investigate and prioritize a fix and update the puppetlabs/pwshlib module.
Updating to the pwshlib version with the fix will immediately take advantage of the improved functionality without waiting for this module to be reconverted and published.
For specific information on troubleshooting a generated module, check the troubleshooting guide for the puppet.dsc module.
Known Limitations
Currently, because of the way Puppet caches files on agents, use of the legacy puppetlabs-dsc
module is not compatible with this or any auto-generated DSC module.
Inclusion of both will lead to pluginsync conflicts.
Reference
Table of Contents
Resource types
dsc_xcluster
: The DSC xCluster resource type. Automatically generated from version 1.7.0.0dsc_xclusterdisk
: The DSC xClusterDisk resource type. Automatically generated from version 1.7.0.0dsc_xclusternetwork
: The DSC xClusterNetwork resource type. Automatically generated from version 1.7.0.0dsc_xclusterpreferredowner
: The DSC xClusterPreferredOwner resource type. Automatically generated from version 1.7.0.0dsc_xclusterquorum
: The DSC xClusterQuorum resource type. Automatically generated from version 1.7.0.0dsc_xwaitforcluster
: The DSC xWaitForCluster resource type. Automatically generated from version 1.7.0.0
Resource types
dsc_xcluster
The DSC xCluster resource type. Automatically generated from version 1.7.0.0
Properties
The following properties are available in the dsc_xcluster
type.
dsc_staticipaddress
Data type: 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.
dsc_xclusterdisk
The DSC xClusterDisk resource type. Automatically generated from version 1.7.0.0
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.
dsc_xclusternetwork
The DSC xClusterNetwork resource type. Automatically generated from version 1.7.0.0
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 adress for the cluster network in the format '10.0.0.0'.
dsc_addressmask
namevar
Data type: String
The adress 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.
dsc_xclusterpreferredowner
The DSC xClusterPreferredOwner resource type. Automatically generated from version 1.7.0.0
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.
dsc_xclusterquorum
The DSC xClusterQuorum resource type. Automatically generated from version 1.7.0.0
Properties
The following properties are available in the dsc_xclusterquorum
type.
dsc_resource
Data type: Optional[String]
dsc_type
Data type: Optional[Enum['NodeMajority', 'NodeAndDiskMajority', 'NodeAndFileShareMajority', 'DiskOnly']]
Parameters
The following parameters are available in the dsc_xclusterquorum
type.
dsc_issingleinstance
namevar
Data type: Enum['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.
dsc_xwaitforcluster
The DSC xWaitForCluster resource type. Automatically generated from version 1.7.0.0
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 cluster existency
dsc_retryintervalsec
Data type: Optional[Integer[0, 18446744073709551615]]
Interval to check the cluster existency
Parameters
The following parameters are available in the dsc_xwaitforcluster
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.
Change log for xFailOverCluster
Unreleased
1.7.0.0
- Changes to xClusterPreferredOwner
- Script Analyzer warnings have been fixed (issue #50). This also failed the tests for the resource.
- Changes to xClusterDisk
- Fixed test that was failing in AppVeyor (issue #55).
- Changes to xFailOverCluster
- Added 'Code of Conduct' text to the README.md (issue #44).
- Added TOC for all resources in the README.md (issue #43).
- Fixed typos and lint errors in README.md.
- Fixed style issue in example in README.md.
- 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 separate file CHANGELOG.md (issue #48).
- Added the resource xClusterPreferredOwner to README.md (issue #51).
- Added the resource xClusterNetwork to README.md (issue #56).
- Removed Credential parameter from parameter list for xWaitForCluster. Parameter Credential does not exist in the schema.mof of the resource (issue #62).
- Now all parameters in the README.md list their data type and type qualifier (issue #58.)
- Added Import-DscResource to example in README.md.
- Added CodeCov and opt-in for all common tests (issue #41).
- Added CodeCov badge to README.md
- Fixed CodeCov badge links so they now can be clicked on.
- Fixed lint rule MD013 in CHANGELOG.md.
- Fixed lint rule MD013 in README.md.
- Fixed lint rule MD024 in README.md.
- Fixed lint rule MD032 in README.md.
- Removed example from README.md (issue #42).
- Fixed typo in filename for ISSUE_TEMPLATE. Was 'ISSUE_TEMPLATE', now it is correctly 'ISSUE_TEMPLATE.md'.
- Changed appveyor.yml to use the new default test framework in the AppVeyor module in DscResource.Tests (AppVeyor.psm1).
- Added VS Code workspace settings file with formatting settings matching the Style Guideline (issue #67). That will make it possible inside VS Code to press SHIFT+ALT+F, or press F1 and choose 'Format document' in the list. The PowerShell code will then be formatted according to the Style Guideline (although maybe not complete, but would help a long way).
- Added new stubs for FailoverClusters module (Tests\Unit\Stubs\FailoverClusters.stubs.psm1) to be able to run unit tests on a computer that does not have or can install Failover Clustering PowerShell module.
- Added a script file (Tests\Unit\Stubs\Write-ModuleStubFile.ps1) to be able to rebuild the stub file (FailoverClusters.stubs.psm1) whenever needed.
- Added code block around types in README.md.
- Changes to xCluster
- Added examples
- 1-CreateFirstNodeOfAFailoverCluster.ps1
- 2-JoinAdditionalNodeToFailoverCluster.ps1
- 3-CreateFailoverClusterWithTwoNodes.ps1 (this is the example from README.md)
- Fixed typo in xCluster parameter description.
- Added links to examples from README.md
- Refactored the unit test for this resource to use stubs and increase coverage
(issue #73).
- Removed the password file (MSFT_xCluster.password.txt) which seemed unnecessary.
- Test-TargetResource now throws and error if domain name cannot be evaluated (issue #72).
- Set-TargetResource now correctly throws and error if domain name cannot be evaluated (issue #71).
- Added examples
- Changes to xWaitForCluster
- Added example
- 1-WaitForFailoverClusterToBePresent.ps1
- Added link to example from README.md
- Added example
- Changes to xClusterDisk
- Refactored the unit test for this resource to use stubs and increase coverage (issue #74).
- Removed an evaluation that called Test-TargetResource in Set-TargetResource method and instead added logic so that Set-TargetResource evaluates if it should remove a disk (issue #90).
- Changed the code to be more aligned with the style guideline.
- Added examples (issue #46)
- 1-AddClusterDisk.ps1
- 2-RemoveClusterDisk.ps1
- Added links to examples from README.md.
- Changes to xClusterPreferredOwner
- Refactored the unit test for this resource to use stubs and increase coverage (issue #76).
- Changed the code to be more aligned with the style guideline.
- Added examples (issue #52)
- 1-AddPreferredOwner.ps1
- 2-RemovePreferredOwner.ps1
- Added links to examples from README.md.
- Changes to xClusterNetwork
- Refactored the unit test for this resource to use stubs and increase coverage (issue #75).
- Changed the code to be more aligned with the style guideline.
- Updated resource and parameter description in README.md and schema.mof.
- Added example (issue #57)
- 1-ChangeClusterNetwork.ps1
- Added links to examples from README.md.
1.6.0.0
- xCluster: Fixed bug in which failure to create a new cluster would hang
1.5.0.0
- Added xClusterQuorum resource with options NodeMajority, NodeAndDiskMajority, NodeAndFileShareMajority, DiskOnly
- Currently does not implement cloud witness for Windows 2016.
- Added xClusterDisk resource
1.2.0.0
- xCluster: Added -NoStorage switch to Add-ClusterNode. This prevents disks from being automatically added when joining a node to a cluster
1.1.0.0
- Removed requirement for CredSSP
1.0.0.0
- Initial release with the following resources:
- xCluster and xWaitForCluster
Dependencies
- puppetlabs/pwshlib (>= 0.7.0 < 2.0.0)