gns3-server/docs/api/v2/controller/vm/projectsprojectidvms.rst

/v2/controller/projects/{project_id}/vms

POST /v2/controller/projects/{project_id}/vms

Create a new VM instance

Parameters

• project_id: UUID for the project

Response status codes

• 400: Invalid request
• 201: Instance created

Input

Name	Mandatory	Type	Description
console		['integer', 'null']	Console TCP port
console_type		enum	Possible values: serial, vnc, telnet
hypervisor_id	✔	string	Hypervisor identifier
name	✔	string	VM name
project_id		string	Project identifier
properties		object	Properties specific to an emulator
vm_id		string	VM identifier
vm_type	✔	enum	Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou

Output

Name	Mandatory	Type	Description
console		['integer', 'null']	Console TCP port
console_type		enum	Possible values: serial, vnc, telnet
hypervisor_id	✔	string	Hypervisor identifier
name	✔	string	VM name
project_id		string	Project identifier
properties		object	Properties specific to an emulator
vm_id		string	VM identifier
vm_type	✔	enum	Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou

Sample session

../../../examples/controller_post_projectsprojectidvms.txt