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


Required Property Name Type Description
required allow_guest_control boolean

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

required backing VmHardwareSerialBackingInfo

Physical resource backing for the virtual serial port.

required label string

Device label.

required start_connected boolean

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

required state VmHardwareConnectionState

Connection status of the virtual device.

required yield_on_poll boolean

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.

JSON Example

    "allow_guest_control": false,
    "backing": {
        "type": "enum"
    "label": "string",
    "start_connected": false,
    "state": "enum",
    "yield_on_poll": false

Was this page helpful?