Skip to content

Commit 5617c49

Browse files
michaeltlombardimichaeltlombardi
authored
Merge pull request MicrosoftDocs#3205 from robinharwood/roharwoo_failoverclusters_example_formatting_2
FailoverClusters Bulk Fixup (2/4) - Update example formatting
2 parents 38dedc8 + 7f9cd8f commit 5617c49

30 files changed

+275
-626
lines changed

‎docset/winserver2022-ps/failoverclusters/Get-ClusterFaultDomainXML.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: ClusterFaultDomain.cdxml-help.xml
44
Module Name: FailoverClusters
5-
ms.date: 11/21/2022
5+
ms.date: 11/22/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterfaultdomainxml?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-ClusterFaultDomainXML
@@ -28,11 +28,8 @@ The `Get-ClusterFaultDomainXML` cmdlet gets the fault domain as an XML string.
2828

2929
### Example 1: Get all fault domains in the cluster in XML form
3030

31-
```
32-
PS C:\> Get-ClusterFaultDomainXML
33-
<Topology>
34-
<Node Name="NMALIWA-VM-1101" Description="" Location=""/>
35-
</Topology>
31+
```powershell
32+
Get-ClusterFaultDomainXML
3633
```
3734

3835
This command gets all the fault domains in the cluster on the local node in XML form.
@@ -103,7 +100,7 @@ Accept wildcard characters: False
103100
### -ThrottleLimit
104101
105102
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
106-
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
103+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
107104
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
108105
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
109106
computer.

‎docset/winserver2022-ps/failoverclusters/Get-ClusterGroup.md‎

Lines changed: 12 additions & 41 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/22/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustergroup?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-ClusterGroup
@@ -32,67 +32,38 @@ together.
3232

3333
### Example 1
3434

35-
```
36-
PS C:\> Get-ClusterGroup
37-
Name OwnerNode State
38-
---- --------- -----
39-
Available Storage node1 Online
40-
Cluster Group node2 Online
41-
cluster1FS node1 Online
42-
cluster1FS-Other node1 Online
35+
```powershell
36+
Get-ClusterGroup
4337
```
4438

4539
This example lists the state and owner node of each clustered role, or resource group, in the local
4640
cluster.
4741

4842
### Example 2
4943

50-
```
51-
PS C:\> Get-ClusterGroup -Name "Cluster Group" | Get-ClusterResource
52-
Name State Group ResourceType
53-
---- ----- ----- ------------
54-
Cluster Disk 1 Online Cluster Group Physical Disk
55-
Cluster IP Address Online Cluster Group IP Address
56-
Cluster IP Addre... Online Cluster Group IPv6 Address
57-
Cluster Name Online Cluster Group Network Name
44+
```powershell
45+
Get-ClusterGroup -Name "Cluster Group" | Get-ClusterResource
5846
```
5947

60-
This example lists the resources in Cluster Group on the local cluster.
48+
This example lists the resources in `Cluster Group` on the local cluster.
6149

6250
### Example 3
6351

64-
```
65-
PS C:\> Get-ClusterNode -Name node1 | Get-ClusterGroup
66-
Name OwnerNode State
67-
---- --------- -----
68-
Cluster Group node1 Online
52+
```powershell
53+
Get-ClusterNode -Name node1 | Get-ClusterGroup
6954
```
7055

7156
This example lists the clustered services and applications, or resource groups, that are currently
72-
owned by node1 in the local cluster.
57+
owned by `node1` in the local cluster.
7358

7459
### Example 4
7560

76-
```
77-
PS C:\> Get-ClusterGroup -Name FileServer1 | Format-List -Property *
78-
Cluster : Cluster1
79-
IsCoreGroup : False
80-
OwnerNode : node1
81-
State : Online
82-
Name : FileServer1
83-
Description :
84-
PersistentState : 0
85-
FailoverThreshold : 4294967295
86-
FailoverPeriod : 6
87-
AutoFailbackType : 0
88-
FailbackWindowStart : 4294967295
89-
FailbackWindowEnd : 4294967295
90-
AntiAffinityClassNames : {}
91-
Id : 189ec8ad-1831-4f57-9bb0-3ffb9cbb9227
61+
```powershell
62+
Get-ClusterGroup -Name FileServer1 | Format-List -Property *
9263
```
9364

9465
This example displays the properties of a clustered file server, or resource group, called
95-
FileServer1, in the form of a list.
66+
`FileServer1`, in the form of a list.
9667

9768
## PARAMETERS
9869

‎docset/winserver2022-ps/failoverclusters/Get-ClusterGroupSet.md‎

Lines changed: 4 additions & 19 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: ClusterCollection.cdxml-help.xml
44
Module Name: FailoverClusters
5-
ms.date: 11/21/2022
5+
ms.date: 11/22/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustergroupset?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-ClusterGroupSet
@@ -28,23 +28,8 @@ The `Get-ClusterGroupSet` cmdlet gets all the group sets in the cluster.
2828

2929
### Example 1: Get all the group sets in the cluster
3030

31-
```
32-
PS C:\> Get-ClusterGroupSet
33-
Name : Set1
34-
GroupNames : {g1}
35-
ProviderNames : {Set2}
36-
StartupDelayTrigger : Delay
37-
StartupCount : 4294967295
38-
IsGlobal : False
39-
StartupDelay : 20
40-
41-
Name : Set2
42-
GroupNames : {g2}
43-
ProviderNames : {}
44-
StartupDelayTrigger : Delay
45-
StartupCount : 4294967295
46-
IsGlobal : False
47-
StartupDelay : 20
31+
```powershell
32+
Get-ClusterGroupSet
4833
```
4934

5035
This command enumerates the group sets in the cluster.
@@ -130,7 +115,7 @@ Accept wildcard characters: False
130115
### -ThrottleLimit
131116
132117
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
133-
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
118+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
134119
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
135120
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
136121
computer.

‎docset/winserver2022-ps/failoverclusters/Get-ClusterGroupSetDependency.md‎

Lines changed: 5 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: ClusterCollection.cdxml-help.xml
44
Module Name: FailoverClusters
5-
ms.date: 11/21/2022
5+
ms.date: 11/22/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustergroupsetdependency?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-ClusterGroupSetDependency
@@ -30,19 +30,11 @@ relationships. You can get all sets that are dependent on a specific set.
3030

3131
### Example 1: Get all the group sets that are provided by the specified set
3232

33-
```
34-
PS C:\> Get-ClusterGroupSetDependency -Provider "Set2"
35-
36-
Name : Set1
37-
GroupNames : {g1}
38-
ProviderNames : {Set2}
39-
StartupDelayTrigger : Delay
40-
StartupCount : 4294967295
41-
IsGlobal : False
42-
StartupDelay : 20
33+
```powershell
34+
Get-ClusterGroupSetDependency -Provider "Set2"
4335
```
4436

45-
This command gets all the group sets that are provided by set named Set2.
37+
This command gets all the group sets that are provided by set named `Set2`.
4638

4739
## PARAMETERS
4840

@@ -157,7 +149,7 @@ Accept wildcard characters: False
157149
### -ThrottleLimit
158150
159151
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
160-
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
152+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
161153
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
162154
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
163155
computer.

‎docset/winserver2022-ps/failoverclusters/Get-ClusterLog.md‎

Lines changed: 10 additions & 22 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/22/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterlog?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-ClusterLog
@@ -36,42 +36,30 @@ authentication on the server computer.
3636

3737
### Example 1: Create a log file for the local cluster
3838

39-
```
40-
PS C:\> Get-ClusterLog
41-
Mode LastWriteTime Length Name
42-
---- ------------- ------ ----
43-
-a--- 9/4/2008 3:53 PM 2211301 Cluster.log
44-
-a--- 9/4/2008 3:53 PM 1261025 Cluster.log
39+
```powershell
40+
Get-ClusterLog
4541
```
4642

4743
This command creates a log file for the local cluster in the cluster reports folder
48-
(C:\Windows\Cluster\Reports) on each node of the cluster.
44+
`C:\Windows\Cluster\Reports` on each node of the cluster.
4945

5046
### Example 2: Create log files for each node and save them locally
5147

