1. Types
  2. vcenter
  3. vm
  4. hardware
  5. serial

vcenter vm hardware serial: info

The info structure contains information about a virtual serial port.

Representation:

{
    "allow_guest_control": true,
    "backing": {
        "auto_detect": true,
        "file": "string",
        "host_device": "string",
        "network_location": "http://myurl.com",
        "no_rx_loss": true,
        "pipe": "string",
        "proxy": "http://myurl.com",
        "type": "FILE"
    },
    "label": "string",
    "start_connected": true,
    "state": "CONNECTED",
    "yield_on_poll": true
}

Attributes:

Name Type Description
Required
label string Device label.
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.
backing backing_info Physical resource backing for the virtual serial port.
state string Connection status of the virtual device.

Defines the valid states for a removable device that is configured to be connected. Value is one of:
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.
start_connected boolean Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
allow_guest_control boolean Flag indicating whether the guest can connect and disconnect the device.