2020-10-02 06:37:50 +00:00
# -*- coding: utf-8 -*-
#
# Copyright (C) 2020 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/>.
"""
API endpoints for VirtualBox nodes .
"""
import os
2020-10-19 04:30:41 +00:00
from fastapi import APIRouter , WebSocket , Depends , status
2020-10-02 06:37:50 +00:00
from fastapi . encoders import jsonable_encoder
from fastapi . responses import StreamingResponse
from uuid import UUID
2020-10-31 05:32:21 +00:00
from gns3server import schemas
2020-10-02 06:37:50 +00:00
from gns3server . compute . virtualbox import VirtualBox
from gns3server . compute . virtualbox . virtualbox_error import VirtualBoxError
from gns3server . compute . project_manager import ProjectManager
2020-10-14 00:19:29 +00:00
from gns3server . compute . virtualbox . virtualbox_vm import VirtualBoxVM
2020-10-02 06:37:50 +00:00
router = APIRouter ( )
2020-10-14 00:19:29 +00:00
responses = {
404 : { " model " : schemas . ErrorMessage , " description " : " Could not find project or VirtualBox node " }
}
def dep_node ( project_id : UUID , node_id : UUID ) :
"""
Dependency to retrieve a node .
"""
vbox_manager = VirtualBox . instance ( )
node = vbox_manager . get_node ( str ( node_id ) , project_id = str ( project_id ) )
return node
2020-10-02 06:37:50 +00:00
2020-10-19 04:30:41 +00:00
@router.post ( " " ,
2020-10-02 06:37:50 +00:00
response_model = schemas . VirtualBox ,
status_code = status . HTTP_201_CREATED ,
responses = { 409 : { " model " : schemas . ErrorMessage , " description " : " Could not create VirtualBox node " } } )
async def create_virtualbox_node ( project_id : UUID , node_data : schemas . VirtualBoxCreate ) :
"""
Create a new VirtualBox node .
"""
vbox_manager = VirtualBox . instance ( )
node_data = jsonable_encoder ( node_data , exclude_unset = True )
vm = await vbox_manager . create_node ( node_data . pop ( " name " ) ,
str ( project_id ) ,
node_data . get ( " node_id " ) ,
node_data . pop ( " vmname " ) ,
linked_clone = node_data . pop ( " linked_clone " , False ) ,
console = node_data . get ( " console " , None ) ,
console_type = node_data . get ( " console_type " , " telnet " ) ,
adapters = node_data . get ( " adapters " , 0 ) )
if " ram " in node_data :
ram = node_data . pop ( " ram " )
if ram != vm . ram :
await vm . set_ram ( ram )
for name , value in node_data . items ( ) :
if name != " node_id " :
if hasattr ( vm , name ) and getattr ( vm , name ) != value :
setattr ( vm , name , value )
return vm . __json__ ( )
@router.get ( " / {node_id} " ,
response_model = schemas . VirtualBox ,
2020-10-14 00:19:29 +00:00
responses = responses )
def get_virtualbox_node ( node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Return a VirtualBox node .
"""
2020-10-14 00:19:29 +00:00
return node . __json__ ( )
2020-10-02 06:37:50 +00:00
@router.put ( " / {node_id} " ,
response_model = schemas . VirtualBox ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def update_virtualbox_node ( node_data : schemas . VirtualBoxUpdate , node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Update a VirtualBox node .
"""
node_data = jsonable_encoder ( node_data , exclude_unset = True )
if " name " in node_data :
name = node_data . pop ( " name " )
vmname = node_data . pop ( " vmname " , None )
2020-10-14 00:19:29 +00:00
if name != node . name :
oldname = node . name
node . name = name
if node . linked_clone :
2020-10-02 06:37:50 +00:00
try :
2020-10-14 00:19:29 +00:00
await node . set_vmname ( node . name )
2020-10-02 06:37:50 +00:00
except VirtualBoxError as e : # In case of error we rollback (we can't change the name when running)
2020-10-14 00:19:29 +00:00
node . name = oldname
node . updated ( )
2020-10-02 06:37:50 +00:00
raise e
if " adapters " in node_data :
adapters = node_data . pop ( " adapters " )
2020-10-14 00:19:29 +00:00
if adapters != node . adapters :
await node . set_adapters ( adapters )
2020-10-02 06:37:50 +00:00
if " ram " in node_data :
ram = node_data . pop ( " ram " )
2020-10-14 00:19:29 +00:00
if ram != node . ram :
await node . set_ram ( ram )
2020-10-02 06:37:50 +00:00
# update the console first to avoid issue if updating console type
2020-10-14 00:19:29 +00:00
node . console = node_data . pop ( " console " , node . console )
2020-10-02 06:37:50 +00:00
for name , value in node_data . items ( ) :
2020-10-14 00:19:29 +00:00
if hasattr ( node , name ) and getattr ( node , name ) != value :
setattr ( node , name , value )
2020-10-02 06:37:50 +00:00
2020-10-14 00:19:29 +00:00
node . updated ( )
return node . __json__ ( )
2020-10-02 06:37:50 +00:00
@router.delete ( " / {node_id} " ,
status_code = status . HTTP_204_NO_CONTENT ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def delete_virtualbox_node ( node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Delete a VirtualBox node .
"""
2020-10-14 00:19:29 +00:00
await VirtualBox . instance ( ) . delete_node ( node . id )
2020-10-02 06:37:50 +00:00
@router.post ( " / {node_id} /start " ,
status_code = status . HTTP_204_NO_CONTENT ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def start_virtualbox_node ( node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Start a VirtualBox node .
"""
2020-10-14 00:19:29 +00:00
if await node . check_hw_virtualization ( ) :
2020-10-02 06:37:50 +00:00
pm = ProjectManager . instance ( )
2020-10-14 00:19:29 +00:00
if pm . check_hardware_virtualization ( node ) is False :
pass # FIXME: check this
2020-10-02 06:37:50 +00:00
#raise ComputeError("Cannot start VM with hardware acceleration (KVM/HAX) enabled because hardware virtualization (VT-x/AMD-V) is already used by another software like VMware or VirtualBox")
2020-10-14 00:19:29 +00:00
await node . start ( )
2020-10-02 06:37:50 +00:00
@router.post ( " / {node_id} /stop " ,
status_code = status . HTTP_204_NO_CONTENT ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def stop_virtualbox_node ( node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Stop a VirtualBox node .
"""
2020-10-14 00:19:29 +00:00
await node . stop ( )
2020-10-02 06:37:50 +00:00
@router.post ( " / {node_id} /suspend " ,
status_code = status . HTTP_204_NO_CONTENT ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def suspend_virtualbox_node ( node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Suspend a VirtualBox node .
"""
2020-10-14 00:19:29 +00:00
await node . suspend ( )
2020-10-02 06:37:50 +00:00
@router.post ( " / {node_id} /resume " ,
status_code = status . HTTP_204_NO_CONTENT ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def resume_virtualbox_node ( node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Resume a VirtualBox node .
"""
2020-10-14 00:19:29 +00:00
await node . resume ( )
2020-10-02 06:37:50 +00:00
@router.post ( " / {node_id} /reload " ,
status_code = status . HTTP_204_NO_CONTENT ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def reload_virtualbox_node ( node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Reload a VirtualBox node .
"""
2020-10-14 00:19:29 +00:00
await node . reload ( )
2020-10-02 06:37:50 +00:00
@router.post ( " / {node_id} /adapters/ {adapter_number} /ports/ {port_number} /nio " ,
status_code = status . HTTP_201_CREATED ,
response_model = schemas . UDPNIO ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def create_nio ( adapter_number : int ,
port_number : int ,
nio_data : schemas . UDPNIO ,
node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Add a NIO ( Network Input / Output ) to the node .
The port number on the VirtualBox node is always 0.
"""
2020-10-14 00:19:29 +00:00
nio = VirtualBox . instance ( ) . create_nio ( jsonable_encoder ( nio_data , exclude_unset = True ) )
await node . adapter_add_nio_binding ( adapter_number , nio )
2020-10-02 06:37:50 +00:00
return nio . __json__ ( )
@router.put ( " / {node_id} /adapters/ {adapter_number} /ports/ {port_number} /nio " ,
status_code = status . HTTP_201_CREATED ,
response_model = schemas . UDPNIO ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def update_nio ( adapter_number : int ,
port_number : int ,
nio_data : schemas . UDPNIO ,
node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Update a NIO ( Network Input / Output ) on the node .
The port number on the VirtualBox node is always 0.
"""
2020-10-14 00:19:29 +00:00
nio = node . get_nio ( adapter_number )
2020-10-02 06:37:50 +00:00
if nio_data . filters :
nio . filters = nio_data . filters
if nio_data . suspend :
nio . suspend = nio_data . suspend
2020-10-14 00:19:29 +00:00
await node . adapter_update_nio_binding ( adapter_number , nio )
2020-10-02 06:37:50 +00:00
return nio . __json__ ( )
@router.delete ( " / {node_id} /adapters/ {adapter_number} /ports/ {port_number} /nio " ,
status_code = status . HTTP_204_NO_CONTENT ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def delete_nio ( adapter_number : int , port_number : int , node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Delete a NIO ( Network Input / Output ) from the node .
The port number on the VirtualBox node is always 0.
"""
2020-10-14 00:19:29 +00:00
await node . adapter_remove_nio_binding ( adapter_number )
2020-10-02 06:37:50 +00:00
2020-11-02 01:35:32 +00:00
@router.post ( " / {node_id} /adapters/ {adapter_number} /ports/ {port_number} /capture/start " ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def start_capture ( adapter_number : int ,
port_number : int ,
node_capture_data : schemas . NodeCapture ,
node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Start a packet capture on the node .
The port number on the VirtualBox node is always 0.
"""
2020-10-14 00:19:29 +00:00
pcap_file_path = os . path . join ( node . project . capture_working_directory ( ) , node_capture_data . capture_file_name )
await node . start_capture ( adapter_number , pcap_file_path )
2020-10-02 06:37:50 +00:00
return { " pcap_file_path " : str ( pcap_file_path ) }
2020-11-02 01:35:32 +00:00
@router.post ( " / {node_id} /adapters/ {adapter_number} /ports/ {port_number} /capture/stop " ,
2020-10-02 06:37:50 +00:00
status_code = status . HTTP_204_NO_CONTENT ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def stop_capture ( adapter_number : int , port_number : int , node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Stop a packet capture on the node .
The port number on the VirtualBox node is always 0.
"""
2020-10-14 00:19:29 +00:00
await node . stop_capture ( adapter_number )
2020-10-02 06:37:50 +00:00
2020-11-02 01:35:32 +00:00
@router.get ( " / {node_id} /adapters/ {adapter_number} /ports/ {port_number} /capture/stream " ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def stream_pcap_file ( adapter_number : int , port_number : int , node : VirtualBoxVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Stream the pcap capture file .
The port number on the VirtualBox node is always 0.
"""
2020-10-14 00:19:29 +00:00
nio = node . get_nio ( adapter_number )
stream = VirtualBox . instance ( ) . stream_pcap_file ( nio , node . project . id )
2020-10-02 06:37:50 +00:00
return StreamingResponse ( stream , media_type = " application/vnd.tcpdump.pcap " )
2020-10-19 04:30:41 +00:00
@router.websocket ( " / {node_id} /console/ws " )
async def console_ws ( websocket : WebSocket , node : VirtualBoxVM = Depends ( dep_node ) ) :
"""
Console WebSocket .
"""
await node . start_websocket_console ( websocket )
@router.post ( " / {node_id} /console/reset " ,
status_code = status . HTTP_204_NO_CONTENT ,
responses = responses )
async def reset_console ( node : VirtualBoxVM = Depends ( dep_node ) ) :
await node . reset_console ( )