Skip to content

Commit 0c65f2b

Browse files
robinharwoodrobinharwood
committed
Fixing formatting
1 parent 8c32009 commit 0c65f2b

17 files changed

+90
-34
lines changed

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

+39-29
Original file line numberDiff line numberDiff line change
@@ -19,47 +19,47 @@ Adds the Cluster Aware Updating (CAU) clustered role that provides the self-upda
1919

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

3434
### Weekly
3535

3636
```
3737
Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>]
38-
[-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-IntervalWeeks <Int32>]
39-
[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
40-
[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
41-
[-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
42-
[-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
43-
[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
44-
[-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
45-
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
46-
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
47-
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
38+
[-StartDate <DateTime>] [-DaysOfWeek <Weekdays>] [-IntervalWeeks <Int32>]
39+
[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
40+
[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
41+
[-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
42+
[-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
43+
[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
44+
[-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
45+
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
46+
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
47+
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
4848
```
4949

5050
### Once
5151

5252
```
5353
Add-CauClusterRole [-VirtualComputerObjectName <String>] [-GroupName <String>] [-RunOnce]
54-
[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
55-
[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
56-
[-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
57-
[-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
58-
[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
59-
[-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
60-
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
61-
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
62-
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
54+
[-CauPluginName <String[]>] [-CauPluginArguments <Hashtable[]>] [-MaxFailedNodes <Int32>]
55+
[-MaxRetriesPerNode <Int32>] [-NodeOrder <String[]>] [-PreUpdateScript <String>]
56+
[-PostUpdateScript <String>] [-ConfigurationName <String>] [-RequireAllNodesOnline]
57+
[-WarnAfter <TimeSpan>] [-StopAfter <TimeSpan>] [-RebootTimeoutMinutes <Int32>] [-SeparateReboots]
58+
[-RunPluginsSerially] [-StopOnPluginFailure] [-EnableFirewallRules] [-FailbackMode <FailbackType>]
59+
[-SuspendClusterNodeTimeoutMinutes <Int32>] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
60+
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-SiteAwareUpdatingOrder <String[]>]
61+
[-OsRollingUpgrade] [-AttemptSoftReboot] [-RebootMode <RebootType>] [[-ClusterName] <String>]
62+
[[-Credential] <PSCredential>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
6363
```
6464

6565
## DESCRIPTION
@@ -166,6 +166,7 @@ Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/
166166
## PARAMETERS
167167

168168
### -AttemptSoftReboot
169+
169170
Indicates that the CAU clustered role attempts a Kernel Soft Reboot (KSR) for the failover cluster.
170171

171172
KSR bypasses BIOS/firmware initialization. You can only use KSR for updates that do not require a
@@ -429,6 +430,7 @@ Accept wildcard characters: False
429430
```
430431

431432
### -ForcePauseAndDrain
433+
432434
Indicates that the CAU cluster role forces cluster nodes to pause and drain roles.
433435

434436
A forced drain moves the roles off of the draining node even if the group cannot move.
@@ -447,6 +449,7 @@ Accept wildcard characters: False
447449
```
448450

449451
### -ForcePauseDrainAndReboot
452+
450453
Indicates that the CAU cluster role forces cluster nodes to pause, drain roles, and restart.
451454

452455
A forced drain moves the roles off of the draining node even if the group cannot move.
@@ -465,6 +468,7 @@ Accept wildcard characters: False
465468
```
466469

467470
### -ForcePauseNoDrain
471+
468472
Indicates that the CAU cluster role forces cluster nodes to pause.
469473
The nodes are not drained.
470474

@@ -569,6 +573,7 @@ Accept wildcard characters: False
569573
```
570574

571575
### -OsRollingUpgrade
576+
572577
Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads.
573578

574579
```yaml
@@ -625,6 +630,7 @@ Accept wildcard characters: False
625630
```
626631

627632
### -RebootMode
633+
628634
{{ Fill RebootMode Description }}
629635

