Skip to content

Commit ae19fed

Browse files
committed
Bulk example formatting update
1 parent b69ee06 commit ae19fed

18 files changed

+193
-96
lines changed

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

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: ClusterAwareUpdating.dll-Help.xml
44
Module Name: ClusterAwareUpdating
5-
ms.date: 12/20/2016
5+
ms.date: 09/27/2022
66
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/add-cauclusterrole?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Add-CauClusterRole
@@ -54,8 +54,21 @@ Mode (HTTP-In) firewall exception is enabled on each node.
5454
## EXAMPLES
5555

5656
### Example 1: Add a CAU clustered role on the specified cluster at a specific interval
57-
```
58-
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
57+
```powershell
58+
$parameters = @{
59+
ClusterName = 'CONTOSO-FC1'
60+
DaysOfWeek = 'Tuesday',
61+
'Saturday'
62+
WeeksOfMonth = '2',
63+
'4'
64+
MaxFailedNodes = '2'
65+
MaxRetriesPerNode = '2'
66+
PostUpdateScript = '\\CONTOSOFileShare\scripts\verifyupdatesinstalled.ps1'
67+
RequireAllNodesOnline = $true
68+
EnableFirewallRules = $true
69+
Force = $true
70+
}
71+
Add-CauClusterRole @parameters
5972
```
6073

6174
This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1.
@@ -67,9 +80,22 @@ that cluster must be running. If it is not already enabled, the Remote Shutdown
6780
rule group will be enabled on each cluster node. Because the command uses the *Force* parameter, the
6881
cmdlet runs without displaying confirmation prompts.
6982

83+
This example uses splatting to pass parameter values from the `$Parameters` variable to the command.
84+
Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
85+
7086
### Example 2: Add a CAU clustered role on the specified cluster at a specific interval
71-
```
72-
PS C:\> Add-CauClusterRole -ClusterName "CONTOSO-FC1" -DaysOfWeek Tuesday,Saturday -IntervalWeeks 3 -MaxFailedNodes 2 -MaxRetriesPerNode 2 -EnableFirewallRules -Force
87+
```powershell
88+
$parameters = @{
89+
ClusterName = 'CONTOSO-FC1'
90+
DaysOfWeek = 'Tuesday',
91+
'Saturday'
92+
IntervalWeeks = '3'
93+
MaxFailedNodes = '2'
94+
MaxRetriesPerNode = '2'
95+
EnableFirewallRules = $true
96+
Force = $true
97+
}
98+
Add-CauClusterRole @parameters
7399
```
74100

75101
This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1.
@@ -81,9 +107,22 @@ enabled, the Remote Shutdown Windows Firewall rule group will be enabled on each
81107
Because the command uses the *Force* parameter, the cmdlet runs without displaying confirmation
82108
prompts.
83109

