Skip to content

Commit 5606106

Browse files
robinharwoodrobinharwood
committed
Build validation fixes and additional parameters
1 parent 400e672 commit 5606106

File tree

5 files changed

+198
-77
lines changed

5 files changed

+198
-77
lines changed

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

Lines changed: 46 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>] [
2626
[-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules]
2727
[-FailbackMode <FailbackType>] [-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain]
2828
[-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
29-
[-OsRollingUpgrade] [[-ClusterName] <String>] [[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm]
30-
[<CommonParameters>]
29+
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
30+
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
3131
```
3232

3333
### Weekly
@@ -41,14 +41,21 @@ Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>] [
4141
[-SeparateReboots] [-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules]
4242
[-FailbackMode <FailbackType>] [-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain]
4343
[-ForcePauseAndDrain] [-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
44-
[-OsRollingUpgrade] [[-ClusterName] <String>] [[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm]
45-
[<CommonParameters>]
44+
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
45+
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
4646
```
4747

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

5461
## DESCRIPTION
@@ -271,17 +278,12 @@ Accept wildcard characters: False
271278
```
272279

273280
### -ConfigurationName
274-
<<<<<<< HEAD
275281

276282
Specifies the Windows PowerShell session configuration that defines the session in which scripts,
277283
specified by the **PreUpdateScript** and **PostUpdateScript** parameters, and cmdlets are run, and can
278284
limit the cmdlets that are available to be run. If either a pre-update or post-update script is
279285
specified but a configuration name isn't specified, then the default session configuration that is
280-
built into Windows PowerShell® is used.
281-
=======
282-
Specifies the Windows PowerShell session configuration that defines the session in which scripts, specified by the *PreUpdateScript* and *PostUpdateScript* parameters, and cmdlets are run, and can limit the cmdlets that are available to be run.
283-
If either a pre-update or post-update script is specified but a configuration name is not specified, then the default session configuration that is built into Windows PowerShell&reg; is used.
284-
>>>>>>> f65c35cc7 (Remove special character)
286+
built into Windows PowerShell is used.
285287

286288
```yaml
287289
Type: String
@@ -618,6 +620,22 @@ Accept pipeline input: False
618620
Accept wildcard characters: False
619621
```
620622

623+
### -RebootMode
624+
{{ Fill RebootMode Description }}
625+
626+
```yaml
627+
Type: RebootType
628+
Parameter Sets: (All)
629+
Aliases:
630+
Accepted values: ClusProp, FullReboot, SoftReboot
631+
632+
Required: False
633+
Position: Named
634+
Default value: None
635+
Accept pipeline input: False
636+
Accept wildcard characters: False
637+
```
638+
621639
### -RebootTimeoutMinutes
622640

623641
Specifies the time in minutes that CAU allows for the restarting of a node. If the restart doesn't
@@ -652,6 +670,21 @@ Accept pipeline input: False
652670
Accept wildcard characters: False
653671
```
654672

673+
### -RunOnce
674+
{{ Fill RunOnce Description }}
675+
676+
```yaml
677+
Type: SwitchParameter
678+
Parameter Sets: Once
679+
Aliases:
680+
681+
Required: False
682+
Position: Named
683+
Default value: None
684+
Accept pipeline input: False
685+
Accept wildcard characters: False
686+
```
687+
655688
### -RunPluginsSerially
656689

657690
Indicates that the cmdlet CAU scans each cluster node for applicable updates and stages the updates

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

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,17 @@ Invoke-CauRun [-MaxFailedNodes <Int32>] [-MaxRetriesPerNode <Int32>] [-NodeOrder
2323
[-RequireAllNodesOnline] [-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>]
2424
[-SeparateReboots] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
2525
[-SuspendClusterNodeTimeoutMinutes <Int32>] [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
26-
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>] [[-ClusterName] <String>]
27-
[[-CauPluginName] <String[]>] [[-Credential] <PSCredential>] [-CauPluginArguments <Hashtable[]>]
28-
[-RunPluginsSerially] [-StopOnPluginFailure] [-OsRollingUpgrade] [-AttemptSoftReboot] [-WhatIf] [-Confirm]
29-
[<CommonParameters>]
26+
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-ForceSelfUpdate] [-SiteAwareUpdatingOrder <String[]>]
27+
[[-ClusterName] <String>] [[-CauPluginName] <String[]>] [[-Credential] <PSCredential>]
28+
[-CauPluginArguments <Hashtable[]>] [-RunPluginsSerially] [-StopOnPluginFailure] [-OsRollingUpgrade]
29+
[-AttemptSoftReboot] [-RebootMode <RebootType>] [-WhatIf] [-Confirm] [<CommonParameters>]
3030
```
3131

3232
### RecoverParamSet
3333
```
34-
Invoke-CauRun [-ForceRecovery] [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain] [-ForcePauseDrainAndReboot]
35-
[-SkipUpdateChecks] [[-ClusterName] <String>] [[-Credential] <PSCredential>] [-WhatIf] [-Confirm]
36-
[<CommonParameters>]
37-
```
38-
39-
### RecoverParamSet
40-
41-
```
42-
Invoke-CauRun [-ForceRecovery] [-Force] [[-ClusterName] <String>] [[-Credential] <PSCredential>]
43-
[-WhatIf] [-Confirm] [<CommonParameters>]
34+
Invoke-CauRun [-ForceRecovery] [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
35+
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-ForceSelfUpdate] [[-ClusterName] <String>]
36+
[[-Credential] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]
4437
```
4538

4639
## DESCRIPTION
@@ -164,8 +157,9 @@ For instance:
164157

165158
For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed.
166159
The following arguments are optional:
167-
- **'IncludeRecommendedUpdates'='\<Value\>'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node.
168-
If not specified, the default value is **'False'**.
160+
- **'IncludeRecommendedUpdates'='\<Value\>'**: Boolean value to indicate that recommended updates
161+
will be applied in addition to important updates on each node. If not specified, the default value
162+
is **'False'**.
169163
-- A standard Windows Update Agent query string that specifies criteria used by the Windows Update
170164
Agent to filter the updates that will be applied to each node. For a name, use **QueryString** and
171165
for a value, enclose the full query in quotation marks. If not specified, then the
@@ -434,6 +428,21 @@ Accept pipeline input: False
434428
Accept wildcard characters: False
435429
```
436430

431+
### -ForceSelfUpdate
432+
{{ Fill ForceSelfUpdate Description }}
433+
434+
```yaml
435+
Type: SwitchParameter
436+
Parameter Sets: (All)
437+
Aliases:
438+
439+
Required: False
440+
Position: Named
441+
Default value: None
442+
Accept pipeline input: False
443+
Accept wildcard characters: False
444+
```
445+
437446
### -MaxFailedNodes
438447

439448
Specifies the maximum number of nodes on which updating can fail.
@@ -542,6 +551,22 @@ Accept pipeline input: False
542551
Accept wildcard characters: False
543552
```
544553

554+
### -RebootMode
555+
{{ Fill RebootMode Description }}
556+
557+
```yaml
558+
Type: RebootType
559+
Parameter Sets: DefaultParamSet
560+
Aliases:
561+
Accepted values: ClusProp, FullReboot, SoftReboot
562+
563+
Required: False
564+
Position: Named
565+
Default value: None
566+
Accept pipeline input: False
567+
Accept wildcard characters: False
568+
```
569+
545570
### -RebootTimeoutMinutes
546571

547572
Specifies the time in minutes that CAU allows for the restarting of a node. If the restart doesn't

‎docset/winserver2022-ps/clusterawareupdating/Invoke-CauScan.md‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ updates that are applied to each node in a specified cluster.
1818

1919
```
2020
Invoke-CauScan [[-ClusterName] <String>] [[-CauPluginName] <String[]>] [[-Credential] <PSCredential>]
21-
[-CauPluginArguments <Hashtable[]>] [-RunPluginsSerially] [-StopOnPluginFailure] [-OsRollingUpgrade]
22-
[-AttemptSoftReboot] [<CommonParameters>]
21+
[-CauPluginArguments <Hashtable[]>] [-RunPluginsSerially] [-StopOnPluginFailure]
22+
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [<CommonParameters>]
2323
```
2424

2525
## DESCRIPTION
@@ -228,6 +228,22 @@ Accept pipeline input: False
228228
Accept wildcard characters: False
229229
```
230230

231+
### -RebootMode
232+
{{ Fill RebootMode Description }}
233+
234+
```yaml
235+
Type: RebootType
236+
Parameter Sets: (All)
237+
Aliases:
238+
Accepted values: ClusProp, FullReboot, SoftReboot
239+
240+
Required: False
241+
Position: Named
242+
Default value: None
243+
Accept pipeline input: False
244+
Accept wildcard characters: False
245+
```
246+
231247
### -RunPluginsSerially
232248

233249
Indicates that CAU scans each cluster node for applicable updates and stages the updates for each
@@ -284,7 +300,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
284300

285301
## OUTPUTS
286302

287-
### Microsoft.ClusterAwareUpdating.CauUpdateInfo
303+
### Microsoft.ClusterAwareUpdating.UpdateInfo
304+
305+
### Microsoft.ClusterAwareUpdating.ActivityIdMap
306+
307+
### Microsoft.ClusterAwareUpdating.UpgradeSetupInfo
288308

289309
## NOTES
290310

‎docset/winserver2022-ps/clusterawareupdating/Save-CauDebugTrace.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
154154

155155
## OUTPUTS
156156

157-
### None
157+
### Microsoft.ClusterAwareUpdating.ActivityIdMap
158+
159+
### System.IO.FileInfo
158160

159161
## NOTES
160162

0 commit comments

Comments
 (0)