/v2/compute/projects/{project_id}/iou/nodes¶
Contents
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¶
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes' -d '{"name": "PC TEST 1", "node_id": "f327173c-2a79-4dee-b57f-eb60c907483b", "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": "f327173c-2a79-4dee-b57f-eb60c907483b",
"path": "iou.bin",
"startup_config_content": "hostname test"
}
HTTP/1.1 201
Connection: close
Content-Length: 614
Content-Type: application/json
Date: Thu, 14 Jun 2018 08:34:54 GMT
Server: Python/3.5 GNS3/2.1.8dev1
X-Route: /v2/compute/projects/{project_id}/iou/nodes
{
"application_id": 1,
"command_line": "",
"console": 5004,
"console_type": "telnet",
"ethernet_adapters": 2,
"l1_keepalives": false,
"md5sum": "e573e8f5c93c6c00783f20c7a170aa6c",
"name": "PC TEST 1",
"node_directory": "/tmp/pytest-of-grossmj/pytest-23/test_json4/project-files/iou/f327173c-2a79-4dee-b57f-eb60c907483b",
"node_id": "f327173c-2a79-4dee-b57f-eb60c907483b",
"nvram": 128,
"path": "iou.bin",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 256,
"serial_adapters": 2,
"status": "stopped",
"use_default_iou_values": true
}