Skip to content

Commit a69ceb7

Browse files
Xelu86Xelu86
committed
Applied feedback per PM/Dev
1 parent 807e16f commit a69ceb7

File tree

5 files changed

+95
-46
lines changed

5 files changed

+95
-46
lines changed

‎docset/winserver2025-ps/failoverclusters/Add-ClusterExcludedAdapter.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
---
2-
external help file: ClusterExcludedAdapter.cdxml-help.xml
2+
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
3+
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
34
Module Name: FailoverClusters
4-
online version:
5+
ms.date: 08/28/2024
6+
online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
57
schema: 2.0.0
8+
title: Add-ClusterExcludedAdapter
69
---
710

811
# Add-ClusterExcludedAdapter
912

1013
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
14+
Adds a network adapter to the list of excluded adapters.
1215

1316
## SYNTAX
1417

@@ -19,17 +22,21 @@ Add-ClusterExcludedAdapter -ExclusionType <AdapterExclusionType> -ExclusionValue
1922

2023
## DESCRIPTION
2124

22-
{{ Fill in the Description }}
25+
The `Add-ClusterExcludedAdapter` cmdlet adds a network adapter to a list of network adapters that
26+
should be excluded from use by the Failover Cluster. By default, the cluster will use all available
27+
network adapters, but in some cases you may want to reserve certain adapters as backup or
28+
management, such as Dell iDRAC or HPE iLO.
2329

2430
## EXAMPLES
2531

2632
### Example 1
2733

2834
```powershell
29-
{{ Add example code here }}
35+
Add-ClusterExcludedAdapter -ExclusionType "IPPrefix" -ExclusionValue "10.10.20.25"
3036
```
3137

32-
{{ Add example description here }}
38+
This example excludes the network adapter based on the IP Address `10.10.20.25` from use by the
39+
cluster.
3340

3441
## PARAMETERS
3542

@@ -79,9 +86,9 @@ Accept wildcard characters: False
7986
8087
Specifies the type of exclusion to add to the cluster. Acceptable values are:
8188
82-
- `IPAddress`: Excludes a network adapter based on its IP address.
83-
- `NetworkName`: Excludes a network adapter based on its network name.
84-
- `SubnetMask`: Excludes a network adapter based on its subnet mask.
89+
- `IPPrefix`: Excludes a network adapter based on its IP address.
90+
- `Description`: Excludes a network adapter based on its description.
91+
- `FriendlyName`: Excludes a network adapter based on its friendly name.
8592

8693
```yaml
8794
Type: AdapterExclusionType
@@ -155,6 +162,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
155162

156163
[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md)
157164

158-
[Repair-ClusterExcludedAdapter](repair-clusterexcludedadapter.md)
165+
[Repair-ClusterNameAccount](repair-clusternameaccount.md)
159166

160167
[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md)

‎docset/winserver2025-ps/failoverclusters/Get-ClusterExcludedAdapter.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
---
2-
external help file: ClusterExcludedAdapter.cdxml-help.xml
2+
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
3+
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
34
Module Name: FailoverClusters
4-
online version: https://go.microsoft.com/fwlink/?LinkId=615932
5+
ms.date: 08/28/2024
6+
online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
57
schema: 2.0.0
8+
title: Get-ClusterExcludedAdapter
69
---
710

811
# Get-ClusterExcludedAdapter
912

1013
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
14+
Retrieves a network adapter from the list of excluded adapters.
1215

1316
## SYNTAX
1417

@@ -19,17 +22,21 @@ Get-ClusterExcludedAdapter -ExclusionType <AdapterExclusionType> [-CimSession <C
1922

2023
## DESCRIPTION
2124

22-
{{ Fill in the Description }}
25+
The `Get-ClusterExcludedAdapter` cmdlet retrieves a network adapter from a list of network adapters
26+
that should be excluded from use by the Failover Cluster. By default, the cluster will use all
27+
available network adapters, but in some cases you may want to reserve certain adapters as backup or
28+
management, such as Dell iDRAC or HPE iLO.
2329

2430
## EXAMPLES
2531

2632
### Example 1
2733

2834
```powershell
29-
{{ Add example code here }}
35+
Get-ClusterExcludedAdapter -ExclusionType "FriendlyName"
3036
```
3137

32-
{{ Add example description here }}
38+
This example retrieves a list of network adapters that have been excluded from use by the cluster
39+
based on the friendly name.
3340

3441
## PARAMETERS
3542

@@ -79,9 +86,9 @@ Accept wildcard characters: False
7986
8087
Specifies the type of exclusion to retrieve from the cluster. Acceptable values are:
8188
82-
- `IPAddress`: Excludes a network adapter based on its IP address.
83-
- `NetworkName`: Excludes a network adapter based on its network name.
84-
- `SubnetMask`: Excludes a network adapter based on its subnet mask.
89+
- `IPPrefix`: Excludes a network adapter based on its IP address.
90+
- `Description`: Excludes a network adapter based on its description.
91+
- `FriendlyName`: Excludes a network adapter based on its friendly name.
8592

8693
```yaml
8794
Type: AdapterExclusionType
@@ -138,6 +145,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
138145

