PowerShell Logo Small

Invoke-CauRun



This is the built-in help made by Microsoft for the command 'Invoke-CauRun', 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.

SYNOPSIS

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

SYNTAX


Invoke-CauRun [[-ClusterName] <String>] [[-CauPluginName] <String[]>] [[-Credential] <PSCredential>] [-CauPluginArguments <Hashtable[]>] [-ConfigurationName <String>]
[-EnableFirewallRules] [-FailbackMode <FailbackType>] [-Force] [-MaxFailedNodes <Int32>] [-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PostUpdateScript <String>]
[-PreUpdateScript <String>] [-RebootTimeoutMinutes <Int32>] [-RequireAllNodesOnline] [-RunPluginsSerially] [-SeparateReboots] [-StopAfter <TimeSpan>] [-StopOnPluginFailure]
[-WarnAfter <TimeSpan>] [-Confirm] [-WhatIf] [<CommonParameters>]
Invoke-CauRun [[-ClusterName] <String>] [[-Credential] <PSCredential>] [-Force] -ForceRecovery [-Confirm] [-WhatIf] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Invoke-CauRun cmdlet performs a scan of cluster nodes for applicable updates and installs those updates via an Updating Run on the specified cluster. The Updating Run
process includes the following:

- Scanning for and downloading applicable updates on each cluster node.

- Moving currently running clustered roles off each cluster node.

- Installing the updates on each cluster node.

- Restarting cluster nodes if required by the installed updates.

- Moving the clustered roles back to the original nodes.

The Updating Run process also includes ensuring that quorum is maintained, checking for additional updates that can only be installed after the initial set of updates are
installed, and saving a report of the actions taken.


Note: To run this cmdlet with the PostUpdateScript or PreUpdateScript parameter, Windows PowerShell® remoting must be enabled on each node. To do this, run the
Enable-PSRemoting cmdlet. In addition, ensure that the Windows Remote Management - Compatibility Mode (HTTP-In) firewall exception is enabled on each node.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/p/?linkid=287668
Add-CauClusterRole
Get-CauRun
Stop-CauRun

REMARKS

<

Examples


EXAMPLE 1

PS C:\> Invoke-CauRun -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin -MaxFailedNodes -1 -MaxRetriesPerNode 3 -RequireAllNodesOnline -Force



This example performs a scan and a full Updating Run on the cluster named CONTOSO-FC1. This cmdlet uses the Microsoft.WindowsUpdatePlugin plug-in and requires that all
cluster nodes be online before the running this cmdlet. In addition, this cmdlet allows no more than three retries per node before marking the node as failed, and allows no
more than one node to fail before marking the entire Updating Run as failed. This cmdlet is performed without confirmation prompts.




EXAMPLE 2

PS C:\> Invoke-CauRun -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{ }, @{ 'HotfixRootFolderPath' =
'\\CauHotfixSrv\shareName' } -EnableFirewallRules -StopOnPluginFailure –SeparateReboots -Force



This example performs a scan and a full Updating Run on the cluster named CONTOSO-FC1. This cmdlet uses the Microsoft.WindowsUpdatePlugin plug-in with the default
configuration, and the Microsoft.HotfixPlugin plug-in using the hotfix root folder \\CauHotfixSrv\shareName and the default hotfix configuration file. If it is not already
enabled, the Remote Shutdown Windows Firewall rule group is enabled on each cluster node before the Updating Run. If a failure occurs during the installation of updates on a
node by Microsoft.WindowsUpdatePlugin, updates will not be applied by Microsoft.HotfixPlugin plug-in. If the installation of updates by Microsoft.WindowsUpdatePlugin
requires a node to restart, the node will restart before Microsoft.HotfixPlugin plug-in installs updates. The cmdlet runs without displaying confirmation prompts.




EXAMPLE 3

PS C:\> Invoke-CauRun -ClusterName CONTOSO-FC1 -ForceRecovery -Force



This example recovers from a previous Updating Run that failed and left the cluster in a Locked state for the cluster named CONTOSO-FC1. The recovery is performed without
confirmation prompts.