gns3-server/docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidstart.rst

3.2 KiB

/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

  • project_id: Project UUID
  • node_id: Node UUID

Response status codes

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

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

../../../examples/compute_post_projectsprojectidtracengnodesnodeidstart.txt