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

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

Get a TraceNG instance

Parameters

  • project_id: Project UUID

  • node_id: Node UUID

Response status codes

  • 200: Success

  • 400: Invalid request

  • 404: Instance doesn’t exist

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 GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/traceng/nodes/c03cc894-a5e9-4359-b85a-1fd917184de4'

GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/traceng/nodes/c03cc894-a5e9-4359-b85a-1fd917184de4 HTTP/1.1



HTTP/1.1 200
Connection: close
Content-Length: 443
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:27:26 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/traceng/nodes/{node_id}

{
    "command_line": "",
    "console": null,
    "console_type": "none",
    "default_destination": "",
    "ip_address": "",
    "name": "TraceNG TEST 1",
    "node_directory": "/tmp/tmp3gc2avyo/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/traceng/c03cc894-a5e9-4359-b85a-1fd917184de4",
    "node_id": "c03cc894-a5e9-4359-b85a-1fd917184de4",
    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
    "status": "stopped"
}

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

Update a TraceNG instance

Parameters

  • project_id: Project UUID

  • node_id: Node UUID

Response status codes

  • 200: Instance updated

  • 400: Invalid request

  • 404: Instance doesn’t exist

  • 409: Conflict

Input

Name Mandatory Type Description
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', 'null'] TraceNG VM name

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 PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/traceng/nodes/5656a9e1-993c-478d-8987-3755026eab7a' -d '{"ip_address": "192.168.1.1", "name": "test"}'

PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/traceng/nodes/5656a9e1-993c-478d-8987-3755026eab7a HTTP/1.1
{
    "ip_address": "192.168.1.1",
    "name": "test"
}


HTTP/1.1 200
Connection: close
Content-Length: 444
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:27:27 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/traceng/nodes/{node_id}

{
    "command_line": "",
    "console": null,
    "console_type": "none",
    "default_destination": "",
    "ip_address": "192.168.1.1",
    "name": "test",
    "node_directory": "/tmp/tmp3gc2avyo/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/traceng/5656a9e1-993c-478d-8987-3755026eab7a",
    "node_id": "5656a9e1-993c-478d-8987-3755026eab7a",
    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
    "status": "stopped"
}

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

Delete a TraceNG instance

Parameters

  • project_id: Project UUID

  • node_id: Node UUID

Response status codes

  • 204: Instance deleted

  • 400: Invalid request

  • 404: Instance doesn’t exist

Sample session

curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/traceng/nodes/36979ca4-4892-4b3e-9202-2143e261d128'

DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/traceng/nodes/36979ca4-4892-4b3e-9202-2143e261d128 HTTP/1.1



HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Wed, 08 Jan 2020 02:27:26 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/traceng/nodes/{node_id}