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]

Parameters

Required Parameter Name Type Position Features Description
required
VirtualPortGroupPolicy
NicTeamingVirtualPortGroupPolicy[] named
  • pipeline
  • Specifies the virtual port group policy to configure.
    optional
    FailbackEnabled
    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
    InheritFailback
    Boolean named Indicates that the value of the FailbackEnabled parameter is inherited from the virtual switch.
    optional
    InheritFailoverOrder
    Boolean named Indicates that the value of the MakeNicActive, MakeNicStandBy, and MakeNicUnused parameters are inherited from the virtual switch.
    optional
    InheritLoadBalancingPolicy
    Boolean named Indicates that the value of the LoadBalancingPolicy parameter is inherited from the virtual switch.
    optional
    InheritNetworkFailoverDetectionPolicy
    Boolean named Indicates that the value of the NetworkFailoverDetectionPolicy parameter is inherited from the virtual switch.
    optional
    InheritNotifySwitches
    Boolean named Indicates that the value of the NotifySwitches parameter is inherited from the virtual switch.
    optional
    LoadBalancingPolicy
    LoadBalancingPolicy named Determines how network traffic is distributed between the network adapters assigned to a switch. The following values are valid:
    optional
    MakeNicActive
    PhysicalNic[] named Specifies the adapters you want to continue to use when the network adapter connectivity is available and active.
    optional
    MakeNicStandby
    PhysicalNic[] named Specifies the adapters you want to use if one of the active adapter's connectivity is unavailable.
    optional
    MakeNicUnused
    PhysicalNic[] named Specifies the adapters you do not want to use.
    optional
    NetworkFailoverDetectionPolicy
    NetworkFailoverDetectionPolicy named Specifies how to reroute traffic in the event of an adapter failure. The following values are valid:
    optional
    NotifySwitches
    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]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    VirtualSwitchPolicy
    NicTeamingVirtualSwitchPolicy[] named
  • pipeline
  • Specifies the virtual switch policy to configure.
    optional
    BeaconInterval
    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
    FailbackEnabled
    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
    LoadBalancingPolicy named Determines how network traffic is distributed between the network adapters assigned to a switch. The following values are valid:
    optional
    MakeNicActive
    PhysicalNic[] named Specifies the adapters you want to continue to use when the network adapter connectivity is available and active.
    optional
    MakeNicStandby
    PhysicalNic[] named Specifies the adapters you want to use if one of the active adapter's connectivity is unavailable.
    optional
    MakeNicUnused
    PhysicalNic[] named Specifies the adapters you do not want to use.
    optional
    NetworkFailoverDetectionPolicy
    NetworkFailoverDetectionPolicy named Specifies how to reroute traffic in the event of an adapter failure. The following values are valid:
    optional
    NotifySwitches
    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

    Feedback

    Was this page helpful?