Files
deb-python-pyvmomi/docs/vim/host/SriovInfo.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

35 lines
1021 B
ReStructuredText

.. _int: https://docs.python.org/2/library/stdtypes.html
.. _bool: https://docs.python.org/2/library/stdtypes.html
.. _vSphere API 5.5: ../../vim/version.rst#vimversionversion9
.. _vim.host.PciPassthruInfo: ../../vim/host/PciPassthruInfo.rst
vim.host.SriovInfo
==================
This data object provides information about the state of SR-IOV device.
:extends: vim.host.PciPassthruInfo_
:since: `vSphere API 5.5`_
Attributes:
sriovEnabled (`bool`_):
Whether SRIOV has been enabled by the user
sriovCapable (`bool`_):
Whether SRIOV is possible for this device
sriovActive (`bool`_):
Whether SRIOV is active for this device (meaning enabled + rebooted)
numVirtualFunctionRequested (`int`_):
Number of SRIOV virtual functions requested for this device
numVirtualFunction (`int`_):
Number of SRIOV virtual functions present on this device
maxVirtualFunctionSupported (`int`_):
Maximum number of SRIOV virtual functions supported on this device