Merge pull request MicrosoftDocs#3132 from robinharwood/roharwoo_cau_stage_2_examples

Bulk example formatting update

Author: sdwheeler

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

@@ -2,7 +2,7 @@
 description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
 external help file: ClusterAwareUpdating.dll-Help.xml
 Module Name: ClusterAwareUpdating
-ms.date: 12/20/2016
+ms.date: 09/27/2022
 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/add-cauclusterrole?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Add-CauClusterRole
@@ -58,8 +58,21 @@ Mode (HTTP-In) firewall exception is enabled on each node.
 
 ### Example 1: Add a CAU clustered role on the specified cluster at a specific interval
 
-```
-PS C:\> Add-CauClusterRole -ClusterName "CONTOSO-FC1" -DaysOfWeek Tuesday,Saturday -WeeksOfMonth 2,4 -MaxFailedNodes 2 -MaxRetriesPerNode 2 -PostUpdateScript \\CONTOSOFileShare\scripts\verifyupdatesinstalled.ps1 -RequireAllNodesOnline -EnableFirewallRules -Force
+```powershell
+$parameters = @{
+    ClusterName = 'CONTOSO-FC1'
+    DaysOfWeek = 'Tuesday',
+                    'Saturday'
+    WeeksOfMonth = '2',
+                    '4'
+    MaxFailedNodes = '2'
+    MaxRetriesPerNode = '2'
+    PostUpdateScript = '\\CONTOSOFileShare\scripts\verifyupdatesinstalled.ps1'
+    RequireAllNodesOnline = $true
+    EnableFirewallRules = $true
+    Force = $true
+}
+Add-CauClusterRole @parameters
 ```
 
 This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1.
@@ -71,10 +84,23 @@ that cluster must be running. If it is not already enabled, the Remote Shutdown
 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.
+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
 
-```
-PS C:\> Add-CauClusterRole -ClusterName "CONTOSO-FC1" -DaysOfWeek Tuesday,Saturday -IntervalWeeks 3 -MaxFailedNodes 2 -MaxRetriesPerNode 2 -EnableFirewallRules -Force
+```powershell
+$parameters = @{
+    ClusterName = 'CONTOSO-FC1'
+    DaysOfWeek = 'Tuesday',
+                    'Saturday'
+    IntervalWeeks = '3'
+    MaxFailedNodes = '2'
+    MaxRetriesPerNode = '2'
+    EnableFirewallRules = $true
+    Force = $true
+}
+Add-CauClusterRole @parameters
 ```
 
 This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1.
@@ -86,10 +112,23 @@ enabled, the Remote Shutdown Windows Firewall rule group will be enabled on each
 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.
+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
 
-```
-PS C:\> Add-CauClusterRole -ClusterName "CONTOSO-FC1" -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{ 'IncludeRecommendedUpdates' = 'True' }, @{ 'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName ' } -StopOnPluginFailure -EnableFirewallRules -Force
+```powershell
+$parameters = @{
+    ClusterName = 'CONTOSO-FC1'
+    CauPluginName = 'Microsoft.WindowsUpdatePlugin',
+                    'Microsoft.HotfixPlugin'
+    CauPluginArguments = @{'IncludeRecommendedUpdates' = 'True'},
+                         @{'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName'}
+    StopOnPluginFailure = $true
+    EnableFirewallRules = $true
+    Force = $true
+}
+Add-CauClusterRole @parameters
 ```
 
 This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1.
@@ -102,6 +141,9 @@ it is not already enabled, the Remote Shutdown Windows Firewall rule group is en
 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.
+Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
+
 ## PARAMETERS
 
 ### -CauPluginArguments

docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md

@@ -5,7 +5,7 @@ Help Version: 5.0.0.1
 Locale: en-US
 Module Guid: 4e804861-1dce-46c1-868d-c8f2ab9d220a
 Module Name: ClusterAwareUpdating
-ms.date: 12/20/2016
+ms.date: 09/27/2022
 title: ClusterAwareUpdating
 ---
 

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

@@ -2,7 +2,7 @@
 description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
 external help file: ClusterAwareUpdating.dll-Help.xml
 Module Name: ClusterAwareUpdating
-ms.date: 12/20/2016
+ms.date: 09/27/2022
 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/disable-cauclusterrole?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Disable-CauClusterRole
@@ -30,8 +30,8 @@ cluster. The self-updating functionality of the cluster can be re-enabled with t
 
 ### Example 1: Disable a CAU clustered role on the specified cluster
 
-```
-PS C:\> Disable-CauClusterRole -ClusterName CONTOSO-FC1 -Force
+```powershell
+Disable-CauClusterRole -ClusterName CONTOSO-FC1 -Force
 ```
 
 This command prevents the CAU clustered role on the CONTOSO-FC1 cluster from performing Updating

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

