Skip to content

Commit 42295a4

Browse files
Merge pull request MicrosoftDocs#3169 from robinharwood/roharwoo_failoverclusters_text_formatting
FailoverClusters BulkFixup (1/4) - Text formatting updates
2 parents be0d8db + 4de78cb commit 42295a4

30 files changed

+153
-144
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Add-ClusterCheckpoint [[-ResourceName] <String>] [-CryptoCheckpointName <String>
2323

2424
## DESCRIPTION
2525

26-
The **Add-ClusterCheckpoint** cmdlet adds a cryptographic key checkpoint or registry checkpoint for
26+
The `Add-ClusterCheckpoint` cmdlet adds a cryptographic key checkpoint or registry checkpoint for
2727
a resource.
2828

2929
Checkpoints help provide failover support for applications that store configuration information

docset/winserver2022-ps/failoverclusters/Add-ClusterDisk.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ Add-ClusterDisk [-InputObject] <PSObject[]> [-Cluster <String>] [<CommonParamete
2121

2222
## DESCRIPTION
2323

24-
The **Add-ClusterDisk** cmdlet makes a new disk available for use in a failover cluster. The disk
25-
(LUN) must be exposed to all nodes in the failover cluster, and should not be exposed to any other
24+
The `Add-ClusterDisk` cmdlet makes a new disk available for use in a failover cluster. The disk
25+
(LUN) must be exposed to all nodes in the failover cluster, and shouldn't be exposed to any other
2626
servers.
2727

2828
When adding a disk, make sure that the configuration of the storage allows the operating system to
2929
recognize and mount the disk as needed. The disk must be a basic disk, not a dynamic disk, and
30-
should not be exposed to servers outside the cluster. The **Get-ClusterAvailableDisk** cmdlet gets
30+
shouldn't be exposed to servers outside the cluster. The `Get-ClusterAvailableDisk` cmdlet gets
3131
information about disks that you can add to the cluster.
3232

3333
## EXAMPLES
@@ -91,7 +91,7 @@ Accept wildcard characters: False
9191
### -InputObject
9292
9393
Specifies the list of shared disks to add to the cluster. The list of disks is generated with the
94-
**Get-ClusterAvailableDisk** cmdlet.
94+
`Get-ClusterAvailableDisk` cmdlet.
9595

9696
```yaml
9797
Type: PSObject[]
@@ -118,7 +118,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
118118

119119
### Microsoft.Management.Infrastructure.CimInstance
120120

121-
This object is output from the Get-Disk and the **Get-VirtualDisk** cmdlets.
121+
This object is output from the `Get-Disk` and the `Get-VirtualDisk` cmdlets.
122122

123123
### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Disk
124124

docset/winserver2022-ps/failoverclusters/Add-ClusterFileServerRole.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,16 @@ Add-ClusterFileServerRole -Storage <StringCollection> [-StaticAddress <StringCol
2323

2424
## DESCRIPTION
2525

26-
The **Add-ClusterFileServerRole** cmdlet creates a clustered file server resource group that
26+
The `Add-ClusterFileServerRole` cmdlet creates a clustered file server resource group that
2727
includes one or more disks, on which shared folders can be created for users.
2828

2929
When adding a clustered file server, specify a name for the file server, any IP address information
30-
that is not automatically supplied by your DHCP settings, and the storage volume or volumes that the
30+
that isn't automatically supplied by your DHCP settings, and the storage volume or volumes that the
3131
clustered file server should use.
3232

33-
Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP)
34-
authentication on the server computer.
33+
> [!NOTE]
34+
> This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP)
35+
> authentication on the server computer.
3536
3637
## EXAMPLES
3738

@@ -92,8 +93,8 @@ Accept wildcard characters: False
9293
### -IgnoreNetwork
9394
9495
Specifies one or more networks to ignore when running the cmdlet. Networks with DHCP enabled are
95-
always included, but other networks need a static address to be specified using the *StaticAddress*
96-
parameter or should be explicitly ignored with this *IgnoreNetwork* parameter.
96+
always included, but other networks need a static address to be specified using the
97+
**StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter.
9798
9899
```yaml
99100
Type: StringCollection
@@ -143,7 +144,7 @@ Accept wildcard characters: False
143144
144145
Specifies one or more static addresses to use when running the cmdlet. Networks with DHCP enabled
145146
are always included, but other networks need a static address to be specified using the
146-
*StaticAddress* parameter or should be explicitly ignored with this *IgnoreNetwork* parameter.
147+
**StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter.
147148
148149
```yaml
149150
Type: StringCollection
@@ -175,9 +176,9 @@ Accept wildcard characters: False
175176
176177
### -Wait
177178
178-
Specifies the time in seconds to wait for the cmdlet. If the *Wait* parameter is not specified, then
179-
the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
180-
cmdlet returns without waiting.
179+
Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified,
180+
then the cmdlet waits for completion. If the value `0` is specified, then the call is initiated and
181+
the cmdlet returns without waiting.
181182

182183
```yaml
183184
Type: Int32

docset/winserver2022-ps/failoverclusters/Add-ClusterGenericApplicationRole.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: Add-ClusterGenericApplicationRole
1111
# Add-ClusterGenericApplicationRole
1212

1313
## SYNOPSIS
14-
Configures high availability for an application that was not originally designed to run in a
14+
Configures high availability for an application that wasn't originally designed to run in a
1515
failover cluster.
1616

1717
## SYNTAX
@@ -25,15 +25,16 @@ Add-ClusterGenericApplicationRole -CommandLine <String> [-Parameters <String>]
2525

2626
## DESCRIPTION
2727

28-
The **Add-ClusterGenericApplicationRole** cmdlet configures high availability for an application
29-
that was not originally designed to run in a failover cluster.
28+
The `Add-ClusterGenericApplicationRole` cmdlet configures high availability for an application
29+
that wasn't originally designed to run in a failover cluster.
3030

3131
If an application is run as a Generic Application, the cluster software will start the application,
3232
then periodically query the operating system to see whether the application appears to be running.
3333
If so, then it is presumed to be online and will not be restarted or failed over.
3434

35-
Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP)
36-
authentication on the server computer.
35+
> [!NOTE]
36+
> This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP)
37+
> authentication on the server computer.
3738
3839
## EXAMPLES
3940

