Skip to content

Commit 71c53a5

Browse files
committed
Bulk reflowed text and header formatting
1 parent 17bf7a5 commit 71c53a5

30 files changed

+877
-417
lines changed

docset/winserver2022-ps/failoverclusters/Get-ClusterFaultDomainXML.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,18 @@ Gets the fault domain as an XML string.
1616
## SYNTAX
1717

1818
```
19-
Get-ClusterFaultDomainXML [-Flags <UInt32>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
20-
[<CommonParameters>]
19+
Get-ClusterFaultDomainXML [-Flags <UInt32>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
20+
[-AsJob] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24+
2425
The **Get-ClusterFaultDomainXML** cmdlet gets the fault domain as an XML string.
2526

2627
## EXAMPLES
2728

2829
### Example 1: Get all fault domains in the cluster in XML form
30+
2931
```
3032
PS C:\> Get-ClusterFaultDomainXML
3133
<Topology>
@@ -38,14 +40,17 @@ This command gets all the fault domains in the cluster on the local node in XML
3840
## PARAMETERS
3941

4042
### -AsJob
41-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
4243

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

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

5055
```yaml
5156
Type: SwitchParameter
@@ -60,9 +65,11 @@ Accept wildcard characters: False
6065
```
6166
6267
### -CimSession
63-
Runs the cmdlet in a remote session or on a remote computer.
64-
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.
65-
The default is the current session on the local computer.
68+
69+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
70+
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
71+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
72+
current session on the local computer.
6673
6774
```yaml
6875
Type: CimSession[]
@@ -77,8 +84,9 @@ Accept wildcard characters: False
7784
```
7885
7986
### -Flags
87+
8088
Specifies an optional set of flags that can change this cmdlet, currently none are supported.
81-
Reserved for future use
89+
Reserved for future use.
8290
8391
```yaml
8492
Type: UInt32
@@ -93,9 +101,12 @@ Accept wildcard characters: False
93101
```
94102
95103
### -ThrottleLimit
96-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
97-
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.
98-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
104+
105+
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
107+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
108+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
109+
computer.
99110

100111
```yaml
101112
Type: Int32
@@ -110,7 +121,11 @@ Accept wildcard characters: False
110121
```
111122

112123
### CommonParameters
113-
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).
124+
125+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
126+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
127+
-WarningAction, and -WarningVariable. For more information, see
128+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
114129

115130
## INPUTS
116131

@@ -121,4 +136,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
121136
## RELATED LINKS
122137

123138
[Set-ClusterFaultDomainXML](./Set-ClusterFaultDomainXML.md)
124-

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

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,22 @@ Gets information about one or more clustered roles (resource groups) in a failov
1616
## SYNTAX
1717

1818
```
19-
Get-ClusterGroup [[-Name] <StringCollection>] [-VMId <Guid>] [-InputObject <PSObject>] [-Cluster <String>]
20-
[<CommonParameters>]
19+
Get-ClusterGroup [[-Name] <StringCollection>] [-VMId <Guid>] [-InputObject <PSObject>]
20+
[-Cluster <String>] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
The **Get-ClusterGroup** cmdlet gets information about one or more clustered roles (resource groups) in a failover cluster.
2524

26-
A resource group is the unit of failover.
27-
During failover, all resources in the resource group move together.
25+
The **Get-ClusterGroup** cmdlet gets information about one or more clustered roles (resource groups)
26+
in a failover cluster.
27+
28+
A resource group is the unit of failover. During failover, all resources in the resource group move
29+
together.
2830

2931
## EXAMPLES
3032

3133
### Example 1
34+
3235
```
3336
PS C:\> Get-ClusterGroup
3437
Name OwnerNode State
@@ -39,9 +42,11 @@ cluster1FS node1 Online
3942
cluster1FS-Other node1 Online
4043
```
4144

42-
This example lists the state and owner node of each clustered role, or resource group, in the local cluster.
45+
This example lists the state and owner node of each clustered role, or resource group, in the local
46+
cluster.
4347

4448
### Example 2
49+
4550
```
4651
PS C:\> Get-ClusterGroup -Name "Cluster Group" | Get-ClusterResource
4752
Name State Group ResourceType
@@ -55,16 +60,19 @@ Cluster Name Online Cluster Group Network Name
5560
This example lists the resources in Cluster Group on the local cluster.
5661

5762
### Example 3
63+
5864
```
5965
PS C:\> Get-ClusterNode -Name node1 | Get-ClusterGroup
6066
Name OwnerNode State
6167
---- --------- -----
6268
Cluster Group node1 Online
6369
```
6470

