Developer Documentation

SerialBackingInfo

The Serial.BackingInfo structure contains information about the physical resource backing a virtual serial port.


Properties

Required Property Name Type Description
optional auto_detect boolean

Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device. This field is optional and it is only relevant when the value of Serial.BackingInfo.type is HOST_DEVICE.

optional file string

Path of the file backing the virtual serial port. This field is optional and it is only relevant when the value of Serial.BackingInfo.type is FILE.

optional host_device string

Name of the device backing the virtual serial port.

This field will be unset if Serial.BackingInfo.auto-detect is true and the virtual serial port is not connected or no suitable device is available on the host.

optional network_location string

URI specifying the location of the network service backing the virtual serial port. - If Serial.BackingInfo.type is NETWORK_SERVER, this field is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running. - If Serial.BackingInfo.type is NETWORK_CLIENT, this field is the location used by the virtual machine to connect to the remote server.

This field is optional and it is only relevant when the value of Serial.BackingInfo.type is one of NETWORK_SERVER or NETWORK_CLIENT.

optional no_rx_loss boolean

Flag that enables optimized data transfer over the pipe. When the value is true, the host 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. This field is optional and it is only relevant when the value of Serial.BackingInfo.type is one of PIPE_SERVER or PIPE_CLIENT.

optional pipe string

Name of the pipe backing the virtual serial port. This field is optional and it is only relevant when the value of Serial.BackingInfo.type is one of PIPE_SERVER or PIPE_CLIENT.

optional proxy string

Proxy service that provides network access to the network backing. If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy. If unset, no proxy service is configured.

required type SerialBackingType Enum

Backing type for the virtual serial port.

Feedback

Was this page helpful?