HostNicTeamingPolicy

HostNicTeamingPolicy
HostNicTeamingPolicy

Policy for a network adapter team.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "policy": "string",
    "reversePolicy": false,
    "notifySwitches": false,
    "rollingOrder": false,
    "failureCriteria": {
        "_typeName": "string",
        "checkSpeed": "string",
        "speed": 0,
        "checkDuplex": false,
        "fullDuplex": false,
        "checkErrorPercent": false,
        "percentage": 0,
        "checkBeacon": false
    },
    "nicOrder": {
        "_typeName": "string",
        "activeNic": [
            "string"
        ],
        "standbyNic": [
            "string"
        ]
    }
}
string
policy
Optional

Network adapter teaming policy includes failover and load balancing, It can be one of the following:

  • loadbalance_ip: route based on ip hash.
  • loadbalance_srcmac: route based on source MAC hash.
  • loadbalance_srcid: route based on the source of the port ID.
  • failover_explicit: use explicit failover order.

See also nicTeamingPolicy.

boolean
reversePolicy
Optional

Deprecated as of VI API 5.1, the system default (true) will be used.

The flag to indicate whether or not the teaming policy is applied to inbound frames as well.

For example, if the policy is explicit failover, a broadcast request goes through uplink1 and comes back through uplink2. Then if the reverse policy is set, the frame is dropped when it is received from uplink2. This reverse policy is useful to prevent the virtual machine from getting reflections.

boolean
notifySwitches
Optional

Flag to specify whether or not to notify the physical switch if a link fails.

If this property is true, ESX Server will respond to the failure by sending a RARP packet from a different physical adapter, causing the switch to update its cache.

boolean
rollingOrder
Optional

The flag to indicate whether or not to use a rolling policy when restoring links.

For example, assume the explicit link order is (vmnic9, vmnic0), therefore vmnic9 goes down, vmnic0 comes up. However, when vmnic9 comes backup, if rollingOrder is set to be true, vmnic0 continues to be used, otherwise, vmnic9 is restored as specified in the explicitly order.

failureCriteria
Optional

This data object type describes the network adapter failover detection algorithm for a network adapter team.

nicOrder
Optional

This data object type describes network adapter ordering policy for a network adapter team.

A physical network adapter can be in the active list, the standby list, or neither. It cannot be in both lists. For a virtual switch, the NicOrderPolicy property is never null when retrieved from the server. When creating a new virtual switch or updating an existing virtual switch, the NicOrderPolicy can be null, in which case the default NicOrderPolicy from the server will be used. For a portgroup, a null NicOrderPolicy property means the portgroup inherits the policy from its parent. Otherwise, the NicOrderPolicy property defined in the portgroup takes precedence. In all cases where the NicOrderPolicy property is set, an empty activeNic array means there are no active Ethernet adapters in the team. An empty standbyNic array means there are no standby Ethernet adapters.