/v1/projects/{project_id}/iou/vms/{vm_id}¶
Contents
GET /v1/projects/{project_id}/iou/vms/{vm_id}¶
Get a IOU instance
Parameters¶
- project_id: UUID for the project
- vm_id: UUID for the instance
Response status codes¶
- 200: Success
- 400: Invalid request
- 404: Instance doesn’t exist
Output¶
Name | Mandatory | Type | Description |
---|---|---|---|
console | ✔ | integer | console TCP port |
ethernet_adapters | ✔ | integer | How many ethernet adapters are connected to the IOU |
iourc_path | ['string', 'null'] | Path of the iourc file used by remote servers | |
l1_keepalives | ✔ | boolean | Always up ethernet interface |
md5sum | ✔ | ['string', 'null'] | Checksum of iou binary |
name | ✔ | string | IOU VM name |
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 |
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 |
use_default_iou_values | ✔ | ['boolean', 'null'] | Use default IOU values |
vm_directory | string | ||
vm_id | ✔ | string | IOU VM UUID |
Sample session¶
curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/82f6e25c-6960-421d-9567-a7453642935b'
GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/82f6e25c-6960-421d-9567-a7453642935b HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONNECTION: keep-alive
CONTENT-LENGTH: 610
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.4.0dev13
X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}
{
"console": 2001,
"ethernet_adapters": 2,
"iourc_path": null,
"l1_keepalives": false,
"md5sum": null,
"name": "PC TEST 1",
"nvram": 128,
"path": "iou.bin",
"private_config": null,
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 256,
"serial_adapters": 2,
"startup_config": null,
"use_default_iou_values": true,
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2yt9sd1l/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/82f6e25c-6960-421d-9567-a7453642935b",
"vm_id": "82f6e25c-6960-421d-9567-a7453642935b"
}
PUT /v1/projects/{project_id}/iou/vms/{vm_id}¶
Update a IOU instance
Parameters¶
- project_id: UUID for the project
- vm_id: UUID for the instance
Response status codes¶
- 200: Instance updated
- 400: Invalid request
- 404: Instance doesn’t exist
- 409: Conflict
Input¶
Name | Mandatory | Type | Description |
---|---|---|---|
console | ['integer', 'null'] | console TCP port | |
ethernet_adapters | ['integer', 'null'] | 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', 'null'] | IOU VM name | |
nvram | ['integer', 'null'] | Allocated NVRAM KB | |
path | ['string', 'null'] | Path of iou binary | |
private_config_content | ['string', 'null'] | Private-config of IOU | |
ram | ['integer', 'null'] | Allocated RAM MB | |
serial_adapters | ['integer', 'null'] | 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 |
---|---|---|---|
console | ✔ | integer | console TCP port |
ethernet_adapters | ✔ | integer | How many ethernet adapters are connected to the IOU |
iourc_path | ['string', 'null'] | Path of the iourc file used by remote servers | |
l1_keepalives | ✔ | boolean | Always up ethernet interface |
md5sum | ✔ | ['string', 'null'] | Checksum of iou binary |
name | ✔ | string | IOU VM name |
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 |
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 |
use_default_iou_values | ✔ | ['boolean', 'null'] | Use default IOU values |
vm_directory | string | ||
vm_id | ✔ | string | IOU VM UUID |
Sample session¶
curl -i -X PUT 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6438493a-152d-4cb0-b8d2-fcfe1f6bf540' -d '{"console": 2002, "ethernet_adapters": 4, "iourc_content": "test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0, "startup_config_content": "hostname test", "use_default_iou_values": true}'
PUT /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6438493a-152d-4cb0-b8d2-fcfe1f6bf540 HTTP/1.1
{
"console": 2002,
"ethernet_adapters": 4,
"iourc_content": "test",
"l1_keepalives": true,
"name": "test",
"nvram": 2048,
"ram": 512,
"serial_adapters": 0,
"startup_config_content": "hostname test",
"use_default_iou_values": true
}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONNECTION: keep-alive
CONTENT-LENGTH: 685
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.4.0dev13
X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}
{
"console": 2002,
"ethernet_adapters": 4,
"iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpyrljan4a/iourc",
"l1_keepalives": true,
"md5sum": null,
"name": "test",
"nvram": 2048,
"path": "iou.bin",
"private_config": null,
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"ram": 512,
"serial_adapters": 0,
"startup_config": "startup-config.cfg",
"use_default_iou_values": true,
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp2yt9sd1l/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/6438493a-152d-4cb0-b8d2-fcfe1f6bf540",
"vm_id": "6438493a-152d-4cb0-b8d2-fcfe1f6bf540"
}
DELETE /v1/projects/{project_id}/iou/vms/{vm_id}¶
Delete a IOU instance
Parameters¶
- project_id: UUID for the project
- vm_id: UUID for the instance
Response status codes¶
- 400: Invalid request
- 404: Instance doesn’t exist
- 204: Instance deleted
Sample session¶
curl -i -X DELETE 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0813062d-a796-44ef-a5ed-e690c633012e'
DELETE /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/0813062d-a796-44ef-a5ed-e690c633012e HTTP/1.1
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONNECTION: keep-alive
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.4.0dev13
X-ROUTE: /v1/projects/{project_id}/iou/vms/{vm_id}