Create Hardware Serial
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Adds a virtual serial port to the virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/serial
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. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains 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
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | VmHardwareSerialCreateSpec |
Specification for the new virtual serial port. |
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"
}| Property Name | Type | Description |
|---|---|---|
| value | string |
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
| Code | Returns | Description |
|---|---|---|
| 401 | ErrorRest | 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 | ErrorRest | 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.not_found : if the virtual machine is not found. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration state cannot be accessed. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is not powered off. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. |
| 503 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| 507 | ErrorRest | com.vmware.vapi.std.errors.unable_to_allocate_resource : if the virtual machine already has the maximum number of supported serial ports. |
| default | ErrorRest | Not available |
On This Page
Hardware Serial Operations
patch
delete
