Developer Documentation
Get Hardware Serial
Returns information about a virtual serial port.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/serial/{port}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. |
| required |
|
string | Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort. |
Response
Response
Response BodyResponse Body
200 OK returns
GetResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: Information about the specified virtual serial port.
{
"value": {
"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
}
}| Property Name | Type | Description |
|---|---|---|
| value | SerialInfo |
Information about the specified virtual serial port. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges. |
| 404 | Error | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the virtual machine or virtual serial port is not found. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration state cannot be accessed. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | Error | Not available |
On This Page
Hardware Serial Operations
patch
delete
