mirror of
https://github.com/GNS3/gns3-server.git
synced 2024-12-23 06:32:26 +00:00
9.0 KiB
9.0 KiB
/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
- node_id: Node UUID
- project_id: Project UUID
Response status codes
- 200: Success
- 400: Invalid request
- 404: Instance doesn't exist
Output
Name | Mandatory | Type | Description |
---|---|---|---|
acpi_shutdown | boolean | ACPI shutdown | |
adapter_type | string | VirtualBox 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 | VirtualBox VM instance name |
node_directory | ✔ | ['string', 'null'] | |
node_id | ✔ | string | Node UUID |
project_id | ✔ | string | Project UUID |
ram | integer | Amount of RAM | |
status | enum | Possible values: started, stopped, suspended | |
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
- node_id: Node UUID
- project_id: Project UUID
Response status codes
- 200: Instance updated
- 400: Invalid request
- 404: Instance doesn't exist
- 409: Conflict
Input
Name | Mandatory | Type | Description |
---|---|---|---|
acpi_shutdown | boolean | ACPI shutdown | |
adapter_type | string | VirtualBox 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 | VirtualBox VM instance name | |
ram | integer | Amount of RAM | |
use_any_adapter | boolean | Allow GNS3 to use any VirtualBox adapter | |
vmname | string | VirtualBox VM name (in VirtualBox itself) |
Output
Name | Mandatory | Type | Description |
---|---|---|---|
acpi_shutdown | boolean | ACPI shutdown | |
adapter_type | string | VirtualBox 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 | VirtualBox VM instance name |
node_directory | ✔ | ['string', 'null'] | |
node_id | ✔ | string | Node UUID |
project_id | ✔ | string | Project UUID |
ram | integer | Amount of RAM | |
status | enum | Possible values: started, stopped, suspended | |
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
- node_id: Node UUID
- project_id: Project UUID
Response status codes
- 400: Invalid request
- 404: Instance doesn't exist
- 204: Instance deleted