/v2/compute/projects/{project_id}/traceng/nodes/{node_id}/start

POST /v2/compute/projects/{project_id}/traceng/nodes/{node_id}/start

Start a TraceNG instance

Parameters

  • node_id: Node UUID
  • project_id: Project UUID

Response status codes

  • 400: Invalid request
  • 404: Instance doesn’t exist
  • 204: Instance started

Input

Name Mandatory Type Description
destination ['string'] Host or IP address to trace

Output

Name Mandatory Type Description
command_line ✔ string Last command line used by GNS3 to start TraceNG
console ✔ ['integer', 'null'] Console TCP port
console_type ✔ enum Possible values: none
default_destination ✔ ['string'] Default destination IP address or hostname for tracing
ip_address ✔ ['string'] Source IP address for tracing
name ✔ string TraceNG VM name
node_directory string Path to the VM working directory
node_id ✔ string Node UUID
project_id ✔ string Project UUID
status ✔ enum Possible values: started, stopped, suspended

Sample session

curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/traceng/nodes/c5b071ef-6ad6-4f0a-a98d-9246893d5381/start' -d '{"destination": "192.168.1.2"}'

POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/traceng/nodes/c5b071ef-6ad6-4f0a-a98d-9246893d5381/start HTTP/1.1
{
    "destination": "192.168.1.2"
}


HTTP/1.1 200
Connection: close
Content-Length: 443
Content-Type: application/json
Date: Thu, 14 Jun 2018 08:34:58 GMT
Server: Python/3.5 GNS3/2.1.8dev1
X-Route: /v2/compute/projects/{project_id}/traceng/nodes/{node_id}/start

{
    "command_line": "",
    "console": 5004,
    "console_type": "none",
    "default_destination": "",
    "ip_address": "",
    "name": "TraceNG TEST 1",
    "node_directory": "/tmp/tmp4zak1_kl/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/traceng/c5b071ef-6ad6-4f0a-a98d-9246893d5381",
    "node_id": "c5b071ef-6ad6-4f0a-a98d-9246893d5381",
    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
    "status": "stopped"
}