summaryrefslogtreecommitdiff
path: root/api-ref/source/os-consoles.inc
diff options
context:
space:
mode:
authorSean Dague <sean@dague.net>2016-04-12 09:03:46 -0400
committerSean Dague <sean@dague.net>2016-04-13 07:34:45 -0400
commitd4e27714405e064ba8f62070e8c48d7fa71b6996 (patch)
treebd8b560fdc3864ea1c121b069926cd6b1d569556 /api-ref/source/os-consoles.inc
parentf1fa7eb15a8b4a081d8d8afd3e6d80302c20e39e (diff)
downloadnova-d4e27714405e064ba8f62070e8c48d7fa71b6996.tar.gz
Import RST files for documentation
This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
Diffstat (limited to 'api-ref/source/os-consoles.inc')
-rw-r--r--api-ref/source/os-consoles.inc142
1 files changed, 142 insertions, 0 deletions
diff --git a/api-ref/source/os-consoles.inc b/api-ref/source/os-consoles.inc
new file mode 100644
index 0000000000..6d4a640976
--- /dev/null
+++ b/api-ref/source/os-consoles.inc
@@ -0,0 +1,142 @@
+.. -*- rst -*-
+
+===============================================================
+ Server consoles (servers, os-consoles, os-console-auth-token)
+===============================================================
+
+Manages server consoles.
+
+Create Console
+==============
+
+.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/consoles
+
+Creates a console for a server instance.
+
+Normal response codes: 200
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+ - server_id: server_id
+
+Response
+^^^^^^^^
+
+Lists Consoles
+==============
+
+.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/consoles
+
+Lists all consoles for a server instance.
+
+Normal response codes: 200
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+ - server_id: server_id
+
+Response
+^^^^^^^^
+
+**Example List consoles: JSON response**
+
+.. literalinclude:: ../../doc/api_samples/os-consoles/consoles-list-resp.json
+ :language: javascript
+
+Show Console Details
+====================
+
+.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/consoles/{console_id}
+
+Shows details for a console for a server instance.
+
+Normal response codes: 200
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+ - server_id: server_id
+ - console_id: console_id
+
+Response
+^^^^^^^^
+
+**Example List consoles: JSON response**
+
+.. literalinclude:: ../../doc/api_samples/os-consoles/consoles-list-resp.json
+ :language: javascript
+
+Delete Console
+==============
+
+.. rest_method:: DELETE /v2.1/{tenant_id}/servers/{server_id}/consoles/{console_id}
+
+Deletes a console for a server instance.
+
+Normal response codes: 202
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+ - server_id: server_id
+ - console_id: console_id
+
+Response
+^^^^^^^^
+
+Show Console Authentication Token
+=================================
+
+.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-console-auth-token
+
+Shows the authentication token for a console for a server instance.
+
+This feature is available for ``rdp-html5`` console type only.
+
+Normal response codes: 200
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+ - server_id: server_id
+
+Response
+^^^^^^^^
+
+**Example List consoles: JSON response**
+
+.. literalinclude:: ../../doc/api_samples/os-consoles/console-auth-show-resp.json
+ :language: javascript
+