@@ -111,7 +112,7 @@ Accept wildcard characters: False
111112

112113
### -CommandLine
113114

114-
Specifies the Windows PowerShell® command line to use for the highly available generic application.
115+
Specifies the Windows PowerShell command line to use for the highly available generic application.
115116
If the full path is specified, then the current directory is parsed out of the Windows PowerShell
116117
command line.
117118

@@ -130,8 +131,8 @@ Accept wildcard characters: False
130131
### -IgnoreNetwork
131132

132133
Specifies one or more networks to ignore when running the cmdlet. Networks with DHCP enabled are
133-
always included, but other networks need a static address to be specified using the *StaticAddress*
134-
parameter or should be explicitly ignored with this *IgnoreNetwork* parameter.
134+
always included, but other networks need a static address to be specified using the
135+
**StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter.
135136

136137
```yaml
137138
Type: StringCollection
@@ -197,7 +198,7 @@ Accept wildcard characters: False
197198

198199
Specifies one or more static addresses to use when running the cmdlet. Networks with DHCP enabled
199200
are always included, but other networks need a static address to be specified using the
200-
*StaticAddress* parameter or should be explicitly ignored with this *IgnoreNetwork* parameter.
201+
**StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter.
201202

202203
```yaml
203204
Type: StringCollection
@@ -229,9 +230,9 @@ Accept wildcard characters: False
229230

230231
### -Wait
231232

232-
Specifies the time in seconds to wait for the cmdlet. If the *Wait* parameter is not specified, then
233-
the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
234-
cmdlet returns without waiting.
233+
Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified,
234+
then the cmdlet waits for completion. If the value `0` is specified, then the call is initiated and
235+
the cmdlet returns without waiting.
235236

236237
```yaml
237238
Type: Int32

docset/winserver2022-ps/failoverclusters/Add-ClusterGenericScriptRole.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,16 @@ Add-ClusterGenericScriptRole -ScriptFilePath <String> [-Storage <StringCollectio
2424

2525
## DESCRIPTION
2626

27-
The **Add-ClusterGenericScriptRole** cmdlet configures an application controlled by a script that
27+
The `Add-ClusterGenericScriptRole` cmdlet configures an application controlled by a script that
2828
runs in Windows Script Host, within a failover cluster.
2929

3030
The script provides the cluster software with information about the current state of the
3131
application. As needed, the cluster software will restart or fail over the script. Through the
3232
script, the application will be restarted or failed over.
3333

34-
Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP)
35-
authentication on the server computer.
34+
> [!NOTE]
35+
> This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP)
36+
> authentication on the server computer.
3637
3738
## EXAMPLES
3839

@@ -46,7 +47,7 @@ cluster1GenScript node2 Online
4647
```
4748

4849
This example configures the script named script1.vbs to run within a failover cluster, using
49-
defaults for the name and IP address, and does not assign a disk.
50+
defaults for the name and IP address, and doesn't assign a disk.
5051

