Data Object - VirtualSerialPortPipeBackingInfo


Data Object Description

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.


Name Type Description

Indicates the role the virtual machine assumes as an endpoint for the pipe. The valid values are "client" or "server".

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, set noRxLoss to true. To disable this feature, set the property to false.

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 the noRxLoss setting 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.

Properties inherited from VirtualDevicePipeBackingInfo
Properties inherited from VirtualDeviceBackingInfo
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition