Skip to content

Commit 3ca3f37

Browse files
Merge pull request MicrosoftDocs#3202 from robinharwood/roharwoo_failoverclusters_text_formatting_4
FailoverClusters BulkFixup (4/4) - Text formatting updates
2 parents 0b80692 + 514f894 commit 3ca3f37

13 files changed

+64
-64
lines changed

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

+3-3
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: 10/21/2022
5+
ms.date: 11/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
@@ -22,7 +22,7 @@ Start-ClusterResource [[-Name] <String>] [-IgnoreLocked] [-ChooseBestNode] [-Wai
2222

2323
## DESCRIPTION
2424

25-
The **Start-ClusterResource** cmdlet brings a resource online in a failover cluster. Before the
25+
The `Start-ClusterResource` cmdlet brings a resource online in a failover cluster. Before the
2626
resource is brought online, any resources that it depends are brought online.
2727

2828
## EXAMPLES
@@ -136,7 +136,7 @@ Accept wildcard characters: False
136136

137137
### -Wait
138138

139-
Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter is not specified,
139+
Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified,
140140
then the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
141141
cmdlet returns without waiting.
142142

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

+5-5
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: 10/21/2022
5+
ms.date: 11/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
@@ -32,7 +32,7 @@ Stop-Cluster [-Force] [-Wait <Int32>] [-InputObject <PSObject>] [-WhatIf] [-Conf
3232

3333
## DESCRIPTION
3434

35-
The **Stop-Cluster** cmdlet stops the Cluster service on all nodes in a failover cluster, which will
35+
The `Stop-Cluster` cmdlet stops the Cluster service on all nodes in a failover cluster, which will
3636
stop all services and applications configured in the cluster. A node can only function as part of
3737
the cluster when the Cluster service is running on that node.
3838

@@ -126,8 +126,8 @@ Accept wildcard characters: False
126126
127127
### -Wait
128128
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
129+
Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified,
130+
then the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
131131
cmdlet returns without waiting.
132132

133133
```yaml
@@ -144,7 +144,7 @@ Accept wildcard characters: False
144144

145145
### -WhatIf
146146

147-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
147+
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
148148

149149
```yaml
150150
Type: SwitchParameter

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

+4-4
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: 10/21/2022
5+
ms.date: 11/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
@@ -22,7 +22,7 @@ Stop-ClusterGroup [[-Name] <String>] [-IgnoreLocked] [-Wait <Int32>] [-InputObje
2222

2323
## DESCRIPTION
2424

25-
The **Stop-ClusterGroup** cmdlet stops one or more clustered roles, also known as resource groups,
25+
The `Stop-ClusterGroup` cmdlet stops one or more clustered roles, also known as resource groups,
2626
on a failover cluster.
2727

2828
If maintenance on a clustered role is needed, the clustered role can be stopped in an orderly
@@ -110,8 +110,8 @@ Accept wildcard characters: False
110110
111111
### -Wait
112112
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
113+
Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified,
114+
then the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
115115
cmdlet returns without waiting.
116116

117117
```yaml

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

+7-7
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: 10/21/2022
5+
ms.date: 11/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/stop-clusternode?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Stop-ClusterNode
@@ -22,9 +22,9 @@ Stop-ClusterNode [[-Name] <StringCollection>] [-Wait <Int32>] [-InputObject <PSO
2222

2323
## DESCRIPTION
2424

25-
The **Stop-ClusterNode** cmdlet stops the Cluster service on a node in a failover cluster. If
26-
stopping the node brings the cluster below quorum, the operation is not permitted. To stop the
27-
cluster, use the **Stop-Cluster** cmdlet instead.
25+
The `Stop-ClusterNode` cmdlet stops the Cluster service on a node in a failover cluster. If
26+
stopping the node brings the cluster below quorum, the operation isn't permitted. To stop the
27+
cluster, use the `Stop-Cluster` cmdlet instead.
2828

2929
Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP)
3030
authentication on the server computer.
@@ -122,8 +122,8 @@ Accept wildcard characters: False
122122
123123
### -Wait
124124
125-
Specifies the time in seconds to wait for the cmdlet. If the *Wait* parameter is not specified, then
126-
the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
125+
Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified,
126+
then the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
127127
cmdlet returns without waiting.
128128

129129
```yaml
@@ -140,7 +140,7 @@ Accept wildcard characters: False
140140

141141
### -WhatIf
142142

143-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
143+
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
144144

145145
```yaml
146146
Type: SwitchParameter

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

+4-4
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: 10/21/2022
5+
ms.date: 11/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/stop-clusterresource?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Stop-ClusterResource
@@ -22,7 +22,7 @@ Stop-ClusterResource [[-Name] <String>] [-IgnoreLocked] [-Wait <Int32>] [-InputO
2222

2323
## DESCRIPTION
2424

25-
The **Stop-ClusterResource** cmdlet takes a resource offline in a failover cluster. Before the
25+
The `Stop-ClusterResource` cmdlet takes a resource offline in a failover cluster. Before the
2626
resource is taken offline, any resources that depend on it are taken offline.
2727

2828
## EXAMPLES
@@ -109,8 +109,8 @@ Accept wildcard characters: False
109109
110110
### -Wait
111111
112-
Specifies the time in seconds to wait for the cmdlet. If the *Wait* parameter is not specified, then
113-
the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
112+
Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified,
113+
then the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
114114
cmdlet returns without waiting.
115115

116116
```yaml

docset/winserver2022-ps/failoverclusters/Suspend-ClusterNode.md

+8-8
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: 10/21/2022
5+
ms.date: 11/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/suspend-clusternode?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Suspend-ClusterNode
@@ -23,8 +23,8 @@ Suspend-ClusterNode [[-Name] <StringCollection>] [-Drain] [-ForceDrain] [-Wait]
2323

2424
## DESCRIPTION
2525

26-
The **Suspend-ClusterNode** cmdlet suspends activity on a failover cluster node, that is, pauses the
27-
node. If you use the *Drain* parameter, clustered roles currently running on the node will be
26+
The `Suspend-ClusterNode` cmdlet suspends activity on a failover cluster node, that is, pauses the
27+
node. If you use the **Drain** parameter, clustered roles currently running on the node will be
2828
drained before the node is paused.
2929

3030
Pausing, or suspending, a node is usually done when applying software updates to the node. If you
@@ -199,10 +199,10 @@ Accept wildcard characters: False
199199
200200
### -Wait
201201
202-
Specifies the time in seconds to wait for the cmdlet. If the *Wait* parameter is not specified, then
203-
the call is initiated and the cmdlet returns without waiting. If specified with no value, then the
204-
cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the cmdlet
205-
returns without waiting.
202+
Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified,
203+
then the call is initiated and the cmdlet returns without waiting. If specified with no value, then
204+
the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
205+
cmdlet returns without waiting.
206206

207207
```yaml
208208
Type: SwitchParameter
@@ -218,7 +218,7 @@ Accept wildcard characters: False
218218

219219
### -WhatIf
220220

221-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
221+
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
222222

223223
```yaml
224224
Type: SwitchParameter

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

+4-4
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: 10/21/2022
5+
ms.date: 11/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/suspend-clusterresource?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Suspend-ClusterResource
@@ -23,7 +23,7 @@ Suspend-ClusterResource [[-Name] <String>] [-VolumeName <String>] [-RedirectedAc
2323

2424
## DESCRIPTION
2525

26-
The **Suspend-ClusterResource** cmdlet turns on maintenance for a disk resource or Cluster Shared
26+
The `Suspend-ClusterResource` cmdlet turns on maintenance for a disk resource or Cluster Shared
2727
Volume (CSV) so that a disk maintenance tool can be run without triggering failover.
2828

2929
This cmdlet only applies to disks and CSVs. For Cluster Shared Volumes, turning on maintenance takes
@@ -158,7 +158,7 @@ Accept wildcard characters: False
158158
### -VolumeName
159159
160160
Specifies the name of the volume to suspend. This parameter is only applicable to CSVs. If this
161-
parameter is not specified, then the operation will be performed on all volumes on the CSV.
161+
parameter isn't specified, then the operation will be performed on all volumes on the CSV.
162162
163163
```yaml
164164
Type: String
@@ -174,7 +174,7 @@ Accept wildcard characters: False
174174
175175
### -WhatIf
176176
177-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
177+
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
178178
179179
```yaml
180180
Type: SwitchParameter

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

+8-8
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: 10/21/2022
5+
ms.date: 11/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/test-cluster?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Test-Cluster
@@ -143,19 +143,19 @@ Accept wildcard characters: False
143143
Specifies the disk number or disks for which to run the cmdlet. If the specified disk is online and
144144
is assigned to a clustered role or Cluster Shared Volume, you must also specify the **Force**
145145
parameter to take the disk offline for the duration of the storage tests. Otherwise, the specified
146-
disk must be offline before the cmdlet is run. If the **Disk** parameter is not specified, storage
146+
disk must be offline before the cmdlet is run. If the **Disk** parameter isn't specified, storage
147147
tests run on all disks that are available for use in the cluster or that are in the cluster resource
148148
offline or failed state.
149149
150150
The acceptable values for this parameter are:
151151
152-
- **Int32, Int64, Uint32, Uint64**. A number that represents a master boot record (MBR) signature of
152+
- **Int32, Int64, Uint32, or Uint64**. A number that represents a master boot record (MBR) signature of
153153
the disk.
154154
- **System.String**. A string that represents a master boot record (MBR) signature of the disk,
155155
hexadecimal format is supported.
156156
- **System.String**. A string that represents the GUID of a GPT disk.
157157
- **ClusterResource**. A cluster resource object that represents a clustered disk.
158-
- **CimInstance#MSFT_Disk**. An object returned from Get-Disk, from the Windows PowerShell storage
158+
- **CimInstance#MSFT_Disk**. An object returned from `Get-Disk`, from the Windows PowerShell storage
159159
module.
160160

161161
```yaml
@@ -173,8 +173,8 @@ Accept wildcard characters: False
173173
### -Force
174174

175175
Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation
176-
from the user before proceeding. When combined with the **Disk** or **Pool** parameters, the disks or
177-
storage pool is taken offline for the duration of the storage tests.
176+
from the user before proceeding. When combined with the **Disk** or **Pool** parameters, the disks
177+
or storage pool is taken offline for the duration of the storage tests.
178178

179179
```yaml
180180
Type: SwitchParameter
@@ -278,7 +278,7 @@ storage pool is online and a virtual disk in the storage pool is assigned to a c
278278
Cluster Shared Volume, you must also specify the **Force** parameter to take the storage pool
279279
offline for the duration of the storage tests. Otherwise, command will exit with an error. The
280280
specified storage pool must be taken offline before running the storage tests. If the **Pool**
281-
parameter is not specified, storage tests run on all storage pools that are available for use in the
281+
parameter isn't specified, storage tests run on all storage pools that are available for use in the
282282
cluster or that are in the cluster resource offline or failed state.
283283

284284
The acceptable values for this parameter are:
@@ -318,7 +318,7 @@ Accept wildcard characters: False
318318

319319
### -WhatIf
320320

321-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
321+
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
322322

323323
```yaml
324324
Type: SwitchParameter

docset/winserver2022-ps/failoverclusters/Test-ClusterResourceFailure.md

+2-2
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: 10/21/2022
5+
ms.date: 11/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/test-clusterresourcefailure?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Test-ClusterResourceFailure
@@ -22,7 +22,7 @@ Test-ClusterResourceFailure [[-Name] <String>] [-InputObject <PSObject>] [-Clust
2222

2323
## DESCRIPTION
2424

25-
The **Test-ClusterResourceFailure** cmdlet simulates a failure of a cluster resource.
25+
The `Test-ClusterResourceFailure` cmdlet simulates a failure of a cluster resource.
2626

2727
Based on the failover and failback policies, when this cmdlet runs, the Cluster service moves the
2828
clustered role, or resource group, and attempts to bring the clustered resource online. This cmdlet

docset/winserver2022-ps/failoverclusters/Update-ClusterFunctionalLevel.md

+11-11
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: 10/21/2022
5+
ms.date: 11/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/update-clusterfunctionallevel?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Update-ClusterFunctionalLevel
@@ -22,36 +22,36 @@ Update-ClusterFunctionalLevel [-Force] [-WhatIf] [-InputObject <PSObject>] [-Clu
2222

2323
## DESCRIPTION
2424

25-
The **Update-ClusterFunctionalLevel** cmdlet updates the functional level of a mixed-version
25+
The `Update-ClusterFunctionalLevel` cmdlet updates the functional level of a mixed-version
2626
cluster. You can update the cluster after all nodes have been updated.
2727

2828
Starting with Windows Server 2016, you can add a node that runs a more recent version of the Windows
2929
operating system into a cluster of nodes that run a previous version of the Windows operating
30-
system. To add a cluster node, use the **Add-ClusterNode** cmdlet.
30+
system. To add a cluster node, use the `Add-ClusterNode` cmdlet.
3131

3232
After you add a node that runs a different version of the Windows operating system, the cluster
3333
becomes a mixed-version cluster. You can implement a mixed-version cluster to continue to run while
3434
you upgrade the operating system on each node in the cluster.
3535

36-
We recommend that you upgrade all nodes in the cluster within a month. We do not recommend using a
36+
We recommend that you upgrade all nodes in the cluster within a month. We don't recommend using a
3737
mixed-version cluster permanently.
3838

3939
You can use this cmdlet to support a rolling operating system upgrade for a cluster. If you use
4040
cluster that runs Hyper-V in which all the nodes run Windows Server 2012 R2, you can upgrade the
4141
nodes of that cluster without downtime for your virtual machines.
4242

43-
First, drain one cluster node by specifying the *Drain* parameter of the **Suspend-ClusterNode**
43+
First, drain one cluster node by specifying the **Drain** parameter of the `Suspend-ClusterNode`
4444
cmdlet. This cmdlet causes all virtual machines to live-migrate to one of the other hosts.
4545

46-
Next, remove the host from the cluster by using the **Remove-ClusterNode** cmdlet.
46+
Next, remove the host from the cluster by using the `Remove-ClusterNode` cmdlet.
4747

48-
Next, install a new version of the operating system. Do not perform an upgrade or in-place
48+
Next, install a new version of the operating system. Don't perform an upgrade or in-place
4949
installation.
5050

5151
Next, add the Hyper-V role and the **Failover Clustering** feature by using the
52-
**Install-WindowsFeature** cmdlet. For more information, type `Get-Help Install-WindowsFeature`.
52+
`Install-WindowsFeature` cmdlet. For more information, type `Get-Help Install-WindowsFeature`.
5353

54-
Finally, add the node into the cluster by using the **Add-ClusterNode** cmdlet.
54+
Finally, add the node into the cluster by using the `Add-ClusterNode` cmdlet.
5555

5656
Repeat these steps for each node of the cluster.
5757

@@ -67,7 +67,7 @@ cluster_17
6767
```
6868

6969
This command tests whether an update would finish successfully. Because the command includes the
70-
*WhatIf* common parameter, the command does not perform the update.
70+
**WhatIf** common parameter, the command doesn't perform the update.
7171

7272
### Example 2: Update a cluster functional level
7373

@@ -135,7 +135,7 @@ Accept wildcard characters: False
135135
136136
### -WhatIf
137137
138-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
138+
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
139139
140140
```yaml
141141
Type: SwitchParameter

0 commit comments

Comments
 (0)