Skip to content

Commit a2e23bc

Browse files
Stacyrch140Stacyrch140
authored
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

Lines changed: 167 additions & 0 deletions
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

Lines changed: 150 additions & 0 deletions
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)

0 commit comments

Comments
 (0)