@@ -2,7 +2,7 @@
 description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
 external help file: ClusterAwareUpdating.dll-Help.xml
 Module Name: ClusterAwareUpdating
-ms.date: 12/20/2016
+ms.date: 09/27/2022
 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/enable-cauclusterrole?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Enable-CauClusterRole
@@ -30,8 +30,8 @@ cluster. The self-updating functionality of the cluster can be disabled with the
 
 ### Example 1: Enable a CAU clustered role on the specified cluster
 
-```
-PS C:\> Enable-CauClusterRole -ClusterName "CONTOSO-FC1" -Force
+```powershell
+Enable-CauClusterRole -ClusterName "CONTOSO-FC1" -Force
 ```
 
 This command enables the CAU clustered role on the CONTOSO-FC1 cluster to begin performing Updating

docset/winserver2022-ps/clusterawareupdating/Export-CauReport.md

@@ -2,7 +2,7 @@
 description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
 external help file: ClusterAwareUpdating.dll-Help.xml
 Module Name: ClusterAwareUpdating
-ms.date: 12/20/2016
+ms.date: 09/27/2022
 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/export-caureport?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Export-CauReport
@@ -34,13 +34,14 @@ cmdlet. For example, the *Last* parameter specifies the most recent Updating Run
 
 ### Example 1: Get a detailed version of the last CAU report for the specified cluster
 
-```
-PS C:\> Get-CauReport -ClusterName "Contoso-FC1" -Last -Detailed | Export-CauReport -Format HTML -Path "C:\temp\contoso-fc1_last.html" -TimeZone ([system.timezoneinfo]::Utc)
+```powershell
+$CauReport = Get-CauReport -ClusterName "Contoso-FC1" -Last -Detailed
+$CauReport | Export-CauReport -Format HTML -Path "C:\temp\contoso-fc1_last.html" -TimeZone ([system.timezoneinfo]::Utc)
 ```
 
 This command gets a detailed version of the last CAU report for the cluster named Contoso-FC1, then
-exports that report in HTML format to the path C:\temp\contoso-fc1_last.html. The timestamps in the
-report are formatted in the Coordinated Universal Time (UTC) zone.
+exports that report in HTML format to the path `C:\temp\contoso-fc1_last.html`. The timestamps in
+the report are formatted in the Coordinated Universal Time (UTC) zone.
 
 ## PARAMETERS
 

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

@@ -2,7 +2,7 @@
 description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
 external help file: ClusterAwareUpdating.dll-Help.xml
 Module Name: ClusterAwareUpdating
-ms.date: 12/20/2016
+ms.date: 09/27/2022
 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-cauclusterrole?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Get-CauClusterRole
@@ -28,20 +28,8 @@ clustered role on the specified cluster.
 
 ### Example 1: Get information about a CAU clustered role on the specified cluster
 
