Navigation

  • index
  • next |
  • previous |
  • GNS3 2.2.37 documentation »
  • Endpoints »
  • Link »

/v2/projects/{project_id}/links/{link_id}/start_capture¶

Contents

  • /v2/projects/{project_id}/links/{link_id}/start_capture
    • POST /v2/projects/{project_id}/links/{link_id}/start_capture
      • Parameters
      • Response status codes
      • Input
      • Output
      • Sample session

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_compute_id ['string', 'null'] Read only property. The compute identifier where a capture is running
capture_file_name ['string', 'null'] Read only property. The name of the capture file if a capture is running
capture_file_path ['string', 'null'] Read only property. The full path of the capture file if a 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/d90f8e95-fda3-49d5-86b5-4c41b2fac7f2/links/514ae6a3-8078-4bb9-9298-1faa599399b9/start_capture' -d '{}'

POST /v2/projects/d90f8e95-fda3-49d5-86b5-4c41b2fac7f2/links/514ae6a3-8078-4bb9-9298-1faa599399b9/start_capture HTTP/1.1
{}


HTTP/1.1 201
Connection: close
Content-Length: 320
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:27:58 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/projects/{project_id}/links/{link_id}/start_capture

{
    "capture_compute_id": null,
    "capture_file_name": null,
    "capture_file_path": null,
    "capturing": false,
    "filters": {},
    "link_id": "514ae6a3-8078-4bb9-9298-1faa599399b9",
    "link_type": "ethernet",
    "nodes": [],
    "project_id": "d90f8e95-fda3-49d5-86b5-4c41b2fac7f2",
    "suspend": false
}

Quick search

Navigation

  • index
  • next |
  • previous |
  • GNS3 2.2.37 documentation »
  • Endpoints »
  • Link »
© Copyright 2015, GNS3 GNS3 Technologies Inc.. Created using Sphinx 1.8.6.