/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
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
Response status codes
**********************
- **201**: Capture started
- **400**: Invalid request
Input
*******
.. raw:: html
Name | Mandatory | Type | Description |
capture_file_name | | string | Read only property. The name of the capture file if capture is running |
data_link_type | | enum | Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC, DLT_PPP_SERIAL |
Output
*******
.. raw:: html
Name | Mandatory | Type | Description |
capture_file_name | | ['string', 'null'] | Read only property. The name of the capture file if capture is running |
capture_file_path | | ['string', 'null'] | Read only property. The full path of the capture file if capture is running |
capturing | | boolean | Read only property. True if a capture running on the link |
link_id | | string | Link UUID |
link_type | | enum | Possible values: ethernet, serial |
nodes | ✔ | array | List of the VMS |
project_id | | string | Project UUID |