Files
deb-python-pyvmomi/docs/vim/vm/device/VirtualSerialPortOption.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.3 KiB

vim.vm.device.VirtualSerialPortOption

The VirtualSerialPortOption data object contains the options for configuring the virtual serial port device defined by the VirtualSerialPort data object. These options include information about how the device is backed physically on the host: by a network socket, a host file, a host serial port device, or a pipe to another process.

extends

vim.vm.device.VirtualDeviceOption

Attributes:

yieldOnPoll (vim.option.BoolOption):

Indicates whether the virtual machine supports the CPU yield option during virtual serial port polling. When this feature is supported and enabled, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port.IfyieldOnPoll.supportedisfalse, the virtual machine ignores the virtual serial port object setting for yieldOnPoll .