mirror of
https://github.com/GNS3/gns3-server.git
synced 2025-01-01 10:36:42 +00:00
2.7 KiB
2.7 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
- link_id: UUID of the link
- project_id: UUID for the project
Response status codes
- 400: Invalid request
- 201: Capture started
Input
| Name | Mandatory | Type | Description |
|---|---|---|---|
| capture_file_name | string | Read only propertie. 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 |
Output
| Name | Mandatory | Type | Description |
|---|---|---|---|
| capture_file_name | ['string', 'null'] | Read only propertie. The name of the capture file if capture is running | |
| capture_file_path | ['string', 'null'] | Read only propertie. The full path of the capture file if capture is running | |
| capturing | boolean | Read only propertie. True if a capture running on the link | |
| link_id | string | Link identifier | |
| nodes | ✔ | array | List of the VMS |
Sample session
../../../examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt