updateservicesdsc
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-updateservicesdsc', '1.0.72-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.0.72.0. The PowerShell module describes itself like this:
Module with DSC Resources for deployment and configuration of Windows Server Update Services.
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_updateservicesapprovalrule
: The DSC UpdateServicesApprovalRule resource type. Automatically generated from version 1.0.72.0dsc_updateservicescleanup
: The DSC UpdateServicesCleanup resource type. Automatically generated from version 1.0.72.0dsc_updateservicesserver
: The DSC UpdateServicesServer resource type. Automatically generated from version 1.0.72.0
Resource types
dsc_updateservicesapprovalrule
The DSC UpdateServicesApprovalRule resource type. Automatically generated from version 1.0.72.0
Properties
The following properties are available in the dsc_updateservicesapprovalrule
type.
dsc_classifications
Data type: Optional[Array[String]]
Classifications in the approval rule.
dsc_computergroups
Data type: Optional[Array[String]]
Computer groups the approval rule applies to.
dsc_enabled
Data type: Optional[Boolean]
Whether the approval rule is enabled.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
An enumerated value that describes if WSUS is configured. Present {default} Absent
dsc_products
Data type: Optional[Array[String]]
Products in the approval rule.
dsc_runrulenow
Data type: Optional[Boolean]
Run the approval rule after it has been created.
dsc_synchronize
Data type: Optional[Boolean]
Synchronize after creating or updating the approval rule.
Parameters
The following parameters are available in the dsc_updateservicesapprovalrule
type.
dsc_name
namevar
Data type: String
Name of the approval rule.
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_updateservicescleanup
The DSC UpdateServicesCleanup resource type. Automatically generated from version 1.0.72.0
Properties
The following properties are available in the dsc_updateservicescleanup
type.
dsc_cleanuplocalpublishedcontentfiles
Data type: Optional[Boolean]
Cleanup local published content files.
dsc_cleanupobsoletecomputers
Data type: Optional[Boolean]
Delete computers that have not contacted the server in 30 days or more.
dsc_cleanupobsoleteupdates
Data type: Optional[Boolean]
Delete updates that are expired and have not been approved for 30 days or more, and delete older update revisions that have not been approved for 30 days or more.
dsc_cleanupunneededcontentfiles
Data type: Optional[Boolean]
Delete update files that aren't needed by updates or downstream servers.
dsc_compressupdates
Data type: Optional[Boolean]
Compress updates.
dsc_declineexpiredupdates
Data type: Optional[Boolean]
Decline updates that aren't approved and have been expired by Microsoft.
dsc_declinesupersededupdates
Data type: Optional[Boolean]
Decline updates that have not been approved fo 30 days or more, are not currently needed by any clients, and are superseded by an approved update.
dsc_timeofday
Data type: Optional[String]
Time of day to start cleanup.
Parameters
The following parameters are available in the dsc_updateservicescleanup
type.
dsc_ensure
namevar
Data type: Enum['Present', 'Absent']
An enumerated value that describes if the WSUS cleanup task exists. Present {default} Absent
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_updateservicesserver
The DSC UpdateServicesServer resource type. Automatically generated from version 1.0.72.0
Properties
The following properties are available in the dsc_updateservicesserver
type.
dsc_classifications
Data type: Optional[Array[String]]
Update classifications, * for all.
dsc_contentdir
Data type: Optional[String]
Folder for WSUS update files.
dsc_languages
Data type: Optional[Array[String]]
Update languages, * for all.
dsc_products
Data type: Optional[Array[String]]
Update products, * for all.
dsc_proxyserverbasicauthentication
Data type: Optional[Boolean]
Allow proxy server basic authentication.
dsc_proxyservercredentialusername
Data type: Optional[String]
Proxy server credential username.
dsc_proxyservername
Data type: Optional[String]
Proxy server to use when synchronizing, omit for no proxy.
dsc_proxyserverport
Data type: Optional[Integer[0, 65535]]
Proxy server port.
dsc_sqlserver
Data type: Optional[String]
SQL Server for the WSUS database, omit for Windows Internal Database.
dsc_synchronizationsperday
Data type: Optional[Integer[0, 65535]]
Synchronizations per day.
dsc_synchronize
Data type: Optional[Boolean]
Begin initial synchronization.
dsc_synchronizeautomatically
Data type: Optional[Boolean]
Synchronize automatically.
dsc_synchronizeautomaticallytimeofday
Data type: Optional[String]
First synchronization.
dsc_updateimprovementprogram
Data type: Optional[Boolean]
Join the Microsoft Update Improvement Program.
dsc_upstreamservername
Data type: Optional[String]
Upstream WSUS server, omit for Microsoft Update.
dsc_upstreamserverport
Data type: Optional[Integer[0, 65535]]
Port of upstream WSUS server.
dsc_upstreamserverreplica
Data type: Optional[Boolean]
Replica of upstream WSUS server.
dsc_upstreamserverssl
Data type: Optional[Boolean]
Use SSL with upstream WSUS server.
Parameters
The following parameters are available in the dsc_updateservicesserver
type.
dsc_ensure
namevar
Data type: Enum['Present', 'Absent']
An enumerated value that describes if WSUS is configured. Present {default} Absent
dsc_proxyservercredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Proxy server credential, omit for anonymous.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_setupcredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Credential to be used to perform the initial configuration.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
Dependencies
- puppetlabs/pwshlib (>= 0.7.0 < 2.0.0)