gns3-server/docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst

/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: Link UUID
• project_id: Project 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

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
nodes	✔	array	List of the VMS
project_id		string	Project UUID

Sample session

../../../examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt