openstack/deb-nova
Code Issues Proposed changes

api-ref: Complete all the verifications of remote consoles

Browse Source 
This patch includes all the verifications of remote consoles

part of blueprint api-ref-in-rst-pike

Co-Authored-By: Markus Zoeller <mzoeller@linux.vnet.ibm.com>
Change-Id: Ib169e4bd931b5a04f31cd0e7c43c161b49eafe5c
This commit is contained in:
He Jie Xu 2016-07-06 14:35:08 +08:00
parent 427e0994db
commit 54af57f485
4 changed files with 204 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api-ref/source/index.rst
View File

@ -18,10 +18,11 @@ the `API guide <http://developer.openstack.org/api-guide/compute/index.html>`_.
.. include:: servers-action-evacuate.inc
.. include:: servers-action-deferred-delete.inc
.. include:: servers-action-console-output.inc
.. include:: servers-action-remote-consoles.inc
.. include:: servers-action-shelve.inc
.. include:: servers-action-crash-dump.inc
.. include:: servers-action-remote-consoles.inc
.. include:: servers-admin-action.inc
.. include:: servers-remote-consoles.inc
.. include:: server-security-groups.inc
.. include:: diagnostics.inc
.. include:: ips.inc

68
api-ref/source/parameters.yaml
View File

@ -3263,10 +3263,16 @@ os-getRDPConsole:
The action.
in: body
required: true
type: string
type: object
os-getRDPConsole-type:
description: |
The type of RDP console. The correct value is ``rdp-html5``.
The type of RDP console. The only valid value is ``rdp-html5``.
in: body
required: true
type: string
os-getRDPConsole-url:
description: |
The URL used to connect to the RDP console.
in: body
required: true
type: string
@ -3275,10 +3281,16 @@ os-getSerialConsole:
The action.
in: body
required: true
type: string
type: object
os-getSerialConsole-type:
description: |
The type of serial console. The correct value is ``serial``.
The type of serial console. The only valid value is ``serial``.
in: body
required: true
type: string
os-getSerialConsole-url:
description: |
The URL used to connect to the Serial console.
in: body
required: true
type: string
@ -3287,10 +3299,16 @@ os-getSPICEConsole:
The action.
in: body
required: true
type: string
type: object
os-getSPICEConsole-type:
description: |
The type of SPICE console. The correct value is ``spice-html5``.
The type of SPICE console. The only valid value is ``spice-html5``.
in: body
required: true
type: string
os-getSPICEConsole-url:
description: |
The URL used to connect to the SPICE console.
in: body
required: true
type: string
@ -3299,10 +3317,16 @@ os-getVNCConsole:
The action.
in: body
required: true
type: string
type: object
os-getVNCConsole-type:
description: |
The type of VNC console. The correct value is ``novnc``.
The type of VNC console. The valid values are ``novnc`` and ``xvpvnc``.
in: body
required: true
type: string
os-getVNCConsole-url:
description: |
The URL used to connect to the VNC console.
in: body
required: true
type: string
@ -3600,6 +3624,34 @@ rebuild:
in: body
required: true
type: string
remote_console:
description: |
The remote console object.
in: body
required: true
type: object
remote_console_protocol:
description: |
The protocol of remote console. The valid values are ``vnc``, ``spice``,
``rdp``, ``serial`` and ``mks``. The protocol ``mks`` is added since
Microversion ``2.8``.
in: body
required: true
type: string
remote_console_type:
description: |
The type of remote console. The valid values are ``novnc``, ``xvpvnc``,
``rdp-html5``, ``spice-html5``, ``serial``, and ``webmks``. The type
``webmks`` is added since Microversion ``2.8``.
in: body
required: true
type: string
remote_console_url:
description: |
The URL is used to connect the console.
in: body
required: true
type: string
removeFixedIp:
description: |
The action.

107
api-ref/source/servers-action-remote-consoles.inc
View File

