gns3-server/docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst

/v2/projects/{project_id}/nodes/{node_id}/stop

POST /v2/projects/{project_id}/nodes/{node_id}/stop

Stop a node instance

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

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

Output

Name	Mandatory	Type	Description
command_line		['null', 'string']	Command line use to start the node
compute_id	✔	string	Compute identifier
console		['integer', 'null']	Console TCP port
console_host		string	Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.
console_type		enum	Possible values: vnc, telnet, http, https, spice, none, null
first_port_name		['string', 'null']	Name of the first port
height		integer	Height of the node (Read only)
label		object
name	✔	string	Node name
node_directory		['null', 'string']	Working directory of the node. Read only
node_id		string	Node UUID
node_type	✔	enum	Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu
port_name_format		string	Formating for port name {0} will be replace by port number
port_segment_size		integer	Size of the port segment
ports		array	List of node ports READ only
project_id		string	Project UUID
properties		object	Properties specific to an emulator
status		enum	Possible values: stopped, started, suspended
symbol		['string', 'null']	Symbol of the node
width		integer	Width of the node (Read only)
x		integer	X position of the node
y		integer	Y position of the node
z		integer	Z position of the node

Sample session

../../../examples/controller_post_projectsprojectidnodesnodeidstop.txt