schanneldsc
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-schanneldsc', '1.1.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.1.0.0. The PowerShell module describes itself like this:
This DSC module is used to manage Secure Channel (SChannel) configurations.
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_cipher
: The DSC Cipher resource type. Automatically generated from version 1.1.0.0dsc_ciphersuites
: The DSC CipherSuites resource type. Automatically generated from version 1.1.0.0dsc_hash
: The DSC Hash resource type. Automatically generated from version 1.1.0.0dsc_keyexchangealgorithm
: The DSC KeyExchangeAlgorithm resource type. Automatically generated from version 1.1.0.0dsc_protocol
: The DSC Protocol resource type. Automatically generated from version 1.1.0.0dsc_schannelsettings
: The DSC SChannelSettings resource type. Automatically generated from version 1.1.0.0
Resource types
dsc_cipher
The DSC Cipher resource type. Automatically generated from version 1.1.0.0
Properties
The following properties are available in the dsc_cipher
type.
dsc_state
Data type: Optional[Enum['Enabled', 'Disabled', 'Default']]
Parameters
The following parameters are available in the dsc_cipher
type.
dsc_cipher
namevar
Data type: Enum['AES 128/128', 'AES 256/256', 'DES 56/56', 'NULL', 'RC2 128/128', 'RC2 40/128', 'RC2 56/128', 'RC4 128/128', 'RC4 40/128', 'RC4 56/128', 'RC4 64/128', 'Triple DES 168']
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_ciphersuites
The DSC CipherSuites resource type. Automatically generated from version 1.1.0.0
Properties
The following properties are available in the dsc_ciphersuites
type.
dsc_ciphersuitesorder
Data type: Optional[Array[String]]
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Parameters
The following parameters are available in the dsc_ciphersuites
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_hash
The DSC Hash resource type. Automatically generated from version 1.1.0.0
Properties
The following properties are available in the dsc_hash
type.
dsc_state
Data type: Optional[Enum['Enabled', 'Disabled', 'Default']]
Parameters
The following parameters are available in the dsc_hash
type.
dsc_hash
namevar
Data type: Enum['MD5', 'SHA', 'SHA256', 'SHA384', 'SHA512']
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_keyexchangealgorithm
The DSC KeyExchangeAlgorithm resource type. Automatically generated from version 1.1.0.0
Properties
The following properties are available in the dsc_keyexchangealgorithm
type.
dsc_state
Data type: Optional[Enum['Enabled', 'Disabled', 'Default']]
Parameters
The following parameters are available in the dsc_keyexchangealgorithm
type.
dsc_keyexchangealgorithm
namevar
Data type: Enum['Diffie-Hellman', 'ECDH', 'PKCS']
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_protocol
The DSC Protocol resource type. Automatically generated from version 1.1.0.0
Properties
The following properties are available in the dsc_protocol
type.
dsc_includeclientside
Data type: Optional[Boolean]
dsc_state
Data type: Optional[Enum['Enabled', 'Disabled', 'Default']]
Parameters
The following parameters are available in the dsc_protocol
type.
dsc_protocol
namevar
Data type: Enum['Multi-Protocol Unified Hello', 'PCT 1.0', 'SSL 2.0', 'SSL 3.0', 'TLS 1.0', 'TLS 1.1', 'TLS 1.2']
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_schannelsettings
The DSC SChannelSettings resource type. Automatically generated from version 1.1.0.0
Properties
The following properties are available in the dsc_schannelsettings
type.
dsc_diffiehellmanminclientkeysize
Data type: Optional[Enum['1024', '2048', '3072', '4096']]
Minimum client key size for the Diffie-Hellman key exchange algorithm
dsc_diffiehellmanminserverkeysize
Data type: Optional[Enum['1024', '2048', '3072', '4096']]
Minimum server key size for the Diffie-Hellman key exchange algorithm
dsc_enablefipsalgorithmpolicy
Data type: Optional[Boolean]
Specifies if the FIPS Algorithm Policy is enabled
dsc_tls12state
Data type: Optional[Enum['Enabled', 'Disabled', 'Default']]
Specifies the state of TLS 1.2 for the .Net Framework 3.5 and 4.0 (not required for v4.6 and above)
Parameters
The following parameters are available in the dsc_schannelsettings
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.
* SChannelDsc
* Updated Readme to correct faulty module name
* Protocol
* Corrected incorrect detection if DisabledByDefault was configured
Dependencies
- puppetlabs/pwshlib (>= 0.7.0 < 2.0.0)