1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-11-12 03:18:55 +00:00
gns3-server/docs/api/v2/compute/vmware/projectsprojectidvmwarenodes.rst

61 lines
5.3 KiB
ReStructuredText
Raw Normal View History

/v2/compute/projects/{project_id}/vmware/nodes
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/vmware/nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new VMware VM instance
Parameters
**********
2016-06-04 08:40:39 +00:00
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **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>VMware adapter type</td> </tr>
2016-06-04 08:40:39 +00:00
<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>linked_clone</td> <td>&#10004;</td> <td>boolean</td> <td>Whether the VM is a linked clone or not</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VMware VM instance name</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>Allow GNS3 to use any VMware adapter</td> </tr>
<tr><td>vmx_path</td> <td>&#10004;</td> <td>string</td> <td>Path to the vmx file</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>VMware adapter type</td> </tr>
2016-06-04 08:40:39 +00:00
<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>
2016-07-14 13:31:49 +00:00
<tr><td>linked_clone</td> <td> </td> <td>boolean</td> <td>Whether the VM is a linked clone or not</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>VMware VM instance name</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>node_directory</td> <td> </td> <td>['string', 'null']</td> <td></td> </tr>
2016-07-14 13:31:49 +00:00
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>Allow GNS3 to use any VMware adapter</td> </tr>
<tr><td>vmx_path</td> <td> </td> <td>string</td> <td>Path to the vmx file</td> </tr>
</table>