Skip to content

Commit 7e9c82b

Browse files
committed
Update formatting
1 parent 7a71443 commit 7e9c82b

8 files changed

+58
-57
lines changed

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

+39-38
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ to a cluster, the failover cluster can update itself on the schedule that is spe
7070
without requiring an external computer to coordinate the cluster updating process.
7171

7272
To run this cmdlet, Windows PowerShell® remoting must be enabled on each node. To do this, run the
73-
`Enable-PSRemoting` cmdlet. In addition, ensure that the Windows Remote Management - Compatibility
74-
Mode (HTTP-In) firewall exception is enabled on each node.
73+
`Enable-PSRemoting` cmdlet. In addition, ensure that the **Windows Remote Management - Compatibility
74+
Mode (HTTP-In)** firewall exception is enabled on each node.
7575

7676
## EXAMPLES
7777

@@ -94,14 +94,14 @@ $parameters = @{
9494
Add-CauClusterRole @parameters
9595
```
9696

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

106106
This example uses splatting to pass parameter values from the `$parameters` variable to the command.
107107
Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
@@ -122,7 +122,7 @@ $parameters = @{
122122
Add-CauClusterRole @parameters
123123
```
124124

125-
This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1.
125+
This command adds the CAU clustered role, using a default name, on the cluster called **CONTOSO-FC1**.
126126
The CAU clustered role is configured to perform Updating Runs on Tuesdays and Saturdays at an
127127
interval of every three weeks. In an Updating Run, the maximum number of failed nodes is two and the
128128
maximum number of retries per node is two. Updating Runs can begin even when the nodes of the
@@ -150,7 +150,7 @@ $parameters = @{
150150
Add-CauClusterRole @parameters
151151
```
152152

153-
This command adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1.
153+
This command adds the CAU clustered role, using a default name, on the cluster called **CONTOSO-FC1**.
154154
The CAU clustered role is configured to perform updates using the **Microsoft.WindowsUpdatePlugin**
155155
plug-in with the optional **IncludeRecommendedUpdates** parameter set to True, and using the
156156
**Microsoft.HotfixPlugin plug-in** using the hotfix root folder `\\CauHotfixSrv\shareName` and the
@@ -187,18 +187,18 @@ Accept wildcard characters: False
187187
### -CauPluginArguments
188188
189189
Specifies an array of name=value pairs (arguments) for each updating plug-in to use.
190-
For instance, to specify a Domain argument for one plug-in:
190+
For instance, to specify a Domain argument for one plug-in:
191191
- `@{Domain=Domain.local}`
192192
You can specify multiple pairs in a set separated with semicolons.
193-
For instance:
193+
For instance:
194194
- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the
195195
**CauPluginName** parameter that you specify. If you specify arguments for more than one plug-in,
196196
provide the sets of name=value pairs in the order that you pass values in **CauPluginName**,
197197
separated by commas. For instance:
198198
- `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}`
199199

200200
For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed.
201-
The following arguments are optional:
201+
The following arguments are optional:
202202
- **'IncludeRecommendedUpdates'='\<Value\>'**: Boolean value to indicate that recommended updates
203203
will be applied in addition to important updates on each node. If not specified, the default value
204204
is False.
@@ -209,14 +209,14 @@ The following arguments are optional:
209209
- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` For more
210210
information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the
211211
criteria such as IsInstalled that can be included in the query strings, see
212-
[IUpdateSearcher::Search method](https://go.microsoft.com/fwlink/p/?LinkId=223304).
212+
[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search).
213213

214214
For the **Microsoft.HotfixPlugin** plug-in.
215-
the following argument is required:
215+
the following argument is required:
216216
- **HotfixRootFolderPath=\<Path\>**: The UNC path to a hotfix root folder in an SMB share with a
217217
structure that contains the updates to apply and that contains the hotfix configuration file
218218

219-
The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in:
219+
The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in:
220220
- **RequireSmbEncryption=\<Value\>**: Boolean value to indicate that SMB Encryption will be enforced
221221
for accessing data from the SMB share. If not specified, the default value is False. To ensure the
222222
integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled
@@ -246,10 +246,11 @@ Accept wildcard characters: False
246246
### -CauPluginName
247247

248248
Specifies one or more plug-ins to use when performing scans or updates. You can specify multiple
249-
values separated with commas. The default is the Microsoft.WindowsUpdatePlugin plug-in. This plug-in
250-
coordinates the Windows Update Agent software resident on each cluster node, the same software that
251-
is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows
252-
Server Update Services (WSUS) server. For more information about how plug-ins work with CAU, see
249+
values separated with commas. The default is the **Microsoft.WindowsUpdatePlugin** plug-in. This
250+
plug-in coordinates the Windows Update Agent software resident on each cluster node, the same
251+
software that is used when updates are downloaded from Windows Update or Microsoft Update, or from
252+
a Windows Server Update Services (WSUS) server. For more information about how plug-ins work with
253+
CAU, see
253254
[How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins).
254255

255256
```yaml
@@ -302,22 +303,6 @@ Accept pipeline input: False
302303
Accept wildcard characters: False
303304
```
304305

305-
### -Confirm
306-
307-
Prompts you for confirmation before running the cmdlet.
308-
309-
```yaml
310-
Type: SwitchParameter
311-
Parameter Sets: (All)
312-
Aliases: cf
313-
314-
Required: False
315-
Position: Named
316-
Default value: False
317-
Accept pipeline input: False
318-
Accept wildcard characters: False
319-
```
320-
321306
### -Credential
322307

323308
Specifies the administrative credentials for the target cluster.
@@ -920,6 +905,22 @@ Accept pipeline input: False
920905
Accept wildcard characters: False
921906
```
922907

908+
### -Confirm
909+
910+
Prompts you for confirmation before running the cmdlet.
911+
912+
```yaml
913+
Type: SwitchParameter
914+
Parameter Sets: (All)
915+
Aliases: cf
916+
917+
Required: False
918+
Position: Named
919+
Default value: False
920+
Accept pipeline input: False
921+
Accept wildcard characters: False
922+
```
923+
923924
### -WhatIf
924925

925926
Shows what would happen if the cmdlet runs.

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ cluster. The self-updating functionality of the cluster can be disabled with the
3434
Enable-CauClusterRole -ClusterName "CONTOSO-FC1" -Force
3535
```
3636

37-
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. The cmdlet runs without
39-
displaying confirmation prompts, as the **Force** parameter was used.
37+
This command enables the CAU clustered role on the **CONTOSO-FC1** cluster to begin performing
38+
Updating Runs. The cmdlet changes the status of the CAU clustered role to Running. The cmdlet runs
39+
without displaying confirmation prompts, as the **Force** parameter was used.
4040

4141
## PARAMETERS
4242

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Updating (CAU) report summary object.
6262
Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -Detailed
6363
```
6464

65-
This command gets a detailed list of the updating runs performed on the cluster named `Contoso-FC1`
65+
This command gets a detailed list of the updating runs performed on the cluster named **Contoso-FC1**
6666
on 01/01/2012 or later.
6767

6868
### Example 2: Get a detailed list of updating runs from a date span from the specified cluster
@@ -71,7 +71,7 @@ on 01/01/2012 or later.
7171
Get-CauReport -ClusterName "Contoso-FC1" -StartDate 01/01/2012 -EndDate 04/01/2012 -Detailed
7272
```
7373

74-
This command gets a detailed list of the updating runs performed on the cluster called `Contoso-FC1`
74+
This command gets a detailed list of the updating runs performed on the cluster called **Contoso-FC1**
7575
starting with updating runs on 01/01/2012 and ending with updating runs on 04/01/2012.
7676

7777
### Example 3: Get the last updating run summary from the specified cluster
@@ -81,7 +81,7 @@ $CauReportSummary = Get-CauReport "Contoso-FC1" -Last
8181
Get-CauReport "Contoso-FC1" -Report $CauReportSummary
8282
```
8383

84-
The first command gets the last updating run report summary from the cluster named `Contoso-FC1` and
84+
The first command gets the last updating run report summary from the cluster named **Contoso-FC1** and
8585
stores the result in the variable named `$CauReportSummary`.
8686

8787
The second command gets the detailed report from the information stored in the `$CauReportSummary`

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ $parameters = @{
100100
Invoke-CauRun @parameters
101101
```
102102

103-
This command performs a scan and a full updating run on the cluster named `CONTOSO-FC1`. This cmdlet
103+
This command performs a scan and a full updating run on the cluster named **CONTOSO-FC1**. This cmdlet
104104
uses the **Microsoft.WindowsUpdatePlugin** plug-in with the default configuration, and the
105105
**Microsoft.HotfixPlugin** plug-in using the hotfix root folder `\\CauHotfixSrv\shareName` and the
106106
default hotfix configuration file. If it isn't already enabled, the **Remote Shutdown** Windows
@@ -121,7 +121,7 @@ Invoke-CauRun -ClusterName "CONTOSO-FC1"-ForceRecovery -Force
121121
```
122122

123123
This command recovers from a previous updating run that failed and left the cluster in a Locked
124-
state for the cluster named `CONTOSO-FC1`. Because the command specifies the **Force** parameter,
124+
state for the cluster named **CONTOSO-FC1**. Because the command specifies the **Force** parameter,
125125
the recovery is performed without confirmation prompts.
126126

127127
## PARAMETERS

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ Invoke-CauScan -ClusterName "CONTOSO-FC1" -CauPluginName "Microsoft.WindowsUpdat
4444
```
4545

4646
This command gets a detailed list of the initial set of updates that would currently be applied to
47-
each node in the cluster named `CONTOSO-FC1`. The list is based on the updates that would be applied
48-
by the **Microsoft.WindowsUpdatePlugin** plug-in, which is the default plug-in. The preview list
49-
includes only an initial set of updates, and doesn't include updates that might become applicable
50-
only after the initial updates are installed.
47+
each node in the cluster named **CONTOSO-FC1**. The list is based on the updates that would be
48+
applied by the **Microsoft.WindowsUpdatePlugin** plug-in, which is the default plug-in. The preview
49+
list includes only an initial set of updates, and doesn't include updates that might become
50+
applicable only after the initial updates are installed.
5151

5252
### Example 2: Get a detailed list of the initial set of updates on the specified cluster using a query string
5353

@@ -68,7 +68,7 @@ Invoke-CauScan $parameters -Credential $Cred
6868
```
6969

7070
This example gets a detailed list of the initial set of updates that would currently be applied to
71-
each node in the cluster named `CONTOSO-FC1`. The list is based on the updates that would be applied
71+
each node in the cluster named **CONTOSO-FC1**. The list is based on the updates that would be applied
7272
by the **Microsoft.WindowsUpdatePlugin** plug-in, using a specified query string, and the
7373
**Microsoft.HotfixPlugin**, after the necessary hotfixes and the hotfix configuration file have been
7474
downloaded to `\\CauHotfixSrv\shareName`. This example also shows how to pass the administrative

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Services (WSUS) server. For more information about how plug-ins work in CAU, see
3939
Register-CauPlugin -Path "C:\PluginDevelopment\Plugin01.dll" -Force
4040
```
4141

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

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Compatibility Mode (HTTP-In)** firewall exception is enabled on each node.
3838
Save-CauDebugTrace -ClusterName "CONTOSO-FC1" -FilePath "C:\temp\testrun.zip"
3939
```
4040

41-
This command saves the debug tracing information for the cluster named `CONTOSO-FC1`, to a trace
41+
This command saves the debug tracing information for the cluster named **CONTOSO-FC1**, to a trace
4242
file called `testrun.zip` in the `C:\temp` folder.
4343

4444
## PARAMETERS

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ $parameters = @{
102102
Set-CauClusterRole $parameters
103103
```
104104

105-
This command configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. The
105+
This command configures settings for the CAU clustered role on the cluster named **CONTOSO-FC1**. The
106106
CAU clustered role is configured to perform updating runs on Tuesdays on the first and second weeks
107107
of each month. The CAU clustered role allows 10 minutes for the restarting of each node, if a
108108
restart is necessary. If the restart doesn't complete within this time, then the updating run on
@@ -139,7 +139,7 @@ DaysOfWeek Tuesday
139139
WeeksInterval 2
140140
```
141141

142-
This command configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. The
142+
This command configures settings for the CAU clustered role on the cluster named **CONTOSO-FC1**. The
143143
CAU clustered role is configured to perform updating runs on Tuesdays on the second week of each
144144
month. The CAU clustered role allows 10 minutes for the restarting of each node, if a restart is
145145
necessary. If the restart doesn't complete within this time, then the updating run on that node is
@@ -158,7 +158,7 @@ Set-CauClusterRole -ClusterName "CONTOSO-FC1" -UpdateNow -Force
158158
```
159159

160160
This command causes the CAU clustered role to initiate an updating run immediately on the cluster
161-
named `CONTOSO-FC1`. Because the command specifies the **Force** parameter, the cmdlet runs without
161+
named **CONTOSO-FC1**. Because the command specifies the **Force** parameter, the cmdlet runs without
162162
displaying confirmation prompts
163163

164164
### Example 4: Configure settings for a CAU cluster role on the specified cluster
@@ -176,7 +176,7 @@ $parameters = @{
176176
Set-CauClusterRole @parameters
177177
```
178178

179-
This example configures settings for the CAU clustered role on the cluster named `CONTOSO-FC1`. Time
179+
This example configures settings for the CAU clustered role on the cluster named **CONTOSO-FC1**. Time
180180
spans are specified for logging a warning or canceling the updating run if it isn't completed. The
181181
earliest date that an updating run can be triggered is 1/1/2012. Because the command specifies the
182182
**Force** parameter, the cmdlet runs without displaying confirmation prompts.

0 commit comments

Comments
 (0)