Vm_Hardware_Serial_BackingSpec

Vm_Hardware_Serial_BackingSpec
Vm_Hardware_Serial_BackingSpec

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

JSON Example 
{
    "type": "string",
    "file": "string",
    "host_device": "string",
    "pipe": "string",
    "no_rx_loss": false,
    "network_location": "string",
    "proxy": "string"
}
Vm_Hardware_Serial_BackingType
type
Required

The Serial.BackingType enumerated type defines the valid backing types for a virtual serial port.
FILE : Virtual serial port is backed by a file.
HOST_DEVICE : Virtual serial port is backed by a device on the host where the virtual machine is running.
PIPE_SERVER : Virtual serial port is backed by a named pipe server. The virtual machine will accept a connection from a host application or another virtual machine on the same host. This is useful for capturing debugging information sent through the virtual serial port.
PIPE_CLIENT : Virtual serial port is backed by a named pipe client. The virtual machine will connect to the named pipe provided by a host application or another virtual machine on the same host. This is useful for capturing debugging information sent through the virtual serial port.
NETWORK_SERVER : Virtual serial port is backed by a network server. This backing may be used to create a network-accessible serial port on the virtual machine, accepting a connection from a remote system.
NETWORK_CLIENT : Virtual serial port is backed by a network client. This backing may be used to create a network-accessible serial port on the virtual machine, initiating a connection to a remote system.

string
file
Optional

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.

string
host_device
Optional

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.

string
pipe
Optional

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.

boolean
no_rx_loss
Optional

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.

string As uri
network_location
Optional

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.

string As uri
proxy
Optional

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.