Skip to content

Commit bdaf9bd

Browse files
Merge pull request MicrosoftDocs#3164 from robinharwood/roharwoo_failoverclusters_line_formatting_3
FailoverClustering Bulk Fixup (3/4) - Line formatting updates
2 parents b869447 + 22219d4 commit bdaf9bd

30 files changed

+1042
-566
lines changed

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

Lines changed: 36 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/remove-clustercheckpoint?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Remove-ClusterCheckpoint
@@ -16,20 +16,26 @@ Removes a cryptographic key checkpoint or registry checkpoint for a resource.
1616
## SYNTAX
1717

1818
```
19-
Remove-ClusterCheckpoint [[-ResourceName] <String>] [-Force] [-CheckpointName <String>] [-RegistryCheckpoint]
20-
[-CryptoCheckpoint] [-InputObject <PSObject>] [-Cluster <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
19+
Remove-ClusterCheckpoint [[-ResourceName] <String>] [-Force] [-CheckpointName <String>]
20+
[-RegistryCheckpoint] [-CryptoCheckpoint] [-InputObject <PSObject>] [-Cluster <String>] [-WhatIf]
21+
[-Confirm] [<CommonParameters>]
2122
```
2223

2324
## DESCRIPTION
24-
The **Remove-ClusterCheckpoint** cmdlet removes a cryptographic key checkpoint or registry checkpoint for a resource.
2525

26-
Checkpoints help provide failover support for applications that store configuration information locally instead of or in addition to storing information in the cluster configuration database.
27-
Applications might store information locally in two ways.
28-
One way is to store configuration information in the registry on the local server; another way is to use cryptographic keys on the local server.
26+
The **Remove-ClusterCheckpoint** cmdlet removes a cryptographic key checkpoint or registry
27+
checkpoint for a resource.
28+
29+
Checkpoints help provide failover support for applications that store configuration information
30+
locally instead of or in addition to storing information in the cluster configuration database.
31+
Applications might store information locally in two ways. One way is to store configuration
32+
information in the registry on the local server; another way is to use cryptographic keys on the
33+
local server.
2934

3035
## EXAMPLES
3136

3237
### Example 1
38+
3339
```
3440
PS C:\> Get-ClusterResource "Cluster Name" | Remove-ClusterCheckpoint -RegistryCheckpoint
3541
@@ -42,11 +48,13 @@ Are you sure you want to remove registry checkpoint 'software\clusname' on resou
4248
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):Y
4349
```
4450

45-
This example removes the registry checkpoint called software\clusname for the resource named Cluster Name.
51+
This example removes the registry checkpoint called software\clusname for the resource named Cluster
52+
Name.
4653

4754
## PARAMETERS
4855

4956
### -CheckpointName
57+
5058
Specifies the name of the checkpoint to remove.
5159

5260
```yaml
@@ -62,8 +70,9 @@ Accept wildcard characters: False
6270
```
6371
6472
### -Cluster
65-
Specifies the name of the cluster on which to run this cmdlet.
66-
If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster.
73+
74+
Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is
75+
`.` or it is omitted, then the cmdlet runs on the local cluster.
6776

6877
```yaml
6978
Type: String
@@ -78,6 +87,7 @@ Accept wildcard characters: False
7887
```
7988

8089
### -Confirm
90+
8191
Prompts you for confirmation before running the cmdlet.
8292

8393
```yaml
@@ -93,6 +103,7 @@ Accept wildcard characters: False
93103
```
94104

95105
### -CryptoCheckpoint
106+
96107
Specifies that cryptographic key checkpoints will be removed.
97108

98109
```yaml
@@ -108,8 +119,9 @@ Accept wildcard characters: False
108119
```
109120

110121
### -Force
111-
Runs the cmdlet without prompting for confirmation.
112-
By default the cmdlet will ask for confirmation from the user before proceeding.
122+
123+
Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation
124+
from the user before proceeding.
113125

114126
```yaml
115127
Type: SwitchParameter
@@ -124,7 +136,9 @@ Accept wildcard characters: False
124136
```
125137

126138
### -InputObject
127-
Specifies the cluster on which to run the cmdlet or the cluster resource from which to remove the checkpoint.
139+
140+
Specifies the cluster on which to run the cmdlet or the cluster resource from which to remove the
141+
checkpoint.
128142

129143
```yaml
130144
Type: PSObject
@@ -139,6 +153,7 @@ Accept wildcard characters: False
139153
```
140154

141155
### -RegistryCheckpoint
156+
142157
Specifies that registry checkpoints will be removed.
143158

144159
```yaml
@@ -154,6 +169,7 @@ Accept wildcard characters: False
154169
```
155170

156171
### -ResourceName
172+
157173
Specifies the resource from which a checkpoint should be removed.
158174

159175
```yaml
@@ -169,8 +185,8 @@ Accept wildcard characters: False
169185
```
170186

171187
### -WhatIf
172-
Shows what would happen if the cmdlet runs.
173-
The cmdlet is not run.
188+
189+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
174190

175191
```yaml
176192
Type: SwitchParameter
@@ -185,7 +201,11 @@ Accept wildcard characters: False
185201
```
186202

187203
### CommonParameters
188-
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).
204+
205+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
206+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
207+
-WarningAction, and -WarningVariable. For more information, see
208+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
189209

