/v2/compute/projects/{project_id}/docker/nodes/{node_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/start_capture

POST /v2/compute/projects/{project_id}/docker/nodes/{node_id}/adapters/{adapter_number:d+}/ports/{port_number:d+}/start_capture

Start a packet capture on a Docker container instance

Parameters

  • project_id: Project UUID
  • node_id: Node UUID
  • adapter_number: Adapter to start a packet capture
  • port_number: Port on the adapter

Response status codes

  • 200: Capture started
  • 400: Invalid request
  • 404: Instance doesn’t exist
  • 409: Node not started

Input

Name Mandatory Type Description
capture_file_name string Capture file name
data_link_type enum Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC, DLT_PPP_SERIAL

Sample session

curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/283cc38e-c13f-41e9-951e-42c9723fb3bc/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'

POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/nodes/283cc38e-c13f-41e9-951e-42c9723fb3bc/adapters/0/ports/0/start_capture HTTP/1.1
{
    "capture_file_name": "test.pcap",
    "data_link_type": "DLT_EN10MB"
}


HTTP/1.1 200
Connection: close
Content-Length: 145
Content-Type: application/json
Date: Mon, 08 Jan 2018 08:15:46 GMT
Server: Python/3.6 GNS3/2.1.2dev1
X-Route: /v2/compute/projects/{project_id}/docker/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture

{
    "pcap_file_path": "/private/var/folders/qy/g6blgc5n7y93pzg61zyt7cmr0000gn/T/pytest-of-behlers/pytest-0/test_json4/tmp/captures/test.pcap"
}