15f7be9a52
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
35 lines
1.8 KiB
ReStructuredText
35 lines
1.8 KiB
ReStructuredText
.. _str: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _direction: ../../../../vim/vm/device/VirtualDevice/URIBackingInfo.rst#direction
|
|
|
|
.. _serviceURI: ../../../../vim/vm/device/VirtualDevice/URIBackingInfo.rst#serviceURI
|
|
|
|
.. _vSphere API 4.1: ../../../../vim/version.rst#vimversionversion6
|
|
|
|
.. _VirtualDeviceURIBackingInfo: ../../../../vim/vm/device/VirtualDevice/URIBackingInfo.rst
|
|
|
|
.. _VirtualDeviceURIBackingOptionDirection: ../../../../vim/vm/device/VirtualDeviceOption/URIBackingOption/Direction.rst
|
|
|
|
.. _vim.vm.device.VirtualDevice.BackingInfo: ../../../../vim/vm/device/VirtualDevice/BackingInfo.rst
|
|
|
|
|
|
vim.vm.device.VirtualDevice.URIBackingInfo
|
|
==========================================
|
|
The `VirtualDeviceURIBackingInfo`_ data object type defines information for using a network socket as backing for a virtual device.
|
|
:extends: vim.vm.device.VirtualDevice.BackingInfo_
|
|
:since: `vSphere API 4.1`_
|
|
|
|
Attributes:
|
|
serviceURI (`str`_):
|
|
|
|
Identifies the local host or a system on the network, depending on the value of `direction`_ .
|
|
* If you use the virtual machine as a server, the URI identifies the host on which the virtual machine runs. In this case, the host name part of the URI should be empty, or it should specify the address of the local host.
|
|
* If you use the virtual machine as a client, the URI identifies the remote system on the network.
|
|
*
|
|
direction (`str`_):
|
|
|
|
The direction of the connection. For possible values see `VirtualDeviceURIBackingOptionDirection`_
|
|
proxyURI (`str`_, optional):
|
|
|
|
Identifies a proxy service that provides network access to the `serviceURI`_ . If you specify a proxy URI, the virtual machine initiates a connection with the proxy service and forwards the `serviceURI`_ and `direction`_ to the proxy.
|