Skip to content

Commit 1eb8922

Browse files
committed
Build validation fixes and additional parameters
1 parent 5390cb3 commit 1eb8922

18 files changed

+266
-205
lines changed

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

Lines changed: 62 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,38 +17,43 @@ Adds the CAU clustered role that provides the self-updating functionality to the
1717

1818
### MonthlyDayOfWeek (Default)
1919
```
20-
Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
21-
[-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-WeeksOfMonth <Int32[]>]
22-
[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
23-
[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
24-
[-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
25-
[-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
26-
[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
27-
[-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
28-
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
29-
[-OsRollingUpgrade] [[-ClusterName] <String>] [[-Credential] <PSCredential>] [-Force] [-WhatIf]
30-
[-Confirm] [<CommonParameters>]
20+
Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>] [-StartDate <DateTime>]
21+
[-DaysOfWeek <Weekdays>] [-WeeksOfMonth <Int32[]>] [-CauPluginName <String[]>]
22+
[-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>] [-MaxRetriesPerNode <Int32>]
23+
[-NodeOrder <String[]>] [-PreUpdateScript <String>] [-PostUpdateScript <String>] [-ConfigurationName <String>]
24+
[-RequireAllNodesOnline] [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>]
25+
[-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules]
26+
[-FailbackMode <FailbackType>] [-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain]
27+
[-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
28+
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
29+
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
3130
```
3231

3332
### Weekly
3433
```
35-
Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
36-
[-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-IntervalWeeks <Int32>]
37-
[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
38-
[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
39-
[-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
40-
[-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
41-
[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
42-
[-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
43-
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
44-
[-OsRollingUpgrade] [[-ClusterName] <String>] [[-Credential] <PSCredential>] [-Force] [-WhatIf]
45-
[-Confirm] [<CommonParameters>]
34+
Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>] [-StartDate <DateTime>]
35+
[-DaysOfWeek <Weekdays>] [-IntervalWeeks <Int32>] [-CauPluginName <String[]>]
36+
[-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>] [-MaxRetriesPerNode <Int32>]
37+
[-NodeOrder <String[]>] [-PreUpdateScript <String>] [-PostUpdateScript <String>] [-ConfigurationName <String>]
38+
[-RequireAllNodesOnline] [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>]
39+
[-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules]
40+
[-FailbackMode <FailbackType>] [-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain]
41+
[-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
42+
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
43+
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
4644
```
4745

48-
### DefaultParamSet
46+
### Once
4947
```
50-
Add-CauClusterRole [-AttemptSoftReboot] [[-ClusterName] <String>] [[-Credential] <PSCredential>]
51-
[-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
48+
Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>] [-RunOnce]
49+
[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
50+
[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>] [-PostUpdateScript <String>]
51+
[-ConfigurationName <String>] [-RequireAllNodesOnline] [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>]
52+
[-RebootTimeoutMinutes <Int32>] [-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure]
53+
[-EnableFirewallRules] [-FailbackMode <FailbackType>] [-SuspendClusterNodeTimeoutMinutes <Int32>]
54+
[-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks]
55+
[-SiteAwareUpdatingOrder <String[]>] [-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>]
56+
[[-ClusterName] <String>] [[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
5257
```
5358

5459
## DESCRIPTION
@@ -551,6 +556,22 @@ Accept pipeline input: False
551556
Accept wildcard characters: False
552557
```
553558

559+
### -RebootMode
560+
{{ Fill RebootMode Description }}
561+
562+
```yaml
563+
Type: RebootType
564+
Parameter Sets: (All)
565+
Aliases:
566+
Accepted values: ClusProp, FullReboot, SoftReboot
567+
568+
Required: False
569+
Position: Named
570+
Default value: None
571+
Accept pipeline input: False
572+
Accept wildcard characters: False
573+
```
574+
554575
### -RebootTimeoutMinutes
555576
Specifies the time in minutes that CAU allows for the restarting of a node. If the restart does not
556577
complete within this time, then the Updating Run on that node will be marked as failed.
@@ -583,6 +604,21 @@ Accept pipeline input: False
583604
Accept wildcard characters: False
584605
```
585606

607+
### -RunOnce
608+
{{ Fill RunOnce Description }}
609+
610+
```yaml
611+
Type: SwitchParameter
612+
Parameter Sets: Once
613+
Aliases:
614+
615+
Required: False
616+
Position: Named
617+
Default value: None
618+
Accept pipeline input: False
619+
Accept wildcard characters: False
620+
```
621+
586622
### -RunPluginsSerially
587623
Indicates that the cmdlet CAU scans each cluster node for applicable updates and stages the updates
588624
for each plug-in in the plug-in order when multiple plug-ins are used during an Updating Run when
@@ -806,10 +842,7 @@ Accept wildcard characters: False
806842
```
807843

808844
### CommonParameters
809-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
810-
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
811-
-WarningAction, and -WarningVariable. For more information, see
812-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
845+
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).
813846

814847
## INPUTS
815848

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Suspends the self-updating functionality on the specified cluster.
1616
## SYNTAX
1717

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

2323
## DESCRIPTION
@@ -117,10 +117,7 @@ Accept wildcard characters: False
117117
```
118118
119119
### CommonParameters
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).
120+
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).
124121
125122
## INPUTS
126123

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Re-enables the self-updating functionality on the specified cluster.
1616
## SYNTAX
1717

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

