Set-NicTeamingPolicy
This cmdlet modifies the specified NIC teaming policy. You can change the load balancing and failover settings. Default NIC teaming policies are set for the entire virtual switch and can be overridden at port group level.
Syntax
-VirtualPortGroupPolicy
<NicTeamingVirtualPortGroupPolicy[]>
[-FailbackEnabled <Boolean>]
[-InheritFailback <Boolean>]
[-InheritFailoverOrder <Boolean>]
[-InheritLoadBalancingPolicy <Boolean>]
[-InheritNetworkFailoverDetectionPolicy <Boolean>]
[-InheritNotifySwitches <Boolean>]
[-LoadBalancingPolicy <LoadBalancingPolicy>]
[-MakeNicActive <PhysicalNic[]>]
[-MakeNicStandby <PhysicalNic[]>]
[-MakeNicUnused <PhysicalNic[]>]
[-NetworkFailoverDetectionPolicy <NetworkFailoverDetectionPolicy>]
[-NotifySwitches <Boolean>]
[CommonParameters]
[-FailbackEnabled <Boolean>]
[-InheritFailback <Boolean>]
[-InheritFailoverOrder <Boolean>]
[-InheritLoadBalancingPolicy <Boolean>]
[-InheritNetworkFailoverDetectionPolicy <Boolean>]
[-InheritNotifySwitches <Boolean>]
[-LoadBalancingPolicy <LoadBalancingPolicy>]
[-MakeNicActive <PhysicalNic[]>]
[-MakeNicStandby <PhysicalNic[]>]
[-MakeNicUnused <PhysicalNic[]>]
[-NetworkFailoverDetectionPolicy <NetworkFailoverDetectionPolicy>]
[-NotifySwitches <Boolean>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
NicTeamingVirtualPortGroupPolicy[] | named |
|
Specifies the virtual port group policy to configure. | optional |
|
Boolean | named |
|
Specifies how a physical adapter is returned to active duty after recovering from a failure. If the value is $true, the adapter is returned to active duty immediately on recovery, displacing the standby adapter that took over its slot, if any. If the value is $false, a failed adapter is left inactive even after recovery until another active adapter fails, requiring its replacement. | optional |
|
Boolean | named |
|
Indicates that the value of the FailbackEnabled parameter is inherited from the virtual switch. | optional |
|
Boolean | named |
|
Indicates that the value of the MakeNicActive, MakeNicStandBy, and MakeNicUnused parameters are inherited from the virtual switch. | optional |
|
Boolean | named |
|
Indicates that the value of the LoadBalancingPolicy parameter is inherited from the virtual switch. | optional |
|
Boolean | named |
|
Indicates that the value of the NetworkFailoverDetectionPolicy parameter is inherited from the virtual switch. | optional |
|
Boolean | named |
|
Indicates that the value of the NotifySwitches parameter is inherited from the virtual switch. | optional |
|
LoadBalancingPolicy | named |
|
Determines how network traffic is distributed between the network adapters assigned to a switch. The following values are valid: | optional |
|
PhysicalNic[] | named |
|
Specifies the adapters you want to continue to use when the network adapter connectivity is available and active. | optional |
|
PhysicalNic[] | named |
|
Specifies the adapters you want to use if one of the active adapter's connectivity is unavailable. | optional |
|
PhysicalNic[] | named |
|
Specifies the adapters you do not want to use. | optional |
|
NetworkFailoverDetectionPolicy | named |
|
Specifies how to reroute traffic in the event of an adapter failure. The following values are valid: | optional |
|
Boolean | named |
|
Indicates that whenever a virtual NIC is connected to the virtual switch or whenever that virtual NIC's traffic is routed over a different physical NIC in the team because of a failover event, a notification is sent over the network to update the lookup tables on the physical switches. |
-VirtualSwitchPolicy
<NicTeamingVirtualSwitchPolicy[]>
[-BeaconInterval <Int32>]
[-FailbackEnabled <Boolean>]
[-LoadBalancingPolicy <LoadBalancingPolicy>]
[-MakeNicActive <PhysicalNic[]>]
[-MakeNicStandby <PhysicalNic[]>]
[-MakeNicUnused <PhysicalNic[]>]
[-NetworkFailoverDetectionPolicy <NetworkFailoverDetectionPolicy>]
[-NotifySwitches <Boolean>]
[CommonParameters]
[-BeaconInterval <Int32>]
[-FailbackEnabled <Boolean>]
[-LoadBalancingPolicy <LoadBalancingPolicy>]
[-MakeNicActive <PhysicalNic[]>]
[-MakeNicStandby <PhysicalNic[]>]
[-MakeNicUnused <PhysicalNic[]>]
[-NetworkFailoverDetectionPolicy <NetworkFailoverDetectionPolicy>]
[-NotifySwitches <Boolean>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
NicTeamingVirtualSwitchPolicy[] | named |
|
Specifies the virtual switch policy to configure. | optional |
|
Int32 | named |
|
Specifies the interval at which the server sends out beacon probes on all NICs in the team. The value must be a positive integer. This parameter is used when the value of the NetworkFailoverDetectionPolicy parameter is BeaconProbing. | optional |
|
Boolean | named |
|
Specifies how a physical adapter is returned to active duty after recovering from a failure. If the value is $true, the adapter is returned to active duty immediately on recovery, displacing the standby adapter that took over its slot, if any. If the value is $false, a failed adapter is left inactive even after recovery until another active adapter fails, requiring its replacement. | optional |
|
LoadBalancingPolicy | named |
|
Determines how network traffic is distributed between the network adapters assigned to a switch. The following values are valid: | optional |
|
PhysicalNic[] | named |
|
Specifies the adapters you want to continue to use when the network adapter connectivity is available and active. | optional |
|
PhysicalNic[] | named |
|
Specifies the adapters you want to use if one of the active adapter's connectivity is unavailable. | optional |
|
PhysicalNic[] | named |
|
Specifies the adapters you do not want to use. | optional |
|
NetworkFailoverDetectionPolicy | named |
|
Specifies how to reroute traffic in the event of an adapter failure. The following values are valid: | optional |
|
Boolean | named |
|
Indicates that whenever a virtual NIC is connected to the virtual switch or whenever that virtual NIC's traffic is routed over a different physical NIC in the team because of a failover event, a notification is sent over the network to update the lookup tables on the physical switches. |
Output
VMware.VimAutomation.ViCore.Types.V1.Host.Networking.NicTeamingPolicy
Examples
Example 1
$policy = Get-VirtualSwitch -VMHost (Get-VMHost *.128) -Name vSwitch1 | Get-NicTeamingPolicy
$policy | Set-NicTeamingPolicy -LoadBalancingPolicy LoadBalanceSrcMac
Configures the NicTeaming policy of the vSwitch1 virtual switch.
Related Commands
NicTeamingPolicy
This cmdlet retrieves the NIC teaming policies of the specified virtual switches and virtual port groups.
This cmdlet modifies the specified NIC teaming policy.
