Skip to content

Commit a2e23bc

Browse files
Stacyrch140Stacyrch140
authoredSep 9, 2024··
Merge pull request #3869 from MicrosoftDocs/main
Publish main to live, Monday 10:30AM PDT, 09/09
2 parents e757944 + fe01b9e commit a2e23bc

File tree

5 files changed

+808
-0
lines changed

5 files changed

+808
-0
lines changed
 

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

+167
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
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
4+
Module Name: FailoverClusters
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
7+
schema: 2.0.0
8+
title: Add-ClusterExcludedAdapter
9+
---
10+
11+
# Add-ClusterExcludedAdapter
12+
13+
## SYNOPSIS
14+
Adds a network adapter to the list of excluded adapters.
15+
16+
## SYNTAX
17+
18+
```
19+
Add-ClusterExcludedAdapter -ExclusionType <AdapterExclusionType> -ExclusionValue <String[]>
20+
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
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.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
34+
```powershell
35+
Add-ClusterExcludedAdapter -ExclusionType "IPPrefix" -ExclusionValue "10.10.20.25"
36+
```
37+
38+
This example excludes the network adapter based on the IP Address `10.10.20.25` from use by the
39+
cluster.
40+
41+
## PARAMETERS
42+
43+
### -AsJob
44+
45+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
46+
complete.
47+
48+
The cmdlet immediately returns an object that represents the job and then displays the command
49+
prompt. You can continue to work in the session while the job completes.
50+
51+
For more information about Windows PowerShell background jobs, see
52+
[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs).
53+
54+
```yaml
55+
Type: SwitchParameter
56+
Parameter Sets: (All)
57+
Aliases:
58+
59+
Required: False
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -CimSession
67+
68+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
69+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
70+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
71+
current session on the local computer.
72+
73+
```yaml
74+
Type: CimSession[]
75+
Parameter Sets: (All)
76+
Aliases: Session
77+
78+
Required: False
79+
Position: Named
80+
Default value: None
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
85+
### -ExclusionType
86+
87+
Specifies the type of exclusion to add to the cluster. Acceptable values are:
88+
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.
92+
93+
```yaml
94+
Type: AdapterExclusionType
95+
Parameter Sets: (All)
96+
Aliases:
97+
Accepted values: IPPrefix, Description, FriendlyName
98+
99+
Required: True
100+
Position: Named
101+
Default value: None
102+
Accept pipeline input: False
103+
Accept wildcard characters: False
104+
```
105+
106+
### -ExclusionValue
107+
108+
Specifies the value to use for the exclusion. The value of this parameter depends on the value of
109+
the `-ExclusionType` parameter.
110+
111+
```yaml
112+
Type: String[]
113+
Parameter Sets: (All)
114+
Aliases:
115+
116+
Required: True
117+
Position: Named
118+
Default value: None
119+
Accept pipeline input: False
120+
Accept wildcard characters: False
121+
```
122+
123+
### -ThrottleLimit
124+
125+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
126+
this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum
127+
throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
128+
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
129+
130+
```yaml
131+
Type: Int32
132+
Parameter Sets: (All)
133+
Aliases:
134+
135+
Required: False
136+
Position: Named
137+
Default value: None
138+
Accept pipeline input: False
139+
Accept wildcard characters: False
140+
```
141+
142+
### CommonParameters
143+
144+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
145+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
146+
-WarningAction, and -WarningVariable. For more information, see
147+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
148+
149+
## INPUTS
150+
151+
### None
152+
153+
## OUTPUTS
154+
155+
### System.Object
156+
157+
## NOTES
158+
159+
## RELATED LINKS
160+
161+
[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md)
162+
163+
[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md)
164+
165+
[Repair-ClusterNameAccount](repair-clusternameaccount.md)
166+
167+
[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md)

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

+150
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
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
4+
Module Name: FailoverClusters
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
7+
schema: 2.0.0
8+
title: Get-ClusterExcludedAdapter
9+
---
10+
11+
# Get-ClusterExcludedAdapter
12+
13+
## SYNOPSIS
14+
Retrieves a network adapter from the list of excluded adapters.
15+
16+
## SYNTAX
17+
18+
```
19+
Get-ClusterExcludedAdapter -ExclusionType <AdapterExclusionType> [-CimSession <CimSession[]>]
20+
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
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.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
34+
```powershell
35+
Get-ClusterExcludedAdapter -ExclusionType "FriendlyName"
36+
```
37+
38+
This example retrieves a list of network adapters that have been excluded from use by the cluster
39+
based on the friendly name.
40+
41+
## PARAMETERS
42+
43+
### -AsJob
44+
45+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
46+
complete.
47+
48+
The cmdlet immediately returns an object that represents the job and then displays the command
49+
prompt. You can continue to work in the session while the job completes.
50+
51+
For more information about Windows PowerShell background jobs, see
52+
[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs).
53+
54+
```yaml
55+
Type: SwitchParameter
56+
Parameter Sets: (All)
57+
Aliases:
58+
59+
Required: False
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -CimSession
67+
68+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
69+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
70+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
71+
current session on the local computer.
72+
73+
```yaml
74+
Type: CimSession[]
75+
Parameter Sets: (All)
76+
Aliases: Session
77+
78+
Required: False
79+
Position: Named
80+
Default value: None
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
85+
### -ExclusionType
86+
87+
Specifies the type of exclusion to retrieve from the cluster. Acceptable values are:
88+
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.
92+
93+
```yaml
94+
Type: AdapterExclusionType
95+
Parameter Sets: (All)
96+
Aliases:
97+
Accepted values: IPPrefix, Description, FriendlyName
98+
99+
Required: True
100+
Position: Named
101+
Default value: None
102+
Accept pipeline input: False
103+
Accept wildcard characters: False
104+
```
105+
106+
### -ThrottleLimit
107+
108+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
109+
this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum
110+
throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
111+
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
112+
113+
```yaml
114+
Type: Int32
115+
Parameter Sets: (All)
116+
Aliases:
117+
118+
Required: False
119+
Position: Named
120+
Default value: None
121+
Accept pipeline input: False
122+
Accept wildcard characters: False
123+
```
124+
125+
### CommonParameters
126+
127+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
128+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
129+
-WarningAction, and -WarningVariable. For more information, see
130+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
131+
132+
## INPUTS
133+
134+
### None
135+
136+
## OUTPUTS
137+
138+
### System.String[]
139+
140+
## NOTES
141+
142+
## RELATED LINKS
143+
144+
[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md)
145+
146+
[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md)
147+
148+
[Repair-ClusterNameAccount](repair-clusternameaccount.md)
149+
150+
[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md)

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

