/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 |
---|---|---|---|
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 GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/f1e67396-246b-4edb-bfeb-cfd6bd028ae1'
GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/f1e67396-246b-4edb-bfeb-cfd6bd028ae1 HTTP/1.1
HTTP/1.1 200
Connection: close
Content-Length: 665
Content-Type: application/json
Date: Mon, 08 Jan 2018 08:15:47 GMT
Server: Python/3.6 GNS3/2.1.2dev1
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": "/private/var/folders/qy/g6blgc5n7y93pzg61zyt7cmr0000gn/T/pytest-of-behlers/pytest-0/test_json4/project-files/iou/f1e67396-246b-4edb-bfeb-cfd6bd028ae1",
"node_id": "f1e67396-246b-4edb-bfeb-cfd6bd028ae1",
"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 |
---|---|---|---|
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 |
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 PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/2e54bfd5-33e4-4958-9eb5-9344095bcf3c' -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/2e54bfd5-33e4-4958-9eb5-9344095bcf3c 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: 660
Content-Type: application/json
Date: Mon, 08 Jan 2018 08:15:48 GMT
Server: Python/3.6 GNS3/2.1.2dev1
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": "/private/var/folders/qy/g6blgc5n7y93pzg61zyt7cmr0000gn/T/pytest-of-behlers/pytest-0/test_json4/project-files/iou/2e54bfd5-33e4-4958-9eb5-9344095bcf3c",
"node_id": "2e54bfd5-33e4-4958-9eb5-9344095bcf3c",
"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/33edb045-964b-4089-857b-cfc31fff99b7'
DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/nodes/33edb045-964b-4089-857b-cfc31fff99b7 HTTP/1.1
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Mon, 08 Jan 2018 08:15:48 GMT
Server: Python/3.6 GNS3/2.1.2dev1
X-Route: /v2/compute/projects/{project_id}/iou/nodes/{node_id}