Data Object - HostNicFailureCriteria

Property of
HostNicTeamingPolicy
Extends
DynamicData

Data Object Description

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

Properties

Name Type Description
checkBeacon*xsd:boolean

The flag to indicate whether or not to enable this property to enable beacon probing as a method to validate the link status of a physical network adapter.

checkBeacon can be enabled only if the VirtualSwitch has been configured to use the beacon. Attempting to set checkBeacon on a PortGroup or VirtualSwitch that does not have beacon probing configured for the applicable VirtualSwitch results in an error.
See beacon
See HostVirtualSwitchBeaconConfig
checkDuplex*xsd:booleanDeprecated. As of VI API 5.1, this property is not supported

The flag to indicate whether or not to use the link duplex reported by the driver as link selection criteria.

If checkDuplex is true, then fullDuplex is the configured duplex mode. The link is considered bad if the link duplex reported by driver is not the same as fullDuplex.

If checkDuplex is false, then fullDuplex is unused, and link duplexity is not used as a detection method.

checkErrorPercent*xsd:booleanDeprecated. As of VI API 5.1, this property is not supported

The flag to indicate whether or not to use link error percentage to detect failure.

If checkErrorPercent is true, then percentage is the configured error percentage that is tolerated. The link is considered bad if error rate exceeds percentage.

If checkErrorPercent is false, percentage is unused, and error percentage is not used as a detection method.

checkSpeed*xsd:stringDeprecated. As of VI API 5.1, this property is not supported

To use link speed as the criteria, checkSpeed must be one of the following values:

  • exact: Use exact speed to detect link failure. speed is the configured exact speed in megabits per second.
  • minimum: Use minimum speed to detect failure. speed is the configured minimum speed in megabits per second.
  • empty string: Do not use link speed to detect failure. speed is unused in this case.

fullDuplex*xsd:booleanDeprecated. As of VI API 5.1, this property is not supported

see vim.host.NetworkPolicy.NicFailureCriteria#checkDuplex
See checkDuplex
percentage*xsd:intDeprecated. As of VI API 5.1, this property is not supported

see vim.host.NetworkPolicy.NicFailureCriteria#checkErrorPercent
See checkErrorPercent
speed*xsd:intDeprecated. As of VI API 5.1, this property is not supported

see vim.host.NetworkPolicy.NicFailureCriteria#checkSpeed
See checkSpeed
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition