How to use the command 'Get-WUApiVersion' (with examples)

The Get-WUApiVersion command is utilized primarily within the PowerShell environment to retrieve the version of the Windows Update Agent (WUA) installed on a system. This utility is a component of the external PSWindowsUpdate module, providing system administrators and users with essential information about the Windows Update infrastructure. Understanding the Windows Update Agent version can help in diagnosing update issues and ensuring that the system is using the most appropriate updates and features.

Use case 1: Retrieve the currently-installed Windows Update Agent version

Code:

Get-WUApiVersion

Motivation:

The primary motivation for using the Get-WUApiVersion command without any additional arguments is straightforward: quickly finding out which version of the Windows Update Agent is installed on your system. This information is crucial for IT professionals and system administrators who need to ensure that the update infrastructure on their computers or servers is up to date. Knowing the exact version can be helpful when troubleshooting update issues or verifying compatibility with specific Windows updates or features.

Explanation:

The command Get-WUApiVersion by itself is simple yet powerful. It calls upon the PSWindowsUpdate module to ask for the current version number of the Windows Update Agent installed on your machine. There are no additional arguments or parameters needed for this basic query.

Example Output:

Windows Update Agent Version: 10.0.19041.1

This output shows the version number of the Windows Update Agent, indicating the specific build and release information pertinent to the installed agent.

Use case 2: Send the current configuration data via email (SMTP)

Code:

Get-WUApiVersion -SendReport -PSWUSettings @{SmtpServer="smtp_server"; Port=smtp_port; From="sender_email"; To="receiver_email"}

Motivation:

The second use case for Get-WUApiVersion involves not only retrieving the version of the Windows Update Agent but also sending this information directly through email. This is particularly useful for system administrators managing multiple machines remotely, or for setting up automated report dispatches without the need for manual checks. By sending the configuration data via email, one can maintain comprehensive logs of system update statuses for audit and compliance purposes, or simply keep oversight over several systems efficiently.

Explanation:

• -SendReport: This flag is used to instruct the command to compile the data and send it via email. It is not just a retrieval task anymore, but an actionable report generation process.

• -PSWUSettings: This key-value argument is critical as it configures the SMTP settings used to send the email. It includes:

  • SmtpServer="smtp_server": Specifies the address of the SMTP server used to send the email.
  • Port=smtp_port: Indicates the port number used to connect to the SMTP server.
  • From="sender_email": The email address from which the report will be sent.
  • To="receiver_email": The recipient email address where the report will be delivered.

Example Output:

Sending email…

Message successfully sent to receiver_email

This output indicates that the command not only retrieved the Windows Update Agent version but also successfully sent this data via email, confirming the reporting was executed as expected.

Conclusion:

The Get-WUApiVersion command in PowerShell offers a straightforward yet potent tool for administrators and users interested in keeping track of their Windows Update Agent version. By utilizing the simple command or enhancing it with SMTP configuration, users can efficiently manage system update compliance and streamline the reporting process, regardless of their location or the number of machines under their purview.