/v2/compute/projects/{project_id}/iou/nodes/{node_id}¶
GET /v2/compute/projects/{project_id}/iou/nodes/{node_id}¶
Get an IOU instance
Parameters¶
project_id: Project UUID
node_id: Node UUID
Response status codes¶
200: Success
400: Invalid request
404: Instance doesn’t exist
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', 'null'] | Console TCP port | |
console_type | enum | Possible values: telnet, none | |
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 | |
usage | string | How to use the IOU VM | |
use_default_iou_values | ['boolean', 'null'] | Use default IOU values |
Sample session¶
curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/a4155e63-9b40-4c8e-bbbc-d93aad187b07'
GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/a4155e63-9b40-4c8e-bbbc-d93aad187b07 HTTP/1.1
HTTP/1.1 200
Connection: close
Content-Length: 631
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:25:57 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/iou/nodes/{node_id}
{
"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-41/test_json4/project-files/iou/a4155e63-9b40-4c8e-bbbc-d93aad187b07",
"node_id": "a4155e63-9b40-4c8e-bbbc-d93aad187b07",
"nvram": 128,
"path": "iou.bin",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 256,
"serial_adapters": 2,
"status": "stopped",
"usage": "",
"use_default_iou_values": true
}
PUT /v2/compute/projects/{project_id}/iou/nodes/{node_id}¶
Update an IOU instance
Parameters¶
project_id: Project UUID
node_id: Node UUID
Response status codes¶
200: Instance updated
400: Invalid request
404: Instance doesn’t exist
409: Conflict
Input¶
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', 'null'] | Console TCP port | |
console_type | enum | Possible values: telnet, none | |
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 | |
usage | string | How to use the IOU VM | |
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', 'null'] | Console TCP port | |
console_type | enum | Possible values: telnet, none | |
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 | |
usage | string | How to use the IOU VM | |
use_default_iou_values | ['boolean', 'null'] | Use default IOU values |
Sample session¶
curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/3472f579-af40-40e7-8dde-e01b07cf1480' -d '{"console": 5005, "ethernet_adapters": 4, "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0, "use_default_iou_values": true}'
PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/3472f579-af40-40e7-8dde-e01b07cf1480 HTTP/1.1
{
"console": 5005,
"ethernet_adapters": 4,
"l1_keepalives": true,
"name": "test",
"nvram": 2048,
"ram": 512,
"serial_adapters": 0,
"use_default_iou_values": true
}
HTTP/1.1 200
Connection: close
Content-Length: 626
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:25:58 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/iou/nodes/{node_id}
{
"application_id": 1,
"command_line": "",
"console": 5005,
"console_type": "telnet",
"ethernet_adapters": 4,
"l1_keepalives": true,
"md5sum": "e573e8f5c93c6c00783f20c7a170aa6c",
"name": "test",
"node_directory": "/tmp/pytest-of-grossmj/pytest-41/test_json4/project-files/iou/3472f579-af40-40e7-8dde-e01b07cf1480",
"node_id": "3472f579-af40-40e7-8dde-e01b07cf1480",
"nvram": 2048,
"path": "iou.bin",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 512,
"serial_adapters": 0,
"status": "stopped",
"usage": "",
"use_default_iou_values": true
}
DELETE /v2/compute/projects/{project_id}/iou/nodes/{node_id}¶
Delete an IOU instance
Parameters¶
project_id: Project UUID
node_id: Node UUID
Response status codes¶
204: Instance deleted
400: Invalid request
404: Instance doesn’t exist
Sample session¶
curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/81f7488a-6a28-46f0-8b26-331906bdcf2e'
DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/81f7488a-6a28-46f0-8b26-331906bdcf2e HTTP/1.1
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Wed, 08 Jan 2020 02:25:57 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/iou/nodes/{node_id}