Skip to content

Commit 17ad8a0

Browse files
committed
AI descriptions added
1 parent 62568cd commit 17ad8a0

File tree

8 files changed

+121
-20
lines changed

8 files changed

+121
-20
lines changed

docset/winserver2025-ps/failoverclusters/Add-WorkgroupClusterNode.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Add-WorkgroupClusterNode [-Node] <String[]> [-Credentials] <PSCredential[]> [-Na
2323

2424
## DESCRIPTION
2525

26-
The `Add-WorkgroupClusterNode` cmdlet adds a node to a workgroup cluster.
26+
The `Add-WorkgroupClusterNode` cmdlet adds a node to a workgroup cluster. This cmdlet allows you to expand an existing workgroup cluster by adding a new node, specifying the required credentials and authentication method. The node can be added with or without shared storage, depending on your configuration.
2727

2828
## EXAMPLES
2929

@@ -44,7 +44,9 @@ This example adds `Node3` to the cluster whose membership is comprised of `Node1
4444
## PARAMETERS
4545

4646
### -AuthenticationMethod
47-
{{ Fill AuthenticationMethod Description }}
47+
Specifies the authentication method to use when adding the node to the workgroup cluster. Acceptable values are:
48+
- `Certificates`: Uses certificate-based authentication for secure communication between nodes.
49+
- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates.
4850

4951
```yaml
5052
Type: WorkgroupClusterAuthenticationMethod
@@ -180,8 +182,23 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
180182
181183
## INPUTS
182184
185+
### System.String[]
186+
You can pipe an array of node names to this cmdlet.
187+
188+
### System.Management.Automation.PSCredential[]
189+
You can pipe an array of credentials to this cmdlet.
190+
191+
### System.String
192+
You can pipe the name of the node to be added.
193+
194+
### System.Management.Automation.PSCredential
195+
You can pipe the credential for the node to be added.
196+
183197
## OUTPUTS
184198
199+
### None
200+
This cmdlet does not generate any output. It performs the operation of adding a node to a workgroup cluster.
201+
185202
## NOTES
186203
187204
## RELATED LINKS

docset/winserver2025-ps/failoverclusters/New-WorkgroupCluster.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ New-WorkgroupCluster [[-Node] <String[]>] [[-Credentials] <PSCredential[]>] [[-N
2525

2626
## DESCRIPTION
2727

28-
The `New-WorkgroupCluster` cmdlet creates a new workgroup cluster.
28+
The `New-WorkgroupCluster` cmdlet creates a new workgroup cluster. This cmdlet allows you to specify the nodes, credentials, cluster name, network configuration, and authentication method for the new cluster. You can configure the cluster to use certificate-based or local account authentication, and optionally enable Storage Spaces Direct or specify static addresses and networks to ignore.
2929

3030
## EXAMPLES
3131

@@ -70,7 +70,9 @@ Accept wildcard characters: False
7070
```
7171
7272
### -AuthenticationMethod
73-
{{ Fill AuthenticationMethod Description }}
73+
Specifies the authentication method to use when creating the workgroup cluster. Acceptable values are:
74+
- `Certificates`: Uses certificate-based authentication for secure communication between nodes.
75+
- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates.
7476

7577
```yaml
7678
Type: WorkgroupClusterAuthenticationMethod
@@ -283,8 +285,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
283285

284286
## INPUTS
285287

288+
### System.String[]
289+
You can pipe an array of node names to this cmdlet.
290+
291+
### System.Management.Automation.PSCredential[]
292+
You can pipe an array of credentials to this cmdlet.
293+
294+
### System.String
295+
You can pipe the name of the cluster to be created.
296+
286297
## OUTPUTS
287298

299+
### None
300+
This cmdlet does not generate any output. It performs the operation of creating a new workgroup cluster.
301+
288302
## NOTES
289303

290304
## RELATED LINKS

docset/winserver2025-ps/failoverclusters/Remove-WorkgroupCluster.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Remove-WorkgroupCluster [[-Node] <String[]>] [[-Credentials] <PSCredential[]>] [
2222

2323
## DESCRIPTION
2424

25-
The `Remove-WorkgroupCluster` cmdlet removes a workgroup cluster.
25+
The `Remove-WorkgroupCluster` cmdlet removes a workgroup cluster. This cmdlet disconnects and removes all nodes from the specified workgroup cluster, using the provided credentials and authentication method. If communication is lost with a node or the cluster membership is incomplete, manual cleanup may be required.
2626

2727
## EXAMPLES
2828

@@ -40,7 +40,9 @@ be removed and manual cleanup may be needed.
4040
## PARAMETERS
4141

4242
### -AuthenticationMethod
43-
{{ Fill AuthenticationMethod Description }}
43+
Specifies the authentication method to use when removing the workgroup cluster. Acceptable values are:
44+
- `Certificates`: Uses certificate-based authentication for secure communication between nodes.
45+
- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates.
4446

4547
```yaml
4648
Type: WorkgroupClusterAuthenticationMethod
@@ -144,8 +146,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
144146
145147
## INPUTS
146148
149+
### System.String[]
150+
You can pipe an array of node names to this cmdlet.
151+
152+
### System.Management.Automation.PSCredential[]
153+
You can pipe an array of credentials to this cmdlet.
154+
147155
## OUTPUTS
148156
157+
### None
158+
This cmdlet does not generate any output. It performs the operation of removing a workgroup cluster.
159+
149160
## NOTES
150161
151162
## RELATED LINKS

docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterCertificates.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,11 @@ Remove-WorkgroupClusterCertificates [[-Authority] <String>] [-Force] [<CommonPar
2020
The Remove-WorkgroupClusterCertificates function removes certificates from the following certificate stores:
2121
- Cert:\LocalMachine\My
2222
- Cert:\LocalMachine\Local Cert Issuer
23+
- Cert:\LocalMachine\Root
2324
- Cert:\CurrentUser\My
2425
- Cert:\CurrentUser\CA
2526

26-
Certificates are filtered for those issued by issuers starring with PKU2UAuthority.
27+
Certificates are filtered for those issued by an issuer name that starts with the value specified in the **Authority** parameter (by default, "PKU2UAuthority*").
2728

2829
## EXAMPLES
2930

@@ -44,7 +45,7 @@ Prompts for confirmation before removing each certificate issued by "CN=PKU2UAut
4445
## PARAMETERS
4546

4647
### -Authority
47-
{{ Fill Authority Description }}
48+
Specifies the issuer name prefix to match when removing certificates. Only certificates issued by an issuer whose name starts with this value will be removed. The default is "PKU2UAuthority*".
4849

4950
```yaml
5051
Type: String
@@ -59,8 +60,7 @@ Accept wildcard characters: False
5960
```
6061
6162
### -Force
62-
Indicates whether to force the removal of certificates without prompting for confirmation.
63-
By default, the value is $false.
63+
Indicates whether to force the removal of certificates without prompting for confirmation. By default, the value is $false.
6464
6565
```yaml
6666
Type: SwitchParameter
@@ -79,8 +79,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
7979
8080
## INPUTS
8181
82+
### System.String
83+
You can pipe a string value for the Authority parameter to this cmdlet.
84+
8285
## OUTPUTS
8386
87+
### None
88+
This cmdlet does not generate any output. It performs the operation of removing certificates from the specified certificate stores.
89+
8490
## NOTES
8591
8692
## RELATED LINKS

docset/winserver2025-ps/failoverclusters/Remove-WorkgroupClusterNode.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Remove-WorkgroupClusterNode [-Node] <String[]> [-Credentials] <PSCredential[]> [
2323

2424
## DESCRIPTION
2525

26-
The `Remove-WorkgroupCluster` function removes a node from the membership in a workgroup Cluster.
27-
The rest of the parameters will be forwarded to the `Remove-ClusterNode` function. Please refer to
28-
the documentation for the
26+
The `Remove-WorkgroupClusterNode` function removes a node from the membership in a workgroup
27+
cluster. The rest of the parameters will be forwarded to the `Remove-ClusterNode` function. Please
28+
refer to the documentation for the
2929
[Remove-ClusterNode](/powershell/module/failoverclusters/remove-clusternode) cmdlet.
3030

3131
## EXAMPLES
@@ -52,7 +52,9 @@ Manual cleanup may be required to clear the node state by logging into `Node3` a
5252
## PARAMETERS
5353

5454
### -AuthenticationMethod
55-
{{ Fill AuthenticationMethod Description }}
55+
Specifies the authentication method to use when removing the node from the workgroup cluster. Acceptable values are:
56+
- `Certificates`: Uses certificate-based authentication for secure communication between nodes.
57+
- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates.
5658

5759
```yaml
5860
Type: WorkgroupClusterAuthenticationMethod
@@ -230,8 +232,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
230232

231233
## INPUTS
232234

235+
### System.String[]
236+
You can pipe an array of node names to this cmdlet.
237+
238+
### System.Management.Automation.PSCredential[]
239+
You can pipe an array of credentials to this cmdlet.
240+
241+
### System.String
242+
You can pipe the name of the node to be removed.
243+
233244
## OUTPUTS
234245

246+
### None
247+
This cmdlet does not generate any output.
248+
235249
## NOTES
236250

237251
## RELATED LINKS

docset/winserver2025-ps/failoverclusters/Start-WorkgroupCluster.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Start-WorkgroupCluster [[-Node] <String[]>] [[-Credentials] <PSCredential[]>] [-
1818
```
1919

2020
## DESCRIPTION
21-
The Start-WorkgroupCluster function starts a workgroup cluster.
21+
The Start-WorkgroupCluster function starts a workgroup cluster. This cmdlet brings the specified workgroup cluster online, using the provided credentials and authentication method. You can optionally ignore the persistent state of the cluster when starting it.
2222

2323
## EXAMPLES
2424

@@ -32,7 +32,9 @@ This example starts the cluster.
3232
## PARAMETERS
3333

3434
### -AuthenticationMethod
35-
{{ Fill AuthenticationMethod Description }}
35+
Specifies the authentication method to use when starting the workgroup cluster. Acceptable values are:
36+
- `Certificates`: Uses certificate-based authentication for secure communication between nodes.
37+
- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates.
3638

3739
```yaml
3840
Type: WorkgroupClusterAuthenticationMethod
@@ -63,7 +65,7 @@ Accept wildcard characters: False
6365
```
6466
6567
### -IgnorePersistentState
66-
{{ Fill IgnorePersistentState Description }}
68+
Indicates that the cmdlet should start the cluster without restoring the previous persistent state. This can be useful if you want to start the cluster in a clean state, ignoring any saved cluster state from previous operations.
6769
6870
```yaml
6971
Type: SwitchParameter
@@ -97,8 +99,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9799
98100
## INPUTS
99101
102+
### System.String[]
103+
You can pipe an array of node names to this cmdlet.
104+
105+
### System.Management.Automation.PSCredential[]
106+
You can pipe an array of credentials to this cmdlet.
107+
100108
## OUTPUTS
101109
110+
### None
111+
This cmdlet does not generate any output. It performs the operation of starting a workgroup cluster.
112+
102113
## NOTES
103114
104115
## RELATED LINKS

docset/winserver2025-ps/failoverclusters/Stop-WorkgroupCluster.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Stop-WorkgroupCluster [[-Node] <String[]>] [[-Credentials] <PSCredential[]>] [-C
1818
```
1919

2020
## DESCRIPTION
21-
The Stop-WorkgroupCluster function stops a workgroup cluster.
21+
The Stop-WorkgroupCluster function stops a workgroup cluster. This cmdlet takes the specified workgroup cluster offline, using the provided credentials and authentication method. You can optionally prompt for confirmation before stopping the cluster.
2222

2323
## EXAMPLES
2424

@@ -32,7 +32,9 @@ This example stops the cluster.
3232
## PARAMETERS
3333

3434
### -AuthenticationMethod
35-
{{ Fill AuthenticationMethod Description }}
35+
Specifies the authentication method to use when stopping the workgroup cluster. Acceptable values are:
36+
- `Certificates`: Uses certificate-based authentication for secure communication between nodes.
37+
- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates.
3638

3739
```yaml
3840
Type: WorkgroupClusterAuthenticationMethod
@@ -97,8 +99,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9799
98100
## INPUTS
99101
102+
### System.String[]
103+
You can pipe an array of node names to this cmdlet.
104+
105+
### System.Management.Automation.PSCredential[]
106+
You can pipe an array of credentials to this cmdlet.
107+
100108
## OUTPUTS
101109
110+
### None
111+
This cmdlet does not generate any output. It performs the operation of stopping a workgroup cluster.
112+
102113
## NOTES
103114
104115
## RELATED LINKS

docset/winserver2025-ps/failoverclusters/Test-WorkgroupCluster.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ credentials in `$cred1` and `$cred2`, and additional parameters.
4242
## PARAMETERS
4343

4444
### -AuthenticationMethod
45-
{{ Fill AuthenticationMethod Description }}
45+
Specifies the authentication method to use when testing the workgroup cluster. Acceptable values are:
46+
- `Certificates`: Uses certificate-based authentication for secure communication between nodes.
47+
- `NoCertificates`: Uses local user accounts and passwords for authentication without certificates.
4648

4749
```yaml
4850
Type: WorkgroupClusterAuthenticationMethod
@@ -292,8 +294,23 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
292294

293295
## INPUTS
294296

297+
### System.String[]
298+
You can pipe an array of node names to this cmdlet.
299+
300+
### System.Management.Automation.PSCredential[]
301+
You can pipe an array of credentials to this cmdlet.
302+
303+
### System.Object[]
304+
You can pipe an array of disk or storage pool objects to this cmdlet.
305+
306+
### System.String
307+
You can pipe the name of the cluster, report, or destination path to this cmdlet.
308+
295309
## OUTPUTS
296310

311+
### Microsoft.FailoverClusters.PowerShell.ClusterValidationReport
312+
Returns a ClusterValidationReport object that contains the results of the cluster validation tests, including the status of each test and the location of the generated report.
313+
297314
## NOTES
298315

299316
## RELATED LINKS

0 commit comments

Comments
 (0)