This is the built-in help made by Microsoft for the command 'Invoke-CauScan', in PowerShell version 5 - as retrieved from
Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
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 a specified cluster.
Invoke-CauScan [[-ClusterName] <String>] [[-CauPluginName] <String[]>] [[-Credential] <PSCredential>] [-CauPluginArguments <Hashtable[]>] [-RunPluginsSerially]
[-StopOnPluginFailure] [<CommonParameters>]
The Invoke-CauScan cmdlet 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 a
specified cluster. Generating the list might take a few minutes.
Note: The preview list includes only an initial set of updates. The list does not include updates that might become applicable only after the initial updates are installed.
Note: If the Microsoft.HotfixPlugin plug-in is specified, the scan returns only the list of hotfix files that are discovered on the hotfix file share.
<
Online Version: http://go.microsoft.com/fwlink/p/?linkid=287669
Invoke-CauRun
<
EXAMPLE 1
PS C:\> Invoke-CauScan -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin -Verbose
This example provides a detailed list of the initial set of updates that would currently be applied to each node in the cluster named CONTOSO-FC1. The list is based on the
updates that would be applied by the Microsoft.WindowsUpdatePlugin plug-in, which is the default plug-in. Note that the preview list includes only an initial set of updates,
and does not include updates that might become applicable only after the initial updates are installed.
EXAMPLE 2
PS C:\>$secpasswd = ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force
PS C:\>$cred = New-Object System.Management.Automation.PSCredential ("username", $secpasswd)
PS C:\>Invoke-CauScan -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{'QueryString'="IsInstalled=0 and
Type='Software' and IsHidden=0"},@{'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName’} -Credential $cred
This example provides a detailed list of the initial set of updates that would currently be applied to each node in the cluster named CONTOSO-FC1. The list is based on the
updates that would be applied by the Microsoft.WindowsUpdatePlugin plug-in, using a specified query string, and the Microsoft.HotfixPlugin, after the necessary hotfixes and
the hotfix configuration file have been downloaded to \\CauHotfixSrv\shareName. This example also shows how to pass the administrative credentials for cluster CONTOSO-FC1 to
the cmdlet.