/v2/compute/projects/{project_id}/iou/nodes/{node_id}¶
Contents
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 |
---|---|---|---|
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 | |
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 GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/3719606a-bb6a-4a9d-b58d-6ca9e81d4cc2'
GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/3719606a-bb6a-4a9d-b58d-6ca9e81d4cc2 HTTP/1.1
HTTP/1.1 200
Connection: close
Content-Length: 640
Content-Type: application/json
Date: Thu, 29 Jun 2017 15:07:08 GMT
Server: Python/3.6 GNS3/2.1.0dev1
X-Route: /v2/compute/projects/{project_id}/iou/nodes/{node_id}
{
"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-63/test_json4/project-files/iou/3719606a-bb6a-4a9d-b58d-6ca9e81d4cc2",
"node_id": "3719606a-bb6a-4a9d-b58d-6ca9e81d4cc2",
"nvram": 128,
"path": "iou.bin",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 256,
"serial_adapters": 2,
"status": "stopped",
"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 |
---|---|---|---|
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 | |
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 |
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 | |
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 PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/e01d02c6-735e-4523-bb83-5ea11ecc97f7' -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/e01d02c6-735e-4523-bb83-5ea11ecc97f7 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: 635
Content-Type: application/json
Date: Thu, 29 Jun 2017 15:07:10 GMT
Server: Python/3.6 GNS3/2.1.0dev1
X-Route: /v2/compute/projects/{project_id}/iou/nodes/{node_id}
{
"command_line": "",
"console": 5005,
"console_type": "telnet",
"ethernet_adapters": 4,
"l1_keepalives": true,
"md5sum": "e573e8f5c93c6c00783f20c7a170aa6c",
"name": "test",
"node_directory": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-63/test_json4/project-files/iou/e01d02c6-735e-4523-bb83-5ea11ecc97f7",
"node_id": "e01d02c6-735e-4523-bb83-5ea11ecc97f7",
"nvram": 2048,
"path": "iou.bin",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 512,
"serial_adapters": 0,
"status": "stopped",
"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/b3d3552b-c851-4c54-88ef-eca874685de5'
DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/b3d3552b-c851-4c54-88ef-eca874685de5 HTTP/1.1
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Thu, 29 Jun 2017 15:07:10 GMT
Server: Python/3.6 GNS3/2.1.0dev1
X-Route: /v2/compute/projects/{project_id}/iou/nodes/{node_id}