Disconnect Hardware Serial
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Disconnects a virtual serial port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the serial port is not connected to its backing. For a powered-off virtual machine, the Serial.update operation may be used to configure the virtual serial port to start in the disconnected state when the virtual machine is powered on.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/serial/{port}/disconnect
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. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/hardware/serial/{port}/disconnect
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | 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. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.already_in_desired_state : if the virtual serial port is already disconnected. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is not powered on. | 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. |
| default | ErrorRest | Not available |
| 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. |
On This Page
Hardware Serial Operations
patch
delete
