0c1e1ccf03
RDP console was only for HyperV driver so removing the API. As API url stay same (because same used for other console types API), RDP console API will return 400. Cleaning up the related config options as well as moving its API ref to obsolete seciton. Keeping RPC method to avoid error when old controller is used with new compute. It can be removed in next RPC version bump. Change-Id: I8f5755009da4af0d12bda096d7a8e85fd41e1a8c
54 lines
1.3 KiB
ReStructuredText
54 lines
1.3 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Get RDP Console (os-getRDPConsole Action)
|
|
=========================================
|
|
|
|
.. rest_method:: POST /servers/{server_id}/action
|
|
max_version: 2.5
|
|
|
|
Gets an `RDP <https://technet.microsoft.com/en-us/windowsserver/ee236407>`__ console for a server.
|
|
|
|
.. warning::
|
|
|
|
Along with HyperV driver, this action was removed in Nova 29.0.0
|
|
(caracal) release.
|
|
|
|
The only supported connect type is ``rdp-html5``. The ``type`` parameter should
|
|
be set as ``rdp-html5``.
|
|
|
|
Specify the ``os-getRDPConsole`` action in the request body.
|
|
|
|
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
|
|
- os-getRDPConsole: os-getRDPConsole
|
|
- type: os-getRDPConsole-type
|
|
|
|
**Example Get RDP Console (os-getRDPConsole Action)**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-rdp-console-post-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- console: remote_console
|
|
- type: os-getRDPConsole-type
|
|
- url: os-getRDPConsole-url
|
|
|
|
**Example Get RDP Console (os-getRDPConsole Action)**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-rdp-console-post-resp.json
|
|
:language: javascript
|