/v1/hypervisor/projects/{project_id}/vmware/vms/{vm_id} ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: GET /v1/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Get a VMware VM instance Parameters ********** - **vm_id**: UUID for the instance - **project_id**: UUID for the project Response status codes ********************** - **200**: Success - **400**: Invalid request - **404**: Instance doesn't exist Output ******* .. raw:: html
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VMware adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
name string VMware VM instance name
project_id string Project UUID
use_any_adapter boolean allow GNS3 to use any VMware adapter
use_ubridge boolean use uBridge for network connections
vm_directory ['string', 'null']
vm_id string VMware VM instance UUID
vmx_path string path to the vmx file
PUT /v1/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Update a VMware VM instance Parameters ********** - **vm_id**: UUID for the instance - **project_id**: UUID for the project Response status codes ********************** - **200**: Instance updated - **400**: Invalid request - **404**: Instance doesn't exist - **409**: Conflict Input ******* .. raw:: html
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VMware adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
name string VMware VM instance name
use_any_adapter boolean allow GNS3 to use any VMware adapter
use_ubridge boolean use uBridge for network connections
vmx_path string path to the vmx file
Output ******* .. raw:: html
Name Mandatory Type Description
acpi_shutdown boolean ACPI shutdown
adapter_type string VMware adapter type
adapters integer number of adapters
console integer console TCP port
enable_remote_console boolean enable the remote console
headless boolean headless mode
name string VMware VM instance name
project_id string Project UUID
use_any_adapter boolean allow GNS3 to use any VMware adapter
use_ubridge boolean use uBridge for network connections
vm_directory ['string', 'null']
vm_id string VMware VM instance UUID
vmx_path string path to the vmx file
DELETE /v1/hypervisor/projects/**{project_id}**/vmware/vms/**{vm_id}** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Delete a VMware VM instance Parameters ********** - **vm_id**: UUID for the instance - **project_id**: UUID for the project Response status codes ********************** - **400**: Invalid request - **404**: Instance doesn't exist - **204**: Instance deleted