110+
This example uses splatting to pass parameter values from the `$Parameters` variable to the command.
111+
Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
112+
84113
### Example 3: Add a CAU clustered role on the specified cluster using plug-ins
85-
```
86-
PS C:\> Add-CauClusterRole -ClusterName "CONTOSO-FC1" -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{ 'IncludeRecommendedUpdates' = 'True' }, @{ 'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName ' } -StopOnPluginFailure -EnableFirewallRules -Force
114+
```powershell
115+
$parameters = @{
116+
ClusterName = 'CONTOSO-FC1'
117+
CauPluginName = 'Microsoft.WindowsUpdatePlugin',
118+
'Microsoft.HotfixPlugin'
119+
CauPluginArguments = @{'IncludeRecommendedUpdates' = 'True'},
120+
@{'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName'}
121+
StopOnPluginFailure = $true
122+
EnableFirewallRules = $true
123+
Force = $true
124+
}
125+
Add-CauClusterRole @parameters
87126
```
88127

89128
This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1.
@@ -96,6 +135,9 @@ it is not already enabled, the Remote Shutdown Windows Firewall rule group is en
96135
cluster node. Because the command uses the *Force* parameter, the cmdlet runs without displaying
97136
confirmation prompts.
98137

138+
This example uses splatting to pass parameter values from the `$Parameters` variable to the command.
139+
Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
140+
99141
## PARAMETERS
100142

101143
### -CauPluginArguments

docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Help Version: 5.0.0.1
55
Locale: en-US
66
Module Guid: 4e804861-1dce-46c1-868d-c8f2ab9d220a
77
Module Name: ClusterAwareUpdating
8-
ms.date: 12/20/2016
8+
ms.date: 09/27/2022
99
title: ClusterAwareUpdating
1010
---
1111

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: ClusterAwareUpdating.dll-Help.xml
44
Module Name: ClusterAwareUpdating
5-
ms.date: 12/20/2016
5+
ms.date: 09/27/2022
66
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/disable-cauclusterrole?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Disable-CauClusterRole
@@ -28,8 +28,8 @@ cluster. The self-updating functionality of the cluster can be re-enabled with t
2828
## EXAMPLES
2929

3030
### Example 1: Disable a CAU clustered role on the specified cluster
31-
```
32-
PS C:\> Disable-CauClusterRole -ClusterName CONTOSO-FC1 -Force
31+
```powershell
32+
Disable-CauClusterRole -ClusterName CONTOSO-FC1 -Force
3333
```
3434

3535
This command prevents the CAU clustered role on the CONTOSO-FC1 cluster from performing Updating

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: ClusterAwareUpdating.dll-Help.xml
44
Module Name: ClusterAwareUpdating
5-
ms.date: 12/20/2016
5+
ms.date: 09/27/2022
66
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/enable-cauclusterrole?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Enable-CauClusterRole
@@ -28,8 +28,8 @@ cluster. The self-updating functionality of the cluster can be disabled with the
2828
## EXAMPLES
2929

3030
### Example 1: Enable a CAU clustered role on the specified cluster
31-
```
32-
PS C:\> Enable-CauClusterRole -ClusterName "CONTOSO-FC1" -Force
31+
```powershell
32+
Enable-CauClusterRole -ClusterName "CONTOSO-FC1" -Force
3333
```
3434

3535
This command enables the CAU clustered role on the CONTOSO-FC1 cluster to begin performing Updating

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: ClusterAwareUpdating.dll-Help.xml
44
Module Name: ClusterAwareUpdating
5-
ms.date: 12/20/2016
5+
ms.date: 09/27/2022
66
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/export-caureport?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Export-CauReport
@@ -32,8 +32,9 @@ cmdlet. For example, the *Last* parameter specifies the most recent Updating Run
3232
## EXAMPLES
3333

3434
### Example 1: Get a detailed version of the last CAU report for the specified cluster
35-
```
36-
PS C:\> Get-CauReport -ClusterName "Contoso-FC1" -Last -Detailed | Export-CauReport -Format HTML -Path "C:\temp\contoso-fc1_last.html" -TimeZone ([system.timezoneinfo]::Utc)
35+
```powershell
36+
$CauReport = Get-CauReport -ClusterName "Contoso-FC1" -Last -Detailed
37+
$CauReport | Export-CauReport -Format HTML -Path "C:\temp\contoso-fc1_last.html" -TimeZone ([system.timezoneinfo]::Utc)
3738
```
3839

3940
This command gets a detailed version of the last CAU report for the cluster named Contoso-FC1, then

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

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: ClusterAwareUpdating.dll-Help.xml
44
Module Name: ClusterAwareUpdating
5-
ms.date: 12/20/2016
5+
ms.date: 09/27/2022
66
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-cauclusterrole?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-CauClusterRole
@@ -26,20 +26,8 @@ clustered role on the specified cluster.
2626
## EXAMPLES
2727

