mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-04 06:21:15 +02:00
Update API documentation. Fixes #1253.
This commit is contained in:
grossmj committed
1 parent
e8353e68bb
commit
ffe21f6b73
324 files changed
+1168
-14199
No files matched your search
@@ -13,8 +13,8 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: Instance created
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
|
||||
Input
|
||||
*******
|
||||
@@ -26,7 +26,7 @@ Input
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -57,7 +57,7 @@ Output
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -78,12 +78,6 @@ Output
|
||||
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodes.txt
|
||||
|
||||
|
||||
GET /v2/projects/**{project_id}**/nodes
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@@ -97,9 +91,3 @@ Response status codes
|
||||
**********************
|
||||
- **200**: List of nodes returned
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodes.txt
|
||||
|
||||
@@ -23,7 +23,7 @@ Output
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -44,12 +44,6 @@ Output
|
||||
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeid.txt
|
||||
|
||||
|
||||
PUT /v2/projects/**{project_id}**/nodes/**{node_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@@ -71,7 +65,7 @@ Input
|
||||
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -102,7 +96,7 @@ Output
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -123,12 +117,6 @@ Output
|
||||
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_put_projectsprojectidnodesnodeid.txt
|
||||
|
||||
|
||||
DELETE /v2/projects/**{project_id}**/nodes/**{node_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@@ -136,18 +124,12 @@ Delete a node instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance deleted
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_delete_projectsprojectidnodesnodeid.txt
|
||||
- **204**: Instance deleted
|
||||
|
||||
@@ -9,18 +9,12 @@ Compute the IDLE PC for a Dynamips node
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance reloaded
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeiddynamipsautoidlepc.txt
|
||||
- **204**: Instance reloaded
|
||||
|
||||
@@ -9,18 +9,12 @@ Compute a list of potential idle PC for a node
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance reloaded
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeiddynamipsidlepcproposals.txt
|
||||
- **204**: Instance reloaded
|
||||
|
||||
@@ -9,14 +9,14 @@ Get a file in the node directory
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance reloaded
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
|
||||
POST /v2/projects/**{project_id}**/nodes/**{node_id}**/files/**{path:.+}**
|
||||
@@ -25,12 +25,12 @@ Write a file in the node directory
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance reloaded
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
@@ -9,14 +9,14 @@ Reload a node instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance reloaded
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
Output
|
||||
*******
|
||||
@@ -28,7 +28,7 @@ Output
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -49,9 +49,3 @@ Output
|
||||
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidreload.txt
|
||||
|
||||
@@ -9,14 +9,14 @@ Start a node instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance started
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance started
|
||||
|
||||
Output
|
||||
*******
|
||||
@@ -28,7 +28,7 @@ Output
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -49,9 +49,3 @@ Output
|
||||
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidstart.txt
|
||||
|
||||
@@ -9,14 +9,14 @@ Stop a node instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance stopped
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance stopped
|
||||
|
||||
Output
|
||||
*******
|
||||
@@ -28,7 +28,7 @@ Output
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -49,9 +49,3 @@ Output
|
||||
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidstop.txt
|
||||
|
||||
@@ -9,14 +9,14 @@ Suspend a node instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance suspended
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance suspended
|
||||
|
||||
Output
|
||||
*******
|
||||
@@ -28,7 +28,7 @@ Output
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -49,9 +49,3 @@ Output
|
||||
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidsuspend.txt
|
||||
|
||||
@@ -13,9 +13,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: All nodes successfully reloaded
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: All nodes successfully reloaded
|
||||
|
||||
Output
|
||||
*******
|
||||
@@ -27,7 +27,7 @@ Output
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -48,9 +48,3 @@ Output
|
||||
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesreload.txt
|
||||
|
||||
@@ -13,9 +13,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: All nodes successfully started
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: All nodes successfully started
|
||||
|
||||
Output
|
||||
*******
|
||||
@@ -27,7 +27,7 @@ Output
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -48,9 +48,3 @@ Output
|
||||
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesstart.txt
|
||||
|
||||
@@ -13,9 +13,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: All nodes successfully stopped
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: All nodes successfully stopped
|
||||
|
||||
Output
|
||||
*******
|
||||
@@ -27,7 +27,7 @@ Output
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -48,9 +48,3 @@ Output
|
||||
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesstop.txt
|
||||
|
||||
@@ -13,9 +13,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: All nodes successfully suspended
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: All nodes successfully suspended
|
||||
|
||||
Output
|
||||
*******
|
||||
@@ -27,7 +27,7 @@ Output
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Compute identifier</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||||
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, spice, null</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
|
||||
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
|
||||
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
|
||||
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
|
||||
@@ -48,9 +48,3 @@ Output
|
||||
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodessuspend.txt
|
||||
|
||||
Reference in new issue
Block a user