1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-04 22:28:12 +00:00
gns3-server/gns3server/handlers/api/compute/virtualbox_handler.py

427 lines
16 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
#
# Copyright (C) 2015 GNS3 Technologies Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
2015-01-24 01:33:49 +00:00
import os
from aiohttp.web import HTTPConflict
2016-05-14 00:00:07 +00:00
from gns3server.web.route import Route
from gns3server.schemas.nio import NIO_SCHEMA
from gns3server.schemas.node import NODE_CAPTURE_SCHEMA
from gns3server.compute.virtualbox import VirtualBox
from gns3server.compute.virtualbox.virtualbox_error import VirtualBoxError
2016-05-14 00:00:07 +00:00
from gns3server.compute.project_manager import ProjectManager
from gns3server.schemas.virtualbox import (
VBOX_CREATE_SCHEMA,
VBOX_OBJECT_SCHEMA
)
class VirtualBoxHandler:
2015-01-31 21:34:49 +00:00
"""
API entry points for VirtualBox.
"""
@Route.post(
r"/projects/{project_id}/virtualbox/nodes",
2015-02-05 00:13:35 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID"
2015-02-05 00:13:35 +00:00
},
status_codes={
2015-01-23 23:38:46 +00:00
201: "Instance created",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
409: "Conflict"
},
description="Create a new VirtualBox VM instance",
input=VBOX_CREATE_SCHEMA,
output=VBOX_OBJECT_SCHEMA)
async def create(request, response):
vbox_manager = VirtualBox.instance()
vm = await vbox_manager.create_node(request.json.pop("name"),
request.match_info["project_id"],
request.json.get("node_id"),
request.json.pop("vmname"),
2016-11-17 09:17:23 +00:00
linked_clone=request.json.pop("linked_clone", False),
console=request.json.get("console", None),
2018-03-24 11:11:21 +00:00
console_type=request.json.get("console_type", "telnet"),
adapters=request.json.get("adapters", 0))
if "ram" in request.json:
ram = request.json.pop("ram")
if ram != vm.ram:
await vm.set_ram(ram)
for name, value in request.json.items():
if name != "node_id":
if hasattr(vm, name) and getattr(vm, name) != value:
setattr(vm, name, value)
response.set_status(201)
2015-01-21 22:21:15 +00:00
response.json(vm)
2015-01-23 23:38:46 +00:00
@Route.get(
r"/projects/{project_id}/virtualbox/nodes/{node_id}",
2015-01-23 23:38:46 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-01-23 23:38:46 +00:00
},
status_codes={
200: "Success",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-23 23:38:46 +00:00
404: "Instance doesn't exist"
},
description="Get a VirtualBox VM instance",
output=VBOX_OBJECT_SCHEMA)
def show(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
2015-01-23 23:38:46 +00:00
response.json(vm)
@Route.put(
r"/projects/{project_id}/virtualbox/nodes/{node_id}",
2015-01-23 23:38:46 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-01-23 23:38:46 +00:00
},
status_codes={
200: "Instance updated",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-23 23:38:46 +00:00
404: "Instance doesn't exist",
409: "Conflict"
},
description="Update a VirtualBox VM instance",
2016-07-12 14:22:55 +00:00
input=VBOX_OBJECT_SCHEMA,
2015-01-23 23:38:46 +00:00
output=VBOX_OBJECT_SCHEMA)
async def update(request, response):
2015-01-23 23:38:46 +00:00
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
2015-01-23 23:38:46 +00:00
if "name" in request.json:
name = request.json.pop("name")
vmname = request.json.pop("vmname", None)
if name != vm.name:
oldname = vm.name
vm.name = name
if vm.linked_clone:
try:
await vm.set_vmname(vm.name)
except VirtualBoxError as e: # In case of error we rollback (we can't change the name when running)
vm.name = oldname
vm.updated()
raise e
2015-03-05 01:24:15 +00:00
if "adapters" in request.json:
adapters = int(request.json.pop("adapters"))
if adapters != vm.adapters:
await vm.set_adapters(adapters)
2015-03-05 01:24:15 +00:00
if "ram" in request.json:
ram = request.json.pop("ram")
if ram != vm.ram:
await vm.set_ram(ram)
# update the console first to avoid issue if updating console type
vm.console = request.json.pop("console", vm.console)
2015-01-23 23:38:46 +00:00
for name, value in request.json.items():
if hasattr(vm, name) and getattr(vm, name) != value:
setattr(vm, name, value)
2015-02-07 00:31:13 +00:00
vm.updated()
2015-01-23 23:38:46 +00:00
response.json(vm)
@Route.delete(
r"/projects/{project_id}/virtualbox/nodes/{node_id}",
2015-01-23 23:38:46 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-01-23 23:38:46 +00:00
},
status_codes={
204: "Instance deleted",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-23 23:38:46 +00:00
404: "Instance doesn't exist"
},
description="Delete a VirtualBox VM instance")
async def delete(request, response):
2015-01-23 23:38:46 +00:00
2015-02-05 00:13:35 +00:00
# check the project_id exists
ProjectManager.instance().get_project(request.match_info["project_id"])
await VirtualBox.instance().delete_node(request.match_info["node_id"])
2015-01-23 23:38:46 +00:00
response.set_status(204)
@Route.post(
r"/projects/{project_id}/virtualbox/nodes/{node_id}/start",
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
},
status_codes={
2015-01-23 23:38:46 +00:00
204: "Instance started",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-23 23:38:46 +00:00
404: "Instance doesn't exist"
},
description="Start a VirtualBox VM instance")
async def start(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
if (await vm.check_hw_virtualization()):
pm = ProjectManager.instance()
if pm.check_hardware_virtualization(vm) is False:
raise HTTPConflict(text="Cannot start VM because hardware virtualization (VT-x/AMD-V) is already used by another software like VMware or KVM (on Linux)")
await vm.start()
response.set_status(204)
@Route.post(
r"/projects/{project_id}/virtualbox/nodes/{node_id}/stop",
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
},
status_codes={
2015-01-23 23:38:46 +00:00
204: "Instance stopped",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-23 23:38:46 +00:00
404: "Instance doesn't exist"
},
description="Stop a VirtualBox VM instance")
async def stop(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.stop()
response.set_status(204)
2015-01-22 02:28:52 +00:00
@Route.post(
r"/projects/{project_id}/virtualbox/nodes/{node_id}/suspend",
2015-01-22 02:28:52 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-01-22 02:28:52 +00:00
},
status_codes={
2015-01-23 23:38:46 +00:00
204: "Instance suspended",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-23 23:38:46 +00:00
404: "Instance doesn't exist"
2015-01-22 02:28:52 +00:00
},
description="Suspend a VirtualBox VM instance")
async def suspend(request, response):
2015-01-22 02:28:52 +00:00
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.suspend()
2015-01-22 02:28:52 +00:00
response.set_status(204)
@Route.post(
r"/projects/{project_id}/virtualbox/nodes/{node_id}/resume",
2015-01-22 02:28:52 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
2015-01-22 02:28:52 +00:00
},
status_codes={
2015-01-23 23:38:46 +00:00
204: "Instance resumed",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-23 23:38:46 +00:00
404: "Instance doesn't exist"
2015-01-22 02:28:52 +00:00
},
description="Resume a suspended VirtualBox VM instance")
async def resume(request, response):
2015-01-22 02:28:52 +00:00
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.resume()
2015-01-22 02:28:52 +00:00
response.set_status(204)
@Route.post(
r"/projects/{project_id}/virtualbox/nodes/{node_id}/reload",
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID"
},
status_codes={
2015-01-23 23:38:46 +00:00
204: "Instance reloaded",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-23 23:38:46 +00:00
404: "Instance doesn't exist"
},
description="Reload a VirtualBox VM instance")
async def reload(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
await vm.reload()
response.set_status(204)
2015-01-23 23:38:46 +00:00
@Route.post(
r"/projects/{project_id}/virtualbox/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio",
2015-01-23 23:38:46 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID",
2015-02-13 22:11:14 +00:00
"adapter_number": "Adapter where the nio should be added",
"port_number": "Port on the adapter (always 0)"
2015-01-23 23:38:46 +00:00
},
status_codes={
201: "NIO created",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-23 23:38:46 +00:00
404: "Instance doesn't exist"
},
description="Add a NIO to a VirtualBox VM instance",
input=NIO_SCHEMA,
output=NIO_SCHEMA)
async def create_nio(request, response):
2015-01-23 23:38:46 +00:00
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
nio_type = request.json["type"]
2015-05-06 21:21:39 +00:00
if nio_type not in ("nio_udp", "nio_nat"):
raise HTTPConflict(text="NIO of type {} is not supported".format(nio_type))
nio = vbox_manager.create_nio(request.json)
await vm.adapter_add_nio_binding(int(request.match_info["adapter_number"]), nio)
2015-01-23 23:38:46 +00:00
response.set_status(201)
response.json(nio)
@Route.put(
r"/projects/{project_id}/virtualbox/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
"adapter_number": "Network adapter where the nio is located",
"port_number": "Port from where the nio should be updated"
},
status_codes={
201: "NIO updated",
400: "Invalid request",
404: "Instance doesn't exist"
},
input=NIO_SCHEMA,
output=NIO_SCHEMA,
description="Update a NIO on a Virtualbox instance")
async def update_nio(request, response):
virtualbox_manager = VirtualBox.instance()
vm = virtualbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
adapter_number = int(request.match_info["adapter_number"])
nio = vm.get_nio(adapter_number)
if "filters" in request.json:
nio.filters = request.json["filters"]
if "suspend" in request.json:
nio.suspend = request.json["suspend"]
await vm.adapter_update_nio_binding(adapter_number, nio)
response.set_status(201)
response.json(request.json)
2015-01-23 23:38:46 +00:00
@Route.delete(
r"/projects/{project_id}/virtualbox/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio",
2015-01-23 23:38:46 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID",
2015-02-13 22:11:14 +00:00
"adapter_number": "Adapter from where the nio should be removed",
2015-03-07 03:08:00 +00:00
"port_number": "Port on the adapter (always 0)"
2015-01-23 23:38:46 +00:00
},
status_codes={
204: "NIO deleted",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-23 23:38:46 +00:00
404: "Instance doesn't exist"
},
description="Remove a NIO from a VirtualBox VM instance")
async def delete_nio(request, response):
2015-01-23 23:38:46 +00:00
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
adapter_number = int(request.match_info["adapter_number"])
await vm.adapter_remove_nio_binding(adapter_number)
2015-01-23 23:38:46 +00:00
response.set_status(204)
2015-01-24 01:33:49 +00:00
@Route.post(
r"/projects/{project_id}/virtualbox/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture",
2015-01-24 01:33:49 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID",
2015-02-13 22:11:14 +00:00
"adapter_number": "Adapter to start a packet capture",
"port_number": "Port on the adapter (always 0)"
2015-01-24 01:33:49 +00:00
},
status_codes={
200: "Capture started",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-24 01:33:49 +00:00
404: "Instance doesn't exist"
},
description="Start a packet capture on a VirtualBox VM instance",
input=NODE_CAPTURE_SCHEMA)
async def start_capture(request, response):
2015-01-24 01:33:49 +00:00
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
2015-02-13 22:11:14 +00:00
adapter_number = int(request.match_info["adapter_number"])
2015-02-08 21:44:56 +00:00
pcap_file_path = os.path.join(vm.project.capture_working_directory(), request.json["capture_file_name"])
await vm.start_capture(adapter_number, pcap_file_path)
response.json({"pcap_file_path": pcap_file_path})
2015-01-24 01:33:49 +00:00
@Route.post(
r"/projects/{project_id}/virtualbox/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture",
2015-01-24 01:33:49 +00:00
parameters={
2016-05-14 00:00:07 +00:00
"project_id": "Project UUID",
"node_id": "Node UUID",
2015-02-13 22:11:14 +00:00
"adapter_number": "Adapter to stop a packet capture",
"port_number": "Port on the adapter (always 0)"
2015-01-24 01:33:49 +00:00
},
status_codes={
204: "Capture stopped",
2015-02-05 00:13:35 +00:00
400: "Invalid request",
2015-01-24 01:33:49 +00:00
404: "Instance doesn't exist"
},
description="Stop a packet capture on a VirtualBox VM instance")
async def stop_capture(request, response):
2015-01-24 01:33:49 +00:00
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
adapter_number = int(request.match_info["adapter_number"])
await vm.stop_capture(adapter_number)
2015-01-24 01:33:49 +00:00
response.set_status(204)
2016-05-14 00:00:07 +00:00
@Route.get(
r"/projects/{project_id}/virtualbox/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap",
description="Stream the pcap capture file",
parameters={
"project_id": "Project UUID",
"node_id": "Node UUID",
"adapter_number": "Adapter to steam a packet capture",
"port_number": "Port on the adapter (always 0)"
},
status_codes={
200: "File returned",
403: "Permission denied",
404: "The file doesn't exist"
})
async def stream_pcap_file(request, response):
virtualbox_manager = VirtualBox.instance()
vm = virtualbox_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
adapter_number = int(request.match_info["adapter_number"])
nio = vm.get_nio(adapter_number)
await virtualbox_manager.stream_pcap_file(nio, vm.project.id, request, response)
2016-05-14 00:00:07 +00:00
@Route.get(
r"/virtualbox/vms",
status_codes={
200: "Success",
},
description="Get all available VirtualBox VMs")
async def get_vms(request, response):
2016-05-14 00:00:07 +00:00
vbox_manager = VirtualBox.instance()
vms = await vbox_manager.list_vms()
2016-05-14 00:00:07 +00:00
response.json(vms)