mirror of
https://github.com/GNS3/gns3-server.git
synced 2024-12-27 08:12:32 +00:00
3.8 KiB
3.8 KiB
/v2/projects/{project_id}/links/{link_id}/start_capture
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
| 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
| Name | Mandatory | Type | Description |
|---|---|---|---|
| capture_compute_id | ['string', 'null'] | Read only property. The compute identifier where a capture is running | |
| capture_file_name | ['string', 'null'] | Read only property. The name of the capture file if a capture is running | |
| capture_file_path | ['string', 'null'] | Read only property. The full path of the capture file if a capture is running | |
| capturing | boolean | Read only property. True if a capture running on the link | |
| filters | object | Packet filter. This allow to simulate latency and errors | |
| link_id | string | Link UUID | |
| link_style | object | Link line style | |
| link_type | enum | Possible values: ethernet, serial | |
| nodes | array | List of the VMS | |
| project_id | string | Project UUID | |
| suspend | boolean | Suspend the link |
Sample session
../../../examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt