Skip to content

Commit

Permalink
Applied feedback per PM/Dev
Browse files Browse the repository at this point in the history
  • Loading branch information
Xelu86 committed Aug 29, 2024
1 parent 807e16f commit a69ceb7
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 46 deletions.
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
---
external help file: ClusterExcludedAdapter.cdxml-help.xml
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
Module Name: FailoverClusters
online version:
ms.date: 08/28/2024
online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Add-ClusterExcludedAdapter
---

# Add-ClusterExcludedAdapter

## SYNOPSIS
{{ Fill in the Synopsis }}
Adds a network adapter to the list of excluded adapters.

## SYNTAX

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

## DESCRIPTION

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

## EXAMPLES

### Example 1

```powershell
{{ Add example code here }}
Add-ClusterExcludedAdapter -ExclusionType "IPPrefix" -ExclusionValue "10.10.20.25"
```

{{ Add example description here }}
This example excludes the network adapter based on the IP Address `10.10.20.25` from use by the
cluster.

## PARAMETERS

Expand Down Expand Up @@ -79,9 +86,9 @@ Accept wildcard characters: False
Specifies the type of exclusion to add to the cluster. Acceptable values are:
- `IPAddress`: Excludes a network adapter based on its IP address.
- `NetworkName`: Excludes a network adapter based on its network name.
- `SubnetMask`: Excludes a network adapter based on its subnet mask.
- `IPPrefix`: Excludes a network adapter based on its IP address.
- `Description`: Excludes a network adapter based on its description.
- `FriendlyName`: Excludes a network adapter based on its friendly name.

```yaml
Type: AdapterExclusionType
Expand Down Expand Up @@ -155,6 +162,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

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

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

[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md)
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
---
external help file: ClusterExcludedAdapter.cdxml-help.xml
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
Module Name: FailoverClusters
online version: https://go.microsoft.com/fwlink/?LinkId=615932
ms.date: 08/28/2024
online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Get-ClusterExcludedAdapter
---

# Get-ClusterExcludedAdapter

## SYNOPSIS
{{ Fill in the Synopsis }}
Retrieves a network adapter from the list of excluded adapters.

## SYNTAX

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

## DESCRIPTION

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

## EXAMPLES

### Example 1

```powershell
{{ Add example code here }}
Get-ClusterExcludedAdapter -ExclusionType "FriendlyName"
```

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

## PARAMETERS

Expand Down Expand Up @@ -79,9 +86,9 @@ Accept wildcard characters: False
Specifies the type of exclusion to retrieve from the cluster. Acceptable values are:
- `IPAddress`: Excludes a network adapter based on its IP address.
- `NetworkName`: Excludes a network adapter based on its network name.
- `SubnetMask`: Excludes a network adapter based on its subnet mask.
- `IPPrefix`: Excludes a network adapter based on its IP address.
- `Description`: Excludes a network adapter based on its description.
- `FriendlyName`: Excludes a network adapter based on its friendly name.

```yaml
Type: AdapterExclusionType
Expand Down Expand Up @@ -138,6 +145,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

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

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

[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md)
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
---
external help file: ClusterExcludedAdapter.cdxml-help.xml
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
Module Name: FailoverClusters
online version: https://go.microsoft.com/fwlink/?LinkId=691107
ms.date: 08/28/2024
online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Remove-ClusterExcludedAdapter
---

# Remove-ClusterExcludedAdapter

## SYNOPSIS
{{ Fill in the Synopsis }}
Removes a network adapter from the list of excluded adapters.

## SYNTAX

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

## DESCRIPTION

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

## EXAMPLES

### Example 1

```powershell
{{ Add example code here }}
Remove-ClusterExcludedAdapter -ExclusionType "IPPrefix" -ExclusionValue "10.10.20.25"
```

{{ Add example description here }}
This example removes the network adapter based on the IP Address `10.10.20.25` from the list of
excluded adapters.

## PARAMETERS

