Merge branch 'main' into roharwoo_cau_stage_2_examples

Author: sdwheeler

docset/winserver2022-ps/clusterawareupdating/Add-CauClusterRole.md

@@ -16,6 +16,7 @@ Adds the CAU clustered role that provides the self-updating functionality to the
 ## SYNTAX
 
 ### MonthlyDayOfWeek (Default)
+
 ```
 Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
 [-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-WeeksOfMonth <Int32[]>]
@@ -29,6 +30,7 @@ Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
 ```
 
 ### Weekly
+
 ```
 Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
 [-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-IntervalWeeks <Int32>]
@@ -42,6 +44,7 @@ Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
 ```
 
 ## DESCRIPTION
+
 The **Add-CauClusterRole** cmdlet adds the Cluster-Aware Updating (CAU) clustered role that provides
 the self-updating functionality to the specified cluster. When the CAU clustered role has been added
 to 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.
 ## EXAMPLES
 
 ### Example 1: Add a CAU clustered role on the specified cluster at a specific interval
+
 ```powershell
 $parameters = @{
     ClusterName = 'CONTOSO-FC1'
@@ -84,6 +88,7 @@ This example uses splatting to pass parameter values from the `$parameters` vari
 Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
 
 ### Example 2: Add a CAU clustered role on the specified cluster at a specific interval
+
 ```powershell
 $parameters = @{
     ClusterName = 'CONTOSO-FC1'
@@ -111,6 +116,7 @@ This example uses splatting to pass parameter values from the `$parameters` vari
 Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
 
 ### Example 3: Add a CAU clustered role on the specified cluster using plug-ins
+
 ```powershell
 $parameters = @{
     ClusterName = 'CONTOSO-FC1'
@@ -141,6 +147,7 @@ Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/
 ## PARAMETERS
 
 ### -CauPluginArguments
+
 Specifies an array of name=value pairs (arguments) for each updating plug-in to use.
 For instance, to specify a Domain argument for one plug-in: 
 - `@{Domain=Domain.local}`
@@ -199,6 +206,7 @@ Accept wildcard characters: False
 ```
 
 ### -CauPluginName
+
 Specifies one or more plug-ins to use when performing scans or updates. You can specify multiple
 values separated with commas. The default is the Microsoft.WindowsUpdatePlugin plug-in. This plug-in
 coordinates the Windows Update Agent software resident on each cluster node, the same software that
@@ -219,6 +227,7 @@ Accept wildcard characters: False
 ```
 
 ### -ClusterName
+
 Specifies the name of the cluster on which to create the CAU clustered role. This parameter is only
 required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference
 a failover cluster different from where the cmdlet is run.
@@ -236,6 +245,7 @@ Accept wildcard characters: False
 ```
 
 ### -ConfigurationName
+
 Specifies 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 the cmdlets that are available to be run. If either a pre-update or post-update script is
@@ -255,6 +265,7 @@ Accept wildcard characters: False
 ```
 
 ### -Confirm
+
 Prompts you for confirmation before running the cmdlet.
 
 ```yaml
@@ -270,6 +281,7 @@ Accept wildcard characters: False
 ```
 
 ### -Credential
+
 Specifies the administrative credentials for the target cluster.
 
 ```yaml
@@ -285,6 +297,7 @@ Accept wildcard characters: False
 ```
 
 ### -DaysOfWeek
+
 Specifies the days of the week on which the updating task will be triggered.
 Multiple values can be specified either separated with commas or as a hexadecimal sum.
 
@@ -312,6 +325,7 @@ Accept wildcard characters: False
 ```
 
 ### -EnableFirewallRules
+
 Indicates that the cmdlet enables the Remote Shutdown Windows Firewall rule group on each cluster
 node, if it is not already enabled. If the *EnableFirewallRules* parameter is specified, CAU will
 also automatically re-enable the Remote Shutdown rule group each time the CAU clustered role
@@ -335,6 +349,7 @@ Accept wildcard characters: False
 ```
 
 ### -FailbackMode
+
 Specifies the method used to bring drained workloads back to the node, at the end of updating the
 node. Drained workloads are workloads that were previously running on the node, but were moved to
 another node.
@@ -361,6 +376,7 @@ Accept wildcard characters: False
 ```
 
 ### -Force
+
 Forces the command to run without asking for user confirmation.
 
 ```yaml
@@ -376,6 +392,7 @@ Accept wildcard characters: False
 ```
 
 ### -GroupName
+
 Specifies the NetBIOS name of the resource group for the CAU clustered role.
 
 ```yaml
@@ -391,6 +408,7 @@ Accept wildcard characters: False
 ```
 
 ### -IntervalWeeks
+
 Specifies the interval between weeks when the task will be triggered.
 An interval of 1 produces a weekly schedule.
 An interval of 2 produces an every-other week schedule.
@@ -408,6 +426,7 @@ Accept wildcard characters: False
 ```
 
 ### -MaxFailedNodes
+
 Specifies the maximum number of nodes on which updating can fail.
 If one more than this number of nodes fails, then the Updating Run is stopped.
 The range is from 0 through 1, less than the number of cluster nodes.
@@ -426,6 +445,7 @@ Accept wildcard characters: False
 ```
 
 ### -MaxRetriesPerNode
+
 Specifies the maximum number of times that the update process attempts to run.
 This includes any pre-update and post-update scripts.
 The update process is retried per node.
@@ -444,6 +464,7 @@ Accept wildcard characters: False
 ```
 
 ### -NodeOrder
+
 Specifies an array of cluster node names in the order that they should be updated.
 
 ```yaml
@@ -459,6 +480,7 @@ Accept wildcard characters: False
 ```
 
 ### -PostUpdateScript
+
 Specifies 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. The file name extension must
 be .ps1 and the total length of the path plus the file name must be no longer than 260 characters.
@@ -478,6 +500,7 @@ Accept wildcard characters: False
 ```
 
 ### -PreUpdateScript
+
 Specifies 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. The file name extension must be .ps1 and
 the total length of the path plus the file name must be no longer than 260 characters. As a best
@@ -498,6 +521,7 @@ Accept wildcard characters: False
 ```
 
 ### -RebootTimeoutMinutes
+
 Specifies the time in minutes that CAU allows for the restarting of a node. If the restart does not
 complete within this time, then the Updating Run on that node will be marked as failed.
 
@@ -514,6 +538,7 @@ Accept wildcard characters: False
 ```
 
 ### -RequireAllNodesOnline
+
 Indicates that the cmdlet enforces that all cluster nodes are online and reachable before updating
 begins.
 
@@ -530,6 +555,7 @@ Accept wildcard characters: False
 ```
 
 ### -RunPluginsSerially
+
 Indicates 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
 you use the *CauPluginName* parameter. By default, CAU scans and stages the applicable updates for
@@ -552,6 +578,7 @@ Accept wildcard characters: False
 ```
 
 ### -SeparateReboots
+
 Indicates 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. By default,
 during an updating run, all plug-ins complete the installation of updates on a cluster node before
@@ -573,6 +600,7 @@ Accept wildcard characters: False
 ```
 
 ### -StartDate
+
 Specifies the earliest date on which the Updating Run can be triggered.
 
 ```yaml
@@ -588,6 +616,7 @@ Accept wildcard characters: False
 ```
 
 ### -StopAfter
+
 Specifies the time in minutes after which the updating run is canceled if it has not completed. The
 time span can be expressed in the standard ways available in Windows PowerShell, for instance,
 `01:30:00` represents one hour and thirty minutes. By default, the updating run is allowed an
@@ -609,6 +638,7 @@ Accept wildcard characters: False
 ```
 
 ### -StopOnPluginFailure
+
 Indicates that this cmdlet coordinates subsequent updates on the node when plug-ins are stopped.
 When multiple plug-ins are used during an updating run, by default, a failure by one plug-in does
 not affect the application of updates on a node by other plug-ins. This parameter is valid only when
@@ -628,6 +658,7 @@ Accept wildcard characters: False
 ```
 
 ### -SuspendClusterNodeTimeoutMinutes
+
 Specifies the maximum amount of time CAU should wait for the **Suspend-ClusterNode** cmdlet to
 succeed if the underlying clustered space is in degraded condition.
 
@@ -651,6 +682,7 @@ Accept wildcard characters: False
 ```
 
 ### -VirtualComputerObjectName
+
 Specifies the name of a pre-staged virtual computer object that is used by the CAU clustered role.
 For more information, see
 [Steps to create computer objects in Active Directory](https://go.microsoft.com/fwlink/p/?LinkId=237624).
@@ -671,6 +703,7 @@ Accept wildcard characters: False
 ```
 
 ### -WarnAfter
+
 Specifies the time in minutes after which a warning will be logged if the Updating Run (including
 any pre-update and post-update scripts) has not completed. By default, no warning will be logged,
 regardless of the time taken by the Updating Run.
@@ -688,6 +721,7 @@ Accept wildcard characters: False
 ```
 
 ### -WeeksOfMonth
+
 Specifies the weeks of the month when the Updating Run should be run.
 The value `5` represents the last week of the month.
 
@@ -704,6 +738,7 @@ Accept wildcard characters: False
 ```
 
 ### -WhatIf
+
 Shows what would happen if the cmdlet runs.
 The cmdlet is not run.
 
@@ -720,6 +755,7 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
+
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
 -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
 -WarningAction, and -WarningVariable. For more information, see

docset/winserver2022-ps/clusterawareupdating/Disable-CauClusterRole.md

@@ -21,13 +21,15 @@ Disable-CauClusterRole [[-ClusterName] <String>] [-Credential <PSCredential>] [-
 ```
 
 ## DESCRIPTION
+
 The **Disable-CauClusterRole** cmdlet suspends the self-updating functionality on the specified
 cluster. The self-updating functionality of the cluster can be re-enabled with the
 **Enable-CauClusterRole** cmdlet.
 
 ## EXAMPLES
 
 ### Example 1: Disable a CAU clustered role on the specified cluster
+
 ```powershell
 Disable-CauClusterRole -ClusterName CONTOSO-FC1 -Force
 ```
@@ -39,6 +41,7 @@ specified the *Force* parameter, the cmdlet runs without displaying confirmation
 ## PARAMETERS
 
 ### -ClusterName
+
 Specifies the name of the cluster on which to disable the self-updating functionality. This
 parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is
 used to reference a failover cluster different from where the cmdlet is run.
@@ -56,6 +59,7 @@ Accept wildcard characters: False
 ```
 
 ### -Confirm
+
 Prompts you for confirmation before running the cmdlet.
 
 ```yaml
@@ -71,6 +75,7 @@ Accept wildcard characters: False
 ```
 
 ### -Credential
+
 Specifies the administrative credentials for the target cluster.
 
 ```yaml
@@ -86,6 +91,7 @@ Accept wildcard characters: False
 ```
 
 ### -Force
+
 Forces the command to run without asking for user confirmation.
 
 ```yaml
@@ -101,6 +107,7 @@ Accept wildcard characters: False
 ```
 
 ### -WhatIf
+
 Shows what would happen if the cmdlet runs.
 The cmdlet is not run.
 
@@ -117,6 +124,7 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
+
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
 -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
 -WarningAction, and -WarningVariable. For more information, see