Cluster Aware Updating Cmdlets in Windows PowerShell

Updated: September 27, 2016

Applies To: Windows 10, Windows PowerShell 5.0, Windows Server Technical Preview

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

Cluster-Aware Updating

This reference provides cmdlet descriptions and syntax for all Cluster-Aware Updating-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.


cmdlet Description


Adds the CAU clustered role that provides the self-updating functionality to the specified cluster.


Suspends the self-updating functionality on the specified cluster.


Re-enables the self-updating functionality on the specified cluster.


Exports one or more Updating Run reports into an HTML or CSV-formatted document.


Gets configuration properties of the CAU clustered role on the specified cluster.


Gets information about one or more software updating plug-ins that are registered on the local computer.


Gets the Updating Run reports for all known Updating Runs, or all Updating Runs that match the specified dates or other specified parameters.


Gets status information about an Updating Run currently in progress.


Performs a scan of cluster nodes for applicable updates and installs those updates via an Updating Run on the specified cluster.


Performs a scan of cluster nodes for applicable updates and returns a list of the initial set of updates that would be applied to each node in the specified cluster.


Registers a CAU software updating plug-in on the local computer.


Removes the CAU clustered role from the specified cluster.


Saves CAU debug tracing information to a local zip file.


Sets configuration properties for the CAU clustered role on the specified cluster.


Stops an Updating Run that is in progress on a cluster.


Tests whether a cluster is properly set up to apply software updates using CAU.


Removes a software updating plug-in from the list of plug-ins that are used by CAU.

To list all the cmdlets that are available, use the Get-Command –Module ClusterAwareUpdating cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

Get-Help <cmdlet name> -Detailed
Get-Help <cmdlet name> -Examples
Get-Help <cmdlet name> -Full

Community Additions