/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

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

Input

Name Mandatory Type Description
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
iourc_content ['string', 'null'] Content of the iourc file. Ignored if Null
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 ['string', 'null'] Path to the private-config of IOU
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 ['string', 'null'] Path to the startup-config of 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
command_line string Last command line used by GNS3 to start QEMU
console integer Console TCP port
console_type enum Possible values: telnet
ethernet_adapters integer How many ethernet adapters are connected to the IOU
iourc_content ['string', 'null'] Content of the iourc file. Ignored if Null
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
private_config ['string', 'null'] Path of the private-config content relative to project directory
private_config_content ['string', 'null'] Private-config of IOU
project_id string Project UUID
ram integer Allocated RAM MB
serial_adapters integer How many serial adapters are connected to the IOU
startup_config ['string', 'null'] Path of the startup-config content relative to project directory
startup_config_content ['string', 'null'] Startup-config of IOU
status enum Possible values: started, stopped, suspended
use_default_iou_values ['boolean', 'null'] Use default IOU values

Sample session

curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes' -d '{"name": "PC TEST 1", "node_id": "fc04f13f-c54d-421e-9a05-bb2fcc16857a", "path": "iou.bin", "startup_config_content": "hostname test"}'

POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes HTTP/1.1
{
    "name": "PC TEST 1",
    "node_id": "fc04f13f-c54d-421e-9a05-bb2fcc16857a",
    "path": "iou.bin",
    "startup_config_content": "hostname test"
}


HTTP/1.1 201
Connection: close
Content-Length: 792
Content-Type: application/json
Date: Tue, 21 Mar 2017 09:31:43 GMT
Server: Python/3.6 GNS3/2.0.0dev11
X-Route: /v2/compute/projects/{project_id}/iou/nodes

{
    "command_line": "",
    "console": 5004,
    "console_type": "telnet",
    "ethernet_adapters": 2,
    "l1_keepalives": false,
    "md5sum": "e573e8f5c93c6c00783f20c7a170aa6c",
    "name": "PC TEST 1",
    "node_directory": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-51/test_json5/project-files/iou/fc04f13f-c54d-421e-9a05-bb2fcc16857a",
    "node_id": "fc04f13f-c54d-421e-9a05-bb2fcc16857a",
    "nvram": 128,
    "path": "iou.bin",
    "private_config": null,
    "private_config_content": null,
    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
    "ram": 256,
    "serial_adapters": 2,
    "startup_config": "startup-config.cfg",
    "startup_config_content": "echo hello",
    "status": "stopped",
    "use_default_iou_values": true
}