1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-11 09:38:08 +00:00
gns3-server/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst

53 lines
3.4 KiB
ReStructuredText
Raw Normal View History

/v2/projects/{project_id}/links/{link_id}/start_capture
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/links/**{link_id}**/start_capture
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2016-06-04 08:40:39 +00:00
Start capture on a link instance. By default we consider it as an Ethernet link
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
Response status codes
**********************
2018-01-08 08:26:44 +00:00
- **400**: Invalid request
- **201**: Capture started
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>capture_file_name</td> <td> </td> <td>string</td> <td>Read only property. The name of the capture file if capture is running</td> </tr>
2017-03-06 13:35:39 +00:00
<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>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-06-04 08:40:39 +00:00
<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-06-04 08:40:39 +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-06-04 08:40:39 +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>
</table>
2018-01-08 08:26:44 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt