mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-04 06:21:15 +02:00
Support for sendings settings for the GNS3VM from the GUI
Ref https://github.com/GNS3/gns3-gui/issues/1441
This commit is contained in:
14 files changed
+301
-173
No files matched your search
@@ -0,0 +1,263 @@
|
||||
#!/usr/bin/env python
|
||||
#
|
||||
# Copyright (C) 2016 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/>.
|
||||
|
||||
import logging
|
||||
import asyncio
|
||||
import socket
|
||||
|
||||
from .base_gns3_vm import BaseGNS3VM
|
||||
from .gns3_vm_error import GNS3VMError
|
||||
|
||||
from ...compute.virtualbox import (
|
||||
VirtualBox,
|
||||
VirtualBoxError
|
||||
)
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class VirtualBoxGNS3VM(BaseGNS3VM):
|
||||
|
||||
def __init__(self):
|
||||
|
||||
super().__init__()
|
||||
self._engine = "virtualbox"
|
||||
self._virtualbox_manager = VirtualBox()
|
||||
|
||||
@asyncio.coroutine
|
||||
def _execute(self, subcommand, args, timeout=60):
|
||||
|
||||
try:
|
||||
result = yield from self._virtualbox_manager.execute(subcommand, args, timeout)
|
||||
return (''.join(result))
|
||||
except VirtualBoxError as e:
|
||||
raise GNS3VMError("Error while executing VBoxManage command: {}".format(e))
|
||||
|
||||
@asyncio.coroutine
|
||||
def _get_state(self):
|
||||
"""
|
||||
Returns the VM state (e.g. running, paused etc.)
|
||||
|
||||
:returns: state (string)
|
||||
"""
|
||||
|
||||
result = yield from self._execute("showvminfo", [self._vmname, "--machinereadable"])
|
||||
for info in result.splitlines():
|
||||
if '=' in info:
|
||||
name, value = info.split('=', 1)
|
||||
if name == "VMState":
|
||||
return value.strip('"')
|
||||
return "unknown"
|
||||
|
||||
@asyncio.coroutine
|
||||
def _look_for_interface(self, network_backend):
|
||||
"""
|
||||
Look for an interface with a specific network backend.
|
||||
|
||||
:returns: interface number or -1 if none is found
|
||||
"""
|
||||
|
||||
result = yield from self._execute("showvminfo", [self._vmname, "--machinereadable"])
|
||||
interface = -1
|
||||
for info in result.splitlines():
|
||||
if '=' in info:
|
||||
name, value = info.split('=', 1)
|
||||
if name.startswith("nic") and value.strip('"') == network_backend:
|
||||
try:
|
||||
interface = int(name[3:])
|
||||
break
|
||||
except ValueError:
|
||||
continue
|
||||
return interface
|
||||
|
||||
@asyncio.coroutine
|
||||
def _look_for_vboxnet(self, interface_number):
|
||||
"""
|
||||
Look for the VirtualBox network name associated with a host only interface.
|
||||
|
||||
:returns: None or vboxnet name
|
||||
"""
|
||||
|
||||
result = yield from self._execute("showvminfo", [self._vmname, "--machinereadable"])
|
||||
for info in result.splitlines():
|
||||
if '=' in info:
|
||||
name, value = info.split('=', 1)
|
||||
if name == "hostonlyadapter{}".format(interface_number):
|
||||
return value.strip('"')
|
||||
return None
|
||||
|
||||
@asyncio.coroutine
|
||||
def _check_dhcp_server(self, vboxnet):
|
||||
"""
|
||||
Check if the DHCP server associated with a vboxnet is enabled.
|
||||
|
||||
:param vboxnet: vboxnet name
|
||||
|
||||
:returns: boolean
|
||||
"""
|
||||
|
||||
properties = yield from self._execute("list", ["dhcpservers"])
|
||||
flag_dhcp_server_found = False
|
||||
for prop in properties.splitlines():
|
||||
try:
|
||||
name, value = prop.split(':', 1)
|
||||
except ValueError:
|
||||
continue
|
||||
if name.strip() == "NetworkName" and value.strip().endswith(vboxnet):
|
||||
flag_dhcp_server_found = True
|
||||
if flag_dhcp_server_found and name.strip() == "Enabled":
|
||||
if value.strip() == "Yes":
|
||||
return True
|
||||
return False
|
||||
|
||||
@asyncio.coroutine
|
||||
def _check_vbox_port_forwarding(self):
|
||||
"""
|
||||
Checks if the NAT port forwarding rule exists.
|
||||
|
||||
:returns: boolean
|
||||
"""
|
||||
|
||||
result = yield from self._execute("showvminfo", [self._vmname, "--machinereadable"])
|
||||
for info in result.splitlines():
|
||||
if '=' in info:
|
||||
name, value = info.split('=', 1)
|
||||
if name.startswith("Forwarding") and value.strip('"').startswith("GNS3VM"):
|
||||
return True
|
||||
return False
|
||||
|
||||
@asyncio.coroutine
|
||||
def list(self):
|
||||
"""
|
||||
List all VirtualBox VMs
|
||||
"""
|
||||
|
||||
return (yield from self._virtualbox_manager.list_vms())
|
||||
|
||||
@asyncio.coroutine
|
||||
def start(self):
|
||||
"""
|
||||
Start the GNS3 VM.
|
||||
"""
|
||||
|
||||
# get a NAT interface number
|
||||
nat_interface_number = yield from self._look_for_interface("nat")
|
||||
if nat_interface_number < 0:
|
||||
raise GNS3VMError("The GNS3 VM must have a NAT interface configured in order to start")
|
||||
|
||||
hostonly_interface_number = yield from self._look_for_interface("hostonly")
|
||||
if hostonly_interface_number < 0:
|
||||
raise GNS3VMError("The GNS3 VM must have a host only interface configured in order to start")
|
||||
|
||||
vboxnet = yield from self._look_for_vboxnet(hostonly_interface_number)
|
||||
if vboxnet is None:
|
||||
raise GNS3VMError("VirtualBox host-only network could not be found for interface {}".format(hostonly_interface_number))
|
||||
|
||||
if not (yield from self._check_dhcp_server(vboxnet)):
|
||||
raise GNS3VMError("DHCP must be enabled on VirtualBox host-only network: {}".format(vboxnet))
|
||||
|
||||
vm_state = yield from self._get_vbox_vm_state()
|
||||
log.info('"{}" state is {}'.format(self._vmname, vm_state))
|
||||
if vm_state in ("poweroff", "saved"):
|
||||
# start the VM if it is not running
|
||||
args = [self._vmname]
|
||||
if self._headless:
|
||||
args.extend(["--type", "headless"])
|
||||
yield from self._execute("startvm", args)
|
||||
log.info("GNS3 VM has been started")
|
||||
self.running = True
|
||||
|
||||
ip_address = "127.0.0.1"
|
||||
try:
|
||||
# get a random port on localhost
|
||||
with socket.socket() as s:
|
||||
s.bind((ip_address, 0))
|
||||
port = s.getsockname()[1]
|
||||
except OSError as e:
|
||||
raise GNS3VMError("Error while getting random port: {}".format(e))
|
||||
|
||||
if (yield from self._check_vbox_port_forwarding()):
|
||||
# delete the GNS3VM NAT port forwarding rule if it exists
|
||||
log.info("Removing GNS3VM NAT port forwarding rule from interface {}".format(nat_interface_number))
|
||||
yield from self._execute("controlvm", [self._vmname, "natpf{}".format(nat_interface_number), "delete", "GNS3VM"])
|
||||
|
||||
# add a GNS3VM NAT port forwarding rule to redirect 127.0.0.1 with random port to port 3080 in the VM
|
||||
log.info("Adding GNS3VM NAT port forwarding rule with port {} to interface {}".format(port, nat_interface_number))
|
||||
yield from self._execute("controlvm", [self._vmname, "natpf{}".format(nat_interface_number),
|
||||
"GNS3VM,tcp,{},{},,3080".format(ip_address, port)])
|
||||
|
||||
original_port = self.port
|
||||
self.port = port
|
||||
|
||||
# TODO: retrieve interfaces on server
|
||||
# # ask the server all a list of all its interfaces along with IP addresses
|
||||
# status, json_data = self._waitForServer(vm_server, "interfaces", retry=120)
|
||||
# if status == 401:
|
||||
# self.error.emit("Wrong user or password for the GNS3 VM".format(status), True)
|
||||
# return False
|
||||
# if status != 200:
|
||||
# msg = "Server {} has replied with status code {} when retrieving the network interfaces".format(
|
||||
# vm_server.url(), status)
|
||||
# log.error(msg)
|
||||
# self.error.emit(msg, True)
|
||||
# return False
|
||||
|
||||
# find the ip address for the first hostonly interface
|
||||
hostonly_ip_address_found = False
|
||||
for interface in json_data:
|
||||
if "name" in interface and interface["name"] == "eth{}".format(hostonly_interface_number - 1):
|
||||
if "ip_address" in interface:
|
||||
self.ip_address = interface["ip_address"]
|
||||
self.port = original_port
|
||||
log.info("GNS3 VM IP address set to {}".format(interface["ip_address"]))
|
||||
hostonly_ip_address_found = True
|
||||
break
|
||||
|
||||
if not hostonly_ip_address_found:
|
||||
raise GNS3VMError("Not IP address could be found in the GNS3 VM for eth{}".format(hostonly_interface_number - 1))
|
||||
|
||||
@asyncio.coroutine
|
||||
def stop(self):
|
||||
"""
|
||||
Stops the GNS3 VM.
|
||||
"""
|
||||
|
||||
yield from self._execute("controlvm", [self._vmname, "acpipowerbutton"], timeout=3)
|
||||
log.info("GNS3 VM hsd been stopped")
|
||||
self.running = False
|
||||
|
||||
@asyncio.coroutine
|
||||
def set_vcpus(self, vcpus):
|
||||
"""
|
||||
Set the number of vCPU cores for the GNS3 VM.
|
||||
|
||||
:param vcpus: number of vCPU cores
|
||||
"""
|
||||
|
||||
yield from self.execute("modifyvm", [self._vmname, "--cpus", str(vcpus)], timeout=3)
|
||||
log.info("GNS3 VM vCPU count set to {}".format(vcpus))
|
||||
|
||||
@asyncio.coroutine
|
||||
def set_ram(self, ram):
|
||||
"""
|
||||
Set the RAM amount for the GNS3 VM.
|
||||
|
||||
:param ram: amount of memory
|
||||
"""
|
||||
|
||||
yield from self._execute("modifyvm", [self._vmname, "--memory", str(ram)], timeout=3)
|
||||
log.info("GNS3 VM RAM amount set to {}".format(ram))
|
||||
Reference in new issue
Block a user