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

1.5 KiB

vim.ServiceManager.ServiceInfo

This data object represents essential information about a particular service. The information is sufficient to be able to identify the service and retrieve the object implementing it.

extends

vmodl.DynamicData

Attributes:

serviceName (str):

A service name. Each service is expected to create a unique name for itself that can be used to locate the service. This name does not need to be unique across hosts or other such locations though.

location (str, optional):

A list of data that can be used to uniquely identify a particular instance of a service. Multiple instances of a service can exist across different domains (for instance, a service that is associated with a particular virtual machine or a particular host). In such cases, the service name is insufficient to identify the service and location data can be used to identify the instance of interest. A service may publish as much location data as is needed to identify it (e.g, vmware.host.or vmware.vm.or both). The particular choice of locations have to be agreed upon by the client and the service.

service (vmodl.ManagedObject):

The managed object that presents this service.

description (str):

A description of the service. Provides help text on how to use the service.