vcenter vm hardware serial: connect
Connects a virtual serial port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system.
For a powered-off virtual machine, the update operation may be used to configure the virtual serial port to start in the connected state when the virtual machine is powered on.
Request:
HTTP request
POST https://{server}/rest/vcenter/vm/{vm}/hardware/serial/{port}/connect
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| vm | string | Virtual machine identifier. |
| port | string | Virtual serial port identifier. |
Response:
HTTP Status Code: 200
NoneErrors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | if the system reports an error while responding to the request. |
| 404 | not_found | if the virtual machine or virtual serial port is not found. |
| 400 | already_in_desired_state | if the virtual serial port is already connected. |
| 400 | not_allowed_in_current_state | if the virtual machine is not powered on. |
| 500 | resource_busy | if the virtual machine is busy performing another operation. |
| 500 | resource_inaccessible | if the virtual machine's configuration state cannot be accessed. |
| 503 | service_unavailable | if the system is unable to communicate with a service to complete the request. |
| 401 | unauthenticated | if the user can not be authenticated. |
| 403 | unauthorized | if the user doesn't have the required privileges. |