/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¶
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 | |
link_id | string | Link UUID | |
link_type | enum | Possible values: ethernet, serial | |
nodes | ✔ | array | List of the VMS |
project_id | string | Project UUID |
Sample session¶
curl -i -X POST 'http://localhost:3080/v2/projects/7f25b14b-4f3d-4259-aa4c-f60f02354636/links/43bc51b2-9cea-4fc2-af09-d61b895aaaf7/start_capture' -d '{}'
POST /v2/projects/7f25b14b-4f3d-4259-aa4c-f60f02354636/links/43bc51b2-9cea-4fc2-af09-d61b895aaaf7/start_capture HTTP/1.1
{}
HTTP/1.1 201
Connection: close
Content-Length: 247
Content-Type: application/json
Date: Tue, 21 Mar 2017 09:31:58 GMT
Server: Python/3.6 GNS3/2.0.0dev11
X-Route: /v2/projects/{project_id}/links/{link_id}/start_capture
{
"capture_file_name": null,
"capture_file_path": null,
"capturing": false,
"link_id": "43bc51b2-9cea-4fc2-af09-d61b895aaaf7",
"link_type": "ethernet",
"nodes": [],
"project_id": "7f25b14b-4f3d-4259-aa4c-f60f02354636"
}