Skip to content

Commit 38dedc8

Browse files
Merge pull request MicrosoftDocs#3206 from robinharwood/roharwoo_failoverclusters_example_formatting_3
FailoverClusters Bulk Fixup (3/4) - Update example formatting
2 parents 281deac + dfe9f32 commit 38dedc8

29 files changed

+240
-304
lines changed

docset/winserver2022-ps/failoverclusters/Remove-ClusterCheckpoint.md

Lines changed: 6 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: 01/09/2023
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustercheckpoint?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Remove-ClusterCheckpoint
@@ -36,20 +36,13 @@ local server.
3636

3737
### Example 1
3838

39+
```powershell
40+
$checkpoint = Get-ClusterCheckpoint -ResourceName "Cluster Name" -RegistryCheckpoint
41+
$checkpoint | Remove-ClusterCheckpoint -Confirm:$false
3942
```
40-
PS C:\> Get-ClusterResource "Cluster Name" | Remove-ClusterCheckpoint -RegistryCheckpoint
4143

42-
43-
44-
PS C:\> Remove-ClusterCheckpoint
45-
Are you sure you want to remove registry checkpoint 'software\clusname' on resource 'Cluster Name'?
46-
47-
48-
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):Y
49-
```
50-
51-
This example removes the registry checkpoint called software\clusname for the resource named Cluster
52-
Name.
44+
This example returns all registry checkpoints for the resource named `Cluster Name`, then removes
45+
them without user confirmation.
5346

5447
## PARAMETERS
5548

docset/winserver2022-ps/failoverclusters/Remove-ClusterFaultDomain.md

Lines changed: 5 additions & 5 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: 10/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterfaultdomain?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Remove-ClusterFaultDomain
@@ -39,11 +39,11 @@ The `Remove-ClusterFaultDomain` cmdlet removes a fault domain. The fault domain
3939

4040
### Example 1: Remove a cluster fault domain
4141

42-
```
43-
PS C:\> Remove-ClusterFaultDomain -Name "Rack001"
42+
```powershell
43+
Remove-ClusterFaultDomain -Name "Rack001"
4444
```
4545

46-
This command removes the cluster fault domain named Rack001.
46+
This command removes the cluster fault domain named `Rack001`.
4747

4848
## PARAMETERS
4949

@@ -191,7 +191,7 @@ Accept wildcard characters: False
191191
### -ThrottleLimit
192192
193193
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
194-
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
194+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
195195
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
196196
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
197197
computer.

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

Lines changed: 11 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: 10/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustergroup?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Remove-ClusterGroup
@@ -32,30 +32,30 @@ resources first, or specify the **RemoveResources** parameter.
3232

3333
### Example 1
3434

35-
```
36-
PS C:\> Remove-ClusterGroup -Name MyFileServer
35+
```powershell
36+
Remove-ClusterGroup -Name MyFileServer
3737
```
3838

3939
This example prompts the user for confirmation and then removes the clustered role named
40-
MyFileServer, if the resources have first been removed from it.
40+
`MyFileServer`, if the resources have first been removed from it.
4141

4242
### Example 2
4343

44-
```
45-
PS C:\> Remove-ClusterGroup -Name MyFileServer -Force
44+
```powershell
45+
Remove-ClusterGroup -Name MyFileServer -Force
4646
```
4747

48-
This example removes the clustered role named MyFileServer, if the resources have first been removed
48+
This example removes the clustered role named `MyFileServer`, if the resources have first been removed
4949
from it. The cmdlet doesn't prompt for confirmation.
5050

5151
### Example 3
5252

