@@ -16,6 +16,7 @@ Adds the CAU clustered role that provides the self-updating functionality to the
1616## SYNTAX
1717
1818### MonthlyDayOfWeek (Default)
19+
1920```
2021Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
2122[-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-WeeksOfMonth <Int32[]>]
@@ -29,6 +30,7 @@ Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
2930```
3031
3132### Weekly
33+
3234```
3335Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
3436[-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-IntervalWeeks <Int32>]
@@ -42,6 +44,7 @@ Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
4244```
4345
4446## DESCRIPTION
47+
4548The ** Add-CauClusterRole** cmdlet adds the Cluster-Aware Updating (CAU) clustered role that provides
4649the self-updating functionality to the specified cluster. When the CAU clustered role has been added
4750to a cluster, the failover cluster can update itself on the schedule that is specified by the user,
@@ -54,6 +57,7 @@ Mode (HTTP-In) firewall exception is enabled on each node.
5457## EXAMPLES
5558
5659### Example 1: Add a CAU clustered role on the specified cluster at a specific interval
60+
5761```
5862PS C:\> Add-CauClusterRole -ClusterName "CONTOSO-FC1" -DaysOfWeek Tuesday,Saturday -WeeksOfMonth 2,4 -MaxFailedNodes 2 -MaxRetriesPerNode 2 -PostUpdateScript \\CONTOSOFileShare\scripts\verifyupdatesinstalled.ps1 -RequireAllNodesOnline -EnableFirewallRules -Force
5963```
@@ -68,6 +72,7 @@ rule group will be enabled on each cluster node. Because the command uses the *F
6872cmdlet runs without displaying confirmation prompts.
6973
7074### Example 2: Add a CAU clustered role on the specified cluster at a specific interval
75+
7176```
7277PS C:\> Add-CauClusterRole -ClusterName "CONTOSO-FC1" -DaysOfWeek Tuesday,Saturday -IntervalWeeks 3 -MaxFailedNodes 2 -MaxRetriesPerNode 2 -EnableFirewallRules -Force
7378```
@@ -82,6 +87,7 @@ Because the command uses the *Force* parameter, the cmdlet runs without displayi
8287prompts.
8388
8489### Example 3: Add a CAU clustered role on the specified cluster using plug-ins
90+
8591```
8692PS C:\> Add-CauClusterRole -ClusterName "CONTOSO-FC1" -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{ 'IncludeRecommendedUpdates' = 'True' }, @{ 'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName ' } -StopOnPluginFailure -EnableFirewallRules -Force
8793```
@@ -99,6 +105,7 @@ confirmation prompts.
99105## PARAMETERS
100106
101107### -CauPluginArguments
108+
102109Specifies an array of name=value pairs (arguments) for each updating plug-in to use.
103110For instance, to specify a Domain argument for one plug-in:
104111- ` @{Domain=Domain.local} `
@@ -157,6 +164,7 @@ Accept wildcard characters: False
157164` ` `
158165
159166### -CauPluginName
167+
160168Specifies one or more plug-ins to use when performing scans or updates. You can specify multiple
161169values separated with commas. The default is the Microsoft.WindowsUpdatePlugin plug-in. This plug-in
162170coordinates the Windows Update Agent software resident on each cluster node, the same software that
@@ -177,6 +185,7 @@ Accept wildcard characters: False
177185` ` `
178186
179187### -ClusterName
188+
180189Specifies the name of the cluster on which to create the CAU clustered role. This parameter is only
181190required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference
182191a failover cluster different from where the cmdlet is run.
@@ -194,6 +203,7 @@ Accept wildcard characters: False
194203` ` `
195204
196205### -ConfigurationName
206+
197207Specifies the Windows PowerShell session configuration that defines the session in which scripts,
198208specified by the *PreUpdateScript* and *PostUpdateScript* parameters, and cmdlets are run, and can
199209limit the cmdlets that are available to be run. If either a pre-update or post-update script is
@@ -213,6 +223,7 @@ Accept wildcard characters: False
213223` ` `
214224
215225### -Confirm
226+
216227Prompts you for confirmation before running the cmdlet.
217228
218229` ` ` yaml
@@ -228,6 +239,7 @@ Accept wildcard characters: False
228239` ` `
229240
230241### -Credential
242+
231243Specifies the administrative credentials for the target cluster.
232244
233245` ` ` yaml
@@ -243,6 +255,7 @@ Accept wildcard characters: False
243255` ` `
244256
245257### -DaysOfWeek
258+
246259Specifies the days of the week on which the updating task will be triggered.
247260Multiple values can be specified either separated with commas or as a hexadecimal sum.
248261
@@ -270,6 +283,7 @@ Accept wildcard characters: False
270283` ` `
271284
272285### -EnableFirewallRules
286+
273287Indicates that the cmdlet enables the Remote Shutdown Windows Firewall rule group on each cluster
274288node, if it is not already enabled. If the *EnableFirewallRules* parameter is specified, CAU will
275289also automatically re-enable the Remote Shutdown rule group each time the CAU clustered role
@@ -293,6 +307,7 @@ Accept wildcard characters: False
293307` ` `
294308
295309### -FailbackMode
310+
296311Specifies the method used to bring drained workloads back to the node, at the end of updating the
297312node. Drained workloads are workloads that were previously running on the node, but were moved to
298313another node.
@@ -319,6 +334,7 @@ Accept wildcard characters: False
319334` ` `
320335
321336### -Force
337+
322338Forces the command to run without asking for user confirmation.
323339
324340` ` ` yaml
@@ -334,6 +350,7 @@ Accept wildcard characters: False
334350` ` `
335351
336352### -GroupName
353+
337354Specifies the NetBIOS name of the resource group for the CAU clustered role.
338355
339356` ` ` yaml
@@ -349,6 +366,7 @@ Accept wildcard characters: False
349366` ` `
350367
351368### -IntervalWeeks
369+
352370Specifies the interval between weeks when the task will be triggered.
353371An interval of 1 produces a weekly schedule.
354372An interval of 2 produces an every-other week schedule.
@@ -366,6 +384,7 @@ Accept wildcard characters: False
366384` ` `
367385
368386### -MaxFailedNodes
387+
369388Specifies the maximum number of nodes on which updating can fail.
370389If one more than this number of nodes fails, then the Updating Run is stopped.
371390The range is from 0 through 1, less than the number of cluster nodes.
@@ -384,6 +403,7 @@ Accept wildcard characters: False
384403` ` `
385404
386405### -MaxRetriesPerNode
406+
387407Specifies the maximum number of times that the update process attempts to run.
388408This includes any pre-update and post-update scripts.
389409The update process is retried per node.
@@ -402,6 +422,7 @@ Accept wildcard characters: False
402422` ` `
403423
404424### -NodeOrder
425+
405426Specifies an array of cluster node names in the order that they should be updated.
406427
407428` ` ` yaml
@@ -417,6 +438,7 @@ Accept wildcard characters: False
417438` ` `
418439
419440### -PostUpdateScript
441+
420442Specifies the path and file name for a Windows PowerShell script to run on each node after updating
421443finishes, and just after the node is brought out of Maintenance mode. The file name extension must
422444be .ps1 and the total length of the path plus the file name must be no longer than 260 characters.
@@ -436,6 +458,7 @@ Accept wildcard characters: False
436458` ` `
437459
438460### -PreUpdateScript
461+
439462Specifies the path and file name for a Windows PowerShell script to run on each node before updating
440463begins, and before the node is put into Maintenance mode. The file name extension must be .ps1 and
441464the total length of the path plus the file name must be no longer than 260 characters. As a best
@@ -456,6 +479,7 @@ Accept wildcard characters: False
456479` ` `
457480
458481### -RebootTimeoutMinutes
482+
459483Specifies the time in minutes that CAU allows for the restarting of a node. If the restart does not
460484complete within this time, then the Updating Run on that node will be marked as failed.
461485
@@ -472,6 +496,7 @@ Accept wildcard characters: False
472496` ` `
473497
474498### -RequireAllNodesOnline
499+
475500Indicates that the cmdlet enforces that all cluster nodes are online and reachable before updating
476501begins.
477502
@@ -488,6 +513,7 @@ Accept wildcard characters: False
488513` ` `
489514
490515### -RunPluginsSerially
516+
491517Indicates that the cmdlet CAU scans each cluster node for applicable updates and stages the updates
492518for each plug-in in the plug-in order when multiple plug-ins are used during an Updating Run when
493519you use the *CauPluginName* parameter. By default, CAU scans and stages the applicable updates for
@@ -510,6 +536,7 @@ Accept wildcard characters: False
510536` ` `
511537
512538### -SeparateReboots
539+
513540Indicates that this cmdlet shuts down CAU and restarts a cluster node after each plug-in installs
514541updates on the node, if the installation of an update by a plug-in requires a restart. By default,
515542during an updating run, all plug-ins complete the installation of updates on a cluster node before
@@ -531,6 +558,7 @@ Accept wildcard characters: False
531558` ` `
532559
533560### -StartDate
561+
534562Specifies the earliest date on which the Updating Run can be triggered.
535563
536564` ` ` yaml
@@ -546,6 +574,7 @@ Accept wildcard characters: False
546574` ` `
547575
548576### -StopAfter
577+
549578Specifies the time in minutes after which the updating run is canceled if it has not completed. The
550579time span can be expressed in the standard ways available in Windows PowerShell, for instance,
551580` 01:30:00` represents one hour and thirty minutes. By default, the updating run is allowed an
@@ -567,6 +596,7 @@ Accept wildcard characters: False
567596` ` `
568597
569598# ## -StopOnPluginFailure
599+
570600Indicates that this cmdlet coordinates subsequent updates on the node when plug-ins are stopped.
571601When multiple plug-ins are used during an updating run, by default, a failure by one plug-in does
572602not affect the application of updates on a node by other plug-ins. This parameter is valid only when
@@ -586,6 +616,7 @@ Accept wildcard characters: False
586616` ` `
587617
588618# ## -SuspendClusterNodeTimeoutMinutes
619+
589620Specifies the maximum amount of time CAU should wait for the **Suspend-ClusterNode** cmdlet to
590621succeed if the underlying clustered space is in degraded condition.
591622
@@ -609,6 +640,7 @@ Accept wildcard characters: False
609640` ` `
610641
611642# ## -VirtualComputerObjectName
643+
612644Specifies the name of a pre-staged virtual computer object that is used by the CAU clustered role.
613645For more information, see
614646[Steps to create computer objects in Active Directory](https://go.microsoft.com/fwlink/p/?LinkId=237624).
@@ -629,6 +661,7 @@ Accept wildcard characters: False
629661` ` `
630662
631663# ## -WarnAfter
664+
632665Specifies the time in minutes after which a warning will be logged if the Updating Run (including
633666any pre-update and post-update scripts) has not completed. By default, no warning will be logged,
634667regardless of the time taken by the Updating Run.
@@ -646,6 +679,7 @@ Accept wildcard characters: False
646679` ` `
647680
648681# ## -WeeksOfMonth
682+
649683Specifies the weeks of the month when the Updating Run should be run.
650684The value `5` represents the last week of the month.
651685
@@ -662,6 +696,7 @@ Accept wildcard characters: False
662696` ` `
663697
664698# ## -WhatIf
699+
665700Shows what would happen if the cmdlet runs.
666701The cmdlet is not run.
667702
@@ -678,6 +713,7 @@ Accept wildcard characters: False
678713` ` `
679714
680715# ## CommonParameters
716+
681717This cmdlet supports the common parameters : -Debug, -ErrorAction, -ErrorVariable,
682718-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
683719-WarningAction, and -WarningVariable. For more information, see
0 commit comments