CmdID

CmdID / PowerShell / Cmdlets / Invoke

Invoke-CauRun

Performs a scan of cluster nodes for applicable updates and installs those updates through an Updating Run on the specified cluster. Windows Server PowerShell reference

From the Windows Server PowerShell reference 38 parameters Its page in the reference

Opens CmdID with your command, read as PowerShell. It is read in your browser and sent nowhere.

Parameters

38 in the Windows Server PowerShell reference
Show its 38 parameters
-AttemptSoftRebootIndicates that command attempts a Kernel Soft Reboot (KSR) for the failover cluster.
-CauPluginArgumentsSpecifies a set of name=value pairs, as arguments, for each updating plug-in to use.
-CauPluginNameSpecifies one or more plug-ins to use when performing updates.
-ClearCorruptReportsSpecifies whether to clear any corrupt reports that were generated during a previous run of the Cluster-Aware Updating (CAU) tool to recover from a failed or interrupted update run.
-ClusterNameSpecifies a cluster for which this cmdlet installs updates.
-ConfigurationNameSpecifies the Windows PowerShell session configuration that defines the session in which scripts are run, specified by PreUpdateScript and PostUpdateScript parameters, and can limit the cmdlets that…
-CredentialSpecifies the administrative credentials for the target cluster.
-EnableFirewallRulesEnables the Remote Shutdown Windows Firewall rule group on each cluster node, if it isn't already enabled.
-FailbackModeSpecifies the method used to bring drained workloads back to the node, at the end of updating the node.
-Force, -fForces the command to run without asking for user confirmation.
-ForcePauseAndDrainIndicates that the command forces cluster nodes to pause and drain roles.
-ForcePauseDrainAndRebootIndicates that the command forces cluster nodes to pause, drain roles, and restart.
-ForcePauseNoDrainIndicates that the command forces cluster nodes to pause.
-ForceRecovery, -RecoverIndicates that the cmdlet recovers from a previous failed run that left the cluster in a Locked state.
-ForceSelfUpdateSpecifies whether to update the CAU plugin on the local computer before running the update.
-MaxFailedNodesSpecifies the maximum number of nodes on which updating can fail.
-MaxRetriesPerNodeSpecifies the maximum number of times that the update process (including any pre-update and post-update scripts) is retried per node.
-NodeOrderSpecifies an array of cluster nodes names in the order that they are updated.
-OsRollingUpgradeIndicates that the CAU cluster role upgrades the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads.
-PostUpdateScriptSpecifies the path and file name for a Windows PowerShell script to run on each node after updating finishes, and just after the node is brought out of Maintenance mode.
-PreUpdateScriptSpecifies the path and file name for a Windows PowerShell script to run on each node before updating begins, and before the node is put into Maintenance mode.
-RebootModeSpecifies the type of reboot to use for each node in the cluster during the update.
-RebootTimeoutMinutesSpecifies the time in minutes that CAU allows for the restarting of a node.
-RequireAllNodesOnlineIndicates that all cluster nodes must be online and reachable before the update begins.
-ResumeNodeSpecifies the name of a node in the cluster to resume updating if it was previously suspended.
-RunPluginsSeriallyIndicates that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed into the CauPluginName parameter when multiple plug-ins are us…
-SeparateRebootsIndicates that CAU will shut down and restart a cluster node after each plug-in installs updates on the node, if the installation of an update by a plug-in requires a restart when multiple plug-ins a…
-SiteAwareUpdatingOrderSpecifies the order in which the command updates cluster nodes.
-SkipUpdateChecksIndicates that the command skips update checks.
-StopAfterSpecifies the time in minutes after which the Updating Run is canceled if it hasn't completed.
-StopOnPluginFailureIndicates that if a failure occurs during the application of updates on a node by any plug-in, subsequent updates on the node that are coordinated by the remaining plug-ins are stopped when multiple…
-SuspendClusterNodeTimeoutMinutesSpecifies the maximum amount of time CAU should wait for the Suspend-ClusterNode cmdlet to succeed if the underlying clustered space is in degraded condition.
-SuspendNodeSpecifies the name of a node in the cluster to suspend updating.
-SuspendRetriesPerNodeSpecifies the number of times to retry suspending a node before moving on to the next node.
-WaitForStorageRepairTimeoutMinutesSpecifies the amount of time in minutes to wait for storage to be repaired on a node before continuing with an update.
-WarnAfterSpecifies the time in minutes after which a warning is logged if the Updating Run, including any pre-update and post-update scripts, hasn't completed.
-Confirm, -cfPrompts you for confirmation before running the cmdlet.
-WhatIf, -wiShows what would happen if the cmdlet runs.