Get-ClusterExcludedAdapter
Retrieves a network adapter from the list of excluded adapters.
Syntax
Default (Default)
Get-ClusterExcludedAdapter
-ExclusionType <AdapterExclusionType>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
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
Get-ClusterExcludedAdapter -ExclusionType "FriendlyName"
This example retrieves a list of network adapters that have been excluded from use by the cluster based on the friendly name.
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes.
For more information about Windows PowerShell background jobs, see about_Jobs.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ExclusionType
Specifies the type of exclusion to retrieve from the cluster. Acceptable values are:
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.
Parameter properties
| Type: | AdapterExclusionType |
| Default value: | None |
| Accepted values: | IPPrefix, Description, FriendlyName |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
this parameter is omitted or a value of 0 is entered, then PowerShell calculates an optimum
throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.