UpdateServicesDsc

The UpdateServicesDsc module is a part of the Windows PowerShell Desired State Configuration (DSC) Resource Kit, which is a collection of DSC Resources.

This module contains the UpdateServicesApprovalRule, UpdateServicesCleanup, and UpdateServicesServer resources.

All of the resources in the DSC Resource Kit are provided AS IS, and are not supported through any Microsoft standard support program or service. The "x" in xStorage stands for experimental, which means that these resources will be fix forward and monitored by the module owner(s).

Please leave comments, feature requests, and bug reports in the Q & A tab for this module.

If you would like to modify this module, feel free. When modifying, please update the module name, resource friendly name, and MOF class name (instructions below). As specified in the license, you may copy or modify this resource as long as they are used on the Windows Platform.

For more information about Windows PowerShell Desired State Configuration, check out the blog posts on the PowerShell Blog (this is a good starting point). There are also great community resources, such as PowerShell.org, or PowerShell Magazine. For more information on the DSC Resource Kit, checkout this blog post.

Installation

To install UpdateServicesDsc module, on a machine with Windows Management Framework version 5 or newer from an elevated PowerShell session run:

Install-Module UpdateServicesDsc

To confirm installation

Get-DSCResource UpdateServicesDsc

Requirements

This module requires a minimum version of PowerShell v5.0.

Details

UpdateServicesApprovalRule resource has following properties

Ensure: An enumerated value that describes if the ApprovalRule is available
Name: Name of the approval rule.
Classifications: Classifications in the approval rule.
Products: Products in the approval rule.
ComputerGroups: Computer groups the approval rule applies to.
Enabled: Whether the approval rule is enabled.
Synchronize: Synchronize after creating or updating the approval rule.

UpdateServicesCleanup resource has following properties:

Ensure: An enumerated value that describes if the WSUS cleanup task exists.
DeclineSupersededUpdates: 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.
DeclineExpiredUpdates: Decline updates that aren't approved and have been expired by Microsoft.
CleanupObsoleteUpdates: 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.
CompressUpdates: Compress updates.
CleanupObsoleteComputers: Delete computers that have not contacted the server in 30 days or more.
CleanupUnneededContentFiles: Delete update files that aren't needed by updates or downstream servers.
CleanupLocalPublishedContentFiles: Cleanup local published content files.
TimeOfDay Time of day to start cleanup.

UpdateServicesServer resource has following properties:

Ensure: An enumerated value that describes if WSUS is configured.
SetupCredential: Credential to be used to perform the initial configuration.
SQLServer: SQL Server for the WSUS database, omit for Windows Internal Database.
ContentDir: Folder for WSUS update files.
UpdateImprovementProgram: Join the Microsoft Update Improvement Program.
UpstreamServerName: Upstream WSUS server, omit for Microsoft Update.
UpstreamServerPort: Port of upstream WSUS server.
UpstreamServerSSL: Use SSL with upstream WSUS server.
UpstreamServerReplica: Replica of upstream WSUS server.
ProxyServerName: Proxy server to use when synchronizing, omit for no proxy.
ProxyServerPort: Proxy server port.
ProxyServerCredential: Proxy server credential, omit for anonymous.
ProxyServerCredentialUsername: Proxy server credential username.
ProxyServerBasicAuthentication: Allow proxy server basic authentication.
Languages: Update languages, * for all.
Products: Update products, * for all.
Classifications: Update classifications, * for all.
SynchronizeAutomatically: Synchronize automatically.
SynchronizeAutomaticallyTimeOfDay: First synchronization.
SynchronizationsPerDay: Synchronizations per day.
Synchronize: Begin initial synchronization.
RunRuleNow: Run Approval Rule on existing content.
ClientTargetingMode: An enumerated value that describes if how the Target Groups are populated.

Renaming Requirements

When making changes to these resources, we suggest the following practice

Update the following names by replacing MSFT with your company/community name or another prefix of your choice.

Module name (ex: xModule becomes cModule)
Resource folder (ex: MSFT_xResource becomes Contoso_xResource)
Resource Name (ex: MSFT_xResource becomes Contoso_cResource)
Resource Friendly Name (ex: xResource becomes cResource)
MOF class name (ex: MSFT_xResource becomes Contoso_cResource)
Filename for the <resource>.schema.mof (ex: MSFT_xResource.schema.mof becomes Contoso_cResource.schema.mof)

Update module and metadata information in the module manifest
Update any configuration that use these resources

We reserve resource and module names without prefixes for future use (e.g. "MSFT_Resource").

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Versions

1.0.73.0

Resolve issues
- Get was failing during deployment because ReferenceObject was null

1.0.47.0

High quality DSC module with the following updates:
- Rename to WSUSDsc
- Add Integration tests
- Fix typo in ReadMe
- Add RunRuleNow param to WSUSApprovalRule resource
- Fix error in WSUSServer resource causing Get- to fail

1.0.0.0

Initial release of xWSUS module with coverage for the following areas:
- Managing xWSUS rules for content synchronization.
- Managing xWSUS rules for content cleanup and compression.
- Managing xWSUS service configuration

Contributing

Please check out common DSC Resources contributing guidelines.

rdbartram/UpdateServicesDsc