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

4.2 KiB

vim.Extension

This data object type contains all information about an extension. An extension may contain zero or more server interfaces and zero or more clients.

extends

vmodl.DynamicData

since

VI API 2.5

Attributes:

description (vim.Description):

Description of extension.

key (str):

Extension key. Should follow java package naming conventions for uniqueness (e.g. "com.example.management").Extension names can only contain characters belonging to the lower ASCII character set (UTF-7) with the exception of the following characters:
  • All whitespace characters ("space" - ascii character 0x20 is allowed)
  • Control characters
  • Comma (ascii 0x2c), Forward slash (ascii 0x2f), Backward slash (ascii 0x5c), Hash/Pound (ascii 0x23), Plus (ascii 0x2b), Greater (ascii 0x3e), Lesser (ascii 0x3c), Equals (ascii 0x3d), Semi-colon (ascii 0x3b) and Double quote (ascii 0x22).

company (str, optional):

Company information.

type (str, optional):

Type of extension (example may include CP-DVS, NUOVA-DVS, etc.).

version (str):

Extension version number as a dot-separated string. For example, "1.0.0"

subjectName (str, optional):

Subject name from client certificate.

server (vim.Extension.ServerInfo, optional):

Servers for this extension.

client (vim.Extension.ClientInfo, optional):

Clients for this extension.

taskList (vim.Extension.TaskTypeInfo, optional):

Definitions of tasks defined by this extension.

eventList (vim.Extension.EventTypeInfo, optional):

Definitions of events defined by this extension.

faultList (vim.Extension.FaultTypeInfo, optional):

Definitions of faults defined by this extension.

privilegeList (vim.Extension.PrivilegeInfo, optional):

Definitions privileges defined by this extension.

resourceList (vim.Extension.ResourceInfo, optional):

Resource data for all locales

lastHeartbeatTime (datetime):

Last extension heartbeat time.

healthInfo (vim.Extension.HealthInfo, optional):

Health specification provided by this extension.

ovfConsumerInfo (vim.Extension.OvfConsumerInfo, optional):

OVF consumer specification provided by this extension.

extendedProductInfo (vim.ext.ExtendedProductInfo, optional):

Extended product information, such as URLs to vendor, product, etc.

managedEntityInfo (vim.ext.ManagedEntityInfo, optional):

Information about entities managed by this extension. An extension can register virtual machines as managed by itself, by setting the managedBy property of the virtual machine.

shownInSolutionManager (bool, optional):

Opt-in to the Solution Manager. If set to true, this extension will be shown in the Solution Manager. If not set, or set to false, this extension is not shown in the Solution Manager.

solutionManagerInfo (vim.ext.SolutionManagerInfo, optional):

Solution Manager configuration for this extension.