52-
```
53-
PS C:\> Get-ClusterLog -Destination .
54-
Mode LastWriteTime Length Name
55-
---- ------------- ------ ----
56-
-a--- 9/4/2008 3:55 PM 2211301 node1_cluster.log
57-
-a--- 9/4/2008 3:55 PM 1261025 node2_cluster.log
48+
```powershell
49+
Get-ClusterLog -Destination .
5850
```
5951

6052
This command creates a log file for each node of the local cluster, and copies all logs to the local
6153
folder.
6254

6355
### Example 3: Create a log file for the local cluster for previous five minutes
6456

65-
```
66-
PS C:\> Get-ClusterLog -TimeSpan 5
67-
Mode LastWriteTime Length Name
68-
---- ------------- ------ ----
69-
-a--- 9/4/2008 3:58 PM 128299 Cluster.log
70-
-a--- 9/4/2008 4:01 PM 104181 Cluster.log
57+
```powershell
58+
Get-ClusterLog -TimeSpan 5
7159
```
7260

7361
This command creates a log file for the local cluster in the cluster reports folder
74-
(C:\Windows\Cluster\Reports) on each node of the cluster. The log covers the last 5 minutes.
62+
`C:\Windows\Cluster\Reports` on each node of the cluster. The log covers the last 5 minutes.
7563

7664
## PARAMETERS
7765

@@ -95,7 +83,7 @@ Accept wildcard characters: False
9583
### -Destination
9684
9785
Specifies the location to which to copy one or more cluster logs. To copy to the current folder, use
98-
`.` for this parameter input. Default location is C:\Windows\Cluster\Reports.
86+
`.` for this parameter input. Default location is `C:\Windows\Cluster\Reports`.
9987

10088
```yaml
10189
Type: String

‎docset/winserver2022-ps/failoverclusters/Get-ClusterNetwork.md‎

Lines changed: 6 additions & 11 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/22/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusternetwork?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-ClusterNetwork
@@ -29,24 +29,19 @@ A failover cluster requires network connectivity among nodes and between clients
2929

3030
### Example 1
3131

32-
```
33-
PS C:\> Get-ClusterNetwork
34-
Name State
35-
---- -----
36-
Cluster Network 1 Up
37-
Cluster Network 2 Up
38-
Cluster Network 3 Up
32+
```powershell
33+
Get-ClusterNetwork
3934
```
4035

4136
This example gets information about the networks used by the local cluster.
4237

4338
### Example 2
4439

45-
```
46-
PS C:\> (Get-ClusterNetwork -Name "Cluster Network 1").Name = "Cluster Network 3"
40+
```powershell
41+
(Get-ClusterNetwork -Name "Cluster Network 1").Name = "Cluster Network 3"
4742
```
4843

49-
This example renames Cluster Network 1 to Cluster Network 3.
44+
This example renames `Cluster Network 1` to `Cluster Network 3`.
5045

5146
## PARAMETERS
5247

‎docset/winserver2022-ps/failoverclusters/Get-ClusterNetworkInterface.md‎

Lines changed: 6 additions & 16 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/22/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusternetworkinterface?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-ClusterNetworkInterface
@@ -30,29 +30,19 @@ and nodes.
3030

3131
### Example 1
3232

33-
```
34-
PS C:\> Get-ClusterNetworkInterface
35-
Name Node Network State
36-
---- ---- ------- -----
37-
node1 - Local A ... node1 Cluster Network 1 Up
38-
node2 - Local A ... node2 Cluster Network 1 Up
39-
node1 - Local A ... node1 Cluster Network 2 Up
40-
node2 - Local A ... node2 Cluster Network 2 Up
33+
```powershell
34+
Get-ClusterNetworkInterface
4135
```
4236

4337
This example displays information about the physical network adapters used by the local cluster.
4438

4539
### Example 2
4640

47-
```
48-
PS C:\> Get-ClusterNode -Name node1 | Get-ClusterNetworkInterface
49-
Name Node Network State
50-
---- ---- ------- -----
51-
node1 - Local A ... node1 Cluster Network 1 Up
52-
node1 - Local A ... node1 Cluster Network 2 Up
41+
```powershell
42+
Get-ClusterNode -Name node1 | Get-ClusterNetworkInterface
5343
```
5444

55-
This example displays information about the physical network adapters used by node1 in the local
45+
This example displays information about the physical network adapters used by `node1` in the local
5646
cluster. This cmdlet is equivalent to `Get-ClusterNetworkInterface -Node node1`.
5747

5848
## PARAMETERS

0 commit comments

Comments
 (0)