gns3-server/docs/api/v2/compute/iou/projectsprojectidiounodes.rst
grossmj 0f496907a0 Fix API status code for start/stop/suspend/reload a node. Fixes #1353.
Fix issues with test.
Update documentation.
2018-06-14 16:39:32 +08:00

6.8 KiB

/v2/compute/projects/{project_id}/iou/nodes

POST /v2/compute/projects/{project_id}/iou/nodes

Create a new IOU instance

Parameters

  • project_id: Project UUID

Response status codes

  • 400: Invalid request
  • 201: Instance created
  • 409: Conflict

Input

Name Mandatory Type Description
application_id ['integer', 'null'] Application ID for running IOU image
console ['integer', 'null'] Console TCP port
console_type enum Possible values: telnet, null
ethernet_adapters integer How many ethernet adapters are connected to the IOU
l1_keepalives ['boolean', 'null'] Always up ethernet interface
md5sum ['string', 'null'] Checksum of iou binary
name string IOU VM name
node_id Node UUID
nvram ['integer', 'null'] Allocated NVRAM KB
path string Path of iou binary
private_config_content ['string', 'null'] Private-config of IOU
ram ['integer', 'null'] Allocated RAM MB
serial_adapters integer How many serial adapters are connected to the IOU
startup_config_content ['string', 'null'] Startup-config of IOU
use_default_iou_values ['boolean', 'null'] Use default IOU values

Output

Name Mandatory Type Description
application_id integer Application ID for running IOU image
command_line string Last command line used by GNS3 to start IOU
console integer Console TCP port
console_type enum Possible values: telnet
ethernet_adapters integer How many ethernet adapters are connected to the IOU
l1_keepalives boolean Always up ethernet interface
md5sum ['string', 'null'] Checksum of iou binary
name string IOU VM name
node_directory string Path to the node working directory
node_id string IOU VM UUID
nvram integer Allocated NVRAM KB
path string Path of iou binary
project_id string Project UUID
ram integer Allocated RAM MB
serial_adapters integer How many serial adapters are connected to the IOU
status enum Possible values: started, stopped, suspended
use_default_iou_values ['boolean', 'null'] Use default IOU values

Sample session

../../../examples/compute_post_projectsprojectidiounodes.txt