VmHardwareSerialUpdateSpec

The Serial.UpdateSpec structure describes the updates to be made to the configuration of a virtual serial port.


Properties

boolean
allow_guest_control Optional

Flag indicating whether the guest can connect and disconnect the device. If unset, the value is unchanged.


backing Optional

Physical resource backing for the virtual serial port. This field may only be modified if the virtual machine is not powered on or the virtual serial port is not connected.

If unset, the value is unchanged.


boolean
start_connected Optional

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. If unset, the value is unchanged.


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. This field may be modified at any time, and changes applied to a connected virtual serial port take effect immediately.

If unset, the value is unchanged.

JSON Example

{
    "allow_guest_control": false,
    "backing": {
        "file": "string",
        "host_device": "string",
        "network_location": "string",
        "no_rx_loss": false,
        "pipe": "string",
        "proxy": "string",
        "type": "enum"
    },
    "start_connected": false,
    "yield_on_poll": false
}
Parameter To

Update Hardware Serial
Feedback

Was this page helpful?