@ -1,15 +1,22 @@
.. -*- rst -*-
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
Get Rdp Console (os-getRDPConsole Action)
=========================================
Get RDP Console (os-getRDPConsole Action) (DEPRECATED)
======================================================
.. 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::
This action is deprecated in microversion 2.5 and superseded
by the API `Server Remote Consoles`_ in microversion 2.6.
The new API offers a unified API for different console types.
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
@ -23,11 +30,11 @@ Request
.. rest_parameters:: parameters.yaml
- server_id: server_id
- server_id: server_id_path
- os-getRDPConsole: os-getRDPConsole
- type: os-getRDPConsole-type
**Example Get Rdp Console (os-getRDPConsole Action): JSON request**
**Example Get RDP Console (os-getRDPConsole Action)**
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-rdp-console-post-req.json
:language: javascript
@ -35,20 +42,36 @@ Request
Response
--------
**Example Get Rdp Console (os-getRDPConsole Action): JSON 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
Get Serial Console (os-getSerialConsole Action)
===============================================
Get Serial Console (os-getSerialConsole Action) (DEPRECATED)
============================================================
.. rest_method:: POST /servers/{server_id}/action
max_version: 2.5
Gets a serial console for a server.
.. warning::
This action is deprecated in microversion 2.5 and superseded
by the API `Server Remote Consoles`_ in microversion 2.6.
The new API offers a unified API for different console types.
Specify the ``os-getSerialConsole`` action in the request body.
The only supported connection type is ``serial``. The ``type`` parameter
should be set as ``serial``.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
@ -60,11 +83,11 @@ Request
.. rest_parameters:: parameters.yaml
- server_id: server_id
- server_id: server_id_path
- os-getSerialConsole: os-getSerialConsole
- type: os-getSerialConsole-type
**Example Get Serial Console (os-getSerialConsole Action): JSON request**
**Example Get Serial Console (os-getSerialConsole Action)**
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-serial-console-post-req.json
:language: javascript
@ -72,20 +95,36 @@ Request
Response
--------
**Example Get Serial Console (os-getSerialConsole Action): JSON response**
.. rest_parameters:: parameters.yaml
- console: remote_console
- type: os-getSerialConsole-type
- url: os-getSerialConsole-url
**Example Get Serial Console (os-getSerialConsole Action)**
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-serial-console-post-resp.json
:language: javascript
Get Spice Console (os-getSPICEConsole Action)
=============================================
Get SPICE Console (os-getSPICEConsole Action) (DEPRECATED)
==========================================================
.. rest_method:: POST /servers/{server_id}/action
max_version: 2.5
Gets a SPICE console for a server.
.. warning::
This action is deprecated in microversion 2.5 and superseded
by the API `Server Remote Consoles`_ in microversion 2.6.
The new API offers a unified API for different console types.
Specify the ``os-getSPICEConsole`` action in the request body.
The only supported connection type is ``spice-html5``. The ``type`` parameter
should be set to ``spice-html5``.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
@ -97,11 +136,11 @@ Request
.. rest_parameters:: parameters.yaml
- server_id: server_id
- server_id: server_id_path
- os-getSPICEConsole: os-getSPICEConsole
- type: os-getSPICEConsole-type
**Example Get Spice Console (os-getSPICEConsole Action): JSON request**
**Example Get Spice Console (os-getSPICEConsole Action)**
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-spice-console-post-req.json
:language: javascript
@ -109,20 +148,36 @@ Request
Response
--------
**Example Get Spice Console (os-getSPICEConsole Action): JSON response**
.. rest_parameters:: parameters.yaml
- console: remote_console
- type: os-getSPICEConsole-type
- url: os-getSPICEConsole-url
**Example Get SPICE Console (os-getSPICEConsole Action)**
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-spice-console-post-resp.json
:language: javascript
Get Vnc Console (os-getVNCConsole Action)
=========================================
Get VNC Console (os-getVNCConsole Action) (DEPRECATED)
======================================================
.. rest_method:: POST /servers/{server_id}/action
max_version: 2.5
Gets a VNC console for a server.
.. warning::
This action is deprecated in microversion 2.5 and superseded
by the API `Server Remote Consoles`_ in microversion 2.6.
The new API offers a unified API for different console types.
Specify the ``os-getVNCConsole`` action in the request body.
The supported connection types are ``novnc``, ``xvpvnc``. Such as connect
with ``novnc``, set ``type`` parameter to ``novnc``.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
@ -134,11 +189,11 @@ Request
.. rest_parameters:: parameters.yaml
- server_id: server_id
- server_id: server_id_path
- os-getVNCConsole: os-getVNCConsole
- type: os-getVNCConsole-type
**Example Get Vnc Console (os-getVNCConsole Action): JSON request**
**Example Get Vnc Console (os-getVNCConsole Action)**
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-vnc-console-post-req.json
:language: javascript
@ -146,7 +201,13 @@ Request
Response
--------
**Example Get Vnc Console (os-getVNCConsole Action): JSON response**
.. rest_parameters:: parameters.yaml
- console: remote_console
- type: os-getVNCConsole-type
- url: os-getVNCConsole-url
**Example Get VNC Console (os-getVNCConsole Action)**
.. literalinclude:: ../../doc/api_samples/os-remote-consoles/get-vnc-console-post-resp.json
:language: javascript

58
api-ref/source/servers-remote-consoles.inc Normal file
View File

@ -0,0 +1,58 @@
.. -*- rst -*-
======================
Server Remote Consoles
======================
Create server remote console.
Create Remote 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``. For the same
protocol, there may be different connection types such as ``vnc protocal and
novnc type`` or ``vnc protocol and xvpvnc type``.
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