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

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

Stop all nodes belonging to the project

Parameters

  • project_id: Project UUID

Response status codes

  • 400: Invalid request
  • 404: Instance doesn’t exist
  • 204: All nodes successfully stopped

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

curl -i -X POST 'http://localhost:3080/v2/projects/e6010926-bd32-43c4-b917-d6fd6f67de91/nodes/stop' -d '{}'

POST /v2/projects/e6010926-bd32-43c4-b917-d6fd6f67de91/nodes/stop HTTP/1.1
{}


HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Thu, 14 Jun 2018 08:35:15 GMT
Server: Python/3.5 GNS3/2.1.8dev1
X-Route: /v2/projects/{project_id}/nodes/stop