NgTech-LTD/gns3-server
2
0 Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-11-03 05:51:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update api documentations

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-10-20 10:54:07 +02:00
1 parent dc363bbd38
commit 69fcf801c3
198 files changed
+1263 -1248
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/drawing/projectsprojectiddrawingsdrawingid.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Create a new drawing instance
Parameters
**********
- **project_id**: Project UUID
- **drawing_id**: Drawing UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -60,8 +60,8 @@ Delete a drawing instance
Parameters
**********
- **project_id**: Project UUID
- **drawing_id**: Drawing UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Update a link instance
Parameters
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -54,8 +54,8 @@ Delete a link instance
Parameters
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start capture on a link instance. By default we consider it as an Ethernet link
Parameters
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop capture on a link instance
Parameters
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodes.rst
+6 -6
View File
@@ -25,8 +25,8 @@ Input
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -40,7 +40,7 @@ Input
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
@@ -56,8 +56,8 @@ Output
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -71,7 +71,7 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
+9 -9
View File
@@ -22,8 +22,8 @@ Output
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -37,7 +37,7 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
@@ -70,8 +70,8 @@ Input
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -85,7 +85,7 @@ Input
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
@@ -101,8 +101,8 @@ Output
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -116,7 +116,7 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
+3 -3
View File
@@ -27,8 +27,8 @@ Output
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -42,7 +42,7 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
+3 -3
View File
@@ -27,8 +27,8 @@ Output
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -42,7 +42,7 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
+3 -3
View File
@@ -27,8 +27,8 @@ Output
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -42,7 +42,7 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
+3 -3
View File
@@ -27,8 +27,8 @@ Output
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -42,7 +42,7 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
docs/api/v2/controller/node/projectsprojectidnodesreload.rst
+3 -3
View File
@@ -26,8 +26,8 @@ Output
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -41,7 +41,7 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
docs/api/v2/controller/node/projectsprojectidnodesstart.rst
+3 -3
View File
@@ -26,8 +26,8 @@ Output
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -41,7 +41,7 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
docs/api/v2/controller/node/projectsprojectidnodesstop.rst
+3 -3
View File
@@ -26,8 +26,8 @@ Output
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -41,7 +41,7 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
+3 -3
View File
@@ -26,8 +26,8 @@ Output
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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: serial, vnc, telnet, http, 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>
@@ -41,7 +41,7 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>symbol</td> <td> </td> <td>['string', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotid.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Delete a snapshot from disk
Parameters
**********
- **project_id**: Project UUID
- **snapshot_id**: Snasphot UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotidrestore.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Restore a snapshot from disk
Parameters
**********
- **project_id**: Project UUID
- **snapshot_id**: Snasphot UUID
- **project_id**: Project UUID
Response status codes
**********************