gns3-server/gns3server/handlers/virtualbox_handler.py

313 lines
10 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 ..web.route import Route
from ..schemas.virtualbox import VBOX_CREATE_SCHEMA
2015-01-23 23:38:46 +00:00
from ..schemas.virtualbox import VBOX_UPDATE_SCHEMA
from ..schemas.virtualbox import VBOX_NIO_SCHEMA
2015-01-24 01:33:49 +00:00
from ..schemas.virtualbox import VBOX_CAPTURE_SCHEMA
from ..schemas.virtualbox import VBOX_OBJECT_SCHEMA
from ..modules.virtualbox import VirtualBox
class VirtualBoxHandler:
2015-01-31 21:34:49 +00:00
"""
API entry points for VirtualBox.
"""
@classmethod
@Route.get(
2015-01-27 03:29:02 +00:00
r"/virtualbox/vms",
status_codes={
200: "Success",
},
description="Get all VirtualBox VMs available")
def show(request, response):
vbox_manager = VirtualBox.instance()
vms = yield from vbox_manager.get_list()
response.json(vms)
@classmethod
@Route.post(
r"/virtualbox",
status_codes={
2015-01-23 23:38:46 +00:00
201: "Instance created",
400: "Invalid project UUID",
409: "Conflict"
},
description="Create a new VirtualBox VM instance",
input=VBOX_CREATE_SCHEMA,
output=VBOX_OBJECT_SCHEMA)
def create(request, response):
vbox_manager = VirtualBox.instance()
vm = yield from vbox_manager.create_vm(request.json.pop("name"),
2015-02-04 01:44:04 +00:00
request.json.pop("project_id"),
request.json.get("uuid"),
request.json.pop("vmname"),
request.json.pop("linked_clone"),
adapters=request.json.get("adapters", 0))
for name, value in request.json.items():
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
@classmethod
@Route.get(
r"/virtualbox/{uuid}",
parameters={
"uuid": "Instance UUID"
},
status_codes={
200: "Success",
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_vm(request.match_info["uuid"])
response.json(vm)
@classmethod
@Route.put(
r"/virtualbox/{uuid}",
parameters={
"uuid": "Instance UUID"
},
status_codes={
200: "Instance updated",
404: "Instance doesn't exist",
409: "Conflict"
},
description="Update a VirtualBox VM instance",
input=VBOX_UPDATE_SCHEMA,
output=VBOX_OBJECT_SCHEMA)
def update(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_vm(request.match_info["uuid"])
for name, value in request.json.items():
if hasattr(vm, name) and getattr(vm, name) != value:
setattr(vm, name, value)
# TODO: FINISH UPDATE (adapters).
response.json(vm)
@classmethod
@Route.delete(
r"/virtualbox/{uuid}",
parameters={
"uuid": "Instance UUID"
},
status_codes={
204: "Instance deleted",
404: "Instance doesn't exist"
},
description="Delete a VirtualBox VM instance")
def delete(request, response):
yield from VirtualBox.instance().delete_vm(request.match_info["uuid"])
response.set_status(204)
@classmethod
@Route.post(
r"/virtualbox/{uuid}/start",
parameters={
2015-01-23 23:38:46 +00:00
"uuid": "Instance UUID"
},
status_codes={
2015-01-23 23:38:46 +00:00
204: "Instance started",
400: "Invalid instance UUID",
404: "Instance doesn't exist"
},
description="Start a VirtualBox VM instance")
def start(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_vm(request.match_info["uuid"])
yield from vm.start()
response.set_status(204)
@classmethod
@Route.post(
r"/virtualbox/{uuid}/stop",
parameters={
2015-01-23 23:38:46 +00:00
"uuid": "Instance UUID"
},
status_codes={
2015-01-23 23:38:46 +00:00
204: "Instance stopped",
400: "Invalid instance UUID",
404: "Instance doesn't exist"
},
description="Stop a VirtualBox VM instance")
def stop(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_vm(request.match_info["uuid"])
yield from vm.stop()
response.set_status(204)
2015-01-22 02:28:52 +00:00
@classmethod
@Route.post(
r"/virtualbox/{uuid}/suspend",
parameters={
2015-01-23 23:38:46 +00:00
"uuid": "Instance UUID"
2015-01-22 02:28:52 +00:00
},
status_codes={
2015-01-23 23:38:46 +00:00
204: "Instance suspended",
400: "Invalid instance UUID",
404: "Instance doesn't exist"
2015-01-22 02:28:52 +00:00
},
description="Suspend a VirtualBox VM instance")
def suspend(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_vm(request.match_info["uuid"])
yield from vm.suspend()
response.set_status(204)
@classmethod
@Route.post(
r"/virtualbox/{uuid}/resume",
parameters={
2015-01-23 23:38:46 +00:00
"uuid": "Instance UUID"
2015-01-22 02:28:52 +00:00
},
status_codes={
2015-01-23 23:38:46 +00:00
204: "Instance resumed",
400: "Invalid instance UUID",
404: "Instance doesn't exist"
2015-01-22 02:28:52 +00:00
},
description="Resume a suspended VirtualBox VM instance")
def suspend(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_vm(request.match_info["uuid"])
yield from vm.resume()
response.set_status(204)
@classmethod
@Route.post(
r"/virtualbox/{uuid}/reload",
parameters={
2015-01-23 23:38:46 +00:00
"uuid": "Instance UUID"
},
status_codes={
2015-01-23 23:38:46 +00:00
204: "Instance reloaded",
400: "Invalid instance UUID",
404: "Instance doesn't exist"
},
description="Reload a VirtualBox VM instance")
def suspend(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_vm(request.match_info["uuid"])
yield from vm.reload()
response.set_status(204)
2015-01-23 23:38:46 +00:00
@Route.post(
r"/virtualbox/{uuid}/adapters/{adapter_id:\d+}/nio",
2015-01-23 23:38:46 +00:00
parameters={
"uuid": "Instance UUID",
"adapter_id": "Adapter where the nio should be added"
2015-01-23 23:38:46 +00:00
},
status_codes={
201: "NIO created",
400: "Invalid instance UUID",
404: "Instance doesn't exist"
},
description="Add a NIO to a VirtualBox VM instance",
input=VBOX_NIO_SCHEMA,
output=VBOX_NIO_SCHEMA)
def create_nio(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_vm(request.match_info["uuid"])
nio = vbox_manager.create_nio(vbox_manager.vboxmanage_path, request.json)
vm.port_add_nio_binding(int(request.match_info["adapter_id"]), nio)
2015-01-23 23:38:46 +00:00
response.set_status(201)
response.json(nio)
@classmethod
@Route.delete(
r"/virtualbox/{uuid}/adapters/{adapter_id:\d+}/nio",
2015-01-23 23:38:46 +00:00
parameters={
"uuid": "Instance UUID",
"adapter_id": "Adapter from where the nio should be removed"
2015-01-23 23:38:46 +00:00
},
status_codes={
204: "NIO deleted",
400: "Invalid instance UUID",
404: "Instance doesn't exist"
},
description="Remove a NIO from a VirtualBox VM instance")
def delete_nio(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_vm(request.match_info["uuid"])
vm.port_remove_nio_binding(int(request.match_info["adapter_id"]))
2015-01-23 23:38:46 +00:00
response.set_status(204)
2015-01-24 01:33:49 +00:00
@Route.post(
r"/virtualbox/{uuid}/capture/{adapter_id:\d+}/start",
2015-01-24 01:33:49 +00:00
parameters={
"uuid": "Instance UUID",
"adapter_id": "Adapter to start a packet capture"
2015-01-24 01:33:49 +00:00
},
status_codes={
200: "Capture started",
400: "Invalid instance UUID",
404: "Instance doesn't exist"
},
description="Start a packet capture on a VirtualBox VM instance",
input=VBOX_CAPTURE_SCHEMA)
def start_capture(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_vm(request.match_info["uuid"])
adapter_id = int(request.match_info["adapter_id"])
2015-01-24 01:33:49 +00:00
pcap_file_path = os.path.join(vm.project.capture_working_directory(), request.json["filename"])
vm.start_capture(adapter_id, pcap_file_path)
response.json({"pcap_file_path": pcap_file_path})
2015-01-24 01:33:49 +00:00
@Route.post(
r"/virtualbox/{uuid}/capture/{adapter_id:\d+}/stop",
2015-01-24 01:33:49 +00:00
parameters={
"uuid": "Instance UUID",
"adapter_id": "Adapter to stop a packet capture"
2015-01-24 01:33:49 +00:00
},
status_codes={
204: "Capture stopped",
400: "Invalid instance UUID",
404: "Instance doesn't exist"
},
description="Stop a packet capture on a VirtualBox VM instance")
def start_capture(request, response):
vbox_manager = VirtualBox.instance()
vm = vbox_manager.get_vm(request.match_info["uuid"])
vm.stop_capture(int(request.match_info["adapter_id"]))
2015-01-24 01:33:49 +00:00
response.set_status(204)