630636
```yaml
@@ -675,6 +681,7 @@ Accept wildcard characters: False
675681
```
676682

677683
### -RunOnce
684+
678685
{{ Fill RunOnce Description }}
679686

680687
```yaml
@@ -735,6 +742,7 @@ Accept wildcard characters: False
735742
```
736743

737744
### -SiteAwareUpdatingOrder
745+
738746
Specifies the order in which the CAU cluster role updates cluster nodes.
739747

740748
By default, CAU selects the order of nodes to update based on the level of activity.
@@ -752,6 +760,7 @@ Accept wildcard characters: False
752760
```
753761

754762
### -SkipUpdateChecks
763+
755764
Indicates that the CAU cluster role skips update checks.
756765

757766
```yaml
@@ -824,6 +833,7 @@ Accept wildcard characters: False
824833
```
825834

826835
### -SuspendClusterNodeTimeoutMinutes
836+
827837
Specifies the maximum amount of time CAU should wait for the `Suspend-ClusterNode` cmdlet to
828838
succeed if the underlying clustered space is in degraded condition.
829839

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

+1
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ Accept wildcard characters: False
124124
```
125125
126126
### CommonParameters
127+
127128
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
128129
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
129130
-WarningAction, and -WarningVariable. For more information, see

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

+1
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ Accept wildcard characters: False
124124
```
125125
126126
### CommonParameters
127+
127128
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
128129
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
129130
-WarningAction, and -WarningVariable. For more information, see

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

+1
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ Accept wildcard characters: False
179179
```
180180
181181
### CommonParameters
182+
182183
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
183184
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
184185
-WarningAction, and -WarningVariable. For more information, see

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

+1
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ Accept wildcard characters: False
7171
```
7272
7373
### CommonParameters
74+
7475
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
7576
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
7677
-WarningAction, and -WarningVariable. For more information, see

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

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

2323
## DESCRIPTION
24-
The **Get-CauDeviceInfoForFeatureUpdates** cmdlet gets device information for feature updates to use with Cluster-Aware Updating (CAU).
24+
25+
The `Get-CauDeviceInfoForFeatureUpdates` cmdlet gets device information for feature updates to use with Cluster-Aware Updating (CAU).
2526

2627
## EXAMPLES
2728

@@ -42,6 +43,7 @@ splatting to pass parameter values from the `$Parameters` variable to the comman
4243
## PARAMETERS
4344

4445
### -ClusterName
46+
4547
Specifies the name of the cluster fow which to get device information.
4648

4749
```yaml
@@ -57,6 +59,7 @@ Accept wildcard characters: False
5759
```
5860
5961
### -Credential
62+
6063
Specifies the administrative credentials for the target cluster.
6164
6265
```yaml
@@ -72,6 +75,7 @@ Accept wildcard characters: False
7275
```
7376
7477
### -PathToDirectory
78+
7579
Specifies a directory.
7680
7781
```yaml
@@ -87,6 +91,7 @@ Accept wildcard characters: False
8791
```
8892
8993
### CommonParameters
94+
9095
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
9196
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
9297
-WarningAction, and -WarningVariable. For more information, see

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

+1
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ Accept wildcard characters: False
6363
```
6464
6565
### CommonParameters
66+
6667
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
6768
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
6869
-WarningAction, and -WarningVariable. For more information, see

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

+5-4
Original file line numberDiff line numberDiff line change
@@ -20,28 +20,28 @@ specified dates or other specified parameters.
2020

2121
```
2222
Get-CauReport [[-ClusterName] <String>] [-Detailed] [-Credential <PSCredential>]
23-
[<CommonParameters>]
23+
[<CommonParameters>]
2424
```
2525

2626
### RangeParamSet
2727

2828
```
2929
Get-CauReport [[-ClusterName] <String>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>]
30-
[-Detailed] [-Credential <PSCredential>] [<CommonParameters>]
30+
[-Detailed] [-Credential <PSCredential>] [<CommonParameters>]
3131
```
3232

