Skip to content

Commit 6f930d2

Browse files
authored
Merge pull request MicrosoftDocs#3131 from robinharwood/roharwoo_cau_stage_1_reflow
Bulk reflow of the clusterawareupdatingmodule
2 parents f2e1a61 + b968569 commit 6f930d2

18 files changed

+738
-472
lines changed

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

+156-107
Large diffs are not rendered by default.

docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ title: ClusterAwareUpdating
1111

1212
# ClusterAwareUpdating Module
1313
## Description
14-
This reference provides cmdlet descriptions and syntax for all Cluster-Aware Updating-specific cmdlets.
15-
It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.
14+
This reference provides cmdlet descriptions and syntax for all Cluster-Aware Updating-specific
15+
cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the
16+
cmdlet.
1617

1718
## ClusterAwareUpdating Cmdlets
1819
### [Add-CauClusterRole](./Add-CauClusterRole.md)
@@ -31,19 +32,23 @@ Exports one or more Updating Run reports into an HTML or CSV-formatted document.
3132
Gets configuration properties of the CAU clustered role on the specified cluster.
3233

3334
### [Get-CauPlugin](./Get-CauPlugin.md)
34-
Gets information about one or more software updating plug-ins that are registered on the local computer.
35+
Gets information about one or more software updating plug-ins that are registered on the local
36+
computer.
3537

3638
### [Get-CauReport](./Get-CauReport.md)
37-
Gets the Updating Run reports for all known Updating Runs, or all Updating Runs that match the specified dates or other specified parameters.
39+
Gets the Updating Run reports for all known Updating Runs, or all Updating Runs that match the
40+
specified dates or other specified parameters.
3841

3942
### [Get-CauRun](./Get-CauRun.md)
4043
Gets status information about an updating run currently in progress.
4144

4245
### [Invoke-CauRun](./Invoke-CauRun.md)
43-
Performs a scan of cluster nodes for applicable updates and installs those updates through an updating run on the specified cluster.
46+
Performs a scan of cluster nodes for applicable updates and installs those updates through an
47+
updating run on the specified cluster.
4448

4549
### [Invoke-CauScan](./Invoke-CauScan.md)
46-
Performs a scan of cluster nodes for applicable updates and gets a list of the initial set of updates that are applied to each node in a specified cluster.
50+
Performs a scan of cluster nodes for applicable updates and gets a list of the initial set of
51+
updates that are applied to each node in a specified cluster.
4752

4853
### [Register-CauPlugin](./Register-CauPlugin.md)
4954
Registers a CAU software updating plug-in on the local computer.

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

+15-10
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ Suspends the self-updating functionality on the specified cluster.
1616
## SYNTAX
1717

1818
```
19-
Disable-CauClusterRole [[-ClusterName] <String>] [-Credential <PSCredential>] [-Force] [-WhatIf] [-Confirm]
20-
[<CommonParameters>]
19+
Disable-CauClusterRole [[-ClusterName] <String>] [-Credential <PSCredential>] [-Force] [-WhatIf]
20+
[-Confirm] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
The **Disable-CauClusterRole** cmdlet suspends the self-updating functionality on the specified cluster.
25-
The self-updating functionality of the cluster can be re-enabled with the **Enable-CauClusterRole** cmdlet.
24+
The **Disable-CauClusterRole** cmdlet suspends the self-updating functionality on the specified
25+
cluster. The self-updating functionality of the cluster can be re-enabled with the
26+
**Enable-CauClusterRole** cmdlet.
2627

2728
## EXAMPLES
2829

@@ -31,15 +32,16 @@ The self-updating functionality of the cluster can be re-enabled with the **Enab
3132
PS C:\> Disable-CauClusterRole -ClusterName CONTOSO-FC1 -Force
3233
```
3334

34-
This command prevents the CAU clustered role on the CONTOSO-FC1 cluster from performing Updating Runs.
35-
The cmdlet changes the status of the CAU clustered role to Offline.
36-
Because the command specified the *Force* parameter, the cmdlet runs without displaying confirmation prompts.
35+
This command prevents the CAU clustered role on the CONTOSO-FC1 cluster from performing Updating
36+
Runs. The cmdlet changes the status of the CAU clustered role to Offline. Because the command
37+
specified the *Force* parameter, the cmdlet runs without displaying confirmation prompts.
3738

3839
## PARAMETERS
3940

4041
### -ClusterName
41-
Specifies the name of the cluster on which to disable the self-updating functionality.
42-
This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.
42+
Specifies the name of the cluster on which to disable the self-updating functionality. This
43+
parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is
44+
used to reference a failover cluster different from where the cmdlet is run.
4345

