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 Qemu nodes .
"""
import os
import sys
2020-10-14 00:19:29 +00:00
from fastapi import APIRouter , Depends , Body , status
2020-10-02 06:37:50 +00:00
from fastapi . encoders import jsonable_encoder
from fastapi . responses import StreamingResponse
from uuid import UUID
from gns3server . endpoints import schemas
from gns3server . compute . project_manager import ProjectManager
from gns3server . compute . compute_error import ComputeError
from gns3server . compute . qemu import Qemu
2020-10-14 00:19:29 +00:00
from gns3server . compute . qemu . qemu_vm import QemuVM
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 Qemu node " }
}
def dep_node ( project_id : UUID , node_id : UUID ) :
"""
Dependency to retrieve a node .
"""
qemu_manager = Qemu . instance ( )
node = qemu_manager . get_node ( str ( node_id ) , project_id = str ( project_id ) )
return node
2020-10-02 06:37:50 +00:00
@router.post ( " / " ,
response_model = schemas . Qemu ,
status_code = status . HTTP_201_CREATED ,
responses = { 409 : { " model " : schemas . ErrorMessage , " description " : " Could not create Qemu node " } } )
async def create_qemu_node ( project_id : UUID , node_data : schemas . QemuCreate ) :
"""
Create a new Qemu node .
"""
qemu = Qemu . instance ( )
node_data = jsonable_encoder ( node_data , exclude_unset = True )
vm = await qemu . create_node ( node_data . pop ( " name " ) ,
str ( project_id ) ,
node_data . pop ( " node_id " , None ) ,
linked_clone = node_data . get ( " linked_clone " , True ) ,
qemu_path = node_data . pop ( " qemu_path " , None ) ,
console = node_data . pop ( " console " , None ) ,
console_type = node_data . pop ( " console_type " , " telnet " ) ,
aux = node_data . get ( " aux " ) ,
aux_type = node_data . pop ( " aux_type " , " none " ) ,
platform = node_data . pop ( " platform " , None ) )
for name , value in node_data . items ( ) :
if hasattr ( vm , name ) and getattr ( vm , name ) != value :
setattr ( vm , name , value )
return vm . __json__ ( )
@router.get ( " / {node_id} " ,
response_model = schemas . Qemu ,
2020-10-14 00:19:29 +00:00
responses = responses )
def get_qemu_node ( node : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Return a Qemu 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 . Qemu ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def update_qemu_node ( node_data : schemas . QemuUpdate , node : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Update a Qemu node .
"""
node_data = jsonable_encoder ( node_data , exclude_unset = True )
# 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 :
await node . update_property ( name , value )
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_qemu_node ( node : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Delete a Qemu node .
"""
2020-10-14 00:19:29 +00:00
await Qemu . instance ( ) . delete_node ( node . id )
2020-10-02 06:37:50 +00:00
@router.post ( " / {node_id} /duplicate " ,
response_model = schemas . Qemu ,
status_code = status . HTTP_201_CREATED ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def duplicate_qemu_node ( destination_node_id : UUID = Body ( . . . , embed = True ) , node : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Duplicate a Qemu node .
"""
2020-10-14 00:19:29 +00:00
new_node = await Qemu . instance ( ) . duplicate_node ( node . id , str ( destination_node_id ) )
2020-10-02 06:37:50 +00:00
return new_node . __json__ ( )
@router.post ( " / {node_id} /resize_disk " ,
status_code = status . HTTP_204_NO_CONTENT ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def resize_qemu_node_disk ( node_data : schemas . QemuDiskResize , node : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
2020-10-14 00:19:29 +00:00
await node . resize_disk ( node_data . drive_name , node_data . extend )
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_qemu_node ( node : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Start a Qemu node .
"""
qemu_manager = Qemu . instance ( )
hardware_accel = qemu_manager . config . get_section_config ( " Qemu " ) . getboolean ( " enable_hardware_acceleration " , True )
if sys . platform . startswith ( " linux " ) :
# the enable_kvm option was used before version 2.0 and has priority
enable_kvm = qemu_manager . config . get_section_config ( " Qemu " ) . getboolean ( " enable_kvm " )
if enable_kvm is not None :
hardware_accel = enable_kvm
2020-10-14 00:19:29 +00:00
if hardware_accel and " -no-kvm " not in node . options and " -no-hax " not in node . options :
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 :
2020-10-02 06:37:50 +00:00
pass #FIXME: check this
#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_qemu_node ( node : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Stop a Qemu node .
"""
2020-10-14 00:19:29 +00:00
await node . stop ( )
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_qemu_node ( node : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Reload a Qemu node .
"""
2020-10-14 00:19:29 +00:00
await node . reload ( )
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_qemu_node ( node : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Suspend a Qemu 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_qemu_node ( node : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Resume a Qemu node .
"""
2020-10-14 00:19:29 +00:00
await node . resume ( )
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 : QemuVM = 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 Qemu node is always 0.
"""
2020-10-14 00:19:29 +00:00
nio = Qemu . 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 : QemuVM = 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 Qemu 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 : QemuVM = 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 Qemu 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
@router.post ( " / {node_id} /adapters/ {adapter_number} /ports/ {port_number} /start_capture " ,
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 : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Start a packet capture on the node .
The port number on the Qemu 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 ) }
@router.post ( " / {node_id} /adapters/ {adapter_number} /ports/ {port_number} /stop_capture " ,
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 : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Stop a packet capture on the node .
The port number on the Qemu 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
@router.post ( " / {node_id} /console/reset " ,
status_code = status . HTTP_204_NO_CONTENT ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def reset_console ( node : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
2020-10-14 00:19:29 +00:00
await node . reset_console ( )
2020-10-02 06:37:50 +00:00
@router.get ( " / {node_id} /adapters/ {adapter_number} /ports/ {port_number} /pcap " ,
2020-10-14 00:19:29 +00:00
responses = responses )
async def stream_pcap_file ( adapter_number : int , port_number : int , node : QemuVM = Depends ( dep_node ) ) :
2020-10-02 06:37:50 +00:00
"""
Stream the pcap capture file .
The port number on the Qemu node is always 0.
"""
2020-10-14 00:19:29 +00:00
nio = node . get_nio ( adapter_number )
stream = Qemu . 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 " )
# @Route.get(
# r"/projects/{project_id}/qemu/nodes/{node_id}/console/ws",
# description="WebSocket for console",
# parameters={
# "project_id": "Project UUID",
# "node_id": "Node UUID",
# })
# async def console_ws(request, response):
#
# qemu_manager = Qemu.instance()
# vm = qemu_manager.get_node(request.match_info["node_id"], project_id=request.match_info["project_id"])
# return await vm.start_websocket_console(request)