Skip to content

Commit bac2a8c

Browse files
Merge pull request MicrosoftDocs#3165 from robinharwood/roharwoo_failoverclusters_line_formatting_4
FailoverClustering Bulk Fixup (3/4) - Line formatting updates
2 parents 17bf7a5 + 327f60f commit bac2a8c

12 files changed

+410
-226
lines changed

docset/winserver2022-ps/failoverclusters/Start-ClusterResource.md

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
44
Module Name: FailoverClusters
5-
ms.date: 12/20/2016
5+
ms.date: 10/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/start-clusterresource?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Start-ClusterResource
@@ -21,39 +21,41 @@ Start-ClusterResource [[-Name] <String>] [-IgnoreLocked] [-ChooseBestNode] [-Wai
2121
```
2222

2323
## DESCRIPTION
24-
The **Start-ClusterResource** cmdlet brings a resource online in a failover cluster.
25-
Before the resource is brought online, any resources that it depends are brought online.
24+
25+
The **Start-ClusterResource** cmdlet brings a resource online in a failover cluster. Before the
26+
resource is brought online, any resources that it depends are brought online.
2627

2728
## EXAMPLES
2829

2930
### Example 1
31+
3032
```
3133
PS C:\> Start-ClusterResource -Name "IP Address 172.24.11.0"
3234
Name State Group ResourceType
3335
---- ----- ----- ------------
3436
IP Address 172.2... Online cluster1FS12 IP Address
3537
```
3638

37-
This example brings the resource called IP Address 172.24.11.0 online on the local cluster.
38-
Before bringing the resource online, this cmdlet brings online any resources on which the resource depends.
39+
This example brings the resource called IP Address 172.24.11.0 online on the local cluster. Before
40+
bringing the resource online, this cmdlet brings online any resources on which the resource depends.
3941

4042
### Example 2
43+
4144
```
4245
PS C:\> Start-ClusterResource -Name "IP Address 172.24.11.0" -Wait 0
4346
Name State Group ResourceType
4447
---- ----- ----- ------------
4548
IP Address 172.2... OnlinePending cluster1FS12 IP Address
4649
```
4750

48-
This example brings the resource called IP Address 172.24.11.0 online on the local cluster.
49-
Before bringing the resource online, this cmdlet brings online any resources on which the resource depends.
51+
This example brings the resource called IP Address 172.24.11.0 online on the local cluster. Before
52+
bringing the resource online, this cmdlet brings online any resources on which the resource depends.
5053
The Windows PowerShell® prompt returns as soon as the action has been initiated.
5154

5255
## PARAMETERS
5356

5457
### -ChooseBestNode
5558

56-
5759
```yaml
5860
Type: SwitchParameter
5961
Parameter Sets: (All)
@@ -67,8 +69,9 @@ Accept wildcard characters: False
6769
```
6870
6971
### -Cluster
70-
Specifies the name of the cluster on which to run this cmdlet.
71-
If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster.
72+
73+
Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is
74+
`.` or it is omitted, then the cmdlet runs on the local cluster.
7275

7376
```yaml
7477
Type: String
@@ -83,6 +86,7 @@ Accept wildcard characters: False
8386
```
8487

8588
### -IgnoreLocked
89+
8690
Specifies that locked groups are ignored when running the cmdlet.
8791

8892
```yaml
@@ -98,6 +102,7 @@ Accept wildcard characters: False
98102
```
99103

100104
### -InputObject
105+
101106
Specifies the cluster resource to bring online.
102107

103108
```yaml
@@ -113,8 +118,9 @@ Accept wildcard characters: False
113118
```
114119

115120
### -Name
116-
Specifies the name of the cluster resource to bring online.
117-
This can also be the name of a Cluster Shared Volume (CSV).
121+
122+
Specifies the name of the cluster resource to bring online. This can also be the name of a Cluster
123+
Shared Volume (CSV).
118124

119125
```yaml
120126
Type: String
@@ -129,9 +135,10 @@ Accept wildcard characters: False
129135
```
130136

131137
### -Wait
132-
Specifies the time in seconds to wait for the cmdlet.
133-
If the **Wait** parameter is not specified, then the cmdlet waits for completion.
134-
If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting.
138+
139+
Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter is not specified,
140+
then the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
141+
cmdlet returns without waiting.
135142

136143
```yaml
137144
Type: Int32
@@ -146,7 +153,11 @@ Accept wildcard characters: False
146153
```
147154

148155
### CommonParameters
149-
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).
156+
157+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
158+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
159+
-WarningAction, and -WarningVariable. For more information, see
160+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
150161

151162
## INPUTS
152163

@@ -177,4 +188,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
177188
[Stop-ClusterResource](./Stop-ClusterResource.md)
178189

179190
[Suspend-ClusterResource](./Suspend-ClusterResource.md)
180-

docset/winserver2022-ps/failoverclusters/Stop-Cluster.md

Lines changed: 37 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
44
Module Name: FailoverClusters
5-
ms.date: 12/20/2016
5+
ms.date: 10/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/stop-cluster?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Stop-Cluster
@@ -11,45 +11,57 @@ title: Stop-Cluster
1111
# Stop-Cluster
1212

1313
## SYNOPSIS
14-
Stops the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster.
14+
Stops the Cluster service on all nodes in a failover cluster, which will stop all services and
15+
applications configured in the cluster.
1516

1617
## SYNTAX
1718

1819
### Cluster name (Default)
20+
1921
```
20-
Stop-Cluster [[-Cluster] <String>] [-Force] [-Wait <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
22+
Stop-Cluster [[-Cluster] <String>] [-Force] [-Wait <Int32>] [-WhatIf] [-Confirm]
23+
[<CommonParameters>]
2124
```
2225

2326
### InputObject
27+
2428
```
25-
Stop-Cluster [-Force] [-Wait <Int32>] [-InputObject <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
29+
Stop-Cluster [-Force] [-Wait <Int32>] [-InputObject <PSObject>] [-WhatIf] [-Confirm]
30+
[<CommonParameters>]
2631
```
2732

2833
## DESCRIPTION
29-
The **Stop-Cluster** cmdlet stops the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster.
30-
A node can only function as part of the cluster when the Cluster service is running on that node.
34+
35+
The **Stop-Cluster** cmdlet stops the Cluster service on all nodes in a failover cluster, which will
36+
stop all services and applications configured in the cluster. A node can only function as part of
37+
the cluster when the Cluster service is running on that node.
3138

3239
## EXAMPLES
3340

3441
### Example 1: Stop Cluster service on all nodes of the local cluster
42+
3543
```
3644
PS C:\> Stop-Cluster
3745
```
3846

39-
This example stops the Cluster service on all nodes in the local cluster, which will stop all services and applications configured in the cluster.
47+
This example stops the Cluster service on all nodes in the local cluster, which will stop all
48+
services and applications configured in the cluster.
4049

4150
### Example 2: Stop Cluster service on all nodes of a cluster
51+
4252
```
4353
PS C:\> Stop-Cluster -Name cluster1
4454
```
4555

46-
This example stops the Cluster service on all nodes in the cluster named cluster1, which will stop all services and applications configured in the cluster.
56+
This example stops the Cluster service on all nodes in the cluster named cluster1, which will stop
57+
all services and applications configured in the cluster.
4758

4859
## PARAMETERS
4960

5061
### -Cluster
51-
Specifies the name of the cluster on which to run this cmdlet.
52-
If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster.
62+
63+
Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is
64+
`.` or it is omitted, then the cmdlet runs on the local cluster.
5365

5466
```yaml
5567
Type: String
@@ -64,6 +76,7 @@ Accept wildcard characters: False
6476
```
6577
6678
### -Confirm
79+
6780
Prompts you for confirmation before running the cmdlet.
6881
6982
```yaml
@@ -79,8 +92,9 @@ Accept wildcard characters: False
7992
```
8093
8194
### -Force
82-
Runs the cmdlet without prompting for confirmation.
83-
By default the cmdlet will ask for confirmation from the user before proceeding.
95+
96+
Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation
97+
from the user before proceeding.
8498
8599
```yaml
86100
Type: SwitchParameter
@@ -95,6 +109,7 @@ Accept wildcard characters: False
95109
```
96110
97111
### -InputObject
112+
98113
Specifies the cluster to stop.
99114
100115
```yaml
@@ -110,9 +125,10 @@ Accept wildcard characters: False
110125
```
111126
112127
### -Wait
113-
Specifies the time in seconds to wait for the cmdlet.
114-
If the *Wait* parameter is not specified, then the cmdlet waits for completion.
115-
If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting.
128+
129+
Specifies the time in seconds to wait for the cmdlet. If the *Wait* parameter is not specified, then
130+
the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
131+
cmdlet returns without waiting.
116132

117133
```yaml
118134
Type: Int32
@@ -127,6 +143,7 @@ Accept wildcard characters: False
127143
```
128144

129145
### -WhatIf
146+
130147
Shows what would happen if the cmdlet runs. The cmdlet is not run.
131148

132149
```yaml
@@ -142,7 +159,11 @@ Accept wildcard characters: False
142159
```
143160

144161
### CommonParameters
145-
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).
162+
163+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
164+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
165+
-WarningAction, and -WarningVariable. For more information, see
166+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
146167

147168
## INPUTS
148169

@@ -165,4 +186,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
165186
[Start-Cluster](./Start-Cluster.md)
166187

167188
[Test-Cluster](./Test-Cluster.md)
168-

docset/winserver2022-ps/failoverclusters/Stop-ClusterGroup.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
33
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
44
Module Name: FailoverClusters
5-
ms.date: 12/20/2016
5+
ms.date: 10/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/stop-clustergroup?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Stop-ClusterGroup
@@ -21,13 +21,17 @@ Stop-ClusterGroup [[-Name] <String>] [-IgnoreLocked] [-Wait <Int32>] [-InputObje
2121
```
2222

2323
## DESCRIPTION
24-
The **Stop-ClusterGroup** cmdlet stops one or more clustered roles, also known as resource groups, on a failover cluster.
2524

26-
If maintenance on a clustered role is needed, the clustered role can be stopped in an orderly fashion by using this cmdlet.
25+
The **Stop-ClusterGroup** cmdlet stops one or more clustered roles, also known as resource groups,
26+
on a failover cluster.
27+
28+
If maintenance on a clustered role is needed, the clustered role can be stopped in an orderly
29+
fashion by using this cmdlet.
2730

2831
## EXAMPLES
2932

3033
### Example 1: Stop a clustered role on the local cluster
34+
3135
```
3236
PS C:\> Stop-ClusterGroup FileServer1
3337
Name OwnerNode State
@@ -40,8 +44,9 @@ This example stops the clustered role, or resource group, called FileServer1 on
4044
## PARAMETERS
4145

4246
### -Cluster
43-
Specifies the name of the cluster on which to run this cmdlet.
44-
If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster.
47+
48+
Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is
49+
`.` or it is omitted, then the cmdlet runs on the local cluster.
4550

4651
```yaml
4752
Type: String
@@ -56,6 +61,7 @@ Accept wildcard characters: False
5661
```
5762
5863
### -IgnoreLocked
64+
5965
Specifies that locked groups are ignored when running the cmdlet.
6066
6167
```yaml
@@ -71,6 +77,7 @@ Accept wildcard characters: False
7177
```
7278
7379
### -InputObject
80+
7481
Specifies the clustered role to stop.
7582
7683
```yaml
@@ -86,6 +93,7 @@ Accept wildcard characters: False
8693
```
8794
8895
### -Name
96+
8997
Specifies the name of the clustered role to stop.
9098
9199
```yaml
@@ -101,9 +109,10 @@ Accept wildcard characters: False
101109
```
102110
103111
### -Wait
104-
Specifies the time in seconds to wait for the cmdlet.
105-
If the *Wait* parameter is not specified, then the cmdlet waits for completion.
106-
If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting.
112+
113+
Specifies the time in seconds to wait for the cmdlet. If the *Wait* parameter is not specified, then
114+
the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
115+
cmdlet returns without waiting.
107116

108117
```yaml
109118
Type: Int32
@@ -118,7 +127,11 @@ Accept wildcard characters: False
118127
```
119128

120129
### CommonParameters
121-
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).
130+
131+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
132+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
133+
-WarningAction, and -WarningVariable. For more information, see
134+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
122135

123136
## INPUTS
124137

@@ -141,4 +154,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
141154
[Remove-ClusterGroup](./Remove-ClusterGroup.md)
142155

143156
[Start-ClusterGroup](./Start-ClusterGroup.md)
144-

0 commit comments

Comments
 (0)