190210
## INPUTS
191211

@@ -204,4 +224,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
204224
[Add-ClusterCheckpoint](./Add-ClusterCheckpoint.md)
205225

206226
[Get-ClusterCheckpoint](./Get-ClusterCheckpoint.md)
207-

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

Lines changed: 47 additions & 25 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: 12/20/2016
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
@@ -16,24 +16,29 @@ Removes a fault domain.
1616
## SYNTAX
1717

1818
### Query (cdxml) (Default)
19+
1920
```
20-
Remove-ClusterFaultDomain [[-Name] <String[]>] [-Id <String[]>] [-Flags <UInt32>] [-CimSession <CimSession[]>]
21-
[-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
Remove-ClusterFaultDomain [[-Name] <String[]>] [-Id <String[]>] [-Flags <UInt32>]
22+
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf] [-Confirm]
23+
[<CommonParameters>]
2224
```
2325

2426
### InputObject (cdxml)
27+
2528
```
26-
Remove-ClusterFaultDomain -InputObject <CimInstance[]> [-Flags <UInt32>] [-CimSession <CimSession[]>]
27-
[-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
29+
Remove-ClusterFaultDomain -InputObject <CimInstance[]> [-Flags <UInt32>]
30+
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf] [-Confirm]
31+
[<CommonParameters>]
2832
```
2933

3034
## DESCRIPTION
31-
The **Remove-ClusterFaultDomain** cmdlet removes a fault domain.
32-
The fault domain cannot be empty.
35+
36+
The **Remove-ClusterFaultDomain** cmdlet removes a fault domain. The fault domain cannot be empty.
3337

3438
## EXAMPLES
3539

3640
### Example 1: Remove a cluster fault domain
41+
3742
```
3843
PS C:\> Remove-ClusterFaultDomain -Name "Rack001"
3944
```
@@ -43,14 +48,17 @@ This command removes the cluster fault domain named Rack001.
4348
## PARAMETERS
4449

4550
### -AsJob
46-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
4751

48-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
49-
You can continue to work in the session while the job completes.
50-
To manage the job, use the `*-Job` cmdlets.
51-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
52+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
53+
complete.
5254

53-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
55+
The cmdlet immediately returns an object that represents the job and then displays the command
56+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
57+
`*-Job` cmdlets. To get the job results, use the
58+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
59+
60+
For more information about Windows PowerShell background jobs, see
61+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
5462

5563
```yaml
5664
Type: SwitchParameter
@@ -65,9 +73,11 @@ Accept wildcard characters: False
6573
```
6674
6775
### -CimSession
68-
Runs the cmdlet in a remote session or on a remote computer.
69-
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
70-
The default is the current session on the local computer.
76+
77+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
78+
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
79+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
80+
current session on the local computer.
7181
7282
```yaml
7383
Type: CimSession[]
@@ -82,6 +92,7 @@ Accept wildcard characters: False
8292
```
8393
8494
### -Confirm
95+
8596
Prompts you for confirmation before running the cmdlet.
8697
8798
```yaml
@@ -97,6 +108,7 @@ Accept wildcard characters: False
97108
```
98109
99110
### -Flags
111+
100112
Specifies optional flags passed when this cmdlet removes the fault domain.
101113
102114
```yaml
@@ -112,6 +124,7 @@ Accept wildcard characters: False
112124
```
113125
114126
### -Id
127+
115128
Specifies the ID of the fault domain to remove as an array.
116129
117130
```yaml
@@ -127,6 +140,7 @@ Accept wildcard characters: False
127140
```
128141
129142
### -InputObject
143+
130144
Specifies the input object that is used in a pipeline command.
131145
132146
```yaml
@@ -142,6 +156,7 @@ Accept wildcard characters: False
142156
```
143157
144158
### -Name
159+
145160
Specifies an array of names of the fault domain that this cmdlet removes.
146161
147162
```yaml
@@ -157,8 +172,9 @@ Accept wildcard characters: False
157172
```
158173
159174
### -PassThru
160-
Returns an object representing the item with which you are working.
161-
By default, this cmdlet does not generate any output.
175+
176+
Returns an object representing the item with which you are working. By default, this cmdlet does not
177+
generate any output.
162178
163179
```yaml
164180
Type: SwitchParameter
@@ -173,9 +189,12 @@ Accept wildcard characters: False
173189
```
174190
175191
### -ThrottleLimit
176-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
177-
If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
178-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
192+
193+
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
195+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
196+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
197+
computer.
179198

180199
```yaml
181200
Type: Int32
@@ -190,8 +209,8 @@ Accept wildcard characters: False
190209
```
191210

192211
### -WhatIf
193-
Shows what would happen if the cmdlet runs.
194-
The cmdlet is not run.
212+
213+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
195214

196215
```yaml
197216
Type: SwitchParameter
@@ -206,7 +225,11 @@ Accept wildcard characters: False
206225
```
207226

208227
### CommonParameters
209-
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).
228+
229+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
230+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
231+
-WarningAction, and -WarningVariable. For more information, see
232+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
210233

211234
## INPUTS
212235

@@ -221,4 +244,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
221244
[New-ClusterFaultDomain](./New-ClusterFaultDomain.md)
222245

223246
[Set-ClusterFaultDomain](./Set-ClusterFaultDomain.md)
224-

0 commit comments

Comments
 (0)