53-
```
54-
PS C:\> Remove-ClusterGroup -Name MyFileServer -Force -RemoveResources
53+
```powershell
54+
Remove-ClusterGroup -Name MyFileServer -Force -RemoveResources
5555
```
5656

57-
This example removes the clustered role named MyFileServer, without prompting for confirmation. All
58-
cluster resources in MyFileServer will be deleted.
57+
This example removes the clustered role named `MyFileServer`, without prompting for confirmation.
58+
All cluster resources in `MyFileServer` will be deleted.
5959

6060
## PARAMETERS
6161

docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromSet.md

Lines changed: 5 additions & 4 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: 10/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustergroupfromset?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Remove-ClusterGroupFromSet
@@ -37,11 +37,12 @@ The `Remove-ClusterGroupFromSet` cmdlet removes a group from a set.
3737

3838
### Example 1: Remove a group from the specified group set
3939

40-
```
41-
PS C:\> Remove-ClusterGroupFromSet -Name "Set001" -Group "Group001"
40+
```powershell
41+
Remove-ClusterGroupSetDependency -Name "Set001" -Provider "Set002"
4242
```
4343

44-
This command removes the group named Group001 from group set named Set001.
44+
This command removes the group set named `Set002` from being a provider for the group set named
45+
`Set001`.
4546

4647
## PARAMETERS
4748

docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSet.md

Lines changed: 5 additions & 5 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: 10/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustergroupset?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Remove-ClusterGroupSet
@@ -37,11 +37,11 @@ Removes a group set from the cluster. The group set cannot be a provider for ano
3737

3838
### Example 1: Remove a group set from the cluster
3939

40-
```
41-
PS C:\> Remove-ClusterGroupSet -Name "Set001"
40+
```powershell
41+
Remove-ClusterGroupSet -Name "Set001"
4242
```
4343

44-
This command removes the group set named Set001 from the cluster.
44+
This command removes the group set named `Set001` from the cluster.
4545

4646
## PARAMETERS
4747

@@ -157,7 +157,7 @@ Accept wildcard characters: False
157157
### -ThrottleLimit
158158
159159
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
160+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
161161
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
162162
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
163163
computer.

docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSetDependency.md

Lines changed: 8 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: ClusterCollection.cdxml-help.xml
44
Module Name: FailoverClusters
5-
ms.date: 11/21/2022
5+
ms.date: 10/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustergroupsetdependency?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Remove-ClusterGroupSetDependency
@@ -11,6 +11,8 @@ title: Remove-ClusterGroupSetDependency
1111
# Remove-ClusterGroupSetDependency
1212

1313
## SYNOPSIS
14+
Removes a dependency from a group set.
15+
1416
## SYNTAX
1517

1618
### Query (cdxml) (Default)
@@ -35,12 +37,12 @@ The `Remove-ClusterGroupSetDependency` cmdlet removes a dependency from a group
3537

3638
### Example 1: Remove a group set dependency on another group set
3739

38-
```
39-
PS C:\> Remove-ClusterGroupSetDependency -Name "Set001" -Provider "Set002"
40+
```powershell
41+
Remove-ClusterGroupSetDependency -Name "Set001" -Provider "Set002"
4042
```
4143

42-
This command removes the group set named Set002 from being a provider for the group set named
43-
Set001.
44+
This command removes the group set named `Set002` from being a provider for the group set named
45+
`Set001`.
4446

4547
## PARAMETERS
4648

@@ -156,7 +158,7 @@ Accept wildcard characters: False
156158
### -ThrottleLimit
157159
158160
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
159-
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
161+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell calculates an
160162
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
161163
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
162164
computer.

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

Lines changed: 8 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: 10/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusternode?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Remove-ClusterNode
@@ -34,19 +34,20 @@ authentication on the server computer.
3434

3535
### Example 1
3636

37-
```
38-
PS C:\> Remove-ClusterNode -Name node4
37+
```powershell
38+
Remove-ClusterNode -Name node4
3939
```
4040

41-
This example removes the node named node4 from the local cluster.
41+
This example removes the node named `node4` from the local cluster.
4242

4343
### Example 2
4444

45-
```
46-
PS C:\> Remove-ClusterNode -Name node4 -Force
45+
```powershell
46+
Remove-ClusterNode -Name node4 -Force
4747
```
4848

49-
This example removes the node named node4 from the local cluster without prompting for confirmation.
49+
This example removes the node named `node4` from the local cluster without prompting for
50+
confirmation.
5051

