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

Update API documentation for appliance endpoints. Ref https://github.com/GNS3/gns3-gui/issues/2630

Browse Source
This commit is contained in:
grossmj committed 2018-11-20 13:04:27 +07:00
1 parent e5950674f8
commit ff5ba3742e
343 files changed
+12431 -11199
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/atm_switch/projectsprojectidatmrelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+2 -2
View File
@@ -9,14 +9,14 @@ Stop a packet capture on an ATM switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeid.rst
+1 -1
View File
@@ -86,7 +86,7 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+4 -4
View File
@@ -9,15 +9,15 @@ Add a NIO to an ATM switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
@@ -27,14 +27,14 @@ Remove a NIO from an ATM switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,9 +9,9 @@ Start a packet capture on an ATM switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidstart.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidstop.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidsuspend.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
docs/api/v2/compute/cloud/projectsprojectidcloudnodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeid.rst
+1 -1
View File
@@ -133,9 +133,9 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+7 -7
View File
@@ -9,15 +9,15 @@ Add a NIO to a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -29,19 +29,19 @@ Sample session
PUT /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a NIO from a Cloud instance
Update a NIO on a Cloud instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be updated
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO updated
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -57,16 +57,16 @@ Remove a NIO from a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+7 -1
View File
@@ -9,9 +9,9 @@ Start a packet capture on a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
Response status codes
@@ -30,3 +30,9 @@ Input
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC, DLT_PPP_SERIAL</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+8 -2
View File
@@ -9,14 +9,20 @@ Stop a packet capture on a cloud instance
Parameters
**********
- **adapter_number**: Adapter on the cloud (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidstart.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidstop.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidsuspend.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
docs/api/v2/compute/docker/projectsprojectiddockernodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeid.rst
+1 -1
View File
@@ -14,9 +14,9 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
PUT /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+9 -9
View File
@@ -9,15 +9,15 @@ Add a NIO to a Docker container
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -29,19 +29,19 @@ Sample session
PUT /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a NIO from a Docker instance
Update a NIO on a Docker instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port from where the nio should be updated
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be updated (always 0)
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO updated
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -57,16 +57,16 @@ Remove a NIO from a Docker container
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Start a packet capture on a Docker container instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+2 -2
View File
@@ -9,16 +9,16 @@ Stop a packet capture on a Docker container instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
- **409**: Container not started
Sample session
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidpause.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance paused
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance paused
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidreload.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance restarted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance restarted
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstart.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstop.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidsuspend.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidunpause.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance unpaused
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance unpaused
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeid.rst
+1 -1
View File
@@ -193,7 +193,7 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+7 -7
View File
@@ -9,33 +9,33 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
PUT /v2/compute/projects/**{project_id}**/dynamips/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a NIO from a Dynamips instance
Update a NIO on a Dynamips instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be updated
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO updated
- **400**: Invalid request
- **404**: Instance doesn't exist
@@ -45,14 +45,14 @@ Remove a NIO from a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,9 +9,9 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
Response status codes
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+2 -2
View File
@@ -9,14 +9,14 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidreload.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidresume.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance resumed
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance resumed
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstart.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstop.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidsuspend.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeid.rst
+1 -1
View File
@@ -102,7 +102,7 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+4 -4
View File
@@ -9,15 +9,15 @@ Add a NIO to an Ethernet hub instance
Parameters
**********
- **adapter_number**: Adapter on the hub (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
@@ -27,14 +27,14 @@ Remove a NIO from an Ethernet hub instance
Parameters
**********
- **adapter_number**: Adapter on the hub (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,9 +9,9 @@ Start a packet capture on an Ethernet hub instance
Parameters
**********
- **adapter_number**: Adapter on the hub (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
Response status codes
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+2 -2
View File
@@ -9,14 +9,14 @@ Stop a packet capture on an Ethernet hub instance
Parameters
**********
- **adapter_number**: Adapter on the hub (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidstart.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidstop.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidsuspend.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeid.rst
+1 -1
View File
@@ -111,7 +111,7 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+4 -4
View File
@@ -9,15 +9,15 @@ Add a NIO to an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
@@ -27,14 +27,14 @@ Remove a NIO from an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,9 +9,9 @@ Start a packet capture on an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+2 -2
View File
@@ -9,14 +9,14 @@ Stop a packet capture on an Ethernet switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidstart.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidstop.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidsuspend.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeid.rst
+1 -1
View File
@@ -86,7 +86,7 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+4 -4
View File
@@ -9,15 +9,15 @@ Add a NIO to a Frame Relay switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
@@ -27,14 +27,14 @@ Remove a NIO from a Frame Relay switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,9 +9,9 @@ Start a packet capture on a Frame Relay switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+2 -2
View File
@@ -9,14 +9,14 @@ Stop a packet capture on a Frame Relay switch instance
Parameters
**********
- **adapter_number**: Adapter on the switch (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidstart.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidstop.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidsuspend.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
docs/api/v2/compute/iou/projectsprojectidiounodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
docs/api/v2/compute/iou/projectsprojectidiounodesnodeid.rst
+1 -1
View File
@@ -134,9 +134,9 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+7 -7
View File
@@ -9,15 +9,15 @@ Add a NIO to a IOU instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -29,19 +29,19 @@ Sample session
PUT /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a NIO from a IOU instance
Update a NIO on an IOU instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO updated
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -57,16 +57,16 @@ Remove a NIO from a IOU instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,9 +9,9 @@ Start a packet capture on an IOU VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
Response status codes
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+2 -2
View File
@@ -9,16 +9,16 @@ Stop a packet capture on an IOU VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
- **409**: VM not started
Sample session
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidreload.rst
+1 -1
View File
@@ -14,9 +14,9 @@ Parameters
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Sample session
***************
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidstart.rst
+1
View File
@@ -25,6 +25,7 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>iourc_content</td> <td> </td> <td>['string', 'null']</td> <td>Content of the iourc file. Ignored if Null</td> </tr>
<tr><td>license_check</td> <td> </td> <td>boolean</td> <td>Whether the license should be checked</td> </tr>
</table>
Output
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidstop.rst
+1 -1
View File
@@ -14,9 +14,9 @@ Parameters
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
Sample session
***************
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidsuspend.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
docs/api/v2/compute/nat/projectsprojectidnatnodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeid.rst
+1 -1
View File
@@ -98,9 +98,9 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+7 -7
View File
@@ -9,15 +9,15 @@ Add a NIO to a nat instance
Parameters
**********
- **adapter_number**: Adapter on the nat (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -29,19 +29,19 @@ Sample session
PUT /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a NIO from a NAT instance
Update a NIO on a NAT instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be updated
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO updated
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -57,16 +57,16 @@ Remove a NIO from a nat instance
Parameters
**********
- **adapter_number**: Adapter on the nat (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+7 -1
View File
@@ -9,9 +9,9 @@ Start a packet capture on a nat instance
Parameters
**********
- **adapter_number**: Adapter on the nat (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
Response status codes
@@ -30,3 +30,9 @@ Input
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC, DLT_PPP_SERIAL</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+8 -2
View File
@@ -9,14 +9,20 @@ Stop a packet capture on a nat instance
Parameters
**********
- **adapter_number**: Adapter on the nat (always 0)
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidstart.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidstop.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidsuspend.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
docs/api/v2/compute/project/projectsprojectid.rst
+1 -1
View File
@@ -124,8 +124,8 @@ Parameters
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: Changes have been written on disk
- **404**: The project doesn't exist
Sample session
***************
docs/api/v2/compute/project/projectsprojectidclose.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: Project closed
- **404**: The project doesn't exist
Sample session
***************
docs/api/v2/compute/qemu/projectsprojectidqemunodes.rst
+5 -5
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -27,7 +27,7 @@ Input
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>Number of adapters</td> </tr>
<tr><td>bios_image</td> <td> </td> <td>string</td> <td>QEMU bios image path</td> </tr>
<tr><td>bios_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU bios image checksum</td> </tr>
<tr><td>boot_priority</td> <td> </td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
<tr><td>boot_priority</td> <td> </td> <td>enum</td> <td>Possible values: c, d, n, cn, cd, dn, dc, nc, nd</td> </tr>
<tr><td>cdrom_image</td> <td> </td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
<tr><td>cdrom_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
@@ -59,7 +59,7 @@ Input
<tr><td>node_id</td> <td> </td> <td></td> <td>Node UUID</td> </tr>
<tr><td>on_close</td> <td> </td> <td>enum</td> <td>Possible values: power_off, shutdown_signal, save_vm_state</td> </tr>
<tr><td>options</td> <td> </td> <td>['string', 'null']</td> <td>Additional QEMU options</td> </tr>
<tr><td>platform</td> <td> </td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null</td> </tr>
<tr><td>platform</td> <td> </td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null, null</td> </tr>
<tr><td>process_priority</td> <td> </td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low, null</td> </tr>
<tr><td>qemu_path</td> <td> </td> <td>['string', 'null']</td> <td>Path to QEMU</td> </tr>
<tr><td>ram</td> <td> </td> <td>['integer', 'null']</td> <td>Amount of RAM in MB</td> </tr>
@@ -76,7 +76,7 @@ Output
<tr><td>adapters</td> <td>&#10004;</td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>bios_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU bios image path</td> </tr>
<tr><td>bios_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU bios image checksum</td> </tr>
<tr><td>boot_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
<tr><td>boot_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd, dn, dc, nc, nd</td> </tr>
<tr><td>cdrom_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
<tr><td>cdrom_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
<tr><td>command_line</td> <td>&#10004;</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
@@ -108,7 +108,7 @@ Output
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>on_close</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: power_off, shutdown_signal, save_vm_state</td> </tr>
<tr><td>options</td> <td>&#10004;</td> <td>string</td> <td>Additional QEMU options</td> </tr>
<tr><td>platform</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb</td> </tr>
<tr><td>platform</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null</td> </tr>
<tr><td>process_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>qemu_path</td> <td>&#10004;</td> <td>string</td> <td>Path to QEMU</td> </tr>
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeid.rst
+7 -7
View File
@@ -28,7 +28,7 @@ Output
<tr><td>adapters</td> <td>&#10004;</td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>bios_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU bios image path</td> </tr>
<tr><td>bios_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU bios image checksum</td> </tr>
<tr><td>boot_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
<tr><td>boot_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd, dn, dc, nc, nd</td> </tr>
<tr><td>cdrom_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
<tr><td>cdrom_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
<tr><td>command_line</td> <td>&#10004;</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
@@ -60,7 +60,7 @@ Output
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>on_close</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: power_off, shutdown_signal, save_vm_state</td> </tr>
<tr><td>options</td> <td>&#10004;</td> <td>string</td> <td>Additional QEMU options</td> </tr>
<tr><td>platform</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb</td> </tr>
<tr><td>platform</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null</td> </tr>
<tr><td>process_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>qemu_path</td> <td>&#10004;</td> <td>string</td> <td>Path to QEMU</td> </tr>
@@ -103,7 +103,7 @@ Input
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>Number of adapters</td> </tr>
<tr><td>bios_image</td> <td> </td> <td>string</td> <td>QEMU bios image path</td> </tr>
<tr><td>bios_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU bios image checksum</td> </tr>
<tr><td>boot_priority</td> <td> </td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
<tr><td>boot_priority</td> <td> </td> <td>enum</td> <td>Possible values: c, d, n, cn, cd, dn, dc, nc, nd</td> </tr>
<tr><td>cdrom_image</td> <td> </td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
<tr><td>cdrom_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
@@ -134,7 +134,7 @@ Input
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>QEMU VM instance name</td> </tr>
<tr><td>on_close</td> <td> </td> <td>enum</td> <td>Possible values: power_off, shutdown_signal, save_vm_state</td> </tr>
<tr><td>options</td> <td> </td> <td>['string', 'null']</td> <td>Additional QEMU options</td> </tr>
<tr><td>platform</td> <td> </td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null</td> </tr>
<tr><td>platform</td> <td> </td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null, null</td> </tr>
<tr><td>process_priority</td> <td> </td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low, null</td> </tr>
<tr><td>qemu_path</td> <td> </td> <td>['string', 'null']</td> <td>Path to QEMU</td> </tr>
<tr><td>ram</td> <td> </td> <td>['integer', 'null']</td> <td>Amount of RAM in MB</td> </tr>
@@ -151,7 +151,7 @@ Output
<tr><td>adapters</td> <td>&#10004;</td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>bios_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU bios image path</td> </tr>
<tr><td>bios_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU bios image checksum</td> </tr>
<tr><td>boot_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
<tr><td>boot_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd, dn, dc, nc, nd</td> </tr>
<tr><td>cdrom_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
<tr><td>cdrom_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
<tr><td>command_line</td> <td>&#10004;</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
@@ -183,7 +183,7 @@ Output
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>on_close</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: power_off, shutdown_signal, save_vm_state</td> </tr>
<tr><td>options</td> <td>&#10004;</td> <td>string</td> <td>Additional QEMU options</td> </tr>
<tr><td>platform</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb</td> </tr>
<tr><td>platform</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null</td> </tr>
<tr><td>process_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>qemu_path</td> <td>&#10004;</td> <td>string</td> <td>Path to QEMU</td> </tr>
@@ -211,9 +211,9 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+7 -7
View File
@@ -9,15 +9,15 @@ Add a NIO to a Qemu VM instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -29,19 +29,19 @@ Sample session
PUT /v2/compute/projects/**{project_id}**/qemu/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a NIO from a Qemu instance
Update a NIO on a Qemu instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be updated
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO updated
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -57,16 +57,16 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+7 -1
View File
@@ -9,9 +9,9 @@ Start a packet capture on a Qemu VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
@@ -30,3 +30,9 @@ Input
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC, DLT_PPP_SERIAL</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+8 -2
View File
@@ -9,14 +9,20 @@ Stop a packet capture on a Qemu VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidreload.rst
+1 -1
View File
@@ -14,9 +14,9 @@ Parameters
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Sample session
***************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidresume.rst
+1 -1
View File
@@ -14,9 +14,9 @@ Parameters
Response status codes
**********************
- **204**: Instance resumed
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance resumed
Sample session
***************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstart.rst
+2 -2
View File
@@ -28,7 +28,7 @@ Output
<tr><td>adapters</td> <td>&#10004;</td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>bios_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU bios image path</td> </tr>
<tr><td>bios_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU bios image checksum</td> </tr>
<tr><td>boot_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
<tr><td>boot_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd, dn, dc, nc, nd</td> </tr>
<tr><td>cdrom_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
<tr><td>cdrom_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
<tr><td>command_line</td> <td>&#10004;</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
@@ -60,7 +60,7 @@ Output
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>on_close</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: power_off, shutdown_signal, save_vm_state</td> </tr>
<tr><td>options</td> <td>&#10004;</td> <td>string</td> <td>Additional QEMU options</td> </tr>
<tr><td>platform</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb</td> </tr>
<tr><td>platform</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null</td> </tr>
<tr><td>process_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>qemu_path</td> <td>&#10004;</td> <td>string</td> <td>Path to QEMU</td> </tr>
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstop.rst
+1 -1
View File
@@ -14,9 +14,9 @@ Parameters
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
Sample session
***************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidsuspend.rst
+1 -1
View File
@@ -14,9 +14,9 @@ Parameters
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
Sample session
***************
docs/api/v2/compute/traceng/projectsprojectidtracengnodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeid.rst
+1 -1
View File
@@ -108,9 +108,9 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+7 -7
View File
@@ -9,15 +9,15 @@ Add a NIO to a TraceNG instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -29,19 +29,19 @@ Sample session
PUT /v2/compute/projects/**{project_id}**/traceng/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a NIO from a TraceNG instance
Update a NIO on a TraceNG instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be updated
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO updated
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -57,16 +57,16 @@ Remove a NIO from a TraceNG instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+7 -1
View File
@@ -9,9 +9,9 @@ Start a packet capture on a TraceNG instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
Response status codes
@@ -30,3 +30,9 @@ Input
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC, DLT_PPP_SERIAL</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt
docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+8 -2
View File
@@ -9,14 +9,20 @@ Stop a packet capture on a TraceNG instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt
docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidreload.rst
+1 -1
View File
@@ -14,9 +14,9 @@ Parameters
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Sample session
***************
docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidstart.rst
+1 -1
View File
@@ -14,9 +14,9 @@ Parameters
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
Input
*******
docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidstop.rst
+1 -1
View File
@@ -14,9 +14,9 @@ Parameters
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
Sample session
***************
docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidsuspend.rst
+1 -1
View File
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
Loaded 100 of 343 files, more files were not shown because too many files have changed in this diff. Show more