2015-02-13 17:27:08 +00:00
/v1/projects/{project_id}/iou/vms/{vm_id}
2015-02-17 09:37:09 +00:00
----------------------------------------------------------------------------------------------------------------------
2015-02-13 17:27:08 +00:00
.. contents ::
GET /v1/projects/**{project_id}** /iou/vms/**{vm_id}**
2015-02-17 09:37:09 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2015-02-13 17:27:08 +00:00
Get a IOU instance
Parameters
***** *****
- **project_id** : UUID for the project
2015-02-19 19:23:27 +00:00
- **vm_id** : UUID for the instance
2015-02-13 17:27:08 +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>
<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>
2015-02-18 10:06:13 +00:00
<tr><td>initial_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the initial config content relative to project directory</td> </tr>
2015-02-13 17:27:08 +00:00
<tr><td>l1_keepalives</td> <td>✔</td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
<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>
<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>
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>IOU VM UUID</td> </tr>
</table>
2015-02-24 10:38:57 +00:00
Sample session
***** ***** *****
.. literalinclude :: ../../examples/get_projectsprojectidiouvmsvmid.txt
2015-02-13 17:27:08 +00:00
PUT /v1/projects/**{project_id}** /iou/vms/**{vm_id}**
2015-02-17 09:37:09 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2015-02-13 17:27:08 +00:00
Update a IOU instance
Parameters
***** *****
- **project_id** : UUID for the project
2015-02-19 19:23:27 +00:00
- **vm_id** : UUID for the instance
2015-02-13 17:27:08 +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-02-18 10:06:13 +00:00
<tr><td>initial_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Initial configuration of the IOU</td> </tr>
2015-02-13 17:27:08 +00:00
<tr><td>l1_keepalives</td> <td> </td> <td>['boolean', 'null']</td> <td>Always up ethernet interface</td> </tr>
<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>
<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>
</table>
Output
***** **
.. 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</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>
2015-02-18 10:06:13 +00:00
<tr><td>initial_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the initial config content relative to project directory</td> </tr>
2015-02-13 17:27:08 +00:00
<tr><td>l1_keepalives</td> <td>✔</td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
<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>
<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>
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>IOU VM UUID</td> </tr>
</table>
2015-02-24 10:38:57 +00:00
Sample session
***** ***** *****
.. literalinclude :: ../../examples/put_projectsprojectidiouvmsvmid.txt
2015-02-13 17:27:08 +00:00
DELETE /v1/projects/**{project_id}** /iou/vms/**{vm_id}**
2015-02-17 09:37:09 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2015-02-13 17:27:08 +00:00
Delete a IOU instance
Parameters
***** *****
- **project_id** : UUID for the project
2015-02-19 19:23:27 +00:00
- **vm_id** : UUID for the instance
2015-02-13 17:27:08 +00:00
Response status codes
***** ***** ***** ***** **
- **400** : Invalid request
- **404** : Instance doesn't exist
- **204** : Instance deleted
2015-02-24 10:38:57 +00:00
Sample session
***** ***** *****
.. literalinclude :: ../../examples/delete_projectsprojectidiouvmsvmid.txt
