mirror of https://github.com/GNS3/gns3-server
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
126 lines
8.5 KiB
126 lines
8.5 KiB
/v1/projects/{project_id}/virtualbox/vms/{vm_id}
|
|
----------------------------------------------------------------------------------------------------------------------
|
|
|
|
.. contents::
|
|
|
|
GET /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Get a VirtualBox VM 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
|
|
*******
|
|
.. raw:: html
|
|
|
|
<table>
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
|
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
|
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
|
|
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
|
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
|
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
|
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance name</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>Amount of RAM</td> </tr>
|
|
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
|
|
<tr><td>vm_directory</td> <td>✔</td> <td>['string', 'null']</td> <td></td> </tr>
|
|
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
|
|
<tr><td>vmname</td> <td> </td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
|
|
</table>
|
|
|
|
Sample session
|
|
***************
|
|
|
|
|
|
.. literalinclude:: ../../examples/get_projectsprojectidvirtualboxvmsvmid.txt
|
|
|
|
|
|
PUT /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Update a VirtualBox VM 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
|
|
*******
|
|
.. raw:: html
|
|
|
|
<table>
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
|
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
|
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
|
|
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
|
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
|
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
|
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
|
<tr><td>name</td> <td> </td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
|
|
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Amount of RAM</td> </tr>
|
|
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
|
|
<tr><td>vmname</td> <td> </td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
|
|
</table>
|
|
|
|
Output
|
|
*******
|
|
.. raw:: html
|
|
|
|
<table>
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
|
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
|
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
|
|
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
|
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
|
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
|
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance name</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>Amount of RAM</td> </tr>
|
|
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
|
|
<tr><td>vm_directory</td> <td>✔</td> <td>['string', 'null']</td> <td></td> </tr>
|
|
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
|
|
<tr><td>vmname</td> <td> </td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
|
|
</table>
|
|
|
|
Sample session
|
|
***************
|
|
|
|
|
|
.. literalinclude:: ../../examples/put_projectsprojectidvirtualboxvmsvmid.txt
|
|
|
|
|
|
DELETE /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Delete a VirtualBox VM 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
|
|
|