Skip to content

Commit 8f0c237

Browse files
committed
Update formatting
1 parent afcaccb commit 8f0c237

7 files changed

+280
-239
lines changed

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

+80-71
Original file line numberDiff line numberDiff line change
@@ -98,14 +98,14 @@ $parameters = @{
9898
Add-CauClusterRole @parameters
9999
```
100100

101-
This command adds the CAU clustered role, using a default name, on the cluster called `CONTOSO-FC1`.
102-
The CAU clustered role is configured to perform Updating Runs on Tuesdays and Saturdays on the
103-
second and fourth weeks of each month. In an Updating Run, the maximum number of failed nodes is
104-
two and the maximum number of retries per node is two. A script called `verifyupdatesinstalled.ps1`
105-
runs on each node after it has been fully updated. Before an Updating Run can begin, all the nodes
106-
of that cluster must be running. If it isn't already enabled, the Remote Shutdown Windows Firewall
107-
rule group will be enabled on each cluster node. Because the command uses the **Force** parameter,
108-
the cmdlet runs without displaying confirmation prompts.
101+
This command adds the CAU clustered role, using a default name, on the cluster called
102+
**CONTOSO-FC1**. The CAU clustered role is configured to perform Updating Runs on Tuesdays and
103+
Saturdays on the second and fourth weeks of each month. In an Updating Run, the maximum number of
104+
failed nodes is two and the maximum number of retries per node is two. A script called
105+
`verifyupdatesinstalled.ps1` runs on each node after it has been fully updated. Before an Updating
106+
Run can begin, all the nodes of that cluster must be running. If it isn't already enabled, the
107+
Remote Shutdown Windows Firewall rule group will be enabled on each cluster node. Because the
108+
command uses the **Force** parameter, the cmdlet runs without displaying confirmation prompts.
109109

110110
This example uses splatting to pass parameter values from the `$parameters` variable to the command.
111111
Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
@@ -126,14 +126,14 @@ $parameters = @{
126126
Add-CauClusterRole @parameters
127127
```
128128

129-
This command adds the CAU clustered role, using a default name, on the cluster called `CONTOSO-FC1`.
130-
The CAU clustered role is configured to perform Updating Runs on Tuesdays and Saturdays at an
131-
interval of every three weeks. In an Updating Run, the maximum number of failed nodes is two and the
132-
maximum number of retries per node is two. Updating Runs can begin even when the nodes of the
133-
cluster aren't all running (if the cluster itself has quorum and is running). If it isn't already
134-
enabled, the Remote Shutdown Windows Firewall rule group will be enabled on each cluster node.
135-
Because the command uses the **Force** parameter, the cmdlet runs without displaying confirmation
136-
prompts.
129+
This command adds the CAU clustered role, using a default name, on the cluster called
130+
**CONTOSO-FC1**. The CAU clustered role is configured to perform Updating Runs on Tuesdays and
131+
Saturdays at an interval of every three weeks. In an Updating Run, the maximum number of failed
132+
nodes is two and the maximum number of retries per node is two. Updating Runs can begin even when
133+
the nodes of the cluster aren't all running (if the cluster itself has quorum and is running). If
134+
it isn't already enabled, the Remote Shutdown Windows Firewall rule group will be enabled on each
135+
cluster node. Because the command uses the **Force** parameter, the cmdlet runs without displaying
136+
confirmation prompts.
137137

138138
This example uses splatting to pass parameter values from the `$parameters` variable to the command.
139139
Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
@@ -154,15 +154,15 @@ $parameters = @{
154154
Add-CauClusterRole @parameters
155155
```
156156

157-
This command adds the CAU clustered role, using a default name, on the cluster called `CONTOSO-FC1`.
158-
The CAU clustered role is configured to perform updates using the **Microsoft.WindowsUpdatePlugin**
159-
plug-in with the optional **IncludeRecommendedUpdates** parameter set to `True`, and using the
160-
**Microsoft.HotfixPlugin plug-in** using the hotfix root folder `\\CauHotfixSrv\shareName` and the
161-
default hotfix configuration file. If a failure occurs during the installation of updates on a node
162-
by **Microsoft.WindowsUpdatePlugin**, updates are applied by **Microsoft.HotfixPlugin plug-in**. If
163-
it isn't already enabled, the Remote Shutdown Windows Firewall rule group is enabled on each
164-
cluster node. Because the command uses the **Force** parameter, the cmdlet runs without displaying
165-
confirmation prompts.
157+
This command adds the CAU clustered role, using a default name, on the cluster called
158+
**CONTOSO-FC1**. The CAU clustered role is configured to perform updates using the
159+
**Microsoft.WindowsUpdatePlugin** plug-in with the optional **IncludeRecommendedUpdates** parameter
160+
set to `True`, and using the **Microsoft.HotfixPlugin plug-in** using the hotfix root folder
161+
`\\CauHotfixSrv\shareName` and the default hotfix configuration file. If a failure occurs during
162+
the installation of updates on a node by **Microsoft.WindowsUpdatePlugin**, updates are applied by
163+
**Microsoft.HotfixPlugin plug-in**. If it isn't already enabled, the Remote Shutdown Windows
164+
Firewall rule group is enabled on each cluster node. Because the command uses the **Force**
165+
parameter, the cmdlet runs without displaying confirmation prompts.
166166

167167
This example uses splatting to pass parameter values from the `$parameters` variable to the command.
168168
Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
@@ -193,34 +193,42 @@ Accept wildcard characters: False
193193
Specifies a set of name=value pairs, as arguments, for each updating plug-in to use.
194194
195195
For instance, to specify a Domain argument for one plug-in:
196+
196197
- `@{Domain=Domain.local}`
197-
You can specify multiple pairs in a set separated with semicolons.
198-
For instance:
199-
- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the
200-
**CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in,
201-
provide the sets of name=value pairs in the order that you pass values in **CauPluginName**,
202-
separated by commas. For instance:
198+
199+
You can specify multiple pairs in a set separated with semicolons. For instance:
200+
201+
- `@{name1=value1;name2=value2;name3=value3}`
202+
203+
These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If
204+
you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order
205+
that you pass values in **CauPluginName**, separated by commas. For instance:
206+
203207
- `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}`
204208

205-
For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed.
206-
The following arguments are optional:
209+
For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following
210+
arguments are optional:
211+
207212
- **'IncludeRecommendedUpdates'='\<Value\>'**: Boolean value to indicate that recommended updates
208213
will be applied in addition to important updates on each node. If not specified, the default value
209214
is False.
210215
- A standard Windows Update Agent query string that specifies criteria used by the Windows Update
211216
Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and
212217
for a value, enclose the full query in quotation marks. If not specified, then the
213218
**Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument:
214-
- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more
215-
information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the
216-
criteria such as IsInstalled that can be included in the query strings, see
217-
[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search).
219+
- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"`
220+
221+
For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in
222+
and the criteria such as IsInstalled that can be included in the query strings, see
223+
[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search).
218224

219225
For the **Microsoft.HotfixPlugin** plug-in, the following argument is required:
226+
220227
- **HotfixRootFolderPath=\<Path\>**: The UNC path to a hotfix root folder in an SMB share with a
221-
structure that contains the updates to apply and that contains the hotfix configuration file
228+
structure that contains the updates to apply and that contains the hotfix configuration file.
222229

223230
The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in:
231+
224232
- **RequireSmbEncryption=\<Value\>**: Boolean value to indicate that SMB Encryption will be enforced
225233
for accessing data from the SMB share. If not specified, the default value is False. To ensure the
226234
integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled
@@ -231,7 +239,7 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in:
231239
- **HotfixInstallerTimeoutMinutes=\<Integer\>**: The length of time in minutes that the plug-in
232240
allows the hotfix installer process to return. If not specified, the default value is 30 minutes.
233241
- **HotfixConfigFileName=\<name\>**: Name for the hotfix configuration file. If not specified, the
234-
default name DefaultHotfixConfig.xml is used. For more information about required and optional
242+
default name `DefaultHotfixConfig.xml` is used. For more information about required and optional
235243
arguments for the **Microsoft.HotfixPlugin** plug-in, see
236244
[How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins).
237245

@@ -250,10 +258,11 @@ Accept wildcard characters: False
250258
### -CauPluginName
251259

252260
Specifies one or more plug-ins to use when performing scans or updates. You can specify multiple
253-
values separated with commas. The default is the Microsoft.WindowsUpdatePlugin plug-in. This plug-in
254-
coordinates the Windows Update Agent software resident on each cluster node, the same software that
255-
is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows
256-
Server Update Services (WSUS) server. For more information about how plug-ins work with CAU, see
261+
values separated with commas. The default is the **Microsoft.WindowsUpdatePlugin** plug-in. This
262+
plug-in coordinates the Windows Update Agent software resident on each cluster node, the same
263+
software that is used when updates are downloaded from Windows Update or Microsoft Update, or from
264+
a Windows Server Update Services (WSUS) server. For more information about how plug-ins work with
265+
CAU, see
257266
[How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins).
258267

259268
```yaml
@@ -306,22 +315,6 @@ Accept pipeline input: False
306315
Accept wildcard characters: False
307316
```
308317

309-
### -Confirm
310-
311-
Prompts you for confirmation before running the cmdlet.
312-
313-
```yaml
314-
Type: SwitchParameter
315-
Parameter Sets: (All)
316-
Aliases: cf
317-
318-
Required: False
319-
Position: Named
320-
Default value: None
321-
Accept pipeline input: False
322-
Accept wildcard characters: False
323-
```
324-
325318
### -Credential
326319

327320
Specifies the administrative credentials for the target cluster.
@@ -400,9 +393,9 @@ another node.
400393

401394
The acceptable values for this parameter are:
402395

403-
- NoFailback
404-
- Immediate
405-
- Policy
396+
- `NoFailback`
397+
- `Immediate`
398+
- `Policy`
406399

407400
The default value is **Immediate**.
408401

@@ -543,8 +536,8 @@ Accept wildcard characters: False
543536
### -MaxRetriesPerNode
544537

545538
Specifies the maximum number of times that the update process attempts to run. This includes any
546-
pre-update and post-update scripts. The update process is retried per node. The maximum is **64**
547-
and the default is **3**.
539+
pre-update and post-update scripts. The update process is retried per node. The maximum is 64
540+
and the default is 3.
548541

549542
```yaml
550543
Type: Int32
@@ -637,11 +630,11 @@ Accept wildcard characters: False
637630
Specifies the type of reboot to use for each node in the cluster during the update. The available
638631
values are:
639632

640-
- ClusProp
641-
- FullReboot
642-
- SoftReboot
643-
- PluginCustomReboot
644-
- OrchestratorDefault
633+
- `ClusProp`
634+
- `FullReboot`
635+
- `SoftReboot`
636+
- `PluginCustomReboot`
637+
- `OrchestratorDefault`
645638

646639
```yaml
647640
Type: RebootType
@@ -888,7 +881,7 @@ Accept wildcard characters: False
888881

889882
Specifies the name of a pre-staged virtual computer object that is used by the CAU clustered role.
890883
For more information, see
891-
[Steps to create computer objects in Active Directory](https://go.microsoft.com/fwlink/p/?LinkId=237624).
884+
[Steps for prestaging the cluster name account](/windows-server/failover-clustering/configure-ad-accounts#steps-for-prestaging-the-cluster-name-account).
892885
If not specified, then a virtual computer object is created using a generated name. Generating a
893886
name automatically requires the cluster name object to have permissions to create the virtual
894887
computer object in Active Directory.
@@ -942,7 +935,7 @@ Accept wildcard characters: False
942935

943936
### -WeeksOfMonth
944937

945-
Specifies the weeks of the month when the Updating Run should be run. The value `5` represents the
938+
Specifies the weeks of the month when the Updating Run should be run. The value 5 represents the
946939
last week of the month.
947940

948941
```yaml
@@ -957,6 +950,22 @@ Accept pipeline input: False
957950
Accept wildcard characters: False
958951
```
959952

953+
### -Confirm
954+
955+
Prompts you for confirmation before running the cmdlet.
956+
957+
```yaml
958+
Type: SwitchParameter
959+
Parameter Sets: (All)
960+
Aliases: cf
961+
962+
Required: False
963+
Position: Named
964+
Default value: None
965+
Accept pipeline input: False
966+
Accept wildcard characters: False
967+
```
968+
960969
### -WhatIf
961970

962971
Shows what would happen if the cmdlet runs. The cmdlet is not run.

docset/winserver2025-ps/clusterawareupdating/Get-CauDeviceInfoForFeatureUpdates.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ Get-CauDeviceInfoForFeatureUpdates $parameters
3939
```
4040

4141
This command retrieves device information for feature updates from the `C:\Updates` directory for
42-
the cluster named `CONTOSO-FC1`. It also specifies the path to the deployment cab file that will be
43-
created for the update in `C:\Deployment\FeatureUpdate.cab`.
42+
the cluster named **CONTOSO-FC1**. It also specifies the path to the deployment cab file that will
43+
be created for the update in `C:\Deployment\FeatureUpdate.cab`.
4444

4545
## PARAMETERS
4646

0 commit comments

Comments
 (0)