gns3-server/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodes.rst

/v2/compute/projects/{project_id}/virtualbox/nodes

POST /v2/compute/projects/{project_id}/virtualbox/nodes

Create a new VirtualBox VM instance

Parameters

• project_id: Project UUID

Response status codes

• 201: Instance created
• 400: Invalid request
• 409: Conflict

Input

Name	Mandatory	Type	Description
adapter_type		string	VirtualBox adapter type
adapters		integer	Number of adapters
console		['integer', 'null']	Console TCP port
console_type		enum	Possible values: telnet, none
custom_adapters		array
headless		boolean	Headless mode
linked_clone		boolean	Whether the VM is a linked clone or not
name	✔	string	VirtualBox VM instance name
node_id			Node UUID
on_close		enum	Possible values: power_off, shutdown_signal, save_vm_state
ram		integer	Amount of RAM
usage		string	How to use the VirtualBox VM
use_any_adapter		boolean	Allow GNS3 to use any VirtualBox adapter
vmname	✔	string	VirtualBox VM name (in VirtualBox itself)

Output

Name	Mandatory	Type	Description
adapter_type		string	VirtualBox adapter type
adapters		integer	Number of adapters
console		['integer', 'null']	Console TCP port
console_type		enum	Possible values: telnet, none
custom_adapters		array
headless		boolean	Headless mode
linked_clone		boolean	Whether the VM is a linked clone or not
name		string	VirtualBox VM instance name
node_directory		['string', 'null']	Path to the VM working directory
node_id		string	Node UUID
on_close		enum	Possible values: power_off, shutdown_signal, save_vm_state
project_id		string	Project UUID
ram		integer	Amount of RAM
status		enum	Possible values: started, stopped, suspended
usage		string	How to use the VirtualBox VM
use_any_adapter		boolean	Allow GNS3 to use any VirtualBox adapter
vmname		string	VirtualBox VM name (in VirtualBox itself)

Sample session

../../../examples/compute_post_projectsprojectidvirtualboxnodes.txt