ExternalVendorCode/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2024-12-25 23:41:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
27624acd06
gns3-server/docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
Julien Duponchelle 27624acd06
Update documentation
2016-06-14 10:24:55 +02:00

4.0 KiB
Raw Blame History

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

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

Suspend a node instance

Parameters

  • node_id: Node UUID
  • project_id: Project UUID

Response status codes

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

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
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, 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
x number X position of the node
y number Y position of the node
z number Z position of the node

Sample session

../../../examples/controller_post_projectsprojectidnodesnodeidsuspend.txt