openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
dbad63e88d06b08d4f1aac358ad3a7f953396ae1
deb-python-pyvmomi/docs/vim/dvs/VmwareDistributedVirtualSwitch/FailureCriteria.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation 
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

2.9 KiB
Raw Blame History

vim.dvs.VmwareDistributedVirtualSwitch.FailureCriteria

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

extends

vim.InheritablePolicy

since

vSphere API 4.0

Attributes:

checkSpeed (vim.StringPolicy, optional):

To use link speed as the criteria,checkSpeedmust 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.

speed (vim.IntPolicy, optional):

See checkSpeed

checkDuplex (vim.BoolPolicy, optional):

The flag to indicate whether or not to use the link duplex reported by the driver as link selection criteria.IfcheckDuplexis 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.IfcheckDuplexis false, then fullDuplex is unused, and link duplexity is not used as a detection method.

fullDuplex (vim.BoolPolicy, optional):

See checkDuplex

checkErrorPercent (vim.BoolPolicy, optional):

The flag to indicate whether or not to use link error percentage to detect failure.IfcheckErrorPercentis true, then percentage is the configured error percentage that is tolerated. The link is considered bad if error rate exceeds percentage.IfcheckErrorPercentis false, percentage is unused, and error percentage is not used as a detection method.

percentage (vim.IntPolicy, optional):

See checkErrorPercent

checkBeacon (vim.BoolPolicy, optional):

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.checkBeaconcan be enabled only if the VirtualSwitch has been configured to use the beacon. Attempting to setcheckBeaconon a PortGroup or VirtualSwitch that does not have beacon probing configured for the applicable VirtualSwitch results in an error.