Developer Documentation

SerialBackingSpec

The Serial.BackingSpec structure provides a specification of the physical resource backing a virtual serial port.


Properties

Required Property Name Type Description
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.BackingSpec.type is FILE.

optional host_device string

Name of the device backing the virtual serial port.

If unset, the virtual serial port will be configured to automatically detect a suitable host device.

optional network_location string

URI specifying the location of the network service backing the virtual serial port. - If Serial.BackingSpec.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.BackingSpec.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.BackingSpec.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. If unset, defaults to false.

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.BackingSpec.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 should be used.

required type SerialBackingType Enum

Backing type for the virtual serial port.

Feedback

Was this page helpful?