openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
404978f0f0607fe0217675a8975a2b2a1eaa9641
deb-python-pyvmomi/docs/vim/AboutInfo.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.5 KiB
Raw Blame History

vim.AboutInfo

This data object type describes system information including the name, type, version, and build number.

extends

vmodl.DynamicData

Attributes:

name (str):

Short form of the product name.

fullName (str):

The complete product name, including the version information.

vendor (str):

Name of the vendor of this product.

version (str):

Dot-separated version string. For example, "1.2".

build (str):

Build string for the server on which this call is made. For example, x.y.z-num. This string does not apply to the API.

localeVersion (str, optional):

Version of the message catalog for the current session's locale.

localeBuild (str, optional):

Build number for the current session's locale. Typically, this is a small number reflecting a localization change from the normal product build.

osType (str):

Operating system type and architecture.Examples of values are:
  • "win32-x86" - For x86-based Windows systems.
  • "linux-x86" - For x86-based Linux systems.
  • "vmnix-x86" - For the x86 ESX Server microkernel.

productLineId (str):

The product ID is a unique identifier for a product line.Examples of values are:
  • "gsx" - For the VMware Server product.
  • "esx" - For the ESX product.
  • "embeddedEsx" - For the ESXi product.
  • "vpx" - For the VirtualCenter product.

apiType (str):

Indicates whether or not the service instance represents a standalone host. If the service instance represents a standalone host, then the physical inventory for that service instance is fixed to that single host. VirtualCenter server provides additional features over single hosts. For example, VirtualCenter offers multi-host management.Examples of values are:
  • "VirtualCenter" - For a VirtualCenter instance.
  • "HostAgent" - For host agent on an ESX Server or VMware Server host.

apiVersion (str):

The version of the API as a dot-separated string. For example, "1.0.0".

instanceUuid (str, optional):

A globally unique identifier associated with this service instance.

licenseProductName (str, optional):

The license product name

licenseProductVersion (str, optional):

The license product version