2016-03-07 16:57:12 +00:00
/v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}
2016-03-07 14:01:35 +00:00
------------------------------------------------------------------------------------------------------------------------------------------
2015-04-07 14:09:27 +00:00
.. contents ::
2016-03-07 16:57:12 +00:00
GET /v2/hypervisor/projects/**{project_id}** /iou/vms/**{vm_id}**
2016-03-07 14:01:35 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2015-04-07 14:09:27 +00:00
Get a IOU instance
Parameters
***** *****
2016-03-11 14:28:45 +00:00
- **project_id** : UUID for the project
2016-03-11 16:02:50 +00:00
- **vm_id** : UUID for the instance
2015-04-07 14:09:27 +00:00
Response status codes
***** ***** ***** ***** **
- **200** : Success
- **400** : Invalid request
- **404** : Instance doesn't exist
Output
***** **
.. raw :: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-03-04 16:50:17 +00:00
<tr><td>command_line</td> <td>✔</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>ethernet_adapters</td> <td>✔</td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
<tr><td>iourc_path</td> <td> </td> <td>['string', 'null']</td> <td>Path of the iourc file used by remote servers</td> </tr>
<tr><td>l1_keepalives</td> <td>✔</td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
2015-07-09 14:16:43 +00:00
<tr><td>md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>name</td> <td>✔</td> <td>string</td> <td>IOU VM name</td> </tr>
<tr><td>nvram</td> <td>✔</td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Path of iou binary</td> </tr>
2015-06-10 12:35:53 +00:00
<tr><td>private_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the private-config content relative to project directory</td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
<tr><td>serial_adapters</td> <td>✔</td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
2015-06-10 12:35:53 +00:00
<tr><td>startup_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the startup-config content relative to project directory</td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>use_default_iou_values</td> <td>✔</td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
2015-07-09 14:16:43 +00:00
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>IOU VM UUID</td> </tr>
</table>
Sample session
***** ***** *****
2016-03-07 14:01:35 +00:00
.. literalinclude :: ../../../examples/hypervisor_get_projectsprojectidiouvmsvmid.txt
2015-04-07 14:09:27 +00:00
2016-03-07 16:57:12 +00:00
PUT /v2/hypervisor/projects/**{project_id}** /iou/vms/**{vm_id}**
2016-03-07 14:01:35 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2015-04-07 14:09:27 +00:00
Update a IOU instance
Parameters
***** *****
2016-03-11 14:28:45 +00:00
- **project_id** : UUID for the project
2016-03-11 16:02:50 +00:00
- **vm_id** : UUID for the instance
2015-04-07 14:09:27 +00:00
Response status codes
***** ***** ***** ***** **
- **200** : Instance updated
- **400** : Invalid request
- **404** : Instance doesn't exist
- **409** : Conflict
Input
***** **
.. raw :: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>ethernet_adapters</td> <td> </td> <td>['integer', 'null']</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
2015-07-09 14:16:43 +00:00
<tr><td>iourc_content</td> <td> </td> <td>['string', 'null']</td> <td>Content of the iourc file. Ignored if Null</td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>l1_keepalives</td> <td> </td> <td>['boolean', 'null']</td> <td>Always up ethernet interface</td> </tr>
2015-07-09 14:16:43 +00:00
<tr><td>md5sum</td> <td> </td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>IOU VM name</td> </tr>
<tr><td>nvram</td> <td> </td> <td>['integer', 'null']</td> <td>Allocated NVRAM KB</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Path of iou binary</td> </tr>
2015-06-10 12:35:53 +00:00
<tr><td>private_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Private-config of IOU</td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>ram</td> <td> </td> <td>['integer', 'null']</td> <td>Allocated RAM MB</td> </tr>
<tr><td>serial_adapters</td> <td> </td> <td>['integer', 'null']</td> <td>How many serial adapters are connected to the IOU</td> </tr>
2015-06-10 12:35:53 +00:00
<tr><td>startup_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Startup-config of IOU</td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>use_default_iou_values</td> <td> </td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
</table>
Output
***** **
.. raw :: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-03-04 16:50:17 +00:00
<tr><td>command_line</td> <td>✔</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>ethernet_adapters</td> <td>✔</td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
<tr><td>iourc_path</td> <td> </td> <td>['string', 'null']</td> <td>Path of the iourc file used by remote servers</td> </tr>
<tr><td>l1_keepalives</td> <td>✔</td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
2015-07-09 14:16:43 +00:00
<tr><td>md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>name</td> <td>✔</td> <td>string</td> <td>IOU VM name</td> </tr>
<tr><td>nvram</td> <td>✔</td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Path of iou binary</td> </tr>
2015-06-10 12:35:53 +00:00
<tr><td>private_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the private-config content relative to project directory</td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
<tr><td>serial_adapters</td> <td>✔</td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
2015-06-10 12:35:53 +00:00
<tr><td>startup_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the startup-config content relative to project directory</td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>use_default_iou_values</td> <td>✔</td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
2015-07-09 14:16:43 +00:00
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
2015-04-07 14:09:27 +00:00
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>IOU VM UUID</td> </tr>
</table>
Sample session
***** ***** *****
2016-03-07 14:01:35 +00:00
.. literalinclude :: ../../../examples/hypervisor_put_projectsprojectidiouvmsvmid.txt
2015-04-07 14:09:27 +00:00
2016-03-07 16:57:12 +00:00
DELETE /v2/hypervisor/projects/**{project_id}** /iou/vms/**{vm_id}**
2016-03-07 14:01:35 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2015-04-07 14:09:27 +00:00
Delete a IOU instance
Parameters
***** *****
2016-03-11 14:28:45 +00:00
- **project_id** : UUID for the project
2016-03-11 16:02:50 +00:00
- **vm_id** : UUID for the instance
2015-04-07 14:09:27 +00:00
Response status codes
***** ***** ***** ***** **
- **400** : Invalid request
- **404** : Instance doesn't exist
- **204** : Instance deleted
Sample session
***** ***** *****
2016-03-07 14:01:35 +00:00
.. literalinclude :: ../../../examples/hypervisor_delete_projectsprojectidiouvmsvmid.txt
2015-04-07 14:09:27 +00:00