Expand Down Expand Up @@ -79,9 +86,9 @@ Accept wildcard characters: False
Specifies the type of exclusion to remove from the cluster. Acceptable values are:
- `IPAddress`: Excludes a network adapter based on its IP address.
- `NetworkName`: Excludes a network adapter based on its network name.
- `SubnetMask`: Excludes a network adapter based on its subnet mask.
- `IPPrefix`: Excludes a network adapter based on its IP address.
- `Description`: Excludes a network adapter based on its description.
- `FriendlyName`: Excludes a network adapter based on its friendly name.

```yaml
Type: AdapterExclusionType
Expand Down Expand Up @@ -155,6 +162,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

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

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

[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md)
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
---
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
Module Name: FailoverClusters
online version: https://go.microsoft.com/fwlink/?linkid=2204048
ms.date: 08/28/2024
online version: https://learn.microsoft.com/powershell/module/failoverclusters/repair-clusternameaccount?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Repair-ClusterNameAccount
---

# Repair-ClusterNameAccount

## SYNOPSIS
{{ Fill in the Synopsis }}
Repairs the Cluster Name Account and ensures that the cluster continues to function properly.

## SYNTAX

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

## DESCRIPTION

{{ Fill in the Description }}
The `Repair-ClusterNameAccount` cmdlet repairs or updates the Cluster Name Account used for
authentication and authorization on a Failover Cluster. The Cluster Name Account is used to create
Highly Available applications or Virtual Computer Objects (VCOs) in the cluster.

To learn more about cluster accounts in domain environments, see
[Configuring cluster accounts in Active Directory](/windows-server/failover-clustering/configure-ad-accounts).

## EXAMPLES

### Example 1

```powershell
{{ Add example code here }}
Repair-ClusterNameAccount -Cluster "Cluster01"
```

This example repairs or updates the Cluster Name Account for the cluster named `Cluster01`.

### Example 2

```powershell
$cred = Get-Credential
Repair-ClusterNameAccount -Cluster "Cluster01" -Credentials $cred -Domain "contoso.com"
```

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

## PARAMETERS

Expand Down Expand Up @@ -78,7 +97,8 @@ Accept wildcard characters: False
### -Domain
Specifies the name of the domain in which to repair the cluster name account.
Specifies the name of the domain in which to repair the cluster name account. This should be the
fully qualified domain name (FQDN) of the domain that the cluster is in.
```yaml
Type: String
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
---
external help file: ClusterExcludedAdapter.cdxml-help.xml
description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml
Module Name: FailoverClusters
online version: https://go.microsoft.com/fwlink/?LinkId=691107
ms.date: 08/28/2024
online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterexcludedadapter?view=windowsserver2025-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
title: Set-ClusterExcludedAdapter
---

# Set-ClusterExcludedAdapter

## SYNOPSIS
{{ Fill in the Synopsis }}
Sets a network adapter to the list of excluded adapters.

## SYNTAX

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

## DESCRIPTION

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

## EXAMPLES

### Example 1

```powershell
{{ Add example code here }}
Set-ClusterExcludedAdapter -ExclusionType "Description" -ExclusionValue "Node-1-FL1","Node-1-FL2"
```

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

## PARAMETERS

Expand Down Expand Up @@ -79,9 +87,9 @@ Accept wildcard characters: False
Specifies the type of exclusion to remove from the cluster. Acceptable values are:
- `IPAddress`: Excludes a network adapter based on its IP address.
- `NetworkName`: Excludes a network adapter based on its network name.
- `SubnetMask`: Excludes a network adapter based on its subnet mask.
- `IPPrefix`: Excludes a network adapter based on its IP address.
- `Description`: Excludes a network adapter based on its description.
- `FriendlyName`: Excludes a network adapter based on its friendly name.

```yaml
Type: AdapterExclusionType
Expand Down Expand Up @@ -157,4 +165,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

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

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

0 comments on commit a69ceb7

Please sign in to comment.