5152
### Example 2: Configure a script on a failover cluster and assign a clustered script name
5253

@@ -70,7 +71,7 @@ cluster1GenScript node2 Pending
7071
```
7172

7273
This example configures the script called script1.vbs to run within a failover cluster, using
73-
defaults for the name and IP address, and does not assign a disk. The cmdlet completes without
74+
defaults for the name and IP address, and doesn't assign a disk. The cmdlet completes without
7475
waiting for all resources to come online.
7576

7677
## PARAMETERS
@@ -95,8 +96,8 @@ Accept wildcard characters: False
9596
### -IgnoreNetwork
9697
9798
Specifies one or more networks to ignore when running the cmdlet. Networks with DHCP enabled are
98-
always included, but other networks need a static address to be specified using the *StaticAddress*
99-
parameter or should be explicitly ignored with this *IgnoreNetwork* parameter.
99+
always included, but other networks need a static address to be specified using the
100+
**StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter.
100101
101102
```yaml
102103
Type: StringCollection
@@ -162,7 +163,7 @@ Accept wildcard characters: False
162163
163164
Specifies one or more static addresses to use when running the cmdlet. Networks with DHCP enabled
164165
are always included, but other networks need a static address to be specified using the
165-
*StaticAddress* parameter or should be explicitly ignored with this *IgnoreNetwork* parameter.
166+
**StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter.
166167
167168
```yaml
168169
Type: StringCollection
@@ -194,9 +195,9 @@ Accept wildcard characters: False
194195
195196
### -Wait
196197
197-
Specifies the time in seconds to wait for the cmdlet. If the *Wait* parameter is not specified, then
198-
the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
199-
cmdlet returns without waiting.
198+
Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified,
199+
then the cmdlet waits for completion. If the value `0` is specified, then the call is initiated and
200+
the cmdlet returns without waiting.
200201

201202
```yaml
202203
Type: Int32

docset/winserver2022-ps/failoverclusters/Add-ClusterGenericServiceRole.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: Add-ClusterGenericServiceRole
1111
# Add-ClusterGenericServiceRole
1212

1313
## SYNOPSIS
14-
Configures high availability for a service that was not originally designed to run in a failover
14+
Configures high availability for a service that wasn't originally designed to run in a failover
1515
cluster.
1616

1717
## SYNTAX
@@ -25,14 +25,15 @@ Add-ClusterGenericServiceRole -ServiceName <String> [-CheckpointKey <StringColle
2525

2626
## DESCRIPTION
2727

28-
The **Add-ClusterGenericServiceRole** cmdlet configures high availability for a service that was not
28+
The `Add-ClusterGenericServiceRole` cmdlet configures high availability for a service that wasn't
2929
originally designed to run in a failover cluster. The cluster software will start the service, then
3030
periodically query the Service Controller, which is a feature of the operating system, to determine
3131
whether the service appears to be running. If so, then it is presumed to be online, and will not be
3232
restarted or failed over.
3333

34-
Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP)
35-
authentication on the server computer.
34+
> [!NOTE]
35+
> This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP)
36+
> authentication on the server computer.
3637
3738
## EXAMPLES
3839

@@ -46,7 +47,7 @@ cluster1GenSvc node1 Online
4647
```
4748

4849
This example configures Service1 as a generic clustered service, using defaults for the name and IP
49-
address, and does not assign a disk.
50+
address, and doesn't assign a disk.
5051

5152
### Example 2: Configure a service that uses default values and a specified disk
5253

@@ -99,8 +100,8 @@ Accept wildcard characters: False
99100
### -IgnoreNetwork
100101

101102
Specifies one or more networks to ignore when running the cmdlet. Networks with DHCP enabled are
102-
always included, but other networks need a static address to be specified using the *StaticAddress*
103-
parameter or should be explicitly ignored with this *IgnoreNetwork* parameter.
103+
always included, but other networks need a static address to be specified using the
104+
**StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter.
104105

105106
```yaml
106107
Type: StringCollection
@@ -166,7 +167,7 @@ Accept wildcard characters: False
166167

167168
Specifies one or more static addresses to use when running the cmdlet. Networks with DHCP enabled
168169
are always included, but other networks need a static address to be specified using the
169-
*StaticAddress* parameter or should be explicitly ignored with this *IgnoreNetwork* parameter.
170+
**StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter.
170171

