xremotedesktopsessionhost
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-xremotedesktopsessionhost', '2.0.0-0-0'
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 v2.0.0. The PowerShell module describes itself like this:
Module with DSC Resources for Remote Desktop Session Host
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.
[2.0.0] - 2020-09-29
Changed
- Updated filename for CHANGELOG.MD to CHANGELOG.md
2.0.0
Added
- xRemoteDesktopSessionHost
- Added automatic release with a new CI pipeline.
- Added DSC HQRM Tests
- xRDCertificateConfiguration
- New resource to configure the used certificate on a deployment
Changed
- Changes to xRDSessionCollectionConfiguration
- Fixing comparison of some RD Session Collection Configuration properties and
supplied parameters by moving to the DscResource.Common
Test-DscParameterState
cmdlet. (issue #82).
- Fixing comparison of some RD Session Collection Configuration properties and
supplied parameters by moving to the DscResource.Common
- Changes to xRDSessionDeployment
- Fixing Get-TargetResource to target the connection broker, instead of assuming localhost
- Changes to xRDServer
- Changed resouce key from Server alone to Role + Server. This allows the resource to be used multiple times for different roles on the same server. (Issue #62)
- Changes to xRemoteApp
- Fix xRDRemoteApp Test-TargetResource to not test PowerShell common parameters
- Changes to tests
- Pin tests to use Pester v4 instead of latest (v5)
1.9.0.0
- Changes to xRDRemoteApp
- Fixing typo in parameter name when calling the function ValidateCustomModeParameters (issue #50).
- Changes to xRDSessionDeployment
- When RDMS service does not exist the Get-TargetResource will no longer throw an error (issue #47).
- Rename Tests/Unit folder to use upper case on first letter.
- Update appveyor.yml to use the default template.
- Added default template files .codecov.yml, .gitattributes, and .gitignore, and .vscode folder.
- xRDSessionCollectionConfiguration:
- Changed CollectionName variable validation max length to 256
- xRDSessionCollection
- Changed CollectionName variable validation max length to 256
- xRDRemoteApp
- Changed CollectionName variable validation max length to 256
1.8.0.0
- Changes to xRDSessionDeployment
- Fixed issue where an initial deployment failed due to a convert to lowercase (issue #39).
- Added unit tests to test Get, Test and Set results in this resource.
- Change to xRDRemoteApp
- Fixed issue where this resource ignored the CollectionName provided in the parameters (issue #41).
- Changed key values in schema.mof to only Alias and CollectionName, DisplayName and FilePath are not key values.
- Added Ensure property (Absent or Present) to enable removal of RemoteApps.
- Added unit tests to test Get, Test and Set results in this resource.
1.7.0.0
- Added additional resources, copied from the Azure RDS quickstart templates.
- xRDSessionCollection:
- Fixed call to Add-RDSessionHost in Set-TargetResource by properly removing CollectionDescription from PSBoundParameters (issue #28)
- Fixed bug on Get-TargetResource that did return any collection instead of the one collection the user asked for (issue #27)
- Added unit tests to test Get, Test and Set results in this resource
1.6.0.0
- xRDSessionCollectionConfiguration: Add support to configure UserProfileDisks on Windows Server 2016
1.5.0.0
- Fix issue where DSC configuration gets into a reboot loop because sessionhost does not match (casing) and RDMS service is not started in time
1.4.0.0
- Updated CollectionName parameter to validate length between 1 and 15 characters, and added tests to verify.
1.3.0.0
- Converted appveyor.yml to install Pester from PSGallery instead of from Chocolatey.
1.2.0.0
- Fixed an issue with version checks where OS version greater than 9 would fail (Windows 10/Server 2016)
1.1.0.0
- Fixed encoding
1.0.1
1.0.0.0
- Initial release with the following resources
- xRDSessionDeployment
- xRDSessionCollection
- xRDSessionCollectionConfiguration
- xRDRemoteApp
Dependencies
- puppetlabs/pwshlib (>= 0.6.1 < 2.0.0)