This API has a deprecated equivalent from v7.0U1.
Get Hardware Serial
Returns information about a virtual serial port.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/serial/{port}
Path Parameters
Path Parameters
string
vm
Required
Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
string
port
Required
Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareSerialInfo
of type application/json
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": "FILE"
},
"label": "string",
"start_connected": false,
"state": "enum",
"yield_on_poll": false
}
boolean
allow_guest_control
Required
Flag indicating whether the guest can connect and disconnect the device.
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.
Possible values are: CONNECTED , RECOVERABLE_ERROR , UNRECOVERABLE_ERROR , NOT_CONNECTED , UNKNOWN
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.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine or virtual serial port is not found.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine’s configuration state cannot be accessed.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVmPortHardwareSerial -Vm "MyVm" -Port "MyPort"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/hardware/serial/{port}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/serial/{port}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Hardware Serial Operations
patch
delete
