gns3-server/docs/api/v1/vmware/projectsprojectidvmwarevms.rst

/v1/projects/{project_id}/vmware/vms

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

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
linked_clone	✔	boolean	either the VM is a linked clone or not
name	✔	string	VMware VM instance name
use_any_adapter		boolean	allow GNS3 to use any VMware adapter
vm_id		string	VMware VM instance identifier
vmx_path	✔	string	path to the vmx file

Output

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
vm_directory		['string', 'null']
vm_id	✔	string	VMware VM instance UUID
vmx_path		string	path to the vmx file