-```
-PS C:\> Get-CauClusterRole -ClusterName "CONTOSO-FC1"
-
-Name                                                        Value 
-----                                                        ----- 
-ResourceGroupName                                           CAUCAUCldy8 
-Status                                                      Online 
-StartDate                                                   10/14/2011 3:00:00 AM 
-MaxFailedNodes                                              2 
-MaxRetriesPerNode                                           2 
-PostUpdateScript                                            G:\verifyupdatesinstalled.ps1 
-RequireAllNodesOnline                                       On 
-DaysOfWeek                                                  Tuesday, Saturday 
-WeeksOfMonth                                                {2, 4}
+```powershell
+Get-CauClusterRole -ClusterName "CONTOSO-FC1"
 ```
 
 This command gets information about the CAU clustered role on the cluster named CONTOSO-FC1.

docset/winserver2022-ps/clusterawareupdating/Get-CauPlugin.md

@@ -2,7 +2,7 @@
 description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
 external help file: ClusterAwareUpdating.dll-Help.xml
 Module Name: ClusterAwareUpdating
-ms.date: 12/20/2016
+ms.date: 09/27/2022
 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-cauplugin?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Get-CauPlugin
@@ -36,15 +36,8 @@ in CAU, see [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=23
 
 ### Example 1: Get information about software update plug-ins
 
-```
-PS C:\> Get-CauPlugin | Format-List -Property "*"
-
-Name       : Microsoft.WindowsUpdatePlugin
-BinaryPath : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\ClusterAwareUpdating\ClusterAwareUpdating.dll
-ClassName  : MS.Internal.ClusterAwareUpdating.WuaPlugin
-Name       : Microsoft.HotfixPlugin
-BinaryPath : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\ClusterAwareUpdating\ClusterAwareUpdating.dll
-ClassName  : MS.Internal.ClusterAwareUpdating.HotfixPlugin
+```powershell
+Get-CauPlugin | Format-List -Property "*"
 ```
 
 This command gets information about the software updating plug-ins that are registered in the local

docset/winserver2022-ps/clusterawareupdating/Get-CauReport.md

@@ -2,7 +2,7 @@
 description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
 external help file: ClusterAwareUpdating.dll-Help.xml
 Module Name: ClusterAwareUpdating
-ms.date: 12/20/2016
+ms.date: 09/27/2022
 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-caureport?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Get-CauReport
@@ -56,31 +56,31 @@ Run report. By default, the report contains summaries only, but more detail can
 
 ### Example 1: Get a detailed list of updating runs from the specified cluster
 
-```
-PS C:\> Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -Detailed
+```powershell
+Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -Detailed
 ```
 
 This command gets a detailed list of the updating runs performed on the cluster named Contoso-FC1 on
 01/01/2012 or later.
 
 ### Example 2: Get a detailed list of updating runs from a date span from the specified cluster
 
-```
-PS C:\> Get-CauReport -ClusterName "Contoso-FC1" -StartDate 01/01/2012 -EndDate 04/01/2012 -Detailed
+```powershell
+Get-CauReport -ClusterName "Contoso-FC1" -StartDate 01/01/2012 -EndDate 04/01/2012 -Detailed
 ```
 
 This command gets a detailed list of the updating runs performed on the cluster called Contoso-FC1
 starting with updating runs on 01/01/2012 and ending with updating runs on 04/01/2012.
 
 ### Example 3: Get the last updating run summary from the specified cluster
 