2323
## DESCRIPTION
@@ -117,10 +117,7 @@ Accept wildcard characters: False
117117
```
118118
119119
### CommonParameters
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).
120+
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).
124121
125122
## INPUTS
126123

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ 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]
20-
[-Force] [-TimeZone <TimeZoneInfo>] [-WhatIf] [-Confirm] [<CommonParameters>]
19+
Export-CauReport [-InputReport] <CauReport[]> [-Format] <OutputType> [-Path] <String> [-PassThru] [-Force]
20+
[-TimeZone <TimeZoneInfo>] [-WhatIf] [-Confirm] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
@@ -168,10 +168,7 @@ Accept wildcard characters: False
168168
```
169169
170170
### CommonParameters
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).
171+
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).
175172
176173
## INPUTS
177174

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,7 @@ Accept wildcard characters: False
7979
```
8080
8181
### CommonParameters
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).
82+
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).
8683
8784
## INPUTS
8885

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,7 @@ Accept wildcard characters: False
8181
```
8282
8383
### CommonParameters
84-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
85-
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
86-
-WarningAction, and -WarningVariable. For more information, see
87-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
84+
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).
8885
8986
## INPUTS
9087

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,7 @@ Accept wildcard characters: False
6767
```
6868
6969
### CommonParameters
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).
70+
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).
7471
7572
## INPUTS
7673

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

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,18 @@ specified dates or other specified parameters.
1818

1919
### AllParamsSet (Default)
2020
```
21-
Get-CauReport [[-ClusterName] <String>] [-Detailed] [-Credential <PSCredential>]
22-
[<CommonParameters>]
21+
Get-CauReport [[-ClusterName] <String>] [-Detailed] [-Credential <PSCredential>] [<CommonParameters>]
2322
```
2423

2524
### RangeParamSet
2625
```
27-
Get-CauReport [[-ClusterName] <String>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>]
28-
[-Detailed] [-Credential <PSCredential>] [<CommonParameters>]
26+
Get-CauReport [[-ClusterName] <String>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [-Detailed]
27+
[-Credential <PSCredential>] [<CommonParameters>]
2928
```
3029

3130
### LastParamSet
3231
```
33-
Get-CauReport [[-ClusterName] <String>] [-Last] [-Detailed] [-Credential <PSCredential>]
34-
[<CommonParameters>]
32+
Get-CauReport [[-ClusterName] <String>] [-Last] [-Detailed] [-Credential <PSCredential>] [<CommonParameters>]
3533
```
3634

3735
### SpecificReportParamSet
@@ -189,10 +187,7 @@ Accept wildcard characters: False
189187
```
190188
191189
### CommonParameters
192-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
193-
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
194-
-WarningAction, and -WarningVariable. For more information, see
195-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
190+
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).
196191
197192
## INPUTS
198193

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

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,17 @@ Get-CauRun [[-ClusterName] <String>] [-Credential <PSCredential>] [<CommonParame
2222

2323
### WaitForStart
2424
```
25-
Get-CauRun [[-ClusterName] <String>] [-Credential <PSCredential>] [-WaitForStart]
26-
[<CommonParameters>]
25+
Get-CauRun [[-ClusterName] <String>] [-Credential <PSCredential>] [-WaitForStart] [<CommonParameters>]
2726
```
2827

2928
### WaitForCompletion
3029
```
31-
Get-CauRun [[-ClusterName] <String>] [-Credential <PSCredential>] [-WaitForCompletion]
32-
[<CommonParameters>]
30+
Get-CauRun [[-ClusterName] <String>] [-Credential <PSCredential>] [-WaitForCompletion] [<CommonParameters>]
3331
```
3432

3533
### ShowClusterNodeState
3634
```
37-
Get-CauRun [[-ClusterName] <String>] [-Credential <PSCredential>] [-ShowClusterNodeState]
38-
[<CommonParameters>]
35+
Get-CauRun [[-ClusterName] <String>] [-Credential <PSCredential>] [-ShowClusterNodeState] [<CommonParameters>]
3936
```
4037

4138
## DESCRIPTION
@@ -153,10 +150,7 @@ Accept wildcard characters: False
153150
```
154151
155152
### CommonParameters
156-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
157-
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
158-
-WarningAction, and -WarningVariable. For more information, see
159-
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
153+
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).
160154
161155
## INPUTS
162156

0 commit comments

Comments
 (0)