mirror of
https://github.com/GNS3/gns3-server.git
synced 2024-12-23 22:52:25 +00:00
4.3 KiB
4.3 KiB
/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
- 400: Invalid request
- 404: Instance doesn't exist
- 204: Instance 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 | |
console_type | enum | Possible values: serial, vnc, telnet, null | |
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, virtualbox, vmware, iou, qemu | |
project_id | string | Project UUID | |
properties | object | Properties specific to an emulator | |
status | enum | Possible values: stopped, started, suspended | |
symbol | string | 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