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

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

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

Get a VirtualBox 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

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_get_projectsprojectidvirtualboxnodesnodeid.txt

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

Update a VirtualBox 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

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)

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_put_projectsprojectidvirtualboxnodesnodeid.txt

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

Delete a VirtualBox VM instance

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

• 204: Instance deleted
• 400: Invalid request
• 404: Instance doesn't exist