Set-ClusterExcludedAdapter
Sets a network adapter to the list of excluded adapters.
Syntax
Set-ClusterExcludedAdapter
-ExclusionType <AdapterExclusionType>
-ExclusionValue <String[]>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] 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
Set-ClusterExcludedAdapter -ExclusionType "Description" -ExclusionValue "Node-1-FL1","Node-1-FL2"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
-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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExclusionType
Specifies the type of exclusion to remove 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.
| Type: | AdapterExclusionType |
| Accepted values: | IPPrefix, Description, FriendlyName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExclusionValue
Specifies the value to use for the exclusion. The value of this parameter depends on the value of
the -ExclusionType parameter.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None