+167
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
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
4+
Module Name: FailoverClusters
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
7+
schema: 2.0.0
8+
title: Remove-ClusterExcludedAdapter
9+
---
10+
11+
# Remove-ClusterExcludedAdapter
12+
13+
## SYNOPSIS
14+
Removes a network adapter from the list of excluded adapters.
15+
16+
## SYNTAX
17+
18+
```
19+
Remove-ClusterExcludedAdapter -ExclusionType <AdapterExclusionType> -ExclusionValue <String[]>
20+
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
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.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
34+
```powershell
35+
Remove-ClusterExcludedAdapter -ExclusionType "IPPrefix" -ExclusionValue "10.10.20.25"
36+
```
37+
38+
This example removes the network adapter based on the IP Address `10.10.20.25` from the list of
39+
excluded adapters.
40+
41+
## PARAMETERS
42+
43+
### -AsJob
44+
45+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
46+
complete.
47+
48+
The cmdlet immediately returns an object that represents the job and then displays the command
49+
prompt. You can continue to work in the session while the job completes.
50+
51+
For more information about Windows PowerShell background jobs, see
52+
[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs).
53+
54+
```yaml
55+
Type: SwitchParameter
56+
Parameter Sets: (All)
57+
Aliases:
58+
59+
Required: False
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -CimSession
67+
68+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
69+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession)
70+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
71+
current session on the local computer.
72+
73+
```yaml
74+
Type: CimSession[]
75+
Parameter Sets: (All)
76+
Aliases: Session
77+
78+
Required: False
79+
Position: Named
80+
Default value: None
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
85+
### -ExclusionType
86+
87+
Specifies the type of exclusion to remove from the cluster. Acceptable values are:
88+
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.
92+
93+
```yaml
94+
Type: AdapterExclusionType
95+
Parameter Sets: (All)
96+
Aliases:
97+
Accepted values: IPPrefix, Description, FriendlyName
98+
99+
Required: True
100+
Position: Named
101+
Default value: None
102+
Accept pipeline input: False
103+
Accept wildcard characters: False
104+
```
105+
106+
### -ExclusionValue
107+
108+
Specifies the value to use for the exclusion. The value of this parameter depends on the value of
109+
the `-ExclusionType` parameter.
110+
111+
```yaml
112+
Type: String[]
113+
Parameter Sets: (All)
114+
Aliases:
115+
116+
Required: True
117+
Position: Named
118+
Default value: None
119+
Accept pipeline input: False
120+
Accept wildcard characters: False
121+
```
122+
123+
### -ThrottleLimit
124+
125+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
126+
this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum
127+
throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
128+
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
129+
130+
```yaml
131+
Type: Int32
132+
Parameter Sets: (All)
133+
Aliases:
134+
135+
Required: False
136+
Position: Named
137+
Default value: None
138+
Accept pipeline input: False
139+
Accept wildcard characters: False
140+
```
141+
142+
### CommonParameters
143+
144+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
145+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
146+
-WarningAction, and -WarningVariable. For more information, see
147+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
148+
149+
## INPUTS
150+
151+
### None
152+
153+
## OUTPUTS
154+
155+
### System.Object
156+
157+
## NOTES
158+
159+
## RELATED LINKS
160+
161+
[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md)
162+
163+
[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md)
164+
165+
[Repair-ClusterNameAccount](repair-clusternameaccount.md)
166+
167+
[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md)

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

+156
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
---
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
4+
Module Name: FailoverClusters
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
7+
schema: 2.0.0
8+
title: Repair-ClusterNameAccount
9+
---
10+
11+
# Repair-ClusterNameAccount
12+
13+
## SYNOPSIS
14+
Repairs the Cluster Name Account and ensures that the cluster continues to function properly.
15+
16+
## SYNTAX
17+
18+
### InputObject (Default)
19+
20+
```
21+
Repair-ClusterNameAccount [-Credentials <PSCredential>] [-Domain <String>] [-InputObject <PSObject>]
22+
[-Cluster <String>] [<CommonParameters>]
23+
```
24+
25+
### Credentials
26+
27+
```
28+
Repair-ClusterNameAccount [-Credentials <PSCredential>] [-Domain <String>] [-Cluster <String>]
29+
[<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
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).
40+
41+
## EXAMPLES
42+
43+
### Example 1
44+
45+
```powershell
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"
56+
```
57+
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.
61+
62+
## PARAMETERS
63+
64+
### -Cluster
65+
66+
Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is
67+
`.` or it is omitted, then the cmdlet runs on the local cluster.
68+
69+
```yaml
70+
Type: String
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: False
75+
Position: Named
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### -Credentials
82+
83+
Specifies the credentials that this cmdlet uses when it connects to Active Directory Domain
84+
Services.
85+
86+
```yaml
87+
Type: PSCredential
88+
Parameter Sets: (All)
89+
Aliases:
90+
91+
Required: False
92+
Position: Named
93+
Default value: None
94+
Accept pipeline input: False
95+
Accept wildcard characters: False
96+
```
97+
98+
### -Domain
99+
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.
102+
103+
```yaml
104+
Type: String
105+
Parameter Sets: (All)
106+
Aliases:
107+
108+
Required: False
109+
Position: Named
110+
Default value: None
111+
Accept pipeline input: False
112+
Accept wildcard characters: False
113+
```
114+
115+
### -InputObject
116+
117+
Specifies the cluster name account to repair.
118+
119+
```yaml
120+
Type: PSObject
121+
Parameter Sets: InputObject
122+
Aliases:
123+
124+
Required: False
125+
Position: Named
126+
Default value: None
127+
Accept pipeline input: True (ByValue)
128+
Accept wildcard characters: False
129+
```
130+
131+
### CommonParameters
132+
133+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
134+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
135+
-WarningAction, and -WarningVariable. For more information, see
136+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
137+
138+
## INPUTS
139+
140+
### System.Management.Automation.PSObject
141+
142+
## OUTPUTS
143+
144+
### System.Object
145+
146+
## NOTES
147+
148+
## RELATED LINKS
149+
150+
[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md)
151+
152+
[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md)
153+
154+
[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md)
155+
156+
[Set-ClusterExcludedAdapter](set-clusterexcludedadapter.md)

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

+168
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
---
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
4+
Module Name: FailoverClusters
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
7+
schema: 2.0.0
8+
title: Set-ClusterExcludedAdapter
9+
---
10+
11+
# Set-ClusterExcludedAdapter
12+
13+
## SYNOPSIS
14+
Sets a network adapter to the list of excluded adapters.
15+
16+
## SYNTAX
17+
18+
```
19+
Set-ClusterExcludedAdapter -ExclusionType <AdapterExclusionType> -ExclusionValue <String[]>
20+
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
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.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
34+
```powershell
35+
Set-ClusterExcludedAdapter -ExclusionType "Description" -ExclusionValue "Node-1-FL1","Node-1-FL2"
36+
```
37+
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.
41+
42+
## PARAMETERS
43+
44+
### -AsJob
45+
46+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
47+
complete.
48+
49+
The cmdlet immediately returns an object that represents the job and then displays the command
50+
prompt. You can continue to work in the session while the job completes.
51+
52+
For more information about Windows PowerShell background jobs, see
53+
[about_Jobs](/powershell/module/microsoft.powershell.core/about/about_jobs).
54+
55+
```yaml
56+
Type: SwitchParameter
57+
Parameter Sets: (All)
58+
Aliases:
59+
60+
Required: False
61+
Position: Named
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
67+
### -CimSession
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](/powershell/module/cimcmdlets/new-cimsession)
71+
or [Get-CimSession](/powershell/module/cimcmdlets/get-cimsession) cmdlet. The default is the
72+
current session on the local computer.
73+
74+
```yaml
75+
Type: CimSession[]
76+
Parameter Sets: (All)
77+
Aliases: Session
78+
79+
Required: False
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### -ExclusionType
87+
88+
Specifies the type of exclusion to remove from the cluster. Acceptable values are:
89+
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.
93+
94+
```yaml
95+
Type: AdapterExclusionType
96+
Parameter Sets: (All)
97+
Aliases:
98+
Accepted values: IPPrefix, Description, FriendlyName
99+
100+
Required: True
101+
Position: Named
102+
Default value: None
103+
Accept pipeline input: False
104+
Accept wildcard characters: False
105+
```
106+
107+
### -ExclusionValue
108+
109+
Specifies the value to use for the exclusion. The value of this parameter depends on the value of
110+
the `-ExclusionType` parameter.
111+
112+
```yaml
113+
Type: String[]
114+
Parameter Sets: (All)
115+
Aliases:
116+
117+
Required: True
118+
Position: Named
119+
Default value: None
120+
Accept pipeline input: False
121+
Accept wildcard characters: False
122+
```
123+
124+
### -ThrottleLimit
125+
126+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
127+
this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum
128+
throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
129+
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
130+
131+
```yaml
132+
Type: Int32
133+
Parameter Sets: (All)
134+
Aliases:
135+
136+
Required: False
137+
Position: Named
138+
Default value: None
139+
Accept pipeline input: False
140+
Accept wildcard characters: False
141+
```
142+
143+
### CommonParameters
144+
145+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
146+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
147+
-WarningAction, and -WarningVariable. For more information, see
148+
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
149+
150+
## INPUTS
151+
152+
### None
153+
154+
## OUTPUTS
155+
156+
### System.Object
157+
158+
## NOTES
159+
160+
## RELATED LINKS
161+
162+
[Add-ClusterExcludedAdapter](add-clusterexcludedadapter.md)
163+
164+
[Get-ClusterExcludedAdapter](get-clusterexcludedadapter.md)
165+
166+
[Remove-ClusterExcludedAdapter](remove-clusterexcludedadapter.md)
167+
168+
[Repair-ClusterNameAccount](repair-clusternameaccount.md)

0 commit comments

Comments
 (0)
Please sign in to comment.