/v1/projects/{project_id}/vmware/vms ---------------------------------------------------------------------------------------------------------------------- .. contents:: POST /v1/projects/**{project_id}**/vmware/vms ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Create a new VMware VM instance Parameters ********** - **project_id**: UUID for the project 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> <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>✔</td> <td>boolean</td> <td>either 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> <tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VMware adapter</td> </tr> <tr><td>use_ubridge</td> <td> </td> <td>boolean</td> <td>use uBridge for network connections</td> </tr> <tr><td>vm_id</td> <td> </td> <td>string</td> <td>VMware VM instance identifier</td> </tr> <tr><td>vmx_path</td> <td>✔</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> <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>VMware VM instance name</td> </tr> <tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project 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>use_ubridge</td> <td> </td> <td>boolean</td> <td>use uBridge for network connections</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>VMware VM instance UUID</td> </tr> <tr><td>vmx_path</td> <td> </td> <td>string</td> <td>path to the vmx file</td> </tr> </table>