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
2.1 KiB
vim.vm.device.VirtualSerialPort.PipeBackingInfo
The VirtualSerialPortPipeBackingInfo data object defines information for backing a VirtualSerialPort with a named pipe. You can use a pipe to connect a virtual serial port to a host application or to another virtual machine on the host computer. This is useful for capturing debugging information sent through the virtual serial port.
- Attributes:
-
endpoint (str):
Indicates the role the virtual machine assumes as an endpoint for the pipe. The valid values are "client" or "server".
noRxLoss (bool, optional):
Enables optimized data transfer over the pipe. When you use this feature, the ESX server buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss. To use optimized data transfer, setnoRxLosstotrue. To disable this feature, set the property tofalse.This property is optional. If this property is not set, the ESX server uses the default value specified in the pipe backing options (noRxLoss.defaultValue - see noRxLoss in the pipe backing option object).To use this property, optimized data transfer must be supported on the host. (See noRxLoss in the pipe backing option object.) If the ESX server does not support the option, it ignores thenoRxLosssetting in the pipe backing information object.Note: You can use this feature even if the other end of the pipe is not an application, but this is more likely to fail.