Merge pull request #3133 from robinharwood/roharwoo_cau_stage_3_text_formatting

Bulk text formatting updates to the clusterawareupdating module

Author: sdwheeler

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

@@ -19,39 +19,39 @@ Adds the CAU clustered role that provides the self-updating functionality to the
 
 ```
 Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
-[-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-WeeksOfMonth <Int32[]>]
-[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
-[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
-[-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
-[-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
-[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
-[-SuspendClusterNodeTimeoutMinutes <Int32>] [[-ClusterName] <String>] [[-Credential] <PSCredential>]
-[-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-WeeksOfMonth <Int32[]>]
+ [-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
+ [-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
+ [-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
+ [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
+ [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
+ [-SuspendClusterNodeTimeoutMinutes <Int32>] [[-ClusterName] <String>] [[-Credential] <PSCredential>]
+ [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### Weekly
 
 ```
 Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
-[-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-IntervalWeeks <Int32>]
-[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
-[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
-[-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
-[-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
-[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
-[-SuspendClusterNodeTimeoutMinutes <Int32>] [[-ClusterName] <String>] [[-Credential] <PSCredential>]
-[-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-IntervalWeeks <Int32>]
+ [-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
+ [-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
+ [-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
+ [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
+ [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
+ [-SuspendClusterNodeTimeoutMinutes <Int32>] [[-ClusterName] <String>] [[-Credential] <PSCredential>]
+ [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
 
-The **Add-CauClusterRole** cmdlet adds the Cluster-Aware Updating (CAU) clustered role that provides
+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,
 without requiring an external computer to coordinate the cluster updating process.
 
 To run this cmdlet, Windows PowerShell® remoting must be enabled on each node. To do this, run the
-**Enable-PSRemoting** cmdlet. In addition, ensure that the Windows Remote Management - Compatibility
+`Enable-PSRemoting` cmdlet. In addition, ensure that the Windows Remote Management - Compatibility
 Mode (HTTP-In) firewall exception is enabled on each node.
 
 ## EXAMPLES
@@ -80,8 +80,8 @@ The CAU clustered role is configured to perform Updating Runs on Tuesdays and Sa
 second and fourth weeks of each month. In an Updating Run, the maximum number of failed nodes is two
 and the maximum number of retries per node is two. A script called verifyupdatesinstalled.ps1 runs
 on each node after it has been fully updated. Before an Updating Run can begin, all the nodes of
-that cluster must be running. If it is not already enabled, the Remote Shutdown Windows Firewall
-rule group will be enabled on each cluster node. Because the command uses the *Force* parameter, the
+that cluster must be running. If it isn't already enabled, the Remote Shutdown Windows Firewall
+rule group will be enabled on each cluster node. Because the command uses the **Force** parameter, the
 cmdlet runs without displaying confirmation prompts.
 
 This example uses splatting to pass parameter values from the `$parameters` variable to the command.
@@ -107,9 +107,9 @@ This command adds the CAU clustered role, using a default name, on the cluster c
 The CAU clustered role is configured to perform Updating Runs on Tuesdays and Saturdays at an
 interval of every three weeks. In an Updating Run, the maximum number of failed nodes is two and the
 maximum number of retries per node is two. Updating Runs can begin even when the nodes of the
-cluster are not all running (if the cluster itself has quorum and is running). If it is not already
+cluster aren't all running (if the cluster itself has quorum and is running). If it isn't already
 enabled, the Remote Shutdown Windows Firewall rule group will be enabled on each cluster node.
-Because the command uses the *Force* parameter, the cmdlet runs without displaying confirmation
+Because the command uses the **Force** parameter, the cmdlet runs without displaying confirmation
 prompts.
 
 This example uses splatting to pass parameter values from the `$parameters` variable to the command.
@@ -133,12 +133,12 @@ Add-CauClusterRole @parameters
 
 This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1.
 The CAU clustered role is configured to perform updates using the **Microsoft.WindowsUpdatePlugin**
-plug-in with the optional *IncludeRecommendedUpdates* parameter set to True, and using the
-**Microsoft.HotfixPlugin plug-in** using the hotfix root folder \\\\CauHotfixSrv\shareName and the
+plug-in with the optional **IncludeRecommendedUpdates** parameter set to True, and using the
+**Microsoft.HotfixPlugin plug-in** using the hotfix root folder `\\CauHotfixSrv\shareName` and the
 default hotfix configuration file. If a failure occurs during the installation of updates on a node
 by **Microsoft.WindowsUpdatePlugin**, updates are applied by **Microsoft.HotfixPlugin plug-in**. If
-it is not already enabled, the Remote Shutdown Windows Firewall rule group is enabled on each
-cluster node. Because the command uses the *Force* parameter, the cmdlet runs without displaying
+it isn't already enabled, the Remote Shutdown Windows Firewall rule group is enabled on each
+cluster node. Because the command uses the **Force** parameter, the cmdlet runs without displaying
 confirmation prompts.
 
 This example uses splatting to pass parameter values from the `$parameters` variable to the command.
@@ -154,7 +154,7 @@ For instance, to specify a Domain argument for one plug-in:
 You can specify multiple pairs in a set separated with semicolons.
 For instance: 
 - `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the
-  *CauPluginName* parameter that you specify. If you specify arguments for more than one plug-in,
+  **CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in,
   provide the sets of name=value pairs in the order that you pass values in **CauPluginName**,
   separated by commas. For instance:
 - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}`
@@ -229,7 +229,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
+required when this cmdlet isn't run on a failover cluster node, or this cmdlet is used to reference
 a failover cluster different from where the cmdlet is run.
 
 ```yaml
@@ -247,9 +247,9 @@ 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
+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
-specified but a configuration name is not specified, then the default session configuration that is
+specified but a configuration name isn't specified, then the default session configuration that is
 built into Windows PowerShell® is used.
 
 ```yaml
@@ -327,13 +327,13 @@ 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
+node, if it isn't 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
 performs an Updating Run, in case the rules are disabled manually in the intervening time. Enabling
 this rule group permits inbound communication to each cluster node during each Updating Run that
 allows CAU to shut down and restart the node remotely (if the installation of an update requires a
-restart). If Windows Firewall is in use on the cluster nodes and the rule group is not enabled, the
-Updating Run will fail. The Remote Shutdown Windows Firewall rule group is not enabled when it will
+restart). If Windows Firewall is in use on the cluster nodes and the rule group isn't enabled, the
+Updating Run will fail. The Remote Shutdown Windows Firewall rule group isn't enabled when it will
 conflict with Group Policy settings that are configured for Windows Firewall.
 
 ```yaml
@@ -506,7 +506,7 @@ begins, and before the node is put into Maintenance mode. The file name extensio
 the total length of the path plus the file name must be no longer than 260 characters. As a best
 practice, the script should be located on a disk in cluster storage, or at a highly available
 network share, to ensure that the script is always accessible to all the cluster nodes. If a
-pre-update script fails, the node is not updated.
+pre-update script fails, the node isn't updated.
 
 ```yaml
 Type: String
@@ -522,7 +522,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
+Specifies the time in minutes that CAU allows for the restarting of a node. If the restart doesn't
 complete within this time, then the Updating Run on that node will be marked as failed.
 
 ```yaml
@@ -558,11 +558,11 @@ Accept wildcard characters: False
 
 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
+you use the **CauPluginName** parameter. By default, CAU scans and stages the applicable updates for
 all plug-ins in parallel. Regardless of the configuration of this parameter, CAU installs the
 applicable updates for each plug-in sequentially.
 
-The parameter is valid only when multiple plug-ins are specified in the *CauPluginName* parameter.
+The parameter is valid only when multiple plug-ins are specified in the **CauPluginName** parameter.
 If a single plug-in is specified, a warning appears.
 
 ```yaml
@@ -584,7 +584,7 @@ updates on the node, if the installation of an update by a plug-in requires a re
 during an updating run, all plug-ins complete the installation of updates on a cluster node before
 the node restarts one time.
 
-The parameter is valid only when multiple plug-ins are specified in the *CauPluginName* parameter.
+The parameter is valid only when multiple plug-ins are specified in the **CauPluginName** parameter.
 If a single plug-in is specified, a warning appears.
 
 ```yaml
@@ -617,7 +617,7 @@ Accept wildcard characters: False
 
 ### -StopAfter
 
-Specifies the time in minutes after which the updating run is canceled if it has not completed. The
+Specifies the time in minutes after which the updating run is canceled if it hasn't 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
 unlimited amount of time to complete.
@@ -640,9 +640,8 @@ 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
-multiple plug-ins are specified in the *CauPluginName* parameter. If a single plug-in is specified,
+When multiple plug-ins are used during an updating run, by default, a failure by one plug-in doesn't affect the application of updates on a node by other plug-ins. This parameter is valid only when
+multiple plug-ins are specified in the **CauPluginName** parameter. If a single plug-in is specified,
 a warning appears.
 
 ```yaml
@@ -659,12 +658,12 @@ Accept wildcard characters: False
 
 ### -SuspendClusterNodeTimeoutMinutes
 
-Specifies the maximum amount of time CAU should wait for the **Suspend-ClusterNode** cmdlet to
+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.
 
-If **Suspend-ClusterNode** fails with ERROR_CLUSTER_SPACE_DEGRADED error, CAU will keep retrying for
-*SuspendClusterNodeTimeoutMinutes* or suspend the call if the command succeeds. The retries for this
-error don not count towards the *MaxRetriesPerNode* parameter set by the user.
+If `Suspend-ClusterNode` fails with ERROR_CLUSTER_SPACE_DEGRADED error, CAU will keep retrying for
+**SuspendClusterNodeTimeoutMinutes** or suspend the call if the command succeeds. The retries for this
+error don't count towards the **MaxRetriesPerNode** parameter set by the user.
 
 The timeout value is per cluster node. So CAU could potentially spend the amount of time specified
 for this value for every node in the cluster in the worst case.
@@ -705,7 +704,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,
+any pre-update and post-update scripts) hasn't completed. By default, no warning will be logged,
 regardless of the time taken by the Updating Run.
 
 ```yaml
@@ -740,7 +739,7 @@ Accept wildcard characters: False
 ### -WhatIf
 
 Shows what would happen if the cmdlet runs.
-The cmdlet is not run.
+The cmdlet isn't run.
 
 ```yaml
 Type: SwitchParameter

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

@@ -17,14 +17,14 @@ Suspends the self-updating functionality on the specified cluster.
 
 ```
 Disable-CauClusterRole [[-ClusterName] <String>] [-Credential <PSCredential>] [-Force] [-WhatIf]
-[-Confirm] [<CommonParameters>]
+ [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
 
-The **Disable-CauClusterRole** cmdlet suspends the self-updating functionality on the specified
+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.
+`Enable-CauClusterRole` cmdlet.
 
 ## EXAMPLES
 
@@ -36,14 +36,14 @@ Disable-CauClusterRole -ClusterName CONTOSO-FC1 -Force
 
 This command prevents the CAU clustered role on the CONTOSO-FC1 cluster from performing Updating
 Runs. The cmdlet changes the status of the CAU clustered role to Offline. Because the command
-specified the *Force* parameter, the cmdlet runs without displaying confirmation prompts.
+specified the **Force** parameter, the cmdlet runs without displaying confirmation prompts.
 
 ## 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
+parameter is only required when this cmdlet isn't run on a failover cluster node, or this cmdlet is
 used to reference a failover cluster different from where the cmdlet is run.
 
 ```yaml
@@ -109,7 +109,7 @@ Accept wildcard characters: False
 ### -WhatIf
 
 Shows what would happen if the cmdlet runs.
-The cmdlet is not run.
+The cmdlet isn't run.
 
 ```yaml
 Type: SwitchParameter

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

@@ -17,14 +17,14 @@ Re-enables the self-updating functionality on the specified cluster.
 
 ```
 Enable-CauClusterRole [[-ClusterName] <String>] [-Credential <PSCredential>] [-Force] [-WhatIf]
-[-Confirm] [<CommonParameters>]
+ [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
 
-The **Enable-CauClusterRole** cmdlet re-enables the self-updating functionality on the specified
+The `Enable-CauClusterRole` cmdlet re-enables the self-updating functionality on the specified
 cluster. The self-updating functionality of the cluster can be disabled with the
-**Disable-CauClusterRole** cmdlet.
+`Disable-CauClusterRole` cmdlet.
 
 ## EXAMPLES
 
@@ -36,14 +36,14 @@ Enable-CauClusterRole -ClusterName "CONTOSO-FC1" -Force
 
 This command enables the CAU clustered role on the CONTOSO-FC1 cluster to begin performing Updating
 Runs. The cmdlet changes the status of the CAU clustered role to Running. Because the command
-specified the *Force* parameter, the cmdlet runs without displaying confirmation prompts.
+specified the **Force** parameter, the cmdlet runs without displaying confirmation prompts.
 
 ## PARAMETERS
 
 ### -ClusterName
 
 Specifies the name of the cluster on which to enable 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
+is only required when this cmdlet isn't run on a failover cluster node, or this cmdlet is used to
 reference a failover cluster different from where the cmdlet is run.
 
 ```yaml
@@ -109,7 +109,7 @@ Accept wildcard characters: False
 ### -WhatIf
 
 Shows what would happen if the cmdlet runs.
-The cmdlet is not run.
+The cmdlet isn't run.
 
 ```yaml
 Type: SwitchParameter