2016-03-14 19:37:07 +00:00
/v2/projects/{project_id}/links/{link_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents ::
2018-01-08 08:26:44 +00:00
GET /v2/projects/**{project_id}** /links/**{link_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a link instance
Parameters
***** *****
- **project_id** : Project UUID
- **link_id** : Link UUID
Response status codes
***** ***** ***** ***** **
- **200** : Link found
- **400** : Invalid request
- **404** : Link doesn't exist
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 property. 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 property. 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 property. True if a capture running on the link</td> </tr>
<tr><td>filters</td> <td> </td> <td>object</td> <td>Packet filter. This allow to simulate latency and errors</td> </tr>
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link UUID</td> </tr>
<tr><td>link_type</td> <td> </td> <td>enum</td> <td>Possible values: ethernet, serial</td> </tr>
<tr><td>nodes</td> <td> </td> <td>array</td> <td>List of the VMS</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>suspend</td> <td> </td> <td>boolean</td> <td>Suspend the link</td> </tr>
</table>
Sample session
***** ***** *****
.. literalinclude :: ../../../examples/controller_get_projectsprojectidlinkslinkid.txt
2016-07-11 13:37:57 +00:00
PUT /v2/projects/**{project_id}** /links/**{link_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a link instance
Parameters
***** *****
2018-01-08 04:57:07 +00:00
- **project_id** : Project UUID
2018-01-08 08:26:44 +00:00
- **link_id** : Link UUID
2016-07-11 13:37:57 +00:00
Response status codes
***** ***** ***** ***** **
2018-01-08 04:57:07 +00:00
- **201** : Link updated
2018-01-08 08:26:44 +00:00
- **400** : Invalid request
2016-07-11 13:37:57 +00:00
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', 'null']</td> <td>Read only property. 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 property. 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 property. True if a capture running on the link</td> </tr>
2018-01-08 04:57:07 +00:00
<tr><td>filters</td> <td> </td> <td>object</td> <td>Packet filter. This allow to simulate latency and errors</td> </tr>
2016-07-11 13:37:57 +00:00
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link UUID</td> </tr>
2016-09-27 15:15:40 +00:00
<tr><td>link_type</td> <td> </td> <td>enum</td> <td>Possible values: ethernet, serial</td> </tr>
2018-01-08 04:57:07 +00:00
<tr><td>nodes</td> <td> </td> <td>array</td> <td>List of the VMS</td> </tr>
2016-07-11 13:37:57 +00:00
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
2018-01-08 04:57:07 +00:00
<tr><td>suspend</td> <td> </td> <td>boolean</td> <td>Suspend the link</td> </tr>
2016-07-11 13:37:57 +00:00
</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 property. 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 property. 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 property. True if a capture running on the link</td> </tr>
2018-01-08 04:57:07 +00:00
<tr><td>filters</td> <td> </td> <td>object</td> <td>Packet filter. This allow to simulate latency and errors</td> </tr>
2016-07-11 13:37:57 +00:00
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link UUID</td> </tr>
2016-09-27 15:15:40 +00:00
<tr><td>link_type</td> <td> </td> <td>enum</td> <td>Possible values: ethernet, serial</td> </tr>
2018-01-08 04:57:07 +00:00
<tr><td>nodes</td> <td> </td> <td>array</td> <td>List of the VMS</td> </tr>
2016-07-11 13:37:57 +00:00
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
2018-01-08 04:57:07 +00:00
<tr><td>suspend</td> <td> </td> <td>boolean</td> <td>Suspend the link</td> </tr>
2016-07-11 13:37:57 +00:00
</table>
2018-01-08 08:26:44 +00:00
Sample session
***** ***** *****
.. literalinclude :: ../../../examples/controller_put_projectsprojectidlinkslinkid.txt
2016-07-11 13:37:57 +00:00
2016-03-14 19:37:07 +00:00
DELETE /v2/projects/**{project_id}** /links/**{link_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a link instance
Parameters
***** *****
2018-01-08 04:57:07 +00:00
- **project_id** : Project UUID
2018-01-08 08:26:44 +00:00
- **link_id** : Link UUID
2016-03-14 19:37:07 +00:00
Response status codes
***** ***** ***** ***** **
2018-01-08 04:57:07 +00:00
- **204** : Link deleted
2018-01-08 08:26:44 +00:00
- **400** : Invalid request
Sample session
***** ***** *****
.. literalinclude :: ../../../examples/controller_delete_projectsprojectidlinkslinkid.txt
2017-03-21 12:32:04 +00:00
