You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md
+11-6
Original file line number
Diff line number
Diff line change
@@ -11,8 +11,9 @@ title: ClusterAwareUpdating
11
11
12
12
# ClusterAwareUpdating Module
13
13
## 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.
16
17
17
18
## ClusterAwareUpdating Cmdlets
18
19
### [Add-CauClusterRole](./Add-CauClusterRole.md)
@@ -31,19 +32,23 @@ Exports one or more Updating Run reports into an HTML or CSV-formatted document.
31
32
Gets configuration properties of the CAU clustered role on the specified cluster.
32
33
33
34
### [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.
35
37
36
38
### [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.
38
41
39
42
### [Get-CauRun](./Get-CauRun.md)
40
43
Gets status information about an updating run currently in progress.
41
44
42
45
### [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.
44
48
45
49
### [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.
47
52
48
53
### [Register-CauPlugin](./Register-CauPlugin.md)
49
54
Registers a CAU software updating plug-in on the local computer.
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.
37
38
38
39
## PARAMETERS
39
40
40
41
### -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.
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,
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.
37
38
38
39
## PARAMETERS
39
40
40
41
### -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.
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,
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.
26
27
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.
29
31
30
32
## EXAMPLES
31
33
@@ -34,8 +36,9 @@ For example, the *Last* parameter specifies the most recent Updating Run.
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.
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,
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.
24
25
25
26
## EXAMPLES
26
27
@@ -46,8 +47,9 @@ This command gets information about the CAU clustered role on the cluster named
46
47
## PARAMETERS
47
48
48
49
### -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.
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,
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.
25
27
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).
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,
0 commit comments