Get Hardware Serial
DescriptionReturns information about a virtual serial port.
Request
URLURL
Path Parameters
Path Parameters
Header Parameters
Header Parameters
Response
Response BodyResponse Body
Information about the specified virtual serial port.
{
"allow_guest_control": false,
"backing": {
"auto_detect": false,
"file": "string",
"host_device": "string",
"network_location": "string",
"no_rx_loss": false,
"pipe": "string",
"proxy": "string",
"type": "enum"
},
"label": "string",
"start_connected": false,
"state": "enum",
"yield_on_poll": false
}
Flag indicating whether the guest can connect and disconnect the device.
Device label.
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
Connection status of the virtual device.
Possible values are: CONNECTED , RECOVERABLE_ERROR , UNRECOVERABLE_ERROR , NOT_CONNECTED , UNKNOWN
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.