65-
This example lists the clustered services and applications, or resource groups, that are currently owned by node1 in the local cluster.
71+
This example lists the clustered services and applications, or resource groups, that are currently
72+
owned by node1 in the local cluster.
6673

6774
### Example 4
75+
6876
```
6977
PS C:\> Get-ClusterGroup -Name FileServer1 | Format-List -Property *
7078
Cluster : Cluster1
@@ -83,13 +91,15 @@ AntiAffinityClassNames : {}
8391
Id : 189ec8ad-1831-4f57-9bb0-3ffb9cbb9227
8492
```
8593

86-
This example displays the properties of a clustered file server, or resource group, called FileServer1, in the form of a list.
94+
This example displays the properties of a clustered file server, or resource group, called
95+
FileServer1, in the form of a list.
8796

8897
## PARAMETERS
8998

9099
### -Cluster
91-
Specifies the name of the cluster on which to run this cmdlet.
92-
If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster.
100+
101+
Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is
102+
`.` or it is omitted, then the cmdlet runs on the local cluster.
93103

94104
```yaml
95105
Type: String
@@ -104,6 +114,7 @@ Accept wildcard characters: False
104114
```
105115
106116
### -InputObject
117+
107118
Specifies the cluster or cluster node on which to enumerate the clustered roles.
108119
109120
```yaml
@@ -119,6 +130,7 @@ Accept wildcard characters: False
119130
```
120131
121132
### -Name
133+
122134
Specifies the name of the clustered role to get.
123135
124136
```yaml
@@ -134,6 +146,7 @@ Accept wildcard characters: False
134146
```
135147
136148
### -VMId
149+
137150
Specifies the virtual machine identifier (ID).
138151
139152
```yaml
@@ -149,7 +162,11 @@ Accept wildcard characters: False
149162
```
150163
151164
### CommonParameters
152-
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).
165+
166+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
167+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
168+
-WarningAction, and -WarningVariable. For more information, see
169+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
153170
154171
## INPUTS
155172
@@ -176,4 +193,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
176193
[Start-ClusterGroup](./Start-ClusterGroup.md)
177194
178195
[Stop-ClusterGroup](./Stop-ClusterGroup.md)
179-

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

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,13 @@ Get-ClusterGroupSet [[-Name] <String[]>] [-IsGlobal <Boolean[]>] [-CimSession <C
2121
```
2222

2323
## DESCRIPTION
24+
2425
The **Get-ClusterGroupSet** cmdlet gets all the group sets in the cluster.
2526

2627
## EXAMPLES
2728

2829
### Example 1: Get all the group sets in the cluster
30+
2931
```
3032
PS C:\> Get-ClusterGroupSet
3133
Name : Set1
@@ -50,14 +52,17 @@ This command enumerates the group sets in the cluster.
5052
## PARAMETERS
5153

5254
### -AsJob
53-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
5455

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

60-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
64+
For more information about Windows PowerShell background jobs, see
65+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
6166

6267
```yaml
6368
Type: SwitchParameter
@@ -72,9 +77,11 @@ Accept wildcard characters: False
7277
```
7378
7479
### -CimSession
75-
Runs the cmdlet in a remote session or on a remote computer.
76-
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.
77-
The default is the current session on the local computer.
80+
81+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
82+
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
83+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
84+
current session on the local computer.
7885
7986
```yaml
8087
Type: CimSession[]
@@ -89,6 +96,7 @@ Accept wildcard characters: False
8996
```
9097
9198
### -IsGlobal
99+
92100
Indicates whether the cmdlet gets the global group sets.
93101
94102
```yaml
@@ -104,6 +112,7 @@ Accept wildcard characters: False
104112
```
105113
106114
### -Name
115+
107116
Specifies the name of the group set that this cmdlet gets as an array.
108117
109118
```yaml
@@ -119,9 +128,12 @@ Accept wildcard characters: False
119128
```
120129
121130
### -ThrottleLimit
122-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
123-
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.
124-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
131+
132+
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
134+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
135+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
136+
computer.
125137

126138
```yaml
127139
Type: Int32
@@ -136,7 +148,11 @@ Accept wildcard characters: False
136148
```
137149

138150
### CommonParameters
139-
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).
151+
152+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
153+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
154+
-WarningAction, and -WarningVariable. For more information, see
155+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
140156

141157
## INPUTS
142158

@@ -151,4 +167,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
151167
[Remove-ClusterGroupSet](./Remove-ClusterGroupSet.md)
152168

153169
[Set-ClusterGroupSet](./Set-ClusterGroupSet.md)
154-

0 commit comments

Comments
 (0)