Skip to content

Latest commit

 

History

History
98 lines (63 loc) · 2.42 KB

servers-remote-consoles.inc

File metadata and controls

98 lines (63 loc) · 2.42 KB

Server Consoles

Manage server consoles.

Create Console

.. rest_method:: POST /servers/{server_id}/remote-consoles

Note

Microversion 2.6 or greater is required for this API.

The API provides a unified request for creating a remote console. The user can get a URL to connect the console from this API. The URL includes the token which is used to get permission to access the console. Servers may support different console protocols. To return a remote console using a specific protocol, such as RDP, set the protocol parameter to rdp.

Normal response codes: 200

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409), notImplemented(501)

Request

.. rest_parameters:: parameters.yaml


   - server_id: server_id_path
   - remote_console: remote_console
   - protocol: remote_console_protocol
   - type: remote_console_type

Example Get Remote VNC Console

.. literalinclude:: ../../doc/api_samples/os-remote-consoles/v2.6/create-vnc-console-req.json
   :language: javascript

Response

.. rest_parameters:: parameters.yaml

    - remote_console: remote_console
    - protocol: remote_console_protocol
    - type: remote_console_type
    - url: remote_console_url

Example Get Remote VNC Console

.. literalinclude:: ../../doc/api_samples/os-remote-consoles/v2.6/create-vnc-console-resp.json
   :language: javascript

Show Console Connection Information

.. rest_method:: GET /os-console-auth-tokens/{console_token}

Given the console authentication token for a server, shows the related connection information.

This method used to be available only for the rdp-html5 console type before microversion 2.31. Starting from microversion 2.31 it's available for all console types.

Normal response codes: 200

Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)

Request

.. rest_parameters:: parameters.yaml

  - console_token: console_token

Response

.. rest_parameters:: parameters.yaml

  - console: console
  - instance_uuid: instance_id_body
  - host: console_host
  - port: port_number
  - internal_access_path: internal_access_path

Example Show Console Authentication Token

.. literalinclude:: ../../doc/api_samples/os-console-auth-tokens/get-console-connect-info-get-resp.json
   :language: javascript