Skip to content

Commit 2d064c2

Browse files
Merge pull request MicrosoftDocs#3207 from robinharwood/roharwoo_failoverclusters_example_formatting_4
FailoverClusters Bulk Fixup (4/4) - Update example formatting
2 parents e4a00fc + e25fd40 commit 2d064c2

13 files changed

+95
-148
lines changed

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

Lines changed: 8 additions & 14 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: 11/21/2022
5+
ms.date: 11/23/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
@@ -29,28 +29,22 @@ resource is brought online, any resources that it depends are brought online.
2929

3030
### Example 1
3131

32-
```
33-
PS C:\> Start-ClusterResource -Name "IP Address 172.24.11.0"
34-
Name State Group ResourceType
35-
---- ----- ----- ------------
36-
IP Address 172.2... Online cluster1FS12 IP Address
32+
```powershell
33+
Start-ClusterResource -Name "IP Address 172.24.11.0"
3734
```
3835

39-
This example brings the resource called IP Address 172.24.11.0 online on the local cluster. Before
36+
This example brings the resource called `IP Address 172.24.11.0` online on the local cluster. Before
4037
bringing the resource online, this cmdlet brings online any resources on which the resource depends.
4138

4239
### Example 2
4340

44-
```
45-
PS C:\> Start-ClusterResource -Name "IP Address 172.24.11.0" -Wait 0
46-
Name State Group ResourceType
47-
---- ----- ----- ------------
48-
IP Address 172.2... OnlinePending cluster1FS12 IP Address
41+
```powershell
42+
Start-ClusterResource -Name "IP Address 172.24.11.0" -Wait 0
4943
```
5044

51-
This example brings the resource called IP Address 172.24.11.0 online on the local cluster. Before
45+
This example brings the resource called `IP Address 172.24.11.0` online on the local cluster. Before
5246
bringing the resource online, this cmdlet brings online any resources on which the resource depends.
53-
The Windows PowerShell® prompt returns as soon as the action has been initiated.
47+
The Windows PowerShell prompt returns as soon as the action has been initiated.
5448

5549
## PARAMETERS
5650

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

Lines changed: 6 additions & 6 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: 11/21/2022
5+
ms.date: 11/23/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
@@ -40,20 +40,20 @@ the cluster when the Cluster service is running on that node.
4040

4141
### Example 1: Stop Cluster service on all nodes of the local cluster
4242

43-
```
44-
PS C:\> Stop-Cluster
43+
```powershell
44+
Stop-Cluster
4545
```
4646

4747
This example stops the Cluster service on all nodes in the local cluster, which will stop all
4848
services and applications configured in the cluster.
4949

5050
### Example 2: Stop Cluster service on all nodes of a cluster
5151

52-
```
53-
PS C:\> Stop-Cluster -Name cluster1
52+
```powershell
53+
Stop-Cluster -Name cluster1
5454
```
5555

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

5959
## PARAMETERS

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

Lines changed: 4 additions & 7 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: 11/21/2022
5+
ms.date: 11/23/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
@@ -32,14 +32,11 @@ fashion by using this cmdlet.
3232

3333
### Example 1: Stop a clustered role on the local cluster
3434

35-
```
36-
PS C:\> Stop-ClusterGroup FileServer1
37-
Name OwnerNode State
38-
---- --------- -----
39-
FileServer1 node1 Offline
35+
```powershell
36+
Stop-ClusterGroup FileServer1
4037
```
4138

42-
This example stops the clustered role, or resource group, called FileServer1 on the local cluster.
39+
This example stops the clustered role, or resource group, called `FileServer1` on the local cluster.
4340

4441
## PARAMETERS
4542

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

Lines changed: 7 additions & 13 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: 11/21/2022
5+
ms.date: 11/23/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
@@ -33,25 +33,19 @@ authentication on the server computer.
3333

3434
### Example 1: Stop Cluster service on a local cluster node
3535

36-
```
37-
PS C:\> Stop-ClusterNode -Name "node3"
38-
Name State
39-
---- -----
40-
node3 Down
36+
```powershell
37+
Stop-ClusterNode -Name "node3"
4138
```
4239

