CmdID

CmdID / PowerShell / Cmdlets / Add

Add-CauClusterRole

Adds the CAU clustered role that provides the self-updating functionality to the specified cluster. Windows Server PowerShell reference

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

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

Parameters

40 in the Windows Server PowerShell reference
Show its 40 parameters
-AttemptSoftRebootIndicates that the CAU clustered role 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 scans or updates.
-ClusterNameSpecifies the name of the cluster on which to create the CAU clustered role.
-ConfigurationNameSpecifies the Windows PowerShell session configuration that defines the session in which scripts, specified by the PreUpdateScript and PostUpdateScript parameters, and cmdlets are run, and can limit…
-CredentialSpecifies the administrative credentials for the target cluster.
-DaysOfWeekSpecifies the days of the week on which the updating task will be triggered.
-EnableFirewallRulesIndicates that the cmdlet enables 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 CAU cluster role forces cluster nodes to pause and drain roles.
-ForcePauseDrainAndRebootIndicates that the CAU cluster role forces cluster nodes to pause, drain roles, and restart.
-ForcePauseNoDrainIndicates that the CAU cluster role forces cluster nodes to pause.
-GroupNameSpecifies the NetBIOS name of the resource group for the CAU clustered role.
-IntervalWeeksSpecifies the interval between weeks when the task will be triggered.
-MaxFailedNodesSpecifies the maximum number of nodes on which updating can fail.
-MaxRetriesPerNodeSpecifies the maximum number of times that the update process attempts to run.
-NodeOrderSpecifies an array of cluster node names in the order that they should be 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 the cmdlet enforces that all cluster nodes are online and reachable before updating begins.
-RunOnceSpecifies that the CAU run should only be performed once, rather than on a recurring schedule.
-RunPluginsSeriallyIndicates that the cmdlet CAU scans each cluster node for applicable updates and stages the updates for each plug-in in the plug-in order when multiple plug-ins are used during an Updating Run when y…
-SeparateRebootsIndicates that this cmdlet shuts down CAU and restarts 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.
-SiteAwareUpdatingOrderSpecifies the order in which the CAU cluster role updates cluster nodes.
-SkipUpdateChecksIndicates that the CAU cluster role skips update checks.
-StartDateSpecifies the earliest date on which the Updating Run can be triggered.
-StopAfterSpecifies the time in minutes after which the updating run is canceled if it hasn't completed.
-StopOnPluginFailureIndicates that this cmdlet coordinates subsequent updates on the node when plug-ins are stopped.
-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.
-SuspendRetriesPerNodeSpecifies the number of times to retry suspending a node before moving on to the next node.
-VirtualComputerObjectNameSpecifies the name of a pre-staged virtual computer object that is used by the CAU clustered role.
-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 will be logged if the Updating Run (including any pre-update and post-update scripts) hasn't completed.
-WeeksOfMonthSpecifies the weeks of the month when the Updating Run should be run.
-Confirm, -cfPrompts you for confirmation before running the cmdlet.
-WhatIf, -wiShows what would happen if the cmdlet runs.