139146
[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md)
140147

141-
[Repair-ClusterExcludedAdapter](repair-clusterexcludedadapter.md)
148+
[Repair-ClusterNameAccount](repair-clusternameaccount.md)
142149

143150
[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md)

‎docset/winserver2025-ps/failoverclusters/Remove-ClusterExcludedAdapter.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
---
2-
external help file: ClusterExcludedAdapter.cdxml-help.xml
2+
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
3+
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
34
Module Name: FailoverClusters
4-
online version: https://go.microsoft.com/fwlink/?LinkId=691107
5+
ms.date: 08/28/2024
6+
online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
57
schema: 2.0.0
8+
title: Remove-ClusterExcludedAdapter
69
---
710

811
# Remove-ClusterExcludedAdapter
912

1013
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
14+
Removes a network adapter from the list of excluded adapters.
1215

1316
## SYNTAX
1417

@@ -19,17 +22,21 @@ Remove-ClusterExcludedAdapter -ExclusionType <AdapterExclusionType> -ExclusionVa
1922

2023
## DESCRIPTION
2124

22-
{{ Fill in the Description }}
25+
The `Remove-ClusterExcludedAdapter` cmdlet removes a network adapter from a list of network
26+
adapters that should be excluded from use by the Failover Cluster. By default, the cluster will use
27+
all available network adapters, but in some cases you may want to reserve certain adapters as
28+
backup or management, such as Dell iDRAC or HPE iLO.
2329

2430
## EXAMPLES
2531

2632
### Example 1
2733

2834
```powershell
29-
{{ Add example code here }}
35+
Remove-ClusterExcludedAdapter -ExclusionType "IPPrefix" -ExclusionValue "10.10.20.25"
3036
```
3137

32-
{{ Add example description here }}
38+
This example removes the network adapter based on the IP Address `10.10.20.25` from the list of
39+
excluded adapters.
3340

3441
## PARAMETERS
3542

@@ -79,9 +86,9 @@ Accept wildcard characters: False
7986
8087
Specifies the type of exclusion to remove from the cluster. Acceptable values are:
8188
82-
- `IPAddress`: Excludes a network adapter based on its IP address.
83-
- `NetworkName`: Excludes a network adapter based on its network name.
84-
- `SubnetMask`: Excludes a network adapter based on its subnet mask.
89+
- `IPPrefix`: Excludes a network adapter based on its IP address.
90+
- `Description`: Excludes a network adapter based on its description.
91+
- `FriendlyName`: Excludes a network adapter based on its friendly name.
8592