-```
-PS C:\> $CauReportSummary = Get-CauReport "Contoso-FC1" -Last
-PS C:\> Get-CauReport "Contoso-FC1" -Report $CauReportSummary
+```powershell
+$CauReportSummary = Get-CauReport "Contoso-FC1" -Last
+Get-CauReport "Contoso-FC1" -Report $CauReportSummary
 ```
 
 The first command gets the last updating run report summary from the cluster named Contoso-FC1 and
-stores the result in the variable named $CauReportSummary.
+stores the result in the variable named `$CauReportSummary`.
 
 The second command gets the detailed report from the information stored in the $CauReportSummary
 variable.

docset/winserver2022-ps/clusterawareupdating/Get-CauRun.md

@@ -2,7 +2,7 @@
 description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
 external help file: ClusterAwareUpdating.dll-Help.xml
 Module Name: ClusterAwareUpdating
-ms.date: 12/20/2016
+ms.date: 09/27/2022
 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-caurun?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Get-CauRun
@@ -51,9 +51,11 @@ Use this cmdlet to monitor current updating runs.
 
 ### Example 1: Get status information about the updating run in progress from the specified cluster
 
+```powershell
+Get-CauRun -ClusterName "CONTOSO-FC1"
 ```
-PS C:\> Get-CauRun -ClusterName "CONTOSO-FC1"
 
+```output
 RunId                   : 834dd11e-584b-41f2-8d22-4c9c0471dbad 
 RunStartTime            : 10/13/2011 1:35:39 PM 
 CurrentOrchestrator     : NODE1 

docset/winserver2022-ps/clusterawareupdating/Invoke-CauRun.md

@@ -2,7 +2,7 @@
 description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
 external help file: ClusterAwareUpdating.dll-Help.xml
 Module Name: ClusterAwareUpdating
-ms.date: 12/20/2016
+ms.date: 09/27/2022
 online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/invoke-caurun?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
 schema: 2.0.0
 title: Invoke-CauRun
@@ -58,8 +58,16 @@ exception is enabled on each node.
 
 ### Example 1: Preform a scan and a full updating run on the specified cluster
 
-```
-PS C:\> Invoke-CauRun -ClusterName "CONTOSO-FC1" -CauPluginName "Microsoft.WindowsUpdatePlugin" -MaxFailedNodes 1 -MaxRetriesPerNode 3 -RequireAllNodesOnline -Force
+```powershell
+$parameters = @{
+    ClusterName = 'CONTOSO-FC1'
+    CauPluginName = 'Microsoft.WindowsUpdatePlugin'
+    MaxFailedNodes = '1'
+    MaxRetriesPerNode = '3'
+    RequireAllNodesOnline = $true
+    Force = $true
+}
+Invoke-CauRun @parameters
 ```
 
 This command performs a scan and a full updating run on the cluster named CONTOSO-FC1. This cmdlet
@@ -69,10 +77,24 @@ before marking the node as failed, and allows no more than one node to fail befo
 entire updating run as failed. Because the command specifies 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.
+Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
+
 ### Example 2: Preform a scan and a full updating run on the specified cluster using multiple plug-ins
 
-```
-PS C:\> Invoke-CauRun -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{ }, @{ 'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName' } -EnableFirewallRules -StopOnPluginFailure -SeparateReboots -Force
+```powershell
+$parameters = @{
+    ClusterName = 'CONTOSO-FC1'
+    CauPluginName = 'Microsoft.WindowsUpdatePlugin',
+                    'Microsoft.HotfixPlugin'
+    CauPluginArguments = @{ },
+                         @{'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName'}
+    StopOnPluginFailure = $true
+    EnableFirewallRules = $true
+    SeparateReboots = $true
+    Force = $true
+}
+Invoke-CauRun @parameters
 ```
 
 This command performs a scan and a full updating run on the cluster named CONTOSO-FC1. This cmdlet
@@ -86,10 +108,13 @@ applied by **Microsoft.HotfixPlugin plug-in**. If the installation of updates by
 **Microsoft.HotfixPlugin plug-in** installs updates. Because the command specifies 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.
+Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
+
 ### Example 3: Recover from a previous updating run that failed on the specified cluster
 
-```
-PS C:\> Invoke-CauRun -ClusterName "CONTOSO-FC1"-ForceRecovery -Force
+```powershell
+Invoke-CauRun -ClusterName "CONTOSO-FC1"-ForceRecovery -Force
 ```
 
 This command recovers from a previous updating run that failed and left the cluster in a Locked