summaryrefslogtreecommitdiff
path: root/api-ref/source/servers-action-remote-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/servers-action-remote-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/servers-action-remote-consoles.inc')
-rw-r--r--api-ref/source/servers-action-remote-consoles.inc146
1 files changed, 146 insertions, 0 deletions
diff --git a/api-ref/source/servers-action-remote-consoles.inc b/api-ref/source/servers-action-remote-consoles.inc
new file mode 100644
index 0000000000..42eb763ef7
--- /dev/null
+++ b/api-ref/source/servers-action-remote-consoles.inc
@@ -0,0 +1,146 @@
+.. -*- rst -*-
+
+Get Rdp Console (Os-Getrdpconsole Action)
+=========================================
+
+.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
+
+Gets an `RDP <https://technet.microsoft.com/en-us/windowsserver/ee236407>`__ console for a server.
+
+Specify the ``os-getRDPConsole`` action in the request body.
+
+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
+ - os-getRDPConsole: os-getRDPConsole
+
+**Example Get Rdp Console (Os-Getrdpconsole Action): JSON request**
+
+.. literalinclude:: ../../doc/api_samples/servers-action/getRDPConsole-create-req.json
+ :language: javascript
+
+Response
+^^^^^^^^
+
+**Example Get Rdp Console (Os-Getrdpconsole Action): JSON request**
+
+.. literalinclude:: ../../doc/api_samples/servers-action/getRDPConsole-create-resp.json
+ :language: javascript
+
+Get Serial Console (Os-Getserialconsole Action)
+===============================================
+
+.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
+
+Gets a serial console for a server.
+
+Specify the ``os-getSerialConsole`` action in the request body.
+
+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
+ - os-getSerialConsole: os-getSerialConsole
+
+**Example Get Serial Console (Os-Getserialconsole Action): JSON request**
+
+.. literalinclude:: ../../doc/api_samples/servers-action/getSerialConsole-create-req.json
+ :language: javascript
+
+Response
+^^^^^^^^
+
+**Example Get Serial Console (Os-Getserialconsole Action): JSON request**
+
+.. literalinclude:: ../../doc/api_samples/servers-action/getSerialConsole-create-resp.json
+ :language: javascript
+
+Get Spice Console (Os-Getspiceconsole Action)
+=============================================
+
+.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
+
+Gets a SPICE console for a server.
+
+Specify the ``os-getSPICEConsole`` action in the request body.
+
+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
+ - os-getSPICEConsole: os-getSPICEConsole
+
+**Example Get Spice Console (Os-Getspiceconsole Action): JSON request**
+
+.. literalinclude:: ../../doc/api_samples/servers-action/getSPICEConsole-create-req.json
+ :language: javascript
+
+Response
+^^^^^^^^
+
+**Example Get Spice Console (Os-Getspiceconsole Action): JSON request**
+
+.. literalinclude:: ../../doc/api_samples/servers-action/getSPICEConsole-create-resp.json
+ :language: javascript
+
+Get Vnc Console (Os-Getvncconsole Action)
+=========================================
+
+.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
+
+Gets a VNC console for a server.
+
+Specify the ``os-getVNCConsole`` action in the request body.
+
+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
+ - os-getVNCConsole: os-getVNCConsole
+
+**Example Get Vnc Console (Os-Getvncconsole Action): JSON request**
+
+.. literalinclude:: ../../doc/api_samples/servers-action/getVNCConsole-create-req.json
+ :language: javascript
+
+Response
+^^^^^^^^
+
+**Example Get Vnc Console (Os-Getvncconsole Action): JSON request**
+
+.. literalinclude:: ../../doc/api_samples/servers-action/getVNCConsole-create-resp.json
+ :language: javascript
+