Vm_Hardware_Serial_Info

Vm_Hardware_Serial_Info
Vm_Hardware_Serial_Info

The Serial.Info structure contains information about a virtual serial port.

JSON Example 
{
    "label": "string",
    "yield_on_poll": false,
    "backing": {
        "type": "string",
        "file": "string",
        "host_device": "string",
        "auto_detect": false,
        "pipe": "string",
        "no_rx_loss": false,
        "network_location": "string",
        "proxy": "string"
    },
    "state": "string",
    "start_connected": false,
    "allow_guest_control": false
}
string
label
Required

Device label.

boolean
yield_on_poll
Required

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.

Vm_Hardware_Serial_BackingInfo
backing
Required

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

Vm_Hardware_ConnectionState
state
Required

The ConnectionState enumerated type defines the valid states for a removable device that is configured to be connected.
CONNECTED : The device is connected and working correctly.
RECOVERABLE_ERROR : Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.
UNRECOVERABLE_ERROR : Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.
NOT_CONNECTED : The device is not connected.
UNKNOWN : The device status is unknown.

boolean
start_connected
Required

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

boolean
allow_guest_control
Required

Flag indicating whether the guest can connect and disconnect the device.

Returned By