Get Hardware Serial
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Returns information about a virtual serial port.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/serial/{port}
Parameters
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, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareSerialGetResponseBody
of type application/json
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
}
}cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/hardware/serial/{port}
Errors
401
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
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
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
Hardware Serial Operations
patch
delete
