Update API documentation

This commit is contained in:
Bernhard Ehlers committed 2018-01-08 09:26:44 +01:00
1 parent 21a7a68875
commit e6d2bd4424
360 files changed
+17598 -896

No files matched your search

@@ -9,14 +9,14 @@ Stop a packet capture on an ATM switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **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
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -9,8 +9,8 @@ Get an ATM switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -38,8 +38,8 @@ Update an ATM switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -81,12 +81,12 @@ Delete an ATM switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
@@ -9,15 +9,15 @@ Add a NIO to an ATM switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **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
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **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
@@ -9,10 +9,10 @@ Start a packet capture on an ATM switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
@@ -0,0 +1,19 @@
/v2/compute/projects/{project_id}/atm_switch/nodes/{node_id}/duplicate
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/atm_switch/nodes/**{node_id}**/duplicate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Duplicate an atm switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **201**: Instance duplicated
- **404**: Instance doesn't exist
@@ -9,12 +9,12 @@ Start an ATM switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
@@ -9,12 +9,12 @@ Stop an ATM switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
@@ -9,12 +9,12 @@ Suspend an ATM Relay switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
@@ -22,3 +22,9 @@ Output
<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
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -61,3 +61,9 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidcloudnodes.txt
@@ -9,8 +9,8 @@ Get a cloud instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -33,6 +33,12 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projectsprojectidcloudnodesnodeid.txt
PUT /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -40,8 +46,8 @@ Update a cloud instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -97,6 +103,12 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidcloudnodesnodeid.txt
DELETE /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -104,12 +116,18 @@ Delete a cloud instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidcloudnodesnodeid.txt
@@ -9,17 +9,23 @@ Add a NIO to a cloud instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the cloud
- **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
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
PUT /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -27,17 +33,23 @@ Update a NIO from a Cloud instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port from where the nio should be updated
- **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
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
DELETE /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -45,14 +57,20 @@ Remove a NIO from a cloud instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the cloud
- **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
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
@@ -9,10 +9,10 @@ Start a packet capture on a cloud instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the cloud
- **node_id**: Node UUID
- **adapter_number**: Adapter on the cloud (always 0)
- **port_number**: Port on the cloud
Response status codes
**********************
@@ -9,14 +9,14 @@ Stop a packet capture on a cloud instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the cloud
- **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
@@ -9,12 +9,12 @@ Start a cloud
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
@@ -9,12 +9,12 @@ Stop a cloud
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
@@ -9,12 +9,12 @@ Suspend a cloud
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -9,14 +9,14 @@ Delete a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
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}**
@@ -25,8 +25,8 @@ Update a Docker instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -85,3 +85,9 @@ Output
<tr><td>usage</td> <td> </td> <td>string</td> <td>How to use the qemu VM</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectiddockernodesnodeid.txt
@@ -9,17 +9,23 @@ Add a NIO to a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **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
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt
PUT /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -27,17 +33,23 @@ Update a NIO from a Docker instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port from where the nio should be updated
- **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
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt
DELETE /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -45,14 +57,20 @@ Remove a NIO from a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt
@@ -9,10 +9,10 @@ Start a packet capture on a Docker container instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
Response status codes
**********************
@@ -31,3 +31,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_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt
@@ -9,15 +9,21 @@ Stop a packet capture on a Docker container instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **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
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt
@@ -0,0 +1,25 @@
/v2/compute/projects/{project_id}/docker/nodes/{node_id}/duplicate
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/duplicate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Duplicate a Docker instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **201**: Instance duplicated
- **404**: Instance doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectiddockernodesnodeidduplicate.txt
@@ -9,12 +9,12 @@ Pause a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance paused
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance paused
@@ -9,12 +9,12 @@ Restart a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance restarted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance restarted
@@ -9,12 +9,12 @@ Start a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
@@ -9,12 +9,12 @@ Stop a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
@@ -9,12 +9,12 @@ Unpause a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance unpaused
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance unpaused
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -9,8 +9,8 @@ Get a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -75,8 +75,8 @@ Update a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -188,12 +188,12 @@ Delete a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
@@ -9,15 +9,15 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **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
@@ -27,15 +27,15 @@ Update a NIO from a Dynamips instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port from where the nio should be updated
- **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
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **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
@@ -9,10 +9,10 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
Response status codes
**********************
@@ -9,14 +9,14 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **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
@@ -9,8 +9,8 @@ Retrieve the idlepc proposals
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -0,0 +1,19 @@
/v2/compute/projects/{project_id}/dynamips/nodes/{node_id}/duplicate
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/dynamips/nodes/**{node_id}**/duplicate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Duplicate a dynamips instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **201**: Instance duplicated
- **404**: Instance doesn't exist
@@ -9,8 +9,8 @@ Retrieve the idlepc proposals
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -9,12 +9,12 @@ Reload a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
@@ -9,12 +9,12 @@ Resume a suspended Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance resumed
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance resumed
@@ -9,12 +9,12 @@ Start a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
@@ -9,12 +9,12 @@ Stop a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
@@ -9,12 +9,12 @@ Suspend a Dynamips VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -9,8 +9,8 @@ Get an Ethernet hub instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -38,8 +38,8 @@ Update an Ethernet hub instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -97,12 +97,12 @@ Delete an Ethernet hub instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
@@ -9,15 +9,15 @@ Add a NIO to an Ethernet hub instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the hub
- **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
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the hub
- **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
@@ -9,10 +9,10 @@ Start a packet capture on an Ethernet hub instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the hub
- **node_id**: Node UUID
- **adapter_number**: Adapter on the hub (always 0)
- **port_number**: Port on the hub
Response status codes
**********************
@@ -9,14 +9,14 @@ Stop a packet capture on an Ethernet hub instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the hub
- **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
@@ -0,0 +1,19 @@
/v2/compute/projects/{project_id}/ethernet_hub/nodes/{node_id}/duplicate
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}**/duplicate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Duplicate an ethernet hub instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **201**: Instance duplicated
- **404**: Instance doesn't exist
@@ -9,12 +9,12 @@ Start an Ethernet hub
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
@@ -9,12 +9,12 @@ Stop an Ethernet hub
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
@@ -9,12 +9,12 @@ Suspend an Ethernet hub
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -9,8 +9,8 @@ Get an Ethernet switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -40,8 +40,8 @@ Update an Ethernet switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -106,12 +106,12 @@ Delete an Ethernet switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
@@ -9,15 +9,15 @@ Add a NIO to an Ethernet switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **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
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **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
@@ -9,10 +9,10 @@ Start a packet capture on an Ethernet switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
@@ -9,14 +9,14 @@ Stop a packet capture on an Ethernet switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **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
@@ -0,0 +1,19 @@
/v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id}/duplicate
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/ethernet_switch/nodes/**{node_id}**/duplicate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Duplicate an ethernet switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **201**: Instance duplicated
- **404**: Instance doesn't exist
@@ -9,12 +9,12 @@ Start an Ethernet switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
@@ -9,12 +9,12 @@ Stop an Ethernet switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
@@ -9,12 +9,12 @@ Suspend an Ethernet switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -9,8 +9,8 @@ Get a Frame Relay switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -38,8 +38,8 @@ Update a Frame Relay switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -81,12 +81,12 @@ Delete a Frame Relay switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
@@ -9,15 +9,15 @@ Add a NIO to a Frame Relay switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **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
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **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
@@ -9,10 +9,10 @@ Start a packet capture on a Frame Relay switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **node_id**: Node UUID
- **adapter_number**: Adapter on the switch (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
@@ -9,14 +9,14 @@ Stop a packet capture on a Frame Relay switch instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the switch
- **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
@@ -0,0 +1,19 @@
/v2/compute/projects/{project_id}/frame_relay_switch/nodes/{node_id}/duplicate
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes/**{node_id}**/duplicate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Duplicate a frame relay switch instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **201**: Instance duplicated
- **404**: Instance doesn't exist
@@ -9,12 +9,12 @@ Start a Frame Relay switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
@@ -9,12 +9,12 @@ Stop a Frame Relay switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
@@ -9,12 +9,12 @@ Suspend a Frame Relay switch
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
+6
View File
@@ -11,3 +11,9 @@ Response status codes
**********************
- **200**: List of IOU images
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_iouimages.txt
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -65,3 +65,9 @@ Output
<tr><td>use_default_iou_values</td> <td> </td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiounodes.txt
@@ -9,8 +9,8 @@ Get an IOU instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -43,6 +43,12 @@ Output
<tr><td>use_default_iou_values</td> <td> </td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projectsprojectidiounodesnodeid.txt
PUT /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -50,8 +56,8 @@ Update an IOU instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -110,6 +116,12 @@ Output
<tr><td>use_default_iou_values</td> <td> </td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidiounodesnodeid.txt
DELETE /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -117,12 +129,18 @@ Delete an IOU instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidiounodesnodeid.txt
@@ -9,17 +9,23 @@ Add a NIO to a IOU instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port where the nio should be added
- **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
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.txt
PUT /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -27,17 +33,23 @@ Update a NIO from a IOU instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port where the nio should be added
- **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
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.txt
DELETE /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -45,14 +57,20 @@ Remove a NIO from a IOU instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port from where the nio should be removed
- **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
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdnio.txt
@@ -9,10 +9,10 @@ Start a packet capture on an IOU VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
Response status codes
**********************
@@ -31,3 +31,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_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt
@@ -9,15 +9,21 @@ Stop a packet capture on an IOU VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **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
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt
@@ -0,0 +1,25 @@
/v2/compute/projects/{project_id}/iou/nodes/{node_id}/duplicate
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/duplicate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Duplicate a IOU instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **201**: Instance duplicated
- **404**: Instance doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiounodesnodeidduplicate.txt
@@ -9,12 +9,18 @@ Reload an IOU instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiounodesnodeidreload.txt
@@ -9,8 +9,8 @@ Start an IOU instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -52,3 +52,9 @@ Output
<tr><td>use_default_iou_values</td> <td> </td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiounodesnodeidstart.txt
@@ -9,12 +9,18 @@ Stop an IOU instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiounodesnodeidstop.txt
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -43,3 +43,9 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidnatnodes.txt
@@ -9,8 +9,8 @@ Get a nat instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -31,6 +31,12 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projectsprojectidnatnodesnodeid.txt
PUT /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -38,8 +44,8 @@ Update a nat instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -74,6 +80,12 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidnatnodesnodeid.txt
DELETE /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -81,12 +93,18 @@ Delete a nat instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidnatnodesnodeid.txt
@@ -9,17 +9,23 @@ Add a NIO to a nat instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the nat
- **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
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
PUT /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -27,17 +33,23 @@ Update a NIO from a NAT instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port from where the nio should be updated
- **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
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
DELETE /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -45,14 +57,20 @@ Remove a NIO from a nat instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the nat
- **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
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
@@ -9,10 +9,10 @@ Start a packet capture on a nat instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the nat
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **port_number**: Port on the nat
Response status codes
**********************
@@ -9,14 +9,14 @@ Stop a packet capture on a nat instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the nat
- **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
@@ -9,12 +9,12 @@ Start a nat
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
@@ -9,12 +9,12 @@ Stop a nat
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
@@ -9,12 +9,12 @@ Suspend a nat
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
@@ -11,3 +11,9 @@ Response status codes
**********************
- **200**: OK
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_networkinterfaces.txt
@@ -16,3 +16,9 @@ Response status codes
- **201**: UDP port allocated
- **404**: The project doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidportsudp.txt
+12
View File
@@ -11,6 +11,12 @@ Response status codes
**********************
- **200**: Project list
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projects.txt
POST /v2/compute/projects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -64,3 +70,9 @@ Output
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projects.txt
@@ -39,6 +39,12 @@ Output
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projectsprojectid.txt
DELETE /v2/compute/projects/**{project_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -50,6 +56,12 @@ 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
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectid.txt
@@ -13,6 +13,12 @@ Parameters
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: Project closed
- **404**: The project doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidclose.txt
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -116,3 +116,9 @@ Output
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the QEMU VM</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodes.txt
@@ -9,8 +9,8 @@ Get a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -69,6 +69,12 @@ Output
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the QEMU VM</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projectsprojectidqemunodesnodeid.txt
PUT /v2/compute/projects/**{project_id}**/qemu/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -76,8 +82,8 @@ Update a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -184,6 +190,12 @@ Output
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the QEMU VM</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidqemunodesnodeid.txt
DELETE /v2/compute/projects/**{project_id}**/qemu/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -191,12 +203,18 @@ Delete a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidqemunodesnodeid.txt
@@ -9,17 +9,23 @@ Add a NIO to a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **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
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt
PUT /v2/compute/projects/**{project_id}**/qemu/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -27,17 +33,23 @@ Update a NIO from a Qemu instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port from where the nio should be updated
- **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
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt
DELETE /v2/compute/projects/**{project_id}**/qemu/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -45,14 +57,20 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **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
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt
@@ -9,10 +9,10 @@ Start a packet capture on a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
@@ -9,14 +9,14 @@ Stop a packet capture on a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port on the adapter (always 0)
- **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
@@ -0,0 +1,25 @@
/v2/compute/projects/{project_id}/qemu/nodes/{node_id}/duplicate
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/qemu/nodes/**{node_id}**/duplicate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Duplicate a Qemu instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **201**: Instance duplicated
- **404**: Instance doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodesnodeidduplicate.txt
@@ -9,12 +9,18 @@ Reload a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodesnodeidreload.txt
@@ -9,12 +9,18 @@ Resume a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance resumed
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance resumed
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodesnodeidresume.txt
Loaded 100 of 360 files, more files were not shown because too many files have changed in this diff. Show more