Vm_Hardware_Serial_CreateSpec

Vm_Hardware_Serial_CreateSpec
Vm_Hardware_Serial_CreateSpec

The Serial.CreateSpec structure provides a specification for the configuration of a newly-created virtual serial port.

JSON Example 
{
    "yield_on_poll": false,
    "backing": {
        "type": "string",
        "file": "string",
        "host_device": "string",
        "pipe": "string",
        "no_rx_loss": false,
        "network_location": "string",
        "proxy": "string"
    },
    "start_connected": false,
    "allow_guest_control": false
}
boolean
yield_on_poll
Optional

CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host. If unset, defaults to false.

Vm_Hardware_Serial_BackingSpec
backing
Optional

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

boolean
start_connected
Optional

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. Defaults to false if unset.

boolean
allow_guest_control
Optional

Flag indicating whether the guest can connect and disconnect the device. Defaults to false if unset.

Parameter To