VmHardwareSerialInfo

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


Properties

boolean
allow_guest_control Required

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


backing Required

Physical resource backing for the virtual serial port.


string
label Required

Device label.


boolean
start_connected Required

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


state Required

Connection status of the virtual device.


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.

JSON Example

{
	"allow_guest_control": false,
	"backing": {
		"type": "FILE"
	},
	"label": "string",
	"start_connected": false,
	"state": "enum",
	"yield_on_poll": false
}
Returned By

Get Hardware Serial

Feedback

Was this page helpful?