2015-01-20 01:30:57 +00:00
# -*- 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
2015-07-22 04:58:28 +00:00
2015-04-27 20:19:17 +00:00
from aiohttp . web import HTTPConflict
2016-03-07 14:01:35 +00:00
from . . . . web . route import Route
from . . . . schemas . nio import NIO_SCHEMA
from . . . . schemas . virtualbox import VBOX_CREATE_SCHEMA
from . . . . schemas . virtualbox import VBOX_UPDATE_SCHEMA
from . . . . schemas . virtualbox import VBOX_OBJECT_SCHEMA
2016-05-11 17:35:36 +00:00
from . . . . schemas . node import NODE_CAPTURE_SCHEMA
2016-04-15 15:57:06 +00:00
from . . . . compute . virtualbox import VirtualBox
from . . . . compute . project_manager import ProjectManager
2015-01-20 01:30:57 +00:00
class VirtualBoxHandler :
2015-01-31 21:34:49 +00:00
2015-01-20 01:30:57 +00:00
"""
API entry points for VirtualBox .
"""
2015-01-24 00:57:54 +00:00
@classmethod
@Route.get (
2015-02-05 00:13:35 +00:00
r " /virtualbox/vms " ,
2015-01-24 00:57:54 +00:00
status_codes = {
200 : " Success " ,
} ,
2016-05-11 17:35:36 +00:00
description = " Get all available VirtualBox VMs " )
2015-11-09 11:14:25 +00:00
def index ( request , response ) :
2015-01-24 00:57:54 +00:00
vbox_manager = VirtualBox . instance ( )
2016-05-11 22:45:17 +00:00
vms = yield from vbox_manager . list_images ( )
2015-01-24 00:57:54 +00:00
response . json ( vms )
2015-01-20 01:30:57 +00:00
@classmethod
@Route.post (
2016-05-11 17:35:36 +00:00
r " /projects/ {project_id} /virtualbox/nodes " ,
2015-02-05 00:13:35 +00:00
parameters = {
" project_id " : " UUID for the project "
} ,
2015-01-20 01:30:57 +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 " ,
2015-01-20 01:30:57 +00:00
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 ( )
2016-05-11 17:35:36 +00:00
vm = yield from vbox_manager . create_node ( request . json . pop ( " name " ) ,
request . match_info [ " project_id " ] ,
request . json . get ( " node_id " ) ,
request . json . pop ( " vmname " ) ,
request . json . pop ( " linked_clone " ) ,
console = request . json . get ( " console " , None ) ,
adapters = request . json . get ( " adapters " , 0 ) )
2015-01-31 02:36:05 +00:00
2015-03-03 00:28:28 +00:00
if " enable_remote_console " in request . json :
yield from vm . set_enable_remote_console ( request . json . pop ( " enable_remote_console " ) )
2015-03-13 23:13:36 +00:00
if " ram " in request . json :
ram = request . json . pop ( " ram " )
if ram != vm . ram :
yield from vm . set_ram ( ram )
2015-01-31 02:36:05 +00:00
for name , value in request . json . items ( ) :
2016-05-11 17:35:36 +00:00
if name != " node_id " :
2015-04-14 12:24:13 +00:00
if hasattr ( vm , name ) and getattr ( vm , name ) != value :
setattr ( vm , name , value )
2015-01-31 02:36:05 +00:00
2015-01-21 21:01:15 +00:00
response . set_status ( 201 )
2015-01-21 22:21:15 +00:00
response . json ( vm )
2015-01-20 01:30:57 +00:00
2015-01-23 23:38:46 +00:00
@classmethod
@Route.get (
2016-05-11 17:35:36 +00:00
r " /projects/ {project_id} /virtualbox/nodes/ {node_id} " ,
2015-01-23 23:38:46 +00:00
parameters = {
2015-02-05 00:13:35 +00:00
" project_id " : " UUID for the project " ,
2016-05-11 17:35:36 +00:00
" node_id " : " UUID for the instance "
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 ( )
2016-05-11 17:35:36 +00:00
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 )
@classmethod
@Route.put (
2016-05-11 17:35:36 +00:00
r " /projects/ {project_id} /virtualbox/nodes/ {node_id} " ,
2015-01-23 23:38:46 +00:00
parameters = {
2015-02-05 00:13:35 +00:00
" project_id " : " UUID for the project " ,
2016-05-11 17:35:36 +00:00
" node_id " : " UUID for the instance "
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 " ,
input = VBOX_UPDATE_SCHEMA ,
output = VBOX_OBJECT_SCHEMA )
def update ( request , response ) :
vbox_manager = VirtualBox . instance ( )
2016-05-11 17:35:36 +00:00
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
2015-03-08 18:32:36 +00:00
if " vmname " in request . json :
vmname = request . json . pop ( " vmname " )
if vmname != vm . vmname :
yield from vm . set_vmname ( vmname )
2015-03-03 00:28:28 +00:00
if " enable_remote_console " in request . json :
yield from vm . set_enable_remote_console ( request . json . pop ( " enable_remote_console " ) )
2015-03-05 01:24:15 +00:00
if " adapters " in request . json :
adapters = int ( request . json . pop ( " adapters " ) )
if adapters != vm . adapters :
yield from vm . set_adapters ( adapters )
2015-03-13 23:13:36 +00:00
if " ram " in request . json :
ram = request . json . pop ( " ram " )
if ram != vm . ram :
yield from vm . set_ram ( ram )
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
2015-01-23 23:38:46 +00:00
response . json ( vm )
@classmethod
@Route.delete (
2016-05-11 17:35:36 +00:00
r " /projects/ {project_id} /virtualbox/nodes/ {node_id} " ,
2015-01-23 23:38:46 +00:00
parameters = {
2015-02-05 00:13:35 +00:00
" project_id " : " UUID for the project " ,
2016-05-11 17:35:36 +00:00
" node_id " : " UUID for the instance "
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 " )
def delete ( request , response ) :
2015-02-05 00:13:35 +00:00
# check the project_id exists
ProjectManager . instance ( ) . get_project ( request . match_info [ " project_id " ] )
2016-05-11 17:35:36 +00:00
yield from VirtualBox . instance ( ) . delete_node ( request . match_info [ " node_id " ] )
2015-01-23 23:38:46 +00:00
response . set_status ( 204 )
2015-01-20 01:30:57 +00:00
@classmethod
@Route.post (
2016-05-11 17:35:36 +00:00
r " /projects/ {project_id} /virtualbox/nodes/ {node_id} /start " ,
2015-01-20 01:30:57 +00:00
parameters = {
2015-02-05 00:13:35 +00:00
" project_id " : " UUID for the project " ,
2016-05-11 17:35:36 +00:00
" node_id " : " UUID for the instance "
2015-01-20 01:30:57 +00:00
} ,
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 "
2015-01-20 01:30:57 +00:00
} ,
description = " Start a VirtualBox VM instance " )
2015-01-22 00:41:35 +00:00
def start ( request , response ) :
2015-01-20 01:30:57 +00:00
vbox_manager = VirtualBox . instance ( )
2016-05-11 17:35:36 +00:00
vm = vbox_manager . get_node ( request . match_info [ " node_id " ] , project_id = request . match_info [ " project_id " ] )
2015-07-27 01:21:30 +00:00
if ( yield from vm . check_hw_virtualization ( ) ) :
2015-07-22 04:58:28 +00:00
pm = ProjectManager . instance ( )
if pm . check_hardware_virtualization ( vm ) is False :
2015-07-27 01:21:30 +00:00
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) " )
2015-01-22 00:41:35 +00:00
yield from vm . start ( )
2015-01-21 21:01:15 +00:00
response . set_status ( 204 )
2015-01-20 01:30:57 +00:00
@classmethod
@Route.post (
2016-05-11 17:35:36 +00:00
r " /projects/ {project_id} /virtualbox/nodes/ {node_id} /stop " ,
2015-01-20 01:30:57 +00:00
parameters = {
2015-02-05 00:13:35 +00:00
" project_id " : " UUID for the project " ,
2016-05-11 17:35:36 +00:00
" node_id " : " UUID for the instance "
2015-01-20 01:30:57 +00:00
} ,
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 "
2015-01-20 01:30:57 +00:00
} ,
description = " Stop a VirtualBox VM instance " )
2015-01-22 00:41:35 +00:00
def stop ( request , response ) :
2015-01-20 01:30:57 +00:00
vbox_manager = VirtualBox . instance ( )
2016-05-11 17:35:36 +00:00
vm = vbox_manager . get_node ( request . match_info [ " node_id " ] , project_id = request . match_info [ " project_id " ] )
2015-01-22 00:41:35 +00:00
yield from vm . stop ( )
2015-01-21 21:01:15 +00:00
response . set_status ( 204 )
2015-01-22 02:28:52 +00:00
@classmethod
@Route.post (
2016-05-11 17:35:36 +00:00
r " /projects/ {project_id} /virtualbox/nodes/ {node_id} /suspend " ,
2015-01-22 02:28:52 +00:00
parameters = {
2015-02-05 00:13:35 +00:00
" project_id " : " UUID for the project " ,
2016-05-11 17:35:36 +00:00
" node_id " : " UUID for the instance "
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 " )
def suspend ( request , response ) :
vbox_manager = VirtualBox . instance ( )
2016-05-11 17:35:36 +00:00
vm = vbox_manager . get_node ( request . match_info [ " node_id " ] , project_id = request . match_info [ " project_id " ] )
2015-01-22 02:28:52 +00:00
yield from vm . suspend ( )
response . set_status ( 204 )
@classmethod
@Route.post (
2016-05-11 17:35:36 +00:00
r " /projects/ {project_id} /virtualbox/nodes/ {node_id} /resume " ,
2015-01-22 02:28:52 +00:00
parameters = {
2015-02-05 00:13:35 +00:00
" project_id " : " UUID for the project " ,
2016-05-11 17:35:36 +00:00
" node_id " : " UUID for the instance "
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 " )
2015-05-01 01:05:37 +00:00
def resume ( request , response ) :
2015-01-22 02:28:52 +00:00
vbox_manager = VirtualBox . instance ( )
2016-05-11 17:35:36 +00:00
vm = vbox_manager . get_node ( request . match_info [ " node_id " ] , project_id = request . match_info [ " project_id " ] )
2015-01-22 02:28:52 +00:00
yield from vm . resume ( )
response . set_status ( 204 )
2015-01-23 02:06:17 +00:00
@classmethod
@Route.post (
2016-05-11 17:35:36 +00:00
r " /projects/ {project_id} /virtualbox/nodes/ {node_id} /reload " ,
2015-01-23 02:06:17 +00:00
parameters = {
2015-02-05 00:13:35 +00:00
" project_id " : " UUID for the project " ,
2016-05-11 17:35:36 +00:00
" node_id " : " UUID for the instance "
2015-01-23 02:06:17 +00:00
} ,
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 "
2015-01-23 02:06:17 +00:00
} ,
description = " Reload a VirtualBox VM instance " )
2015-02-05 00:13:35 +00:00
def reload ( request , response ) :
2015-01-23 02:06:17 +00:00
vbox_manager = VirtualBox . instance ( )
2016-05-11 17:35:36 +00:00
vm = vbox_manager . get_node ( request . match_info [ " node_id " ] , project_id = request . match_info [ " project_id " ] )
2015-01-23 02:06:17 +00:00
yield from vm . reload ( )
response . set_status ( 204 )
2015-01-23 23:38:46 +00:00
@Route.post (
2016-05-11 17:35:36 +00:00
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 = {
2015-02-05 00:13:35 +00:00
" project_id " : " UUID for the project " ,
2016-05-11 17:35:36 +00:00
" node_id " : " UUID for the instance " ,
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 " ,
2015-04-27 20:19:17 +00:00
input = NIO_SCHEMA ,
output = NIO_SCHEMA )
2015-01-23 23:38:46 +00:00
def create_nio ( request , response ) :
vbox_manager = VirtualBox . instance ( )
2016-05-11 17:35:36 +00:00
vm = vbox_manager . get_node ( request . match_info [ " node_id " ] , project_id = request . match_info [ " project_id " ] )
2015-04-27 20:19:17 +00:00
nio_type = request . json [ " type " ]
2015-05-06 21:21:39 +00:00
if nio_type not in ( " nio_udp " , " nio_nat " ) :
2015-04-27 20:19:17 +00:00
raise HTTPConflict ( text = " NIO of type {} is not supported " . format ( nio_type ) )
2015-01-24 00:57:54 +00:00
nio = vbox_manager . create_nio ( vbox_manager . vboxmanage_path , request . json )
2015-02-13 22:11:14 +00:00
yield from 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 )
@classmethod
@Route.delete (
2016-05-11 17:35:36 +00:00
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 = {
2015-02-05 00:13:35 +00:00
" project_id " : " UUID for the project " ,
2016-05-11 17:35:36 +00:00
" node_id " : " UUID for the instance " ,
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 " )
def delete_nio ( request , response ) :
vbox_manager = VirtualBox . instance ( )
2016-05-11 17:35:36 +00:00
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
yield from vm . adapter_remove_nio_binding ( int ( request . match_info [ " adapter_number " ] ) )
2015-01-23 23:38:46 +00:00
response . set_status ( 204 )
2015-01-24 01:33:49 +00:00
@Route.post (
2016-05-11 17:35:36 +00:00
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 = {
2015-02-05 00:13:35 +00:00
" project_id " : " UUID for the project " ,
2016-05-11 17:35:36 +00:00
" node_id " : " UUID for the instance " ,
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 " ,
2016-05-11 17:35:36 +00:00
input = NODE_CAPTURE_SCHEMA )
2015-01-24 01:33:49 +00:00
def start_capture ( request , response ) :
vbox_manager = VirtualBox . instance ( )
2016-05-11 17:35:36 +00:00
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 " ] )
2015-05-27 19:56:27 +00:00
yield from vm . start_capture ( adapter_number , pcap_file_path )
2015-01-31 19:01:23 +00:00
response . json ( { " pcap_file_path " : pcap_file_path } )
2015-01-24 01:33:49 +00:00
@Route.post (
2016-05-11 17:35:36 +00:00
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 = {
2015-02-05 00:13:35 +00:00
" project_id " : " UUID for the project " ,
2016-05-11 17:35:36 +00:00
" node_id " : " UUID for the instance " ,
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 " )
2015-02-16 23:53:50 +00:00
def stop_capture ( request , response ) :
2015-01-24 01:33:49 +00:00
vbox_manager = VirtualBox . instance ( )
2016-05-11 17:35:36 +00:00
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
vm . stop_capture ( int ( request . match_info [ " adapter_number " ] ) )
2015-01-24 01:33:49 +00:00
response . set_status ( 204 )