8693
```yaml
8794
Type: AdapterExclusionType
@@ -155,6 +162,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
155162

156163
[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md)
157164

158-
[Repair-ClusterExcludedAdapter](repair-clusterexcludedadapter.md)
165+
[Repair-ClusterNameAccount](repair-clusternameaccount.md)
159166

160167
[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md)

‎docset/winserver2025-ps/failoverclusters/Repair-ClusterNameAccount.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
---
2+
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
23
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
34
Module Name: FailoverClusters
4-
online version: https://go.microsoft.com/fwlink/?linkid=2204048
5+
ms.date: 08/28/2024
6+
online version: https://learn.microsoft.com/powershell/module/failoverclusters/repair-clusternameaccount?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
57
schema: 2.0.0
8+
title: Repair-ClusterNameAccount
69
---
710

811
# Repair-ClusterNameAccount
912

1013
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
14+
Repairs the Cluster Name Account and ensures that the cluster continues to function properly.
1215

1316
## SYNTAX
1417

@@ -28,17 +31,33 @@ Repair-ClusterNameAccount [-Credentials <PSCredential>] [-Domain <String>] [-Clu
2831

2932
## DESCRIPTION
3033

31-
{{ Fill in the Description }}
34+
The `Repair-ClusterNameAccount` cmdlet repairs or updates the Cluster Name Account used for
35+
authentication and authorization on a Failover Cluster. The Cluster Name Account is used to create
36+
Highly Available applications or Virtual Computer Objects (VCOs) in the cluster.
37+
38+
To learn more about cluster accounts in domain environments, see
39+
[Configuring cluster accounts in Active Directory](/windows-server/failover-clustering/configure-ad-accounts).
3240

3341
## EXAMPLES
3442

3543
### Example 1
3644

3745
```powershell
38-
{{ Add example code here }}
46+
Repair-ClusterNameAccount -Cluster "Cluster01"
47+
```
48+
49+
This example repairs or updates the Cluster Name Account for the cluster named `Cluster01`.
50+
51+
### Example 2
52+
53+
```powershell
54+
$cred = Get-Credential
55+
Repair-ClusterNameAccount -Cluster "Cluster01" -Credentials $cred -Domain "contoso.com"
3956
```
4057

41-
{{ Add example description here }}
58+
This example repairs or updates the Cluster Name Account for the cluster named `Cluster01` using
59+
the specified credentials and domain. The `Get-Credential` cmdlet is used to create a PSCredential
60+
object for the `-Credentials` parameter.
4261

4362
## PARAMETERS
4463

@@ -78,7 +97,8 @@ Accept wildcard characters: False
7897
7998
### -Domain
8099
81-
Specifies the name of the domain in which to repair the cluster name account.
100+
Specifies the name of the domain in which to repair the cluster name account. This should be the
101+
fully qualified domain name (FQDN) of the domain that the cluster is in.
82102
83103
```yaml
84104
Type: String

‎docset/winserver2025-ps/failoverclusters/Set-ClusterExcludedAdapter.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
---
2-
external help file: ClusterExcludedAdapter.cdxml-help.xml
2+
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
3+
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
34
Module Name: FailoverClusters
4-
online version: https://go.microsoft.com/fwlink/?LinkId=691107
5+
ms.date: 08/28/2024
6+
online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
57
schema: 2.0.0
8+
title: Set-ClusterExcludedAdapter
69
---
710

811
# Set-ClusterExcludedAdapter
912

1013
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
14+
Sets a network adapter to the list of excluded adapters.
1215

1316
## SYNTAX
1417

@@ -19,17 +22,22 @@ Set-ClusterExcludedAdapter -ExclusionType <AdapterExclusionType> -ExclusionValue
1922

2023
## DESCRIPTION
2124

22-
{{ Fill in the Description }}
25+
The `Set-ClusterExcludedAdapter` cmdlet configures a network adapter in a list of network adapters
26+
that should be excluded from use by the Failover Cluster. By default, the cluster will use all
27+
available network adapters, but in some cases you may want to reserve certain adapters as backup or
28+
management, such as Dell iDRAC or HPE iLO.
2329

2430
## EXAMPLES
2531

2632
### Example 1
2733

2834
```powershell
29-
{{ Add example code here }}
35+
Set-ClusterExcludedAdapter -ExclusionType "Description" -ExclusionValue "Node-1-FL1","Node-1-FL2"
3036
```
3137

32-
{{ Add example description here }}
38+
This example sets the list of excluded network adapters for the cluster. After running this
39+
command, the cluster will no longer use `Node-1-FL1` or `Node-1-FL2` for cluster communications,
40+
ensuring that they are available for management or backup purposes.
3341

3442
## PARAMETERS
3543

@@ -79,9 +87,9 @@ Accept wildcard characters: False
7987
8088
Specifies the type of exclusion to remove from the cluster. Acceptable values are:
8189
82-
- `IPAddress`: Excludes a network adapter based on its IP address.
83-
- `NetworkName`: Excludes a network adapter based on its network name.
84-
- `SubnetMask`: Excludes a network adapter based on its subnet mask.
90+
- `IPPrefix`: Excludes a network adapter based on its IP address.
91+
- `Description`: Excludes a network adapter based on its description.
92+
- `FriendlyName`: Excludes a network adapter based on its friendly name.
8593

8694
```yaml
8795
Type: AdapterExclusionType
@@ -157,4 +165,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
157165

158166
[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md)
159167

160-
[Repair-ClusterExcludedAdapter](repair-clusterexcludedadapter.md)
168+
[Repair-ClusterNameAccount](repair-clusternameaccount.md)

0 commit comments

Comments
 (0)