43-
This example stops the Cluster service on the node named node3 of the local cluster.
40+
This example stops the Cluster service on the node named `node3` of the local cluster.
4441

4542
### Example 2: Stop Cluster service on a cluster node
4643

47-
```
48-
PS C:\> Stop-ClusterNode -Name "node1" -Cluster "cluster2"
49-
Name State
50-
---- -----
51-
node1 Down
44+
```powershell
45+
Stop-ClusterNode -Name "node1" -Cluster "cluster2"
5246
```
5347

54-
This example stops the Cluster service on the node named node1 on the cluster named cluster2.
48+
This example stops the Cluster service on the node named `node1` on the cluster named `cluster2`.
5549

5650
## PARAMETERS
5751

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

Lines changed: 5 additions & 8 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: 11/21/2022
5+
ms.date: 11/23/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
@@ -29,15 +29,12 @@ resource is taken offline, any resources that depend on it are taken offline.
2929

3030
### Example 1: Take a resource offline
3131

32-
```
33-
PS C:\> Stop-ClusterResource "IP Address 10.24.11.0"
34-
Name State Group ResourceType
35-
---- ----- ----- ------------
36-
IP Address 10.2... Offline cluster1FS12 IP Address
32+
```powershell
33+
Stop-ClusterResource "IP Address 10.24.11.0"
3734
```
3835

39-
This example takes the resource called IP Address 10.24.11.0 offline on the local cluster. Before
40-
taking the resource offline, it takes offline any dependent resources.
36+
This example takes the resource called `IP Address 10.24.11.0` offline on the local cluster.
37+
Before taking the resource offline, it takes offline any dependent resources.
4138

4239
## PARAMETERS
4340

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

Lines changed: 14 additions & 23 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: 11/21/2022
5+
ms.date: 11/23/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
@@ -35,45 +35,36 @@ stop, not pause, the Cluster service on that node.
3535

3636
### Example 1: Pause a node of the local cluster
3737

38-
```
39-
PS C:\> Suspend-ClusterNode -Name "node1"
40-
Name State
41-
---- -----
42-
node1 Paused
38+
```powershell
39+
Suspend-ClusterNode -Name "node1"
4340
```
4441

45-
This example pauses the node named node1 on the local cluster.
42+
This example pauses the node named `node1` on the local cluster.
4643

4744
### Example 2: Pause a node of a cluster
4845

49-
```
50-
PS C:\> Suspend-ClusterNode "node2" -Cluster "cluster2"
51-
Name State
52-
---- -----
53-
node2 Paused
46+
```powershell
47+
Suspend-ClusterNode "node2" -Cluster "cluster2"
5448
```
5549

56-
This example pauses the node named node2 on the cluster named cluster2.
50+
This example pauses the node named `node2` on the cluster named `cluster2`.
5751

5852
### Example 3: Pause a node and move its workloads
5953

60-
```
61-
PS C:\> Suspend-ClusterNode -Name "node1" -Target "node2" -Drain
62-
Name State
63-
---- -----
64-
node1 Paused
54+
```powershell
55+
Suspend-ClusterNode -Name "node1" -Target "node2" -Drain
6556
```
6657

67-
This example pauses the node named node1 and moves the workloads from it to the node named node2.
58+
This example pauses the node named `node1` and moves the workloads from it to the node named
59+
`node2`.
6860

6961
### Example 4: Preview a pause operation
7062

71-
```
72-
PS C:\> Suspend-ClusterNode node1 -Drain -WhatIf
73-
What if: Performing operation "Suspend-ClusterNode" on Target "node1".
63+
```powershell
64+
Suspend-ClusterNode node1 -Drain -WhatIf
7465
```
7566

76-
This example provides a preview of the operation that will be performed on the node named node1.
67+
This example provides a preview of the operation that will be performed on the node named `node1`.
7768

7869
## PARAMETERS
7970

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

Lines changed: 7 additions & 13 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: 11/21/2022
5+
ms.date: 11/23/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
@@ -34,26 +34,20 @@ dependent resources offline, which interrupts client access. For other disks, Lo
3434

3535
### Example 1: Turn on maintenance for a CSV
3636