3333
### LastParamSet
3434

3535
```
3636
Get-CauReport [[-ClusterName] <String>] [-Last] [-Detailed] [-Credential <PSCredential>]
37-
[<CommonParameters>]
37+
[<CommonParameters>]
3838
```
3939

4040
### SpecificReportParamSet
4141

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

4747
## DESCRIPTION
@@ -204,6 +204,7 @@ Accept wildcard characters: False
204204
```
205205
206206
### CommonParameters
207+
207208
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
208209
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
209210
-WarningAction, and -WarningVariable. For more information, see

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

+1
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,7 @@ Accept wildcard characters: False
166166
```
167167
168168
### CommonParameters
169+
169170
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
170171
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
171172
-WarningAction, and -WarningVariable. For more information, see

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

+11
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Invoke-CauRun [-MaxFailedNodes <Int32>] [-MaxRetriesPerNode <Int32>] [-NodeOrder
3030
```
3131

3232
### RecoverParamSet
33+
3334
```
3435
Invoke-CauRun [-ForceRecovery] [-Force] [-ForcePauseNoDrain] [-ForcePauseAndDrain]
3536
[-ForcePauseDrainAndReboot] [-SkipUpdateChecks] [-ForceSelfUpdate] [[-ClusterName] <String>]
@@ -125,6 +126,7 @@ recovery is performed without confirmation prompts.
125126
## PARAMETERS
126127

127128
### -AttemptSoftReboot
129+
128130
Indicates that command attempts a Kernel Soft Reboot (KSR) for the failover cluster.
129131

130132
KSR bypasses BIOS/firmware initialization.
@@ -357,6 +359,7 @@ Accept wildcard characters: False
357359
```
358360

359361
### -ForcePauseAndDrain
362+
360363
Indicates that the command forces cluster nodes to pause and drain roles.
361364

362365
A forced drain moves the roles off of the draining node even if the group cannot move.
@@ -375,6 +378,7 @@ Accept wildcard characters: False
375378
```
376379

377380
### -ForcePauseDrainAndReboot
381+
378382
Indicates that the command forces cluster nodes to pause, drain roles, and restart.
379383

380384
A forced drain moves the roles off of the draining node even if the group cannot move.
@@ -393,6 +397,7 @@ Accept wildcard characters: False
393397
```
394398

395399
### -ForcePauseNoDrain
400+
396401
Indicates that the command forces cluster nodes to pause.
397402
The nodes are not drained.
398403

@@ -429,6 +434,7 @@ Accept wildcard characters: False
429434
```
430435

431436
### -ForceSelfUpdate
437+
432438
{{ Fill ForceSelfUpdate Description }}
433439

434440
```yaml
@@ -496,6 +502,7 @@ Accept wildcard characters: False
496502
```
497503

498504
### -OsRollingUpgrade
505+
499506
Indicates that the CAU cluster role upgrades the operating system of the cluster nodes without stopping the Hyper-V or the Scale-Out File Server workloads.
500507

501508
```yaml
@@ -552,6 +559,7 @@ Accept wildcard characters: False
552559
```
553560

554561
### -RebootMode
562+
555563
{{ Fill RebootMode Description }}
556564

557565
```yaml
@@ -646,6 +654,7 @@ Accept wildcard characters: False
646654
```
647655

648656
### -SiteAwareUpdatingOrder
657+
649658
Specifies the order in which the command updates cluster nodes.
650659

651660
By default, CAU selects the order of nodes to update based on the level of activity.
@@ -663,6 +672,7 @@ Accept wildcard characters: False
663672
```
664673

665674
### -SkipUpdateChecks
675+
666676
Indicates that the command skips update checks.
667677

668678
```yaml
@@ -782,6 +792,7 @@ Accept wildcard characters: False
782792
```
783793

784794
### CommonParameters
795+
785796
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
786797
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
787798
-WarningAction, and -WarningVariable. For more information, see

0 commit comments

Comments
 (0)