Update documentation

This commit is contained in:
Julien Duponchelle 2015-02-19 20:23:27 +01:00
parent 48f5c7c8b3
commit 3797e27de5
34 changed files with 77 additions and 77 deletions
docs/api
dynamips_device
dynamips_vm
iou
virtualbox
vpcs

View File

@ -9,8 +9,8 @@ Get a Dynamips device instance
Parameters
**********
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
Response status codes
**********************
@ -38,8 +38,8 @@ Update a Dynamips device instance
Parameters
**********
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
Response status codes
**********************
@ -95,8 +95,8 @@ Delete a Dynamips device instance
Parameters
**********
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,9 +9,9 @@ Add a NIO to a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port on the device
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@ -128,9 +128,9 @@ Remove a NIO from a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port on the device
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************

View File

@ -9,9 +9,9 @@ Start a packet capture on a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port on the device
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************

View File

@ -9,9 +9,9 @@ Stop a packet capture on a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port on the device
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@ -75,8 +75,8 @@ Update a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@ -189,8 +189,8 @@ Delete a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter
- **adapter_number**: Adapter where the nio should be added
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
Response status codes
**********************
@ -27,10 +27,10 @@ Remove a NIO from a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Reload a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Resume a suspended Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Suspend a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@ -44,8 +44,8 @@ Update a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@ -97,8 +97,8 @@ Delete a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port where the nio should be added
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
Response status codes
**********************
@ -27,10 +27,10 @@ Remove a NIO from a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port from where the nio should be removed
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Start a packet capture on a IOU VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Stop a packet capture on a IOU VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Reload a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get a VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@ -43,8 +43,8 @@ Update a VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@ -94,8 +94,8 @@ Delete a VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter where the nio should be added
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
@ -27,10 +27,10 @@ Remove a NIO from a VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always)
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter (always)
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Start a packet capture on a VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Stop a packet capture on a VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Reload a VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Resume a suspended VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start a VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop a VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Suspend a VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Get a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@ -38,8 +38,8 @@ Update a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@ -79,8 +79,8 @@ Delete a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,10 +9,10 @@ Add a NIO to a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port where the nio should be added
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
Response status codes
**********************
@ -27,10 +27,10 @@ Remove a NIO from a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **port_number**: Port from where the nio should be removed
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Reload a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Start a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

View File

@ -9,8 +9,8 @@ Stop a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************