mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Rebuild documentation
This commit is contained in:
174 files changed
+1069
-5167
No files matched your search
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the switch (always 0)
|
||||
- **port_number**: Port on the switch
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the switch
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the switch (always 0)
|
||||
- **port_number**: Port on the switch
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the switch
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -29,8 +29,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the switch (always 0)
|
||||
- **port_number**: Port on the switch
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the switch
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the switch (always 0)
|
||||
- **port_number**: Port on the switch
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the switch
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -42,7 +42,7 @@ Body
|
||||
<tr><td>interfaces</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Cloud name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td></td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
@@ -54,7 +54,7 @@ Output
|
||||
<tr><td>interfaces</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Cloud name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -27,7 +27,7 @@ Output
|
||||
<tr><td>interfaces</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Cloud name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
@@ -80,7 +80,7 @@ Body
|
||||
<tr><td>interfaces</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Cloud name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
@@ -94,7 +94,7 @@ Output
|
||||
<tr><td>interfaces</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Cloud name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the cloud (always 0)
|
||||
- **port_number**: Port on the cloud
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the cloud
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -35,8 +35,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the cloud (always 0)
|
||||
- **port_number**: Port on the cloud
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the cloud
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the cloud (always 0)
|
||||
- **port_number**: Port on the cloud
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the cloud
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the cloud (always 0)
|
||||
- **port_number**: Port on the cloud
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the cloud
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter where the nio should be added
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -35,8 +35,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter where the nio should be added
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter where the nio should be added
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -29,8 +29,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter from where the nio should be removed
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -41,7 +41,7 @@ Body
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Ethernet hub name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td></td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
@@ -52,7 +52,7 @@ Output
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Ethernet hub name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -26,7 +26,7 @@ Output
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Ethernet hub name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
@@ -72,7 +72,7 @@ Body
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Ethernet hub name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
@@ -85,7 +85,7 @@ Output
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Ethernet hub name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the hub (always 0)
|
||||
- **port_number**: Port on the hub
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the hub
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -29,8 +29,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the hub (always 0)
|
||||
- **port_number**: Port on the hub
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the hub
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the hub (always 0)
|
||||
- **port_number**: Port on the hub
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the hub
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the hub (always 0)
|
||||
- **port_number**: Port on the hub
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the hub
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -44,7 +44,7 @@ Body
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Ethernet switch name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td></td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
@@ -55,7 +55,7 @@ Output
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Ethernet switch name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -26,7 +26,7 @@ Output
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Ethernet switch name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
@@ -75,7 +75,7 @@ Body
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Ethernet switch name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
@@ -88,7 +88,7 @@ Output
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Ethernet switch name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the switch (always 0)
|
||||
- **port_number**: Port on the switch
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the switch
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -29,8 +29,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the switch (always 0)
|
||||
- **port_number**: Port on the switch
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the switch
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the switch (always 0)
|
||||
- **port_number**: Port on the switch
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the switch
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the switch (always 0)
|
||||
- **port_number**: Port on the switch
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the switch
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the switch (always 0)
|
||||
- **port_number**: Port on the switch
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the switch
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -29,8 +29,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the switch (always 0)
|
||||
- **port_number**: Port on the switch
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the switch
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the switch (always 0)
|
||||
- **port_number**: Port on the switch
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the switch
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the switch (always 0)
|
||||
- **port_number**: Port on the switch
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the switch
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **port_number**: Port where the nio should be added
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port where the nio should be added
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -35,8 +35,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **port_number**: Port from where the nio should be removed
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port from where the nio should be removed
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -25,7 +25,7 @@ Input
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Nat name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
@@ -38,7 +38,7 @@ Output
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Nat name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -26,7 +26,7 @@ Output
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Nat name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
@@ -62,7 +62,7 @@ Input
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Nat name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
@@ -75,7 +75,7 @@ Output
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Nat name</td> </tr>
|
||||
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
||||
<tr><td>ports</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
||||
</table>
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the nat (always 0)
|
||||
- **port_number**: Port on the nat
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the nat
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -35,8 +35,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the nat (always 0)
|
||||
- **port_number**: Port on the nat
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the nat
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the nat (always 0)
|
||||
- **port_number**: Port on the nat
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the nat
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter on the nat (always 0)
|
||||
- **port_number**: Port on the nat
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the nat
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -35,8 +35,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter where the nio should be added
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -35,8 +35,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter from where the nio should be removed
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter where the nio should be added
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -29,8 +29,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter from where the nio should be removed
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+2
-2
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **port_number**: Port where the nio should be added
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port where the nio should be added
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -35,8 +35,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **port_number**: Port from where the nio should be removed
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port from where the nio should be removed
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -11,8 +11,8 @@ Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: Project UUID
|
||||
- **port_number**: Port on the adapter
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
/v2/compute/projects/{project_id}/vpcs/nodes/{node_id}/suspend
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vpcs/nodes/**{node_id}**/suspend
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Suspend a VPCS instance (stop it)
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance stopped
|
||||
|
||||
Reference in new issue
Block a user