Return command_line and node_directory via the controller

This commit is contained in:
Julien Duponchelle
2016-05-12 10:39:50 +02:00
parent 885a870ae8
commit 5280644327
167 changed files with 5280 additions and 33 deletions

View File

@ -0,0 +1,20 @@
/v2/projects/{project_id}/links/{link_id}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/projects/**{project_id}**/links/**{link_id}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get the pcap from the capture
Parameters
**********
- **link_id**: UUID of the link
- **project_id**: UUID for the project
Response status codes
**********************
- **200**: Return the file
- **403**: Permission denied
- **404**: The file doesn't exist

View File

@ -0,0 +1,48 @@
/v2/projects/{project_id}/links/{link_id}/start_capture
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/links/**{link_id}**/start_capture
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start capture on a link instance. By default we consider it as an ethernet link
Parameters
**********
- **link_id**: UUID of the link
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **201**: Capture started
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>capture_file_name</td> <td> </td> <td>string</td> <td>Read only propertie. The name of the capture file if capture is running</td> </tr>
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only propertie. The name of the capture file if capture is running</td> </tr>
<tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only propertie. The full path of the capture file if capture is running</td> </tr>
<tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only propertie. True if a capture running on the link</td> </tr>
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link identifier</td> </tr>
<tr><td>nodes</td> <td>&#10004;</td> <td>array</td> <td>List of the VMS</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt

View File

@ -0,0 +1,25 @@
/v2/projects/{project_id}/links/{link_id}/stop_capture
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/links/**{link_id}**/stop_capture
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stop capture on a link instance
Parameters
**********
- **link_id**: UUID of the link
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **201**: Capture stopped
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinkslinkidstopcapture.txt

View File

@ -0,0 +1,8 @@
Node
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
node/*

View File

@ -0,0 +1,75 @@
/v2/projects/{project_id}/nodes
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new node instance
Parameters
**********
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodes.txt
GET /v2/projects/**{project_id}**/nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List nodes of a project
Parameters
**********
- **project_id**: UUID for the project
Response status codes
**********************
- **200**: List of nodes
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodes.txt

View File

@ -0,0 +1,73 @@
/v2/projects/{project_id}/nodes/{node_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
PUT /v2/projects/**{project_id}**/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a node instance
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_put_projectsprojectidnodesnodeid.txt
DELETE /v2/projects/**{project_id}**/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a node instance
Parameters
**********
- **node_id**: UUID for the node
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance deleted
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectidnodesnodeid.txt

View File

@ -0,0 +1,41 @@
/v2/projects/{project_id}/nodes/{node_id}/reload
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/nodes/**{node_id}**/reload
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Reload a node instance
Parameters
**********
- **node_id**: UUID for the node
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidreload.txt

View File

@ -0,0 +1,41 @@
/v2/projects/{project_id}/nodes/{node_id}/start
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/nodes/**{node_id}**/start
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a node instance
Parameters
**********
- **node_id**: UUID for the node
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidstart.txt

View File

@ -0,0 +1,41 @@
/v2/projects/{project_id}/nodes/{node_id}/stop
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/nodes/**{node_id}**/stop
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a node instance
Parameters
**********
- **node_id**: UUID for the node
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidstop.txt

View File

@ -0,0 +1,41 @@
/v2/projects/{project_id}/nodes/{node_id}/suspend
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/nodes/**{node_id}**/suspend
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a node instance
Parameters
**********
- **node_id**: UUID for the node
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidsuspend.txt