4446
```yaml
4547
Type: String
@@ -115,7 +117,10 @@ Accept wildcard characters: False
115117
```
116118
117119
### CommonParameters
118-
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).
120+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
121+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
122+
-WarningAction, and -WarningVariable. For more information, see
123+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
119124
120125
## INPUTS
121126

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

+15-10
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ Re-enables the self-updating functionality on the specified cluster.
1616
## SYNTAX
1717

1818
```
19-
Enable-CauClusterRole [[-ClusterName] <String>] [-Credential <PSCredential>] [-Force] [-WhatIf] [-Confirm]
20-
[<CommonParameters>]
19+
Enable-CauClusterRole [[-ClusterName] <String>] [-Credential <PSCredential>] [-Force] [-WhatIf]
20+
[-Confirm] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
The **Enable-CauClusterRole** cmdlet re-enables the self-updating functionality on the specified cluster.
25-
The self-updating functionality of the cluster can be disabled with the **Disable-CauClusterRole** cmdlet.
24+
The **Enable-CauClusterRole** cmdlet re-enables the self-updating functionality on the specified
25+
cluster. The self-updating functionality of the cluster can be disabled with the
26+
**Disable-CauClusterRole** cmdlet.
2627

2728
## EXAMPLES
2829

@@ -31,15 +32,16 @@ The self-updating functionality of the cluster can be disabled with the **Disabl
3132
PS C:\> Enable-CauClusterRole -ClusterName "CONTOSO-FC1" -Force
3233
```
3334

34-
This command enables the CAU clustered role on the CONTOSO-FC1 cluster to begin performing Updating Runs.
35-
The cmdlet changes the status of the CAU clustered role to Running.
36-
Because the command specified the *Force* parameter, the cmdlet runs without displaying confirmation prompts.
35+
This command enables the CAU clustered role on the CONTOSO-FC1 cluster to begin performing Updating
36+
Runs. The cmdlet changes the status of the CAU clustered role to Running. Because the command
37+
specified the *Force* parameter, the cmdlet runs without displaying confirmation prompts.
3738

3839
## PARAMETERS
3940

4041
### -ClusterName
41-
Specifies the name of the cluster on which to enable the self-updating functionality.
42-
This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.
42+
Specifies the name of the cluster on which to enable the self-updating functionality. This parameter
43+
is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to
44+
reference a failover cluster different from where the cmdlet is run.
4345

4446
```yaml
4547
Type: String
@@ -115,7 +117,10 @@ Accept wildcard characters: False
115117
```
116118
117119
### CommonParameters
118-
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).
120+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
121+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
122+
-WarningAction, and -WarningVariable. For more information, see
123+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
119124
120125
## INPUTS
121126

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

+17-10
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,18 @@ Exports one or more Updating Run reports into an HTML or CSV-formatted document.
1616
## SYNTAX
1717

1818
```
19-
Export-CauReport [-InputReport] <CauReport[]> [-Format] <OutputType> [-Path] <String> [-PassThru] [-Force]
20-
[-TimeZone <TimeZoneInfo>] [-WhatIf] [-Confirm] [<CommonParameters>]
19+
Export-CauReport [-InputReport] <CauReport[]> [-Format] <OutputType> [-Path] <String> [-PassThru]
20+
[-Force] [-TimeZone <TimeZoneInfo>] [-WhatIf] [-Confirm] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
The **Export-CauReport** cmdlet exports one or more Updating Run reports into an HTML or CSV-formatted document.
25-
Each Run report summarizes both the node-level and cluster-level summary status for the Updating Run.
24+
The **Export-CauReport** cmdlet exports one or more Updating Run reports into an HTML or
25+
CSV-formatted document. Each Run report summarizes both the node-level and cluster-level summary
26+
status for the Updating Run.
2627

27-
Pipe one or more reports from the **Get-CauReport** cmdlet with the *Detailed* parameter, and control the content in the report by specifying appropriate parameters for the **Get-CauReport** cmdlet.
28-
For example, the *Last* parameter specifies the most recent Updating Run.
28+
Pipe one or more reports from the **Get-CauReport** cmdlet with the *Detailed* parameter, and
29+
control the content in the report by specifying appropriate parameters for the **Get-CauReport**
30+
cmdlet. For example, the *Last* parameter specifies the most recent Updating Run.
2931

3032
## EXAMPLES
3133

@@ -34,8 +36,9 @@ For example, the *Last* parameter specifies the most recent Updating Run.
3436
PS C:\> Get-CauReport -ClusterName "Contoso-FC1" -Last -Detailed | Export-CauReport -Format HTML -Path "C:\temp\contoso-fc1_last.html" -TimeZone ([system.timezoneinfo]::Utc)
3537
```
3638