2828
### Example 1: Get information about a CAU clustered role on the specified cluster
29-
```
30-
PS C:\> Get-CauClusterRole -ClusterName "CONTOSO-FC1"
31-
32-
Name Value
33-
---- -----
34-
ResourceGroupName CAUCAUCldy8
35-
Status Online
36-
StartDate 10/14/2011 3:00:00 AM
37-
MaxFailedNodes 2
38-
MaxRetriesPerNode 2
39-
PostUpdateScript G:\verifyupdatesinstalled.ps1
40-
RequireAllNodesOnline On
41-
DaysOfWeek Tuesday, Saturday
42-
WeeksOfMonth {2, 4}
29+
```powershell
30+
Get-CauClusterRole -ClusterName "CONTOSO-FC1"
4331
```
4432

4533
This command gets information about the CAU clustered role on the cluster named CONTOSO-FC1.

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

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: ClusterAwareUpdating.dll-Help.xml
44
Module Name: ClusterAwareUpdating
5-
ms.date: 12/20/2016
5+
ms.date: 09/27/2022
66
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-cauplugin?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-CauPlugin
@@ -34,15 +34,8 @@ in CAU, see [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=23
3434
## EXAMPLES
3535

3636
### Example 1: Get information about software update plug-ins
37-
```
38-
PS C:\> Get-CauPlugin | Format-List -Property "*"
39-
40-
Name : Microsoft.WindowsUpdatePlugin
41-
BinaryPath : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\ClusterAwareUpdating\ClusterAwareUpdating.dll
42-
ClassName : MS.Internal.ClusterAwareUpdating.WuaPlugin
43-
Name : Microsoft.HotfixPlugin
44-
BinaryPath : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\ClusterAwareUpdating\ClusterAwareUpdating.dll
45-
ClassName : MS.Internal.ClusterAwareUpdating.HotfixPlugin
37+
```powershell
38+
Get-CauPlugin | Format-List -Property "*"
4639
```
4740

4841
This command gets information about the software updating plug-ins that are registered in the local

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: ClusterAwareUpdating.dll-Help.xml
44
Module Name: ClusterAwareUpdating
5-
ms.date: 12/20/2016
5+
ms.date: 09/27/2022
66
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-caureport?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-CauReport
@@ -50,25 +50,25 @@ Run report. By default, the report contains summaries only, but more detail can
5050
## EXAMPLES
5151

5252
### Example 1: Get a detailed list of updating runs from the specified cluster
53-
```
54-
PS C:\> Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -Detailed
53+
```powershell
54+
Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -Detailed
5555
```
5656

5757
This command gets a detailed list of the updating runs performed on the cluster named Contoso-FC1 on
5858
01/01/2012 or later.
5959

6060
### Example 2: Get a detailed list of updating runs from a date span from the specified cluster
61-
```
62-
PS C:\> Get-CauReport -ClusterName "Contoso-FC1" -StartDate 01/01/2012 -EndDate 04/01/2012 -Detailed
61+
```powershell
62+
Get-CauReport -ClusterName "Contoso-FC1" -StartDate 01/01/2012 -EndDate 04/01/2012 -Detailed
6363
```
6464

6565
This command gets a detailed list of the updating runs performed on the cluster called Contoso-FC1
6666
starting with updating runs on 01/01/2012 and ending with updating runs on 04/01/2012.
6767