5152
## PARAMETERS
5253

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

Lines changed: 7 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: 10/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterresource?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Remove-ClusterResource
@@ -29,20 +29,20 @@ removing a resource, be sure to review whether any other resource is dependent o
2929

3030
### Example 1
3131

32-
```
33-
PS C:\> Remove-ClusterResource -Name "Cluster Disk 4"
32+
```powershell
33+
Remove-ClusterResource -Name "Cluster Disk 4"
3434
```
3535

36-
This example prompts the user for confirmation and then deletes the cluster named Cluster Disk 4
36+
This example prompts the user for confirmation and then deletes the cluster named `Cluster Disk 4`
3737
from the local cluster.
3838

3939
### Example 2
4040

41-
```
42-
PS C:\> Remove-ClusterResource -Name "Cluster Disk 5" -Force
41+
```powershell
42+
Remove-ClusterResource -Name "Cluster Disk 5" -Force
4343
```
4444

45-
This example deletes the cluster named Cluster Disk 5 from the local cluster without prompting for
45+
This example deletes the cluster named `Cluster Disk 5` from the local cluster without prompting for
4646
confirmation.
4747

4848
## PARAMETERS

docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md

Lines changed: 18 additions & 15 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: 10/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterresourcedependency?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Remove-ClusterResourceDependency
@@ -34,27 +34,30 @@ offline might vary.
3434

3535
### Example 1
3636

37-
```
38-
PS C:\> Remove-ClusterResourceDependency -Resource cluster1FS -Provider "IP Address 2001:4898:9:2:: (3)"
39-
Name State Group ResourceType
40-
---- ----- ----- ------------
41-
cluster1FS Online cluster1FS Network Name
37+
```powershell
38+
$parameters = @{
39+
Resource = 'cluster1FS'
40+
Provider = 'IP Address 2001:4898:9:2:: (3)'
41+
}
42+
Remove-ClusterResourceDependency @parameters
4243
```
4344

44-
This example removes the dependency between cluster resource cluster1FS and the resource named IP
45-
Address 2001:4898:9:2:: (3).
45+
This example removes the dependency between cluster resource `cluster1FS` and the resource named
46+
`IP Address 2001:4898:9:2:: (3)`.
4647

4748
### Example 2
4849

49-
```
50-
PS C:\> Get-ClusterResource -Name cluster1FS | Remove-ClusterResourceDependency -Provider "IP Address 2001:4898:9:2:: (3)"
51-
Name State Group ResourceType
52-
---- ----- ----- ------------
53-
cluster1FS Online cluster1FS Network Name
50+
```powershell
51+
$parameters = @{
52+
Provider = 'IP Address 2001:4898:9:2:: (3)'
53+
}
54+
Get-ClusterResource -Name cluster1FS | Remove-ClusterResourceDependency @parameters
5455
```
5556

56-
This example removes the dependency between the cluster resource named cluster1FS and the resource
57-
named IP Address 2001:4898:9:2:: (3).
57+
This example removes the dependency between the cluster resource named `cluster1FS` and the resource
58+
named `IP Address 2001:4898:9:2:: (3)`. This example uses splatting to pass parameter values from
59+
the `$Parameters` variable to the command. Learn more about
60+
[Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting).
5861

5962
## PARAMETERS
6063

docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceType.md

Lines changed: 4 additions & 4 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: 10/21/2022
66
online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterresourcetype?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Remove-ClusterResourceType
@@ -31,11 +31,11 @@ resources of that type will not be able to be used in the cluster.
3131

3232
### Example 1
3333

34-
```
35-
PS C:\> Remove-ClusterResourceType -Name ResType1
34+
```powershell
35+
Remove-ClusterResourceType -Name ResType1
3636
```
3737

38-
This example removes the registered resource type named ResType1 on the local cluster.
38+
This example removes the registered resource type named `ResType1` on the local cluster.
3939

4040
## PARAMETERS
4141

0 commit comments

Comments
 (0)