171172
```yaml
172173
Type: StringCollection
@@ -198,9 +199,9 @@ Accept wildcard characters: False
198199

199200
### -Wait
200201

201-
Specifies the time in seconds to wait for the cmdlet. If the *Wait* parameter is not specified, then
202-
the cmdlet waits for completion. If `-Wait 0` is specified, then the call is initiated and the
203-
cmdlet returns without waiting.
202+
Specifies the time in seconds to wait for the cmdlet. If the **Wait** parameter isn't specified,
203+
then the cmdlet waits for completion. If the value `0` is specified, then the call is initiated and
204+
the cmdlet returns without waiting.
204205

205206
```yaml
206207
Type: Int32

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Add-ClusterGroup [-Name] <StringCollection> [[-GroupType] <GroupType>] [-InputOb
2323

2424
## DESCRIPTION
2525

26-
The **Add-ClusterGroup** cmdlet adds an empty resource group to the failover cluster configuration,
26+
The `Add-ClusterGroup` cmdlet adds an empty resource group to the failover cluster configuration,
2727
in preparation for adding clustered resources to the group. A resource group, or a clustered role,
2828
is the unit of failover. During failover, all resources in the resource group move together.
2929

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Add-ClusterGroupSetDependency -InputObject <CimInstance[]> [-Provider] <String>
3131

3232
## DESCRIPTION
3333

34-
The **Add-ClusterGroupSetDependency** cmdlet adds a dependency to a cluster set.
34+
The `Add-ClusterGroupSetDependency` cmdlet adds a dependency to a cluster set.
3535

3636
## EXAMPLES
3737

@@ -158,7 +158,7 @@ Accept wildcard characters: False
158158
### -ThrottleLimit
159159
160160
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
161-
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
162162
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
163163
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
164164
computer.

docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToSet.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Add-ClusterGroupToSet -InputObject <CimInstance[]> [-Group] <String> [-CimSessio
3131

3232
## DESCRIPTION
3333

34-
The **Add-ClusterGroupToSet** cmdlet adds a group to a set. A group can only belong to one set.
34+
The `Add-ClusterGroupToSet` cmdlet adds a group to a set. A group can only belong to one set.
3535

3636
## EXAMPLES
3737

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

+5-4
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,16 @@ Add-ClusterNode [[-Name] <StringCollection>] [-NoStorage] [-InputObject <PSObjec
2222

2323
## DESCRIPTION
2424

25-
The **Add-ClusterNode** cmdlet adds a node, or server, to a failover cluster. Before adding the new
25+
The `Add-ClusterNode` cmdlet adds a node, or server, to a failover cluster. Before adding the new
2626
node, you should run validation tests on the existing nodes together with the proposed new node.
2727

2828
Before adding the new node, you should run validation tests on the existing nodes together with the
2929
proposed new node. By running the validation tests, you can confirm that the server to be added is
3030
connected correctly to the networks and storage and that it contains the same software updates.
3131

32-
Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP)
33-
authentication on the server computer.
32+
> [!NOTE]
33+
> This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP)
34+
> authentication on the server computer.
3435
3536
## EXAMPLES
3637

@@ -111,7 +112,7 @@ Accept wildcard characters: False
111112
112113
Ensures that shared storage, on the node being joined to the cluster, will not be added to the
113114
cluster during the join operation. Shared storage can be added by piping the ClusterDiskInfo object
114-
from the **Get-ClusterAvailableDisk** cmdlet into the **Add-ClusterDisk** cmdlet.
115+
from the `Get-ClusterAvailableDisk` cmdlet into the `Add-ClusterDisk` cmdlet.
115116

116117
```yaml
117118
Type: SwitchParameter

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Add-ClusterResource [-Name] <String> [[-Group] <String>] [-ResourceType] <String
2222

2323
## DESCRIPTION
2424

25-
The **Add-ClusterResource** cmdlet adds a resource to a clustered role, or resource group, in a
25+
The `Add-ClusterResource` cmdlet adds a resource to a clustered role, or resource group, in a
2626
failover cluster. Before adding the resource, obtain the resource type and the name of the group to
2727
which to add the resource.
2828

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Add-ClusterResourceDependency [[-Resource] <String>] [[-Provider] <String>]
2323

2424
## DESCRIPTION
2525

26-
The **Add-ClusterResourceDependency** cmdlet adds a resource to the list of resources on which a
26+
The `Add-ClusterResourceDependency` cmdlet adds a resource to the list of resources on which a
2727
particular resource depends, using AND as the connector, within a failover cluster. Existing
28-
dependencies will remain on the list. If you specify the *InputObject* parameter, the *Resource*
28+
dependencies will remain on the list. If you specify the **InputObject** parameter, the **Resource**
2929
parameter will be ignored.
3030

3131
A dependent resource is brought online after the resources on which it depends. A dependent resource

0 commit comments

Comments
 (0)