6868
### Example 3: Get the last updating run summary from the specified cluster
69-
```
70-
PS C:\> $CauReportSummary = Get-CauReport "Contoso-FC1" -Last
71-
PS C:\> Get-CauReport "Contoso-FC1" -Report $CauReportSummary
69+
```powershell
70+
$CauReportSummary = Get-CauReport "Contoso-FC1" -Last
71+
Get-CauReport "Contoso-FC1" -Report $CauReportSummary
7272
```
7373

7474
The first command gets the last updating run report summary from the cluster named Contoso-FC1 and

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: ClusterAwareUpdating.dll-Help.xml
44
Module Name: ClusterAwareUpdating
5-
ms.date: 12/20/2016
5+
ms.date: 09/27/2022
66
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-caurun?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-CauRun
@@ -45,9 +45,11 @@ Use this cmdlet to monitor current updating runs.
4545
## EXAMPLES
4646

4747
### Example 1: Get status information about the updating run in progress from the specified cluster
48+
```powershell
49+
Get-CauRun -ClusterName "CONTOSO-FC1"
4850
```
49-
PS C:\> Get-CauRun -ClusterName "CONTOSO-FC1"
5051

52+
```output
5153
RunId : 834dd11e-584b-41f2-8d22-4c9c0471dbad
5254
RunStartTime : 10/13/2011 1:35:39 PM
5355
CurrentOrchestrator : NODE1

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

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: ClusterAwareUpdating.dll-Help.xml
44
Module Name: ClusterAwareUpdating
5-
ms.date: 12/20/2016
5+
ms.date: 09/27/2022
66
online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/invoke-caurun?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Invoke-CauRun
@@ -54,8 +54,16 @@ exception is enabled on each node.
5454
## EXAMPLES
5555

5656
### Example 1: Preform a scan and a full updating run on the specified cluster
57-
```
58-
PS C:\> Invoke-CauRun -ClusterName "CONTOSO-FC1" -CauPluginName "Microsoft.WindowsUpdatePlugin" -MaxFailedNodes 1 -MaxRetriesPerNode 3 -RequireAllNodesOnline -Force
57+
```powershell
58+
$parameters = @{
59+
ClusterName = 'CONTOSO-FC1'
60+
CauPluginName = 'Microsoft.WindowsUpdatePlugin'
61+
MaxFailedNodes = '1'
62+
MaxRetriesPerNode = '3'
63+
RequireAllNodesOnline = $true
64+
Force = $true
65+
}
66+
Invoke-CauRun @parameters
5967
```
6068

6169
This command performs a scan and a full updating run on the cluster named CONTOSO-FC1. This cmdlet
@@ -65,9 +73,23 @@ before marking the node as failed, and allows no more than one node to fail befo
6573
entire updating run as failed. Because the command specifies the *Force* parameter, the cmdlet runs
6674
without displaying confirmation prompts.
6775

76+
This example uses splatting to pass parameter values from the `$Parameters` variable to the command.
77+
Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
78+
6879
### Example 2: Preform a scan and a full updating run on the specified cluster using multiple plug-ins
69-
```
70-
PS C:\> Invoke-CauRun -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{ }, @{ 'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName' } -EnableFirewallRules -StopOnPluginFailure -SeparateReboots -Force
80+
```powershell
81+
$parameters = @{
82+
ClusterName = 'CONTOSO-FC1'
83+
CauPluginName = 'Microsoft.WindowsUpdatePlugin',
84+
'Microsoft.HotfixPlugin'
85+
CauPluginArguments = @{ },
86+
@{'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName'}
87+
StopOnPluginFailure = $true
88+
EnableFirewallRules = $true
89+
SeparateReboots = $true
90+
Force = $true
91+
}
92+
Invoke-CauRun @parameters
7193
```
7294

7395
This command performs a scan and a full updating run on the cluster named CONTOSO-FC1. This cmdlet
@@ -81,9 +103,12 @@ applied by **Microsoft.HotfixPlugin plug-in**. If the installation of updates by
81103
**Microsoft.HotfixPlugin plug-in** installs updates. Because the command specifies the *Force*
82104
parameter, the cmdlet runs without displaying confirmation prompts.
83105

106+
This example uses splatting to pass parameter values from the `$Parameters` variable to the command.
107+
Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
108+
84109
### Example 3: Recover from a previous updating run that failed on the specified cluster
85-
```
86-
PS C:\> Invoke-CauRun -ClusterName "CONTOSO-FC1"-ForceRecovery -Force
110+
```powershell
111+
Invoke-CauRun -ClusterName "CONTOSO-FC1"-ForceRecovery -Force
87112
```
88113

89114
This command recovers from a previous updating run that failed and left the cluster in a Locked

0 commit comments

Comments
 (0)