Skip to content

Commit 26b3086

Browse files
committed
2nd pass
1 parent 0c65f2b commit 26b3086

10 files changed

+258
-223
lines changed

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

+18-11
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in:
229229
- **HotfixConfigFileName=\<name\>**: Name for the hotfix configuration file. If not specified, the
230230
default name DefaultHotfixConfigFile.xml is used. For more information about required and optional
231231
arguments for the **Microsoft.HotfixPlugin** plug-in, see
232-
[How CAU Plug-ins Work](https://go.microsoft.com/fwlink/p/?LinkId=235333).
232+
[How CAU Plug-ins Work](/windows-server/failover-clustering/cluster-aware-updating-plug-ins).
233233

234234
```yaml
235235
Type: Hashtable[]
@@ -631,13 +631,20 @@ Accept wildcard characters: False
631631

632632
### -RebootMode
633633

634-
{{ Fill RebootMode Description }}
634+
Specifies the type of reboot to use for each node in the cluster during the update. The available
635+
values are:
636+
637+
- `ClusProp`
638+
- `FullReboot`
639+
- `SoftReboot`
640+
- `PluginCustomReboot`
641+
- `OrchestratorDefault`
635642

636643
```yaml
637644
Type: RebootType
638645
Parameter Sets: (All)
639646
Aliases:
640-
Accepted values: ClusProp, FullReboot, SoftReboot
647+
Accepted values: ClusProp, FullReboot, SoftReboot, PluginCustomReboot, OrchestratorDefault
641648
642649
Required: False
643650
Position: Named
@@ -682,7 +689,8 @@ Accept wildcard characters: False
682689

683690
### -RunOnce
684691

685-
{{ Fill RunOnce Description }}
692+
Specifies that the CAU run should only be performed once, rather than on a recurring schedule. This
693+
can be useful if you only need to perform a one-time update of your cluster nodes.
686694

687695
```yaml
688696
Type: SwitchParameter
@@ -934,7 +942,7 @@ Accept wildcard characters: False
934942
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
935943
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
936944
-WarningAction, and -WarningVariable. For more information, see
937-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
945+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
938946

939947
## INPUTS
940948

@@ -948,13 +956,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
948956

949957
## RELATED LINKS
950958

951-
[Disable-CauClusterRole](./Disable-CauClusterRole.md)
952-
953-
[Enable-CauClusterRole](./Enable-CauClusterRole.md)
959+
[Disable-CauClusterRole](disable-cauclusterrole.md)
954960

955-
[Get-CauClusterRole](./Get-CauClusterRole.md)
961+
[Enable-CauClusterRole](enable-cauclusterrole.md)
956962

957-
[Remove-CauClusterRole](./Remove-CauClusterRole.md)
963+
[Get-CauClusterRole](get-cauclusterrole.md)
958964

959-
[Set-CauClusterRole](./Set-CauClusterRole.md)
965+
[Remove-CauClusterRole](remove-cauclusterrole.md)
960966

967+
[Set-CauClusterRole](set-cauclusterrole.md)

docset/winserver2022-ps/clusterawareupdating/ClusterAwareUpdating.md

-2
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,3 @@ Tests whether a cluster is properly set up to apply software updates using CAU.
7272

7373
### [Unregister-CauPlugin](./Unregister-CauPlugin.md)
7474
Removes a software updating plug-in from the list of plug-ins that are used by CAU.
75-
76-

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

+20-22
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ 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
37+
This command enables the CAU clustered role on the `CONTOSO-FC1` cluster to begin performing Updating
3838
Runs. The cmdlet changes the status of the CAU clustered role to Running. The cmdlet runs without
3939
displaying confirmation prompts, as the **Force** parameter was used.
4040

@@ -58,28 +58,28 @@ Accept pipeline input: False
5858
Accept wildcard characters: False
5959
```
6060
61-
### -Confirm
61+
### -Credential
6262
63-
Prompts you for confirmation before running the cmdlet.
63+
Specifies the administrative credentials for the target cluster.
6464
6565
```yaml
66-
Type: SwitchParameter
66+
Type: PSCredential
6767
Parameter Sets: (All)
68-
Aliases: cf
68+
Aliases:
6969

7070
Required: False
7171
Position: Named
72-
Default value: False
72+
Default value: None
7373
Accept pipeline input: False
7474
Accept wildcard characters: False
7575
```
7676
77-
### -Credential
77+
### -Force
7878
79-
Specifies the administrative credentials for the target cluster.
79+
Forces the command to run without asking for user confirmation.
8080
8181
```yaml
82-
Type: PSCredential
82+
Type: SwitchParameter
8383
Parameter Sets: (All)
8484
Aliases:
8585

@@ -90,26 +90,25 @@ Accept pipeline input: False
9090
Accept wildcard characters: False
9191
```
9292
93-
### -Force
93+
### -Confirm
9494
95-
Forces the command to run without asking for user confirmation.
95+
Prompts you for confirmation before running the cmdlet.
9696
9797
```yaml
9898
Type: SwitchParameter
9999
Parameter Sets: (All)
100-
Aliases:
100+
Aliases: cf
101101

102102
Required: False
103103
Position: Named
104-
Default value: None
104+
Default value: False
105105
Accept pipeline input: False
106106
Accept wildcard characters: False
107107
```
108108
109109
### -WhatIf
110110
111-
Shows what would happen if the cmdlet runs.
112-
The cmdlet isn't run.
111+
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
113112
114113
```yaml
115114
Type: SwitchParameter
@@ -128,7 +127,7 @@ Accept wildcard characters: False
128127
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
129128
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
130129
-WarningAction, and -WarningVariable. For more information, see
131-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
130+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
132131
133132
## INPUTS
134133
@@ -142,13 +141,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
142141
143142
## RELATED LINKS
144143
145-
[Add-CauClusterRole](./Add-CauClusterRole.md)
146-
147-
[Disable-CauClusterRole](./Disable-CauClusterRole.md)
144+
[Add-CauClusterRole](add-cauclusterrole.md)
148145
149-
[Get-CauClusterRole](./Get-CauClusterRole.md)
146+
[Disable-CauClusterRole](disable-cauclusterrole.md)
150147
151-
[Remove-CauClusterRole](./Remove-CauClusterRole.md)
148+
[Get-CauClusterRole](get-cauclusterrole.md)
152149
153-
[Set-CauClusterRole](./Set-CauClusterRole.md)
150+
[Remove-CauClusterRole](remove-cauclusterrole.md)
154151
152+
[Set-CauClusterRole](set-cauclusterrole.md)

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

+7-6
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Get-CauDeviceInfoForFeatureUpdates [[-ClusterName] <String>] [-Credential <PSCre
2222

2323
## DESCRIPTION
2424

25-
The `Get-CauDeviceInfoForFeatureUpdates` cmdlet gets device information for feature updates to use with Cluster-Aware Updating (CAU).
25+
The `Get-CauDeviceInfoForFeatureUpdates` cmdlet gets device information for feature updates to use
26+
with Cluster-Aware Updating (CAU).
2627

2728
## EXAMPLES
2829

@@ -95,7 +96,7 @@ Accept wildcard characters: False
9596
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
9697
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
9798
-WarningAction, and -WarningVariable. For more information, see
98-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
99+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
99100
100101
## INPUTS
101102
@@ -111,10 +112,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
111112
112113
## RELATED LINKS
113114
114-
[Get-CauClusterRole](Get-CauClusterRole.md)
115+
[Get-CauClusterRole](get-cauclusterrole.md)
115116
116-
[Get-CauPlugin](Get-CauPlugin.md)
117+
[Get-CauPlugin](get-cauplugin.md)
117118
118-
[Get-CauReport](Get-CauReport.md)
119+
[Get-CauReport](get-caureport.md)
119120
120-
[Get-CauRun](Get-CauRun.md)
121+
[Get-CauRun](get-caurun.md)

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

+8-9
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ Get-CauReport [[-ClusterName] <String>] [-Last] [-Detailed] [-Credential <PSCred
4040
### SpecificReportParamSet
4141

4242
```
43-
Get-CauReport [[-ClusterName] <String>] [-Report <CauReportSummary>] [-Credential <PSCredential>]
44-
[<CommonParameters>]
43+
Get-CauReport [[-ClusterName] <String>] [-Report <CauReportSummary>]
44+
[-Credential <PSCredential>] [<CommonParameters>]
4545
```
4646

4747
## DESCRIPTION
@@ -62,16 +62,16 @@ 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 on
66-
01/01/2012 or later.
65+
This command gets a detailed list of the updating runs performed on the cluster named `Contoso-FC1`
66+
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
6969

7070
```powershell
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`
@@ -208,7 +208,7 @@ Accept wildcard characters: False
208208
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
209209
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
210210
-WarningAction, and -WarningVariable. For more information, see
211-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
211+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
212212
213213
## INPUTS
214214
@@ -224,5 +224,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
224224
225225
## RELATED LINKS
226226
227-
[Export-CauReport](./Export-CauReport.md)
228-
227+
[Export-CauReport](export-caureport.md)

0 commit comments

Comments
 (0)