37-
This command gets a detailed version of the last CAU report for the cluster named Contoso-FC1, then exports that report in HTML format to the path C:\temp\contoso-fc1_last.html.
38-
The timestamps in the report are formatted in the Coordinated Universal Time (UTC) zone.
39+
This command gets a detailed version of the last CAU report for the cluster named Contoso-FC1, then
40+
exports that report in HTML format to the path C:\temp\contoso-fc1_last.html. The timestamps in the
41+
report are formatted in the Coordinated Universal Time (UTC) zone.
3942

4043
## PARAMETERS
4144

@@ -87,7 +90,8 @@ Accept wildcard characters: False
8790
```
8891
8992
### -InputReport
90-
Specifies an array of CAU report objects, such as generated from a call to Get-CauReport with the *Detailed* parameter.
93+
Specifies an array of CAU report objects, such as generated from a call to Get-CauReport with the
94+
*Detailed* parameter.
9195
9296
```yaml
9397
Type: CauReport[]
@@ -164,7 +168,10 @@ Accept wildcard characters: False
164168
```
165169
166170
### CommonParameters
167-
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).
171+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
172+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
173+
-WarningAction, and -WarningVariable. For more information, see
174+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
168175
169176
## INPUTS
170177

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

+9-4
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ Get-CauClusterRole [[-ClusterName] <String>] [-Credential <PSCredential>] [<Comm
2020
```
2121

2222
## DESCRIPTION
23-
The **Get-CauClusterRole** cmdlet gets configuration properties of the Cluster-Aware Updating (CAU) clustered role on the specified cluster.
23+
The **Get-CauClusterRole** cmdlet gets configuration properties of the Cluster-Aware Updating (CAU)
24+
clustered role on the specified cluster.
2425

2526
## EXAMPLES
2627

@@ -46,8 +47,9 @@ This command gets information about the CAU clustered role on the cluster named
4647
## PARAMETERS
4748

4849
### -ClusterName
49-
Specifies the name of the cluster for which the CAU clustered role information that this cmdlet gets.
50-
This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.
50+
Specifies the name of the cluster for which the CAU clustered role information that this cmdlet
51+
gets. This parameter is only required when this cmdlet is not run on a failover cluster node, or
52+
this cmdlet is used to reference a failover cluster different from where the cmdlet is run.
5153

5254
```yaml
5355
Type: String
@@ -77,7 +79,10 @@ Accept wildcard characters: False
7779
```
7880
7981
### CommonParameters
80-
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).
82+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
83+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
84+
-WarningAction, and -WarningVariable. For more information, see
85+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
8186
8287
## INPUTS
8388

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

+16-9
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ title: Get-CauPlugin
1111
# Get-CauPlugin
1212

1313
## SYNOPSIS
14-
Gets information about one or more software updating plug-ins that are registered on the local computer.
14+
Gets information about one or more software updating plug-ins that are registered on the local
15+
computer.
1516

1617
## SYNTAX
1718

@@ -20,13 +21,15 @@ Get-CauPlugin [[-Name] <String>] [<CommonParameters>]
2021
```
2122

2223
## DESCRIPTION
23-
The **Get-CauPlugin** cmdlet gets information about one or more software updating plug-ins that are registered on the local computer.
24-
A plug-in can be specified or information can be retrieved about all registered plug-ins.
24+
The **Get-CauPlugin** cmdlet gets information about one or more software updating plug-ins that are
25+
registered on the local computer. A plug-in can be specified or information can be retrieved about
26+
all registered plug-ins.
2527

26-
CAU always uses a plug-in when performing updates.
27-
The default is the **Microsoft.WindowsUpdatePlugin** plug-in.
28-
This plug-in communicates with the Windows Update agent, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server.
29-
For more information about how plug-ins work in CAU, see [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333).
28+
CAU always uses a plug-in when performing updates. The default is the
29+
**Microsoft.WindowsUpdatePlugin** plug-in. This plug-in communicates with the Windows Update agent,
30+
the same software that is used when updates are downloaded from Windows Update or Microsoft Update,
31+
or from a Windows Server Update Services (WSUS) server. For more information about how plug-ins work
32+
in CAU, see [How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333).
3033

3134
## EXAMPLES
3235

@@ -42,7 +45,8 @@ BinaryPath : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\ClusterAwareUpda
4245
ClassName : MS.Internal.ClusterAwareUpdating.HotfixPlugin
4346
```
4447

45-
This command gets information about the software updating plug-ins that are registered in the local CAU tool.
48+
This command gets information about the software updating plug-ins that are registered in the local
49+
CAU tool.
4650

4751
## PARAMETERS
4852

@@ -63,7 +67,10 @@ Accept wildcard characters: False
6367
```
6468
6569
### CommonParameters
66-
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).
70+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
71+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
72+
-WarningAction, and -WarningVariable. For more information, see
73+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
6774
6875
## INPUTS
6976

0 commit comments

Comments
 (0)