37-
```
38-
PS C:\> Suspend-ClusterResource -Name "Cluster Disk 2"
39-
Name State Group ResourceType
40-
---- ----- ----- ------------
41-
Cluster Disk 2 Online(Maintenance) Available Storage Physical Disk
37+
```powershell
38+
Suspend-ClusterResource -Name "Cluster Disk 2"
4239
```
4340

44-
This example turns on maintenance for CSV named Cluster Disk 2 so that you can run a disk
41+
This example turns on maintenance for CSV named `Cluster Disk 2` so that you can run a disk
4542
maintenance tool without triggering failover.
4643

4744
### Example 2: Turn on maintenance for multiple volumes
4845

49-
```
50-
PS C:\> Get-ClusterSharedVolume -Name "Cluster Disk 5" | Suspend-ClusterResource
51-
Name State Node
52-
---- ----- ----
53-
Cluster Disk 5 Online node2
46+
```powershell
47+
Get-ClusterSharedVolume -Name "Cluster Disk 5" | Suspend-ClusterResource
5448
```
5549

56-
This example turns on maintenance for all volumes on the CSV named Cluster Disk 5.
50+
This example turns on maintenance for all volumes on the CSV named `Cluster Disk 5`.
5751

5852
## PARAMETERS
5953

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

Lines changed: 4 additions & 3 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: 11/21/2022
5+
ms.date: 11/23/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
@@ -55,8 +55,9 @@ This example runs all applicable cluster validation tests on the local cluster.
5555
Test-Cluster -Node "node1", "node2"
5656
```
5757

58-
This example runs all cluster validation tests on the nodes named node1 and node2. If either node1
59-
or node2 is already a member of a cluster, then the tests will include all nodes in that cluster.
58+
This example runs all cluster validation tests on the nodes named `node1` and `node2`. If either
59+
`node1` or `node2` is already a member of a cluster, then the tests will include all nodes in that
60+
cluster.
6061

6162
### Example 3: View tests and categories in cluster validation
6263

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

Lines changed: 4 additions & 7 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: 11/21/2022
5+
ms.date: 11/23/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
@@ -32,14 +32,11 @@ can be used to simulate what actions the Cluster service will take when a resour
3232

3333
### Example 1: Simulate a failure
3434

35-
```
36-
PS C:\> Test-ClusterResourceFailure -Name "Cluster Disk 4"
37-
Name State Group ResourceType
38-
---- ----- ----- ------------
39-
Cluster Disk 4 Failed cluster12FS Physical Disk
35+
```powershell
36+
Test-ClusterResourceFailure -Name "Cluster Disk 4"
4037
```
4138

42-
This example simulates a failure in cluster resource named Cluster Disk 4.
39+
This example simulates a failure in cluster resource named `Cluster Disk 4`.
4340

4441
## PARAMETERS
4542

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

Lines changed: 7 additions & 13 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: 11/21/2022
5+
ms.date: 11/23/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
@@ -59,27 +59,21 @@ Repeat these steps for each node of the cluster.
5959

6060
### Example 1: Test a possible update
6161

62-
```
63-
PS C:\> Update-ClusterFunctionalLevel -WhatIf
64-
Name
65-
----
66-
cluster_17
62+
```powershell
63+
Update-ClusterFunctionalLevel -WhatIf
6764
```
6865

6966
This command tests whether an update would finish successfully. Because the command includes the
7067
**WhatIf** common parameter, the command doesn't perform the update.
7168

7269
### Example 2: Update a cluster functional level
7370

74-
```
75-
PS C:\> Update-ClusterFunctionalLevel -Cluster "cluster_17"
76-
Name
77-
----
78-
cluster_17
71+
```powershell
72+
Update-ClusterFunctionalLevel -Cluster "cluster_17"
7973
```
8074

81-
This command updates the cluster functional level of the cluster named cluster_17. All of the nodes
82-
of this cluster must already be updated before you run this command.
75+
This command updates the cluster functional level of the cluster named `cluster_17`. All of the
76+
nodes of this cluster must already be updated before you run this command.
8377

8478
## PARAMETERS
8579

0 commit comments

Comments
 (0)