This page looks best with JavaScript enabled

WSUS Maintenance Utility

Clean up your WSUS

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
o       o  o-o  o   o  o-o      o   o             o
|       | |     |   | |         |\ /|     o       |
o   o   o  o-o  |   |  o-o      | O |  oo   o-o  -o- o-o o-o   oo o-o   o-o o-o
 \ / \ /      | |   |     |     |   | | | | |  |  |  |-' |  | | | |  | |    |-'
  o   o   o--o   o-o  o--o      o   o o-o-| o  o  o  o-o o  o o-o-o  o  o-o o-o

o   o  o    o    o
|   |  |  o | o  |
|   | -o-   |   -o- o  o
|   |  |  | | |  |  |  |                 Version 20.03.20
 o-o   o  | o |  o  o--O
                       |            Mike Galvin   https://gal.vin
                    o--o              & ideas@habs.homelinux.net

This version includes code contribution from ideas@habs.homelinux.net.
For full instructions and documentation, visit my site.

Please consider supporting my work:

WSUS Maintenance Utility can also be downloaded from:

Tweet me if you have questions: @mikegalvin_

-Mike

Features and Requirements

  • It’s designed to run either on a WSUS server itself or can be run from a remote machine.
  • The computer that is running the utility must have the WSUS management PowerShell modules installed.
  • The utility requires at least PowerShell 5.0

This utility has been tested on Windows 10, Windows Server 2019 and Windows Server 2016.

Generating A Password File

The password used for SMTP server authentication must be in an encrypted text file. To generate the password file, run the following command in PowerShell on the computer and logged in with the user that will be running the utility. When you run the command, you will be prompted for a username and password. Enter the username and password you want to use to authenticate to your SMTP server.

Please note: This is only required if you need to authenticate to the SMTP server when send the log via e-mail.

1
2
$creds = Get-Credential
$creds.Password | ConvertFrom-SecureString | Set-Content c:\scripts\ps-script-pwd.txt

After running the commands, you will have a text file containing the encrypted password. When configuring the -Pwd switch enter the path and file name of this file.

Configuration

Here’s a list of all the command line switches and example configurations.

Command Line Switch Description Example
-Server The WSUS server to run the maintenance routine on. wsus01
-Port The port WSUS is running on the server. If you do not configure this, the default port of 8530 will be used. If the WsusSSL switch is used the default port will be 8531. 6969
-WsusSsl Use this option if your WSUS server uses SSL. N/A
-NoBanner Use this option to hide the ASCII art title in the console. N/A
-L The path to output the log file to. The file name will be WSUS-Maint_YYYY-MM-dd_HH-mm-ss.log. Do not add a trailing \ backslash. C:\scripts\logs
-Subject The subject line for the e-mail log. Encapsulate with single or double quotes. If no subject is specified, the default of “WSUS Maintenance Utility Log” will be used. ‘Server: Notification’
-SendTo The e-mail address the log should be sent to. me@contoso.com
-From The e-mail address the log should be sent from. WsusMaint@contoso.com
-Smtp The DNS name or IP address of the SMTP server. smtp.live.com OR smtp.office365.com
-User The user account to authenticate to the SMTP server. example@contoso.com
-Pwd The txt file containing the encrypted password for SMTP authentication. C:\scripts\ps-script-pwd.txt
-UseSsl Configures the utility to connect to the SMTP server using SSL. N/A

Example

1
WSUS-Maintenance.ps1 -Server wsus01 -L C:\scripts\logs -Subject 'Server: WSUS Maintenance' -SendTo me@contoso.com -From WSUS-Maint@contoso.com -Smtp smtp.outlook.com -User me@contoso.com -Pwd C:\foo\pwd.txt -UseSsl

The above command will run the maintenance on the server wsus01 using the default port. The log file will be output to C:\scripts\logs and sent via e-mail with a custom subject line.

Change Log

2020-03-20: Version 20.03.20

  • Added code contribution from ideas@habs.homelinux.net.
  • Individual cleanup jobs now run separately.
  • Improved reporting.
  • Made slight improvements to documentation.

2020-03-05: Version 20.03.03 ‘Burger’

  • Added SSL option for connecting to the WSUS server.
  • Made the -Port switch optional. If it is not specified, the default port is used. If -WsusSsl is specified, the default port for SSL is used.
  • Added config report.
  • Added ASCII banner art when run in the console.
  • Added option to disable the ASCII banner art.
  • Refactored code.
  • Fully backwards compatible.

2019-09-04 v1.8

  • Added custom subject line for e-mail.

2019-04-23 v1.7

  • The script will now not run the clean up process twice.
  • The script will now report if the service isn’t running before starting.

2017-10-16 v1.6

  • Changed SMTP authentication to require an encrypted password file.
  • Added instructions on how to generate an encrypted password file.

2017-10-07 v1.5

  • Added necessary information to add the script to the PowerShell Gallery.

2017-09-25 v1.4

  • Cleaned up formatting, minor changes to code for efficiency.

2017-08-11 v1.3

  • Improved, cleaner logging. The log file is no longer produced from PowerShell’s Transcript function.

2017-07-22 v1.2

  • Improved commenting on the code for documentation purposes.
  • Added authentication and SSL options for e-mail notification.

2017-05-22 v1.1

  • Added configuration via command line switches.
Share on
Support the author with