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

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

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

Get a TraceNG instance

Parameters

• node_id: Node UUID
• project_id: Project 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

../../../examples/compute_get_projectsprojectidtracengnodesnodeid.txt

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

Update a TraceNG instance

Parameters

• node_id: Node UUID
• project_id: Project 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

../../../examples/compute_put_projectsprojectidtracengnodesnodeid.txt

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

Delete 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 deleted

Sample session

../../../examples/compute_delete_projectsprojectidtracengnodesnodeid.txt