This cmdlet is part of the Vexasoft Cmdlet Library. You can download it now or click here to find out more.

Get-WindowsUpdateAgent

Synopsis

Gets the Windows Update Agent settings on a local or remote computer.

Syntax

  • Get-WindowsUpdateAgent [-ComputerName] [-Credential]

Description

The Get-WindowsUpdateAgent cmdlet is used to retrieve the settings associated with Windows Update and the Windows Update Agent, such as install time, polling frequency, recommended update settings and WSUS configuration, on the local or a remote computer.

Parameters

  • ComputerName The computer against which to run the cmdlet. By default this parameter will be populated with the name of the local computer.
  • Credential The credentials under which to run the cmdlet. By default this cmdlet will run as the current user. Using this parameter and the Get-PSCredential cmdlet you can specify an alternate set of credentials under which to execute this command.

Inputs

Get-WindowsUpdateAgent accepts pipeline input only for the ComputerName parameter and requires that the input object contain a property named either Computer, CN or ComputerName.

Outputs

Get-WindowsUpdateAgent outputs a Vexasoft.WindowsUpdateAgent object detailing the Windows Update Agent settings on the target computer.

Notes

The Get-WindowsUpdateAgent cmdlet requires that the RPC service is started on the computer it is trying to access and that DNS services are available to resolve target host names.

Example 1

This command will retrieve the Windows Update configuration for the local computer:

C:\PS>Get-WindowsUpdateAgent

Example 2

This command will retrieve the Windows Update configuration for the computer PC01

C:\PS>Get-WindowsUpdateAgent -computer PC01