@@ -19,47 +19,47 @@ Adds the Cluster Aware Updating (CAU) clustered role that provides the self-upda
1919
2020```
2121Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
22- [-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-WeeksOfMonth <Int32[]>]
23- [-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
24- [-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
25- [-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
26- [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
27- [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
28- [-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
29- [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
30- [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
31- [[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
22+ [-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-WeeksOfMonth <Int32[]>]
23+ [-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
24+ [-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
25+ [-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
26+ [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
27+ [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
28+ [-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
29+ [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
30+ [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
31+ [[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
3232```
3333
3434### Weekly
3535
3636```
3737Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
38- [-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-IntervalWeeks <Int32>]
39- [-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
40- [-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
41- [-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
42- [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
43- [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
44- [-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
45- [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
46- [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
47- [[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
38+ [-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-IntervalWeeks <Int32>]
39+ [-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
40+ [-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
41+ [-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
42+ [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
43+ [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
44+ [-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
45+ [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
46+ [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
47+ [[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
4848```
4949
5050### Once
5151
5252```
5353Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>] [-RunOnce]
54- [-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
55- [-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
56- [-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
57- [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
58- [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
59- [-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
60- [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
61- [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
62- [[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
54+ [-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
55+ [-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
56+ [-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
57+ [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
58+ [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
59+ [-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
60+ [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
61+ [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
62+ [[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
6363```
6464
6565## DESCRIPTION
@@ -166,6 +166,7 @@ Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/
166166## PARAMETERS
167167
168168### -AttemptSoftReboot
169+
169170Indicates that the CAU clustered role attempts a Kernel Soft Reboot (KSR) for the failover cluster.
170171
171172KSR bypasses BIOS/firmware initialization. You can only use KSR for updates that do not require a
@@ -429,6 +430,7 @@ Accept wildcard characters: False
429430` ` `
430431
431432# ## -ForcePauseAndDrain
433+
432434Indicates that the CAU cluster role forces cluster nodes to pause and drain roles.
433435
434436A forced drain moves the roles off of the draining node even if the group cannot move.
@@ -447,6 +449,7 @@ Accept wildcard characters: False
447449` ` `
448450
449451# ## -ForcePauseDrainAndReboot
452+
450453Indicates that the CAU cluster role forces cluster nodes to pause, drain roles, and restart.
451454
452455A forced drain moves the roles off of the draining node even if the group cannot move.
@@ -465,6 +468,7 @@ Accept wildcard characters: False
465468` ` `
466469
467470# ## -ForcePauseNoDrain
471+
468472Indicates that the CAU cluster role forces cluster nodes to pause.
469473The nodes are not drained.
470474
@@ -569,6 +573,7 @@ Accept wildcard characters: False
569573` ` `
570574
571575# ## -OsRollingUpgrade
576+
572577Indicates 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.
573578
574579` ` ` yaml
@@ -625,6 +630,7 @@ Accept wildcard characters: False
625630` ` `
626631
627632# ## -RebootMode
633+
628634{{ Fill RebootMode Description }}
629635
630636` ` ` yaml
@@ -675,6 +681,7 @@ Accept wildcard characters: False
675681` ` `
676682
677683# ## -RunOnce
684+
678685{{ Fill RunOnce Description }}
679686
680687` ` ` yaml
@@ -735,6 +742,7 @@ Accept wildcard characters: False
735742` ` `
736743
737744# ## -SiteAwareUpdatingOrder
745+
738746Specifies the order in which the CAU cluster role updates cluster nodes.
739747
740748By default, CAU selects the order of nodes to update based on the level of activity.
@@ -752,6 +760,7 @@ Accept wildcard characters: False
752760` ` `
753761
754762# ## -SkipUpdateChecks
763+
755764Indicates that the CAU cluster role skips update checks.
756765
757766` ` ` yaml
@@ -824,6 +833,7 @@ Accept wildcard characters: False
824833` ` `
825834
826835# ## -SuspendClusterNodeTimeoutMinutes
836+
827837Specifies the maximum amount of time CAU should wait for the `Suspend-ClusterNode` cmdlet to
828838succeed if the underlying clustered space is in degraded condition.
829839
0 commit comments