Files
56adc9bd85ecd5b1f401fd32cf63201b8db28cc7
nova /api-ref /source /servers-remote-consoles.inc
Stephen Finucane 02eb9cffe6 Remove 'nova-xvpvncproxy' 
This legacy service is no longer used and was deprecated during the
Stein cycle [1]. It's time to say adios and remove them in their
entirety. This is pretty straightforward, with the sole exception of
schema for the 'remote-consoles' API, which has to continue supporting
requests for type 'xvpvnc' even if we can't fulfil those requests now.
[1] https://review.opendev.org/#/c/610076/
Part of blueprint remove-xvpvncproxy
Depends-On: https://review.opendev.org/695853
Change-Id: I2f7f2379d0cd54e4d0a91008ddb44858cfc5a4cf
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019年12月23日 14:20:28 +00:00

99 lines
2.4 KiB
ReStructuredText

.. -*- rst -*-
=================
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