/v2/compute/projects/{project_id}/vmware/nodes/{node_id} ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: GET /v2/compute/projects/**{project_id}**/vmware/nodes/**{node_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Get a VMware VM instance Parameters ********** - **project_id**: Project UUID - **node_id**: Node UUID 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>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>node_directory</td> <td> </td> <td>['string', 'null']</td> <td></td> </tr> <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> <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> PUT /v2/compute/projects/**{project_id}**/vmware/nodes/**{node_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Update a VMware VM instance Parameters ********** - **project_id**: Project UUID - **node_id**: Node UUID 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>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>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> 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>node_directory</td> <td> </td> <td>['string', 'null']</td> <td></td> </tr> <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> <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> DELETE /v2/compute/projects/**{project_id}**/vmware/nodes/**{node_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Delete a VMware VM instance Parameters ********** - **project_id**: Project UUID - **node_id**: Node UUID Response status codes ********************** - **400**: Invalid request - **404**: Instance doesn't exist - **204**: Instance deleted