Create Hardware Serial
Adds a virtual serial port to the virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/serial
Parameters
Parameters
string
vm
Required
Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine.
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
Request Body
Request Body
VmHardwareSerialCreateRequestBody of type application/json (required){
"spec": {
"allow_guest_control": false,
"backing": {
"file": "string",
"host_device": "string",
"network_location": "string",
"no_rx_loss": false,
"pipe": "string",
"proxy": "string",
"type": "enum"
},
"start_connected": false,
"yield_on_poll": false
}
}
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareSerialCreateResponseBody
of type application/json
Virtual serial port identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.
{
"value": "string"
}
string
value
Optional
Virtual serial port identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"allow_guest_control":false,"backing":{"file":"string","host_device":"string","network_location":"string","no_rx_loss":false,"pipe":"string","proxy":"string","type":"enum"},"start_connected":false,"yield_on_poll":false}}' https://{api_host}/rest/vcenter/vm/{vm}/hardware/serial
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is not powered off.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
500
com.vmware.vapi.std.errors.error : if the system reported that the serial port device was created but was unable to confirm the creation because the identifier of the new device could not be determined.
if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.unable_to_allocate_resource : if the virtual machine already has the maximum number of supported serial ports. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. | 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.
On This Page
Hardware Serial Operations
patch
delete
