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

Rebuild documentation

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-08-29 15:58:29 +02:00
1 parent bbc1505274
commit d121c201e4
241 files changed
+1226 -907
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
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on an ATM switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get an ATM switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -38,8 +38,8 @@ Update an ATM switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -81,8 +81,8 @@ Delete an ATM switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to an ATM switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
Response status codes
**********************
@@ -27,10 +27,10 @@ Remove a NIO from an ATM switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on an ATM switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start an ATM switch
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop an ATM switch
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/atm_switch/projectsprojectidatmswitchnodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend an ATM Relay switch
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/capabilities.rst
+8
View File
@@ -0,0 +1,8 @@
Capabilities
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
capabilities/*
docs/api/v2/compute/capabilities/capabilities.rst
+29
View File
@@ -0,0 +1,29 @@
/v2/compute/capabilities
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/capabilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Retrieve the capabilities of the server
Response status codes
**********************
- **200**: OK
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>node_types</td> <td>&#10004;</td> <td>array</td> <td></td> </tr>
<tr><td>version</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Version number</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_capabilities.txt
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get a cloud instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -45,8 +45,8 @@ Update a cloud instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -112,8 +112,8 @@ Delete a cloud instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a cloud instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **project_id**: Project UUID
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a cloud instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a cloud instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a cloud instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a cloud
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a cloud
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a cloud
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeid.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Delete a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -25,8 +25,8 @@ Update a Docker instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **project_id**: Project UUID
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a Docker container instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a Docker container instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidpause.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Pause a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Restart a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidunpause.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Unpause a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -79,8 +79,8 @@ Update a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -202,8 +202,8 @@ Delete a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **project_id**: Project UUID
Response status codes
**********************
@@ -27,10 +27,10 @@ Remove a NIO from a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidautoidlepc.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Retrieve the idlepc proposals
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeididlepcproposals.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Retrieve the idlepc proposals
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Reload a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidresume.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Resume a suspended Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a Dynamips VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get an Ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -38,8 +38,8 @@ Update an Ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -97,8 +97,8 @@ Delete an Ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to an Ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
- **project_id**: Project UUID
Response status codes
**********************
@@ -27,10 +27,10 @@ Remove a NIO from an Ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on an Ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on an Ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start an Ethernet hub
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop an Ethernet hub
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend an Ethernet hub
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get an Ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -38,8 +38,8 @@ Update an Ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -100,8 +100,8 @@ Delete an Ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to an Ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
Response status codes
**********************
@@ -27,10 +27,10 @@ Remove a NIO from an Ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on an Ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on an Ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start an Ethernet switch
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop an Ethernet switch
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend an Ethernet switch
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get a Frame Relay switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -38,8 +38,8 @@ Update a Frame Relay switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -81,8 +81,8 @@ Delete a Frame Relay switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a Frame Relay switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
Response status codes
**********************
@@ -27,10 +27,10 @@ Remove a NIO from a Frame Relay switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a Frame Relay switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a Frame Relay switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a Frame Relay switch
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a Frame Relay switch
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a Frame Relay switch
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/iou/projectsprojectidiounodesnodeid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get an IOU instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -60,8 +60,8 @@ Update an IOU instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -141,8 +141,8 @@ Delete an IOU instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a IOU instance
Parameters
**********
- **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
- **project_id**: Project UUID
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a IOU instance
Parameters
**********
- **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
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on an IOU VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on an IOU VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Reload an IOU instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start an IOU instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop an IOU instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -44,8 +44,8 @@ Update a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -93,8 +93,8 @@ Delete a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
- **project_id**: Project UUID
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a nat
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a nat
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a nat
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get a Qemu VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -80,8 +80,8 @@ Update a Qemu VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -197,8 +197,8 @@ Delete a Qemu VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a Qemu VM instance
Parameters
**********
- **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)
- **project_id**: Project UUID
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
- **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)
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a Qemu VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a Qemu VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Reload a Qemu VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidresume.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Resume a Qemu VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a Qemu VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a Qemu VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a Qemu VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/version/version.rst
-36
View File
@@ -27,39 +27,3 @@ Sample session
.. literalinclude:: ../../../examples/compute_get_version.txt
POST /v2/compute/version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Check if version is the same as the server
Response status codes
**********************
- **200**: Same version
- **409**: Invalid version
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Whether this is a local server or not</td> </tr>
<tr><td>version</td> <td>&#10004;</td> <td>string</td> <td>Version number</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Whether this is a local server or not</td> </tr>
<tr><td>version</td> <td>&#10004;</td> <td>string</td> <td>Version number</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_version.txt
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -54,8 +54,8 @@ Update a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -123,8 +123,8 @@ Delete a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
- **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)
- **project_id**: Project UUID
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **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
Response status codes
**********************
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Reload a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidresume.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Resume a suspended VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a VirtualBox VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -47,8 +47,8 @@ Update a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -108,8 +108,8 @@ Delete a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a VMware VM instance
Parameters
**********
- **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)
- **project_id**: Project UUID
Response status codes
**********************
@@ -27,10 +27,10 @@ Remove a NIO from a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **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
Response status codes
**********************
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidinterfacesvmnet.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Allocate a VMware VMnet interface on the server
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Reload a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidresume.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Resume a suspended VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a VMware VM instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
Loaded 100 of 241 files, more files were not shown because too many files have changed in this diff. Show more