/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¶
- 400: Invalid request
- 201: Capture started
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_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 | |
filters | object | Packet filter. This allow to simulate latency and errors | |
link_id | string | Link UUID | |
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¶
curl -i -X POST 'http://localhost:3080/v2/projects/405691bc-6538-4f45-b65f-e3309c3543ea/links/4fc4bbd0-38a2-4360-82ad-658636472f8a/start_capture' -d '{}'
POST /v2/projects/405691bc-6538-4f45-b65f-e3309c3543ea/links/4fc4bbd0-38a2-4360-82ad-658636472f8a/start_capture HTTP/1.1
{}
HTTP/1.1 201
Connection: close
Content-Length: 288
Content-Type: application/json
Date: Thu, 14 Jun 2018 08:35:14 GMT
Server: Python/3.5 GNS3/2.1.8dev1
X-Route: /v2/projects/{project_id}/links/{link_id}/start_capture
{
"capture_file_name": null,
"capture_file_path": null,
"capturing": false,
"filters": {},
"link_id": "4fc4bbd0-38a2-4360-82ad-658636472f8a",
"link_type": "ethernet",
"nodes": [],
"project_id": "405691bc-6538-4f45-b65f-e3309c3543ea",
"suspend": false
}