Skip to content

Commit f20a65c

Browse files
robinharwoodrobinharwood
committed
Formatting and metadata updates
1 parent 6e404de commit f20a65c

18 files changed

+85
-81
lines changed

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

+33-28
Original file line numberDiff line numberDiff line change
@@ -18,44 +18,48 @@ Adds the Cluster Aware Updating (CAU) clustered role that provides the self-upda
1818
### MonthlyDayOfWeek (Default)
1919

2020
```
21-
Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>] [-StartDate <DateTime>]
22-
[-DaysOfWeek <Weekdays>] [-WeeksOfMonth <Int32[]>] [-CauPluginName <String[]>]
23-
[-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>] [-MaxRetriesPerNode <Int32>]
24-
[-NodeOrder <String[]>] [-PreUpdateScript <String>] [-PostUpdateScript <String>] [-ConfigurationName <String>]
25-
[-RequireAllNodesOnline] [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>]
26-
[-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules]
27-
[-FailbackMode <FailbackType>] [-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain]
28-
[-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
29-
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
30-
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
22+
[-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-WeeksOfMonth <Int32[]>]
23+
[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
24+
[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
25+
[-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
26+
[-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
27+
[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
28+
[-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
29+
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
30+
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
31+
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
3132
```
3233

3334
### Weekly
3435

3536
```
36-
Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>] [-StartDate <DateTime>]
37-
[-DaysOfWeek <Weekdays>] [-IntervalWeeks <Int32>] [-CauPluginName <String[]>]
38-
[-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>] [-MaxRetriesPerNode <Int32>]
39-
[-NodeOrder <String[]>] [-PreUpdateScript <String>] [-PostUpdateScript <String>] [-ConfigurationName <String>]
40-
[-RequireAllNodesOnline] [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>]
41-
[-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules]
42-
[-FailbackMode <FailbackType>] [-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain]
43-
[-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
44-
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
45-
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
37+
Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
38+
[-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-IntervalWeeks <Int32>]
39+
[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
40+
[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
41+
[-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
42+
[-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
43+
[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
44+
[-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
45+
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
46+
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
47+
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
4648
```
4749

4850
### Once
51+
4952
```
5053
Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>] [-RunOnce]
51-
[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
52-
[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>] [-PostUpdateScript <String>]
53-
[-ConfigurationName <String>] [-RequireAllNodesOnline] [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>]
54-
[-RebootTimeoutMinutes <Int32>] [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure]
55-
[-EnableFirewallRules] [-FailbackMode <FailbackType>] [-SuspendClusterNodeTimeoutMinutes <Int32>]
56-
[-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks]
57-
[-SiteAwareUpdatingOrder <String[]>] [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>]
58-
[[-ClusterName] <String>] [[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
54+
[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
55+
[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
56+
[-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
57+
[-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
58+
[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
59+
[-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
60+
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
61+
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
62+
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
5963
```
6064

6165
## DESCRIPTION
@@ -72,6 +76,7 @@ Mode (HTTP-In) firewall exception is enabled on each node.
7276
## EXAMPLES
7377

7478
### Example 1: Add a CAU clustered role on the specified cluster at a specific interval
79+
7580
```powershell
7681
$parameters = @{
7782
ClusterName = 'CONTOSO-FC1'

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

-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,6 @@ Accept wildcard characters: False
124124
```
125125
126126
### CommonParameters
127-
128127
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
129128
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
130129
-WarningAction, and -WarningVariable. For more information, see

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

+2-3
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ Enable-CauClusterRole -ClusterName "CONTOSO-FC1" -Force
3535
```
3636

3737
This command enables the CAU clustered role on the CONTOSO-FC1 cluster to begin performing Updating
38-
Runs. The cmdlet changes the status of the CAU clustered role to Running. Because the command
39-
specified the **Force** parameter, the cmdlet runs without displaying confirmation prompts.
38+
Runs. The cmdlet changes the status of the CAU clustered role to Running. The cmdlet runs without
39+
displaying confirmation prompts, as the **Force** parameter was used.
4040

4141
## PARAMETERS
4242

@@ -124,7 +124,6 @@ Accept wildcard characters: False
124124
```
125125
126126
### CommonParameters
127-
128127
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
129128
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
130129
-WarningAction, and -WarningVariable. For more information, see

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

-1
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,6 @@ Accept wildcard characters: False
179179
```
180180
181181
### CommonParameters
182-
183182
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
184183
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
185184
-WarningAction, and -WarningVariable. For more information, see

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

-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ Accept wildcard characters: False
7171
```
7272
7373
### CommonParameters
74-
7574
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
7675
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
7776
-WarningAction, and -WarningVariable. For more information, see

‎docset/winserver2022-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,18 @@ The **Get-CauDeviceInfoForFeatureUpdates** cmdlet gets device information for fe
2626
## EXAMPLES
2727

2828
### Example 1: Get device information
29+
2930
```powershell
30-
Get-CauDeviceInfoForFeatureUpdates -ClusterName "CONTOSO-FC1" -PathToDirectory "C:\temp\contoso-device-info"
31+
$Parameters = @{
32+
ClusterName = 'CONTOSO-FC1'
33+
PathToDirectory = 'C:\temp\contoso-device-info'
34+
}
35+
Get-CauDeviceInfoForFeatureUpdates $Parameters
3136
```
3237

33-
This example gets device information for CAU for the specified cluster.
38+
This example gets device information for CAU for the specified cluster. This example uses
39+
splatting to pass parameter values from the `$Parameters` variable to the command. Learn more about
40+
[Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
3441

3542
## PARAMETERS
3643

@@ -80,7 +87,10 @@ Accept wildcard characters: False
8087
```
8188
8289
### CommonParameters
83-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
90+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
91+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
92+
-WarningAction, and -WarningVariable. For more information, see
93+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
8494
8595
## INPUTS
8696

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

-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ Accept wildcard characters: False
6363
```
6464
6565
### CommonParameters
66-
6766
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
6867
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
6968
-WarningAction, and -WarningVariable. For more information, see

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

+12-11
Original file line numberDiff line numberDiff line change
@@ -19,38 +19,40 @@ specified dates or other specified parameters.
1919
### AllParamsSet (Default)
2020

2121
```
22-
Get-CauReport [[-ClusterName] <String>] [-Detailed] [-Credential <PSCredential>] [<CommonParameters>]
22+
Get-CauReport [[-ClusterName] <String>] [-Detailed] [-Credential <PSCredential>]
23+
[<CommonParameters>]
2324
```
2425

2526
### RangeParamSet
2627

2728
```
28-
Get-CauReport [[-ClusterName] <String>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [-Detailed]
29-
[-Credential <PSCredential>] [<CommonParameters>]
29+
Get-CauReport [[-ClusterName] <String>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>]
30+
[-Detailed] [-Credential <PSCredential>] [<CommonParameters>]
3031
```
3132

3233
### LastParamSet
3334

3435
```
35-
Get-CauReport [[-ClusterName] <String>] [-Last] [-Detailed] [-Credential <PSCredential>] [<CommonParameters>]
36+
Get-CauReport [[-ClusterName] <String>] [-Last] [-Detailed] [-Credential <PSCredential>]
37+
[<CommonParameters>]
3638
```
3739

3840
### SpecificReportParamSet
3941

4042
```
4143
Get-CauReport [[-ClusterName] <String>] [-Report <CauReportSummary>] [-Credential <PSCredential>]
42-
[<CommonParameters>]
44+
[<CommonParameters>]
4345
```
4446

4547
## DESCRIPTION
4648

4749
The `Get-CauReport` cmdlet gets the Updating Run reports for all known Updating Runs, or all
4850
Updating Runs that match the specified dates or other specified parameters. This cmdlet can return a
49-
list of all Updating Run reports between the specified **StartDate** and **EndDate** parameters, or if
50-
the **Last** parameter is specified instead of dates, then the cmdlet returns the most recent Updating
51-
Run report. By default, the report contains summaries only, but more detail can be obtained with the
52-
**Detailed** parameter or by using the **Report** parameter and specifying a Cluster-Aware Updating
53-
(CAU) report summary object.
51+
list of all Updating Run reports between the specified **StartDate** and **EndDate** parameters, or
52+
if the **Last** parameter is specified instead of dates, then the cmdlet returns the most recent
53+
Updating Run report. By default, the report contains summaries only, but more detail can be obtained
54+
with the **Detailed** parameter or by using the **Report** parameter and specifying a Cluster-Aware
55+
Updating (CAU) report summary object.
5456

5557
## EXAMPLES
5658

@@ -202,7 +204,6 @@ Accept wildcard characters: False
202204
```
203205
204206
### CommonParameters
205-
206207
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
207208
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
208209
-WarningAction, and -WarningVariable. For more information, see

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

-1
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,6 @@ Accept wildcard characters: False
166166
```
167167
168168
### CommonParameters
169-
170169
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
171170
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
172171
-WarningAction, and -WarningVariable. For more information, see

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

+5-6
Original file line numberDiff line numberDiff line change
@@ -160,11 +160,11 @@ The following arguments are optional:
160160
- **'IncludeRecommendedUpdates'='\<Value\>'**: Boolean value to indicate that recommended updates
161161
will be applied in addition to important updates on each node. If not specified, the default value
162162
is **'False'**.
163-
-- A standard Windows Update Agent query string that specifies criteria used by the Windows Update
164-
Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and
165-
for a value, enclose the full query in quotation marks. If not specified, then the
166-
**Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument:
167-
- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"`
163+
- A standard Windows Update Agent query string that specifies criteria used by the Windows Update
164+
Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and
165+
for a value, enclose the full query in quotation marks. If not specified, then the
166+
**Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument:
167+
- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"`
168168

169169
For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in
170170
and the criteria such as IsInstalled that can be included in the query strings, see
@@ -782,7 +782,6 @@ Accept wildcard characters: False
782782
```
783783

784784
### CommonParameters
785-
786785
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
787786
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
788787
-WarningAction, and -WarningVariable. For more information, see

‎docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ For instance:
110110
- `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}`
111111

112112
For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed.
113+
113114
The following arguments are optional:
114115
- **'IncludeRecommendedUpdates'='\<Value\>'**: Boolean value to indicate that recommended updates
115116
will be applied in addition to important updates on each node. If not specified, the default value
@@ -118,7 +119,7 @@ The following arguments are optional:
118119
Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and
119120
for a value, enclose the full query in quotation marks. If not specified, then the
120121
**Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument:
121-
- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"`
122+
- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"`
122123

