Skip to content

Commit 54091ae

Browse files
authored
Update formatting
1 parent 69533f4 commit 54091ae

File tree

1 file changed

+30
-23
lines changed

1 file changed

+30
-23
lines changed

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

+30-23
Original file line numberDiff line numberDiff line change
@@ -147,51 +147,58 @@ Accept wildcard characters: False
147147
148148
### -CauPluginArguments
149149
150-
Specifies a set of name=value pairs for each updating plug-in to use.
150+
Specifies a set of name=value pairs, as arguments, for each updating plug-in to use.
151+
151152
For instance, to specify a Domain argument for one plug-in:
153+
152154
- `@{Domain=Domain.local}`
153-
You can specify multiple pairs in a set separated with semicolons.
154-
For instance:
155-
- `@{name1=value1;name2=value2;name3=value3}` These name=value pairs must be meaningful to the
156-
**CauPluginName** that you specify. If you specify arguments for more than one plug-in, provide
157-
the sets of name=value pairs in the order that you pass values in **CauPluginName**, separated by
158-
commas. For instance:
155+
156+
You can specify multiple pairs in a set separated with semicolons. For instance:
157+
158+
- `@{name1=value1;name2=value2;name3=value3}`
159+
160+
These name=value pairs must be meaningful to the **CauPluginName** parameter that you specify. If
161+
you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order
162+
that you pass values in **CauPluginName**, separated by commas. For instance:
163+
159164
- `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}`
160165

161-
For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed.
162-
The following arguments are optional:
166+
For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. The following
167+
arguments are optional:
168+
163169
- **'IncludeRecommendedUpdates'='\<Value\>'**: Boolean value to indicate that recommended updates
164170
will be applied in addition to important updates on each node. If not specified, the default value
165-
is **'False'**.
171+
is False.
166172
- A standard Windows Update Agent query string that specifies criteria used by the Windows Update
167173
Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and
168174
for a value, enclose the full query in quotation marks. If not specified, then the
169175
**Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument:
170-
- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"`
176+
- `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"`
171177

172178
For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in
173179
and the criteria such as IsInstalled that can be included in the query strings, see
174180
[IUpdateSearcher::Search method](/windows/win32/api/wuapi/nf-wuapi-iupdatesearcher-search).
175181

176182
For the **Microsoft.HotfixPlugin** plug-in, the following argument is required:
177-
- **HotfixRootFolderPath**: The UNC path to a hotfix root folder in an SMB share with a structure
178-
that contains the updates to apply and that contains the hotfix configuration file.
183+
184+
- **HotfixRootFolderPath=\<Path\>**: The UNC path to a hotfix root folder in an SMB share with a
185+
structure that contains the updates to apply and that contains the hotfix configuration file.
179186

180187
The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in:
181-
- **RequireSmbEncryption=\<Value\>**: Boolean value to indicate that SMB Encryption is enforced for
182-
data accessed from the SMB share. If not specified, the default value is False. To ensure the
188+
189+
- **RequireSmbEncryption=\<Value\>**: Boolean value to indicate that SMB Encryption will be enforced
190+
for accessing data from the SMB share. If not specified, the default value is False. To ensure the
183191
integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled
184192
for either SMB signing or SMB Encryption.
185-
- **DisableAclChecks=\<Value\>**: Boolean value to indicate that the plug-in checks for sufficient
186-
permissions on the hotfix root folder and the hotfix configuration file. If not specified, the
187-
default value is False.
193+
- **DisableAclChecks=\<Value\>**: Boolean value to indicate that the plug-in will check for
194+
sufficient permissions on the hotfix root folder and the hotfix configuration file. If not
195+
specified, the default value is False.
188196
- **HotfixInstallerTimeoutMinutes=\<Integer\>**: The length of time in minutes that the plug-in
189197
allows the hotfix installer process to return. If not specified, the default value is 30 minutes.
190-
- **HotfixConfigFileName=\<name\>**: Name for the hotfix configuration file.
191-
If not specified, the default name `DefaultHotfixConfig.xml` is used.
192-
193-
For more information about required and optional arguments for the **Microsoft.HotfixPlugin**
194-
plug-in, see [How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins).
198+
- **HotfixConfigFileName=\<name\>**: Name for the hotfix configuration file. If not specified, the
199+
default name `DefaultHotfixConfig.xml` is used. For more information about required and optional
200+
arguments for the **Microsoft.HotfixPlugin** plug-in, see
201+
[How Cluster-Aware Updating plug-ins work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins).
195202

196203
```yaml
197204
Type: Hashtable[]

0 commit comments

Comments
 (0)