ExternalVendorCode/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2024-12-23 06:32:26 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
54131bc9bb
gns3-server/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst
Julien Duponchelle 54131bc9bb
Update the documentation
2017-03-06 14:35:39 +01:00

2.9 KiB
Raw Blame History

/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_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