123124
For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in
124125
and the criteria such as IsInstalled that can be included in the query strings, see
@@ -163,7 +164,9 @@ Specifies one or more plug-ins to use when performing scans. You can specify mul
163164
separated with commas. The default is the **Microsoft.WindowsUpdatePlugin** plug-in. This plug-in
164165
coordinates the Windows Update Agent software resident on each cluster node, the same software that
165166
is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows
166-
Server Update Services (WSUS) server. For more information about how plug-ins work with
167+
Server Update Services (WSUS) server.
168+
169+
For more information about how plug-ins work with
167170
Cluster-Aware Updating (CAU), see
168171
[Cluster-Aware Updating plug-ins](https://go.microsoft.com/fwlink/p/?LinkId=235333).
169172

@@ -288,7 +291,6 @@ Accept wildcard characters: False
288291
```
289292

290293
### CommonParameters
291-
292294
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
293295
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
294296
-WarningAction, and -WarningVariable. For more information, see

‎docset/winserver2022-ps/clusterawareupdating/Register-CauPlugin.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ Register-CauPlugin -Path "C:\PluginDevelopment\Plugin01.dll" -Force
4040
```
4141

4242
The command registers a plug-in called Plugin01.dll located in the C:\PluginDevelopment folder.
43-
Because the command specifies the **Force** parameter, the cmdlet runs without displaying confirmation
44-
prompts.
43+
Because the command specifies the **Force** parameter, the cmdlet runs without displaying
44+
confirmation prompts.
4545

4646
## PARAMETERS
4747

‎docset/winserver2022-ps/clusterawareupdating/Remove-CauClusterRole.md

-1
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,6 @@ Accept wildcard characters: False
128128
```
129129
130130
### CommonParameters
131-
132131
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
133132
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
134133
-WarningAction, and -WarningVariable. For more information, see

‎docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md

-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,6 @@ Accept wildcard characters: False
142142
```
143143

144144
### CommonParameters
145-
146145
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
147146
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
148147
-WarningAction, and -WarningVariable. For more information, see

0 commit comments

Comments
 (0)