mirror of
https://github.com/GNS3/gns3-server.git
synced 2024-12-24 23:16:44 +00:00
927 lines
37 KiB
Python
927 lines
37 KiB
Python
# -*- 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/>.
|
||
|
||
"""
|
||
VMware VM instance.
|
||
"""
|
||
|
||
import sys
|
||
import os
|
||
import socket
|
||
import shutil
|
||
import asyncio
|
||
import tempfile
|
||
|
||
from pkg_resources import parse_version
|
||
from gns3server.ubridge.hypervisor import Hypervisor
|
||
from gns3server.utils.telnet_server import TelnetServer
|
||
from gns3server.utils.interfaces import get_windows_interfaces
|
||
from collections import OrderedDict
|
||
from .vmware_error import VMwareError
|
||
from ..nios.nio_udp import NIOUDP
|
||
from .nio_vmnet import NIOVMNET
|
||
from ..adapters.ethernet_adapter import EthernetAdapter
|
||
from ..base_vm import BaseVM
|
||
|
||
if sys.platform.startswith('win'):
|
||
import msvcrt
|
||
import win32file
|
||
|
||
import logging
|
||
log = logging.getLogger(__name__)
|
||
|
||
|
||
class VMwareVM(BaseVM):
|
||
|
||
"""
|
||
VMware VM implementation.
|
||
"""
|
||
|
||
def __init__(self, name, vm_id, project, manager, vmx_path, linked_clone, console=None):
|
||
|
||
super().__init__(name, vm_id, project, manager, console=console)
|
||
|
||
self._linked_clone = linked_clone
|
||
self._vmx_pairs = OrderedDict()
|
||
self._ubridge_hypervisor = None
|
||
self._telnet_server_thread = None
|
||
self._serial_pipe = None
|
||
self._vmnets = []
|
||
self._maximum_adapters = 10
|
||
self._started = False
|
||
self._closed = False
|
||
|
||
# VMware VM settings
|
||
self._headless = False
|
||
self._vmx_path = vmx_path
|
||
self._enable_remote_console = False
|
||
self._acpi_shutdown = False
|
||
self._adapters = 0
|
||
self._ethernet_adapters = {}
|
||
self._adapter_type = "e1000"
|
||
self._use_ubridge = True
|
||
self._use_any_adapter = False
|
||
|
||
if not os.path.exists(vmx_path):
|
||
raise VMwareError('VMware VM "{name}" [{id}]: could not find VMX file "{vmx_path}"'.format(name=name, id=vm_id, vmx_path=vmx_path))
|
||
|
||
def __json__(self):
|
||
|
||
json = {"name": self.name,
|
||
"vm_id": self.id,
|
||
"console": self.console,
|
||
"project_id": self.project.id,
|
||
"vmx_path": self.vmx_path,
|
||
"headless": self.headless,
|
||
"acpi_shutdown": self.acpi_shutdown,
|
||
"enable_remote_console": self.enable_remote_console,
|
||
"adapters": self._adapters,
|
||
"adapter_type": self.adapter_type,
|
||
"use_ubridge": self.use_ubridge,
|
||
"use_any_adapter": self.use_any_adapter,
|
||
"vm_directory": self.working_dir}
|
||
return json
|
||
|
||
@property
|
||
def vmnets(self):
|
||
|
||
return self._vmnets
|
||
|
||
@asyncio.coroutine
|
||
def _control_vm(self, subcommand, *additional_args):
|
||
|
||
args = [self._vmx_path]
|
||
args.extend(additional_args)
|
||
result = yield from self.manager.execute(subcommand, args)
|
||
log.debug("Control VM '{}' result: {}".format(subcommand, result))
|
||
return result
|
||
|
||
def _read_vmx_file(self):
|
||
"""
|
||
Reads from the VMware VMX file corresponding to this VM.
|
||
"""
|
||
|
||
try:
|
||
self._vmx_pairs = self.manager.parse_vmware_file(self._vmx_path)
|
||
except OSError as e:
|
||
raise VMwareError('Could not read VMware VMX file "{}": {}'.format(self._vmx_path, e))
|
||
|
||
def _write_vmx_file(self):
|
||
"""
|
||
Writes pairs to the VMware VMX file corresponding to this VM.
|
||
"""
|
||
|
||
try:
|
||
self.manager.write_vmx_file(self._vmx_path, self._vmx_pairs)
|
||
except OSError as e:
|
||
raise VMwareError('Could not write VMware VMX file "{}": {}'.format(self._vmx_path, e))
|
||
|
||
@asyncio.coroutine
|
||
def create(self):
|
||
"""
|
||
Creates this VM and handle linked clones.
|
||
"""
|
||
|
||
if self._linked_clone and not os.path.exists(os.path.join(self.working_dir, os.path.basename(self._vmx_path))):
|
||
# create the base snapshot for linked clones
|
||
base_snapshot_name = "GNS3 Linked Base for clones"
|
||
vmsd_path = os.path.splitext(self._vmx_path)[0] + ".vmsd"
|
||
if not os.path.exists(vmsd_path):
|
||
raise VMwareError("{} doesn't not exist".format(vmsd_path))
|
||
try:
|
||
vmsd_pairs = self.manager.parse_vmware_file(vmsd_path)
|
||
except OSError as e:
|
||
raise VMwareError('Could not read VMware VMSD file "{}": {}'.format(vmsd_path, e))
|
||
gns3_snapshot_exists = False
|
||
for value in vmsd_pairs.values():
|
||
if value == base_snapshot_name:
|
||
gns3_snapshot_exists = True
|
||
break
|
||
if not gns3_snapshot_exists:
|
||
log.info("Creating snapshot '{}'".format(base_snapshot_name))
|
||
yield from self._control_vm("snapshot", base_snapshot_name)
|
||
|
||
# create the linked clone based on the base snapshot
|
||
new_vmx_path = os.path.join(self.working_dir, self.name + ".vmx")
|
||
yield from self._control_vm("clone",
|
||
new_vmx_path,
|
||
"linked",
|
||
"-snapshot={}".format(base_snapshot_name),
|
||
"-cloneName={}".format(self.name))
|
||
|
||
try:
|
||
vmsd_pairs = self.manager.parse_vmware_file(vmsd_path)
|
||
except OSError as e:
|
||
raise VMwareError('Could not read VMware VMSD file "{}": {}'.format(vmsd_path, e))
|
||
|
||
snapshot_name = None
|
||
for name, value in vmsd_pairs.items():
|
||
if value == base_snapshot_name:
|
||
snapshot_name = name.split(".", 1)[0]
|
||
break
|
||
|
||
if snapshot_name is None:
|
||
raise VMwareError("Could not find the linked base snapshot in {}".format(vmsd_path))
|
||
|
||
num_clones_entry = "{}.numClones".format(snapshot_name)
|
||
if num_clones_entry in vmsd_pairs:
|
||
try:
|
||
nb_of_clones = int(vmsd_pairs[num_clones_entry])
|
||
except ValueError:
|
||
raise VMwareError("Value of {} in {} is not a number".format(num_clones_entry, vmsd_path))
|
||
vmsd_pairs[num_clones_entry] = str(nb_of_clones - 1)
|
||
|
||
for clone_nb in range(0, nb_of_clones):
|
||
clone_entry = "{}.clone{}".format(snapshot_name, clone_nb)
|
||
if clone_entry in vmsd_pairs:
|
||
del vmsd_pairs[clone_entry]
|
||
|
||
try:
|
||
self.manager.write_vmware_file(vmsd_path, vmsd_pairs)
|
||
except OSError as e:
|
||
raise VMwareError('Could not write VMware VMSD file "{}": {}'.format(vmsd_path, e))
|
||
|
||
# update the VMX file path
|
||
self._vmx_path = new_vmx_path
|
||
|
||
def _get_vmx_setting(self, name, value=None):
|
||
|
||
if name in self._vmx_pairs:
|
||
if value is not None:
|
||
if self._vmx_pairs[name] == value:
|
||
return value
|
||
else:
|
||
return self._vmx_pairs[name]
|
||
return None
|
||
|
||
def _set_network_options(self):
|
||
"""
|
||
Set up VMware networking.
|
||
"""
|
||
|
||
# first some sanity checks
|
||
for adapter_number in range(0, self._adapters):
|
||
|
||
# we want the vmnet interface to be connected when starting the VM
|
||
connected = "ethernet{}.startConnected".format(adapter_number)
|
||
if self._get_vmx_setting(connected):
|
||
del self._vmx_pairs[connected]
|
||
|
||
# check for adapter type
|
||
if self._adapter_type != "default":
|
||
adapter_type = "ethernet{}.virtualdev".format(adapter_number)
|
||
if adapter_type in self._vmx_pairs and self._vmx_pairs[adapter_type] != self._adapter_type:
|
||
raise VMwareError("Existing VMware network adapter {} is not of type {}, please fix or set adapter type to default in GNS3".format(adapter_number,
|
||
self._adapter_type))
|
||
|
||
# # check if any vmnet interface managed by GNS3 is being used on existing VMware adapters
|
||
# if self._get_vmx_setting("ethernet{}.present".format(adapter_number), "TRUE"):
|
||
# connection_type = "ethernet{}.connectiontype".format(adapter_number)
|
||
# if connection_type in self._vmx_pairs and self._vmx_pairs[connection_type] in ("hostonly", "custom"):
|
||
# vnet = "ethernet{}.vnet".format(adapter_number)
|
||
# if vnet in self._vmx_pairs:
|
||
# vmnet = os.path.basename(self._vmx_pairs[vnet])
|
||
# #nio = self._ethernet_adapters[adapter_number].get_nio(0)
|
||
# if self.manager.is_managed_vmnet(vmnet):
|
||
# raise VMwareError("Network adapter {} is already associated with VMnet interface {} which is managed by GNS3, please remove".format(adapter_number, vmnet))
|
||
|
||
# then configure VMware network adapters
|
||
self.manager.refresh_vmnet_list()
|
||
for adapter_number in range(0, self._adapters):
|
||
|
||
# add/update the interface
|
||
ethernet_adapter = {"ethernet{}.present".format(adapter_number): "TRUE",
|
||
"ethernet{}.addresstype".format(adapter_number): "generated",
|
||
"ethernet{}.generatedaddressoffset".format(adapter_number): "0"}
|
||
self._vmx_pairs.update(ethernet_adapter)
|
||
if self._adapter_type != "default":
|
||
self._vmx_pairs["ethernet{}.virtualdev".format(adapter_number)] = self._adapter_type
|
||
|
||
connection_type = "ethernet{}.connectiontype".format(adapter_number)
|
||
if not self._use_any_adapter and connection_type in self._vmx_pairs and self._vmx_pairs[connection_type] in ("nat", "bridged", "hostonly"):
|
||
continue
|
||
self._vmx_pairs["ethernet{}.connectiontype".format(adapter_number)] = "custom"
|
||
|
||
if self._use_ubridge:
|
||
# make sure we have a vmnet per adapter if we use uBridge
|
||
allocate_vmnet = False
|
||
|
||
# first check if a vmnet is already assigned to the adapter
|
||
vnet = "ethernet{}.vnet".format(adapter_number)
|
||
if vnet in self._vmx_pairs:
|
||
vmnet = os.path.basename(self._vmx_pairs[vnet])
|
||
if vmnet in self.manager.is_managed_vmnet(vmnet):
|
||
# vmnet already managed, try to allocate a new one
|
||
allocate_vmnet = True
|
||
else:
|
||
# otherwise allocate a new one
|
||
allocate_vmnet = True
|
||
|
||
if allocate_vmnet:
|
||
try:
|
||
vmnet = self.manager.allocate_vmnet()
|
||
except:
|
||
# clear everything up in case of error (e.g. no enough vmnets)
|
||
self._vmnets.clear()
|
||
raise
|
||
|
||
# mark the vmnet managed by us
|
||
if not vmnet in self._vmnets:
|
||
self._vmnets.append(vmnet)
|
||
self._vmx_pairs["ethernet{}.vnet".format(adapter_number)] = vmnet
|
||
|
||
# disable remaining network adapters
|
||
for adapter_number in range(self._adapters, self._maximum_adapters):
|
||
if self._get_vmx_setting("ethernet{}.present".format(adapter_number), "TRUE"):
|
||
log.debug("disabling remaining adapter {}".format(adapter_number))
|
||
self._vmx_pairs["ethernet{}.startconnected".format(adapter_number)] = "FALSE"
|
||
|
||
@asyncio.coroutine
|
||
def _add_ubridge_connection(self, nio, adapter_number):
|
||
"""
|
||
Creates a connection in uBridge.
|
||
|
||
:param nio: NIO instance
|
||
:param adapter_number: adapter number
|
||
"""
|
||
|
||
vnet = "ethernet{}.vnet".format(adapter_number)
|
||
if vnet not in self._vmx_pairs:
|
||
raise VMwareError("vnet {} not in VMX file".format(vnet))
|
||
yield from self._ubridge_hypervisor.send("bridge create {name}".format(name=vnet))
|
||
vmnet_interface = os.path.basename(self._vmx_pairs[vnet])
|
||
if sys.platform.startswith("linux"):
|
||
yield from self._ubridge_hypervisor.send('bridge add_nio_linux_raw {name} "{interface}"'.format(name=vnet,
|
||
interface=vmnet_interface))
|
||
elif sys.platform.startswith("win"):
|
||
windows_interfaces = get_windows_interfaces()
|
||
npf = None
|
||
for interface in windows_interfaces:
|
||
if "netcard" in interface and vmnet_interface in interface["netcard"]:
|
||
npf = interface["id"]
|
||
elif vmnet_interface in interface["name"]:
|
||
npf = interface["id"]
|
||
if npf:
|
||
yield from self._ubridge_hypervisor.send('bridge add_nio_ethernet {name} "{interface}"'.format(name=vnet,
|
||
interface=npf))
|
||
else:
|
||
raise VMwareError("Could not find NPF id for VMnet interface {}".format(vmnet_interface))
|
||
else:
|
||
yield from self._ubridge_hypervisor.send('bridge add_nio_ethernet {name} "{interface}"'.format(name=vnet,
|
||
interface=vmnet_interface))
|
||
|
||
if isinstance(nio, NIOUDP):
|
||
yield from self._ubridge_hypervisor.send('bridge add_nio_udp {name} {lport} {rhost} {rport}'.format(name=vnet,
|
||
lport=nio.lport,
|
||
rhost=nio.rhost,
|
||
rport=nio.rport))
|
||
|
||
if nio.capturing:
|
||
yield from self._ubridge_hypervisor.send('bridge start_capture {name} "{pcap_file}"'.format(name=vnet,
|
||
pcap_file=nio.pcap_output_file))
|
||
|
||
yield from self._ubridge_hypervisor.send('bridge start {name}'.format(name=vnet))
|
||
|
||
@asyncio.coroutine
|
||
def _delete_ubridge_connection(self, adapter_number):
|
||
"""
|
||
Deletes a connection in uBridge.
|
||
|
||
:param adapter_number: adapter number
|
||
"""
|
||
|
||
vnet = "ethernet{}.vnet".format(adapter_number)
|
||
if vnet not in self._vmx_pairs:
|
||
raise VMwareError("vnet {} not in VMX file".format(vnet))
|
||
yield from self._ubridge_hypervisor.send("bridge delete {name}".format(name=vnet))
|
||
|
||
@property
|
||
def ubridge_path(self):
|
||
"""
|
||
Returns the uBridge executable path.
|
||
|
||
:returns: path to uBridge
|
||
"""
|
||
|
||
path = self._manager.config.get_section_config("Server").get("ubridge_path", "ubridge")
|
||
if path == "ubridge":
|
||
path = shutil.which("ubridge")
|
||
return path
|
||
|
||
@asyncio.coroutine
|
||
def _start_ubridge(self):
|
||
"""
|
||
Starts uBridge (handles connections to and from this VMware VM).
|
||
"""
|
||
|
||
server_config = self._manager.config.get_section_config("Server")
|
||
server_host = server_config.get("host")
|
||
self._ubridge_hypervisor = Hypervisor(self._project, self.ubridge_path, self.working_dir, server_host)
|
||
|
||
log.info("Starting new uBridge hypervisor {}:{}".format(self._ubridge_hypervisor.host, self._ubridge_hypervisor.port))
|
||
yield from self._ubridge_hypervisor.start()
|
||
log.info("Hypervisor {}:{} has successfully started".format(self._ubridge_hypervisor.host, self._ubridge_hypervisor.port))
|
||
yield from self._ubridge_hypervisor.connect()
|
||
if parse_version(self._ubridge_hypervisor.version) < parse_version('0.9.1'):
|
||
raise VMwareError("uBridge version must be >= 0.9.1, detected version is {}".format(self._ubridge_hypervisor.version))
|
||
|
||
def check_hw_virtualization(self):
|
||
"""
|
||
Returns either hardware virtualization is activated or not.
|
||
|
||
:returns: boolean
|
||
"""
|
||
|
||
self._read_vmx_file()
|
||
if self._get_vmx_setting("vhv.enable", "TRUE"):
|
||
return True
|
||
return False
|
||
|
||
@asyncio.coroutine
|
||
def start(self):
|
||
"""
|
||
Starts this VMware VM.
|
||
"""
|
||
|
||
# The lock dection is not working on OSX the .lck is never deleted
|
||
if os.path.exists(self._vmx_path + ".lck") and not sys.platform.startswith("darwin"):
|
||
raise VMwareError("VM locked, it is either running or being edited in VMware")
|
||
|
||
ubridge_path = self.ubridge_path
|
||
if not ubridge_path or not os.path.isfile(ubridge_path):
|
||
raise VMwareError("ubridge is necessary to start a VMware VM")
|
||
|
||
if self._use_ubridge:
|
||
yield from self._start_ubridge()
|
||
|
||
self._read_vmx_file()
|
||
self._set_network_options()
|
||
self._set_serial_console()
|
||
self._write_vmx_file()
|
||
|
||
if self._headless:
|
||
yield from self._control_vm("start", "nogui")
|
||
else:
|
||
yield from self._control_vm("start")
|
||
|
||
if self._use_ubridge:
|
||
for adapter_number in range(0, self._adapters):
|
||
nio = self._ethernet_adapters[adapter_number].get_nio(0)
|
||
if nio:
|
||
yield from self._add_ubridge_connection(nio, adapter_number)
|
||
|
||
if self._enable_remote_console and self._console is not None:
|
||
yield from asyncio.sleep(1) # give some time to VMware to create the pipe file.
|
||
self._start_remote_console()
|
||
|
||
if self._get_vmx_setting("vhv.enable", "TRUE"):
|
||
self._hw_virtualization = True
|
||
|
||
self._started = True
|
||
log.info("VMware VM '{name}' [{id}] started".format(name=self.name, id=self.id))
|
||
|
||
@asyncio.coroutine
|
||
def stop(self):
|
||
"""
|
||
Stops this VMware VM.
|
||
"""
|
||
|
||
self._hw_virtualization = False
|
||
self._stop_remote_console()
|
||
if self._ubridge_hypervisor and self._ubridge_hypervisor.is_running():
|
||
yield from self._ubridge_hypervisor.stop()
|
||
|
||
try:
|
||
if self.acpi_shutdown:
|
||
# use ACPI to shutdown the VM
|
||
yield from self._control_vm("stop", "soft")
|
||
else:
|
||
yield from self._control_vm("stop")
|
||
finally:
|
||
self._started = False
|
||
|
||
self._read_vmx_file()
|
||
if self._use_ubridge:
|
||
self._vmnets.clear()
|
||
# remove the adapters managed by GNS3
|
||
for adapter_number in range(0, self._adapters):
|
||
if self._get_vmx_setting("ethernet{}.vnet".format(adapter_number)) or \
|
||
self._get_vmx_setting("ethernet{}.connectiontype".format(adapter_number)) is None:
|
||
vnet = "ethernet{}.vnet".format(adapter_number)
|
||
if vnet in self._vmx_pairs:
|
||
vmnet = os.path.basename(self._vmx_pairs[vnet])
|
||
if not self.manager.is_managed_vmnet(vmnet):
|
||
continue
|
||
log.debug("removing adapter {}".format(adapter_number))
|
||
for key in self._vmx_pairs.keys():
|
||
if key.startswith("ethernet{}.".format(adapter_number)):
|
||
del self._vmx_pairs[key]
|
||
|
||
# re-enable any remaining network adapters
|
||
for adapter_number in range(self._adapters, self._maximum_adapters):
|
||
if self._get_vmx_setting("ethernet{}.present".format(adapter_number), "TRUE"):
|
||
log.debug("enabling remaining adapter {}".format(adapter_number))
|
||
self._vmx_pairs["ethernet{}.startconnected".format(adapter_number)] = "TRUE"
|
||
self._write_vmx_file()
|
||
|
||
log.info("VMware VM '{name}' [{id}] stopped".format(name=self.name, id=self.id))
|
||
|
||
@asyncio.coroutine
|
||
def suspend(self):
|
||
"""
|
||
Suspends this VMware VM.
|
||
"""
|
||
|
||
if self.manager.host_type != "ws":
|
||
raise VMwareError("Pausing a VM is only supported by VMware Workstation")
|
||
yield from self._control_vm("pause")
|
||
log.info("VMware VM '{name}' [{id}] paused".format(name=self.name, id=self.id))
|
||
|
||
@asyncio.coroutine
|
||
def resume(self):
|
||
"""
|
||
Resumes this VMware VM.
|
||
"""
|
||
|
||
if self.manager.host_type != "ws":
|
||
raise VMwareError("Unpausing a VM is only supported by VMware Workstation")
|
||
yield from self._control_vm("unpause")
|
||
log.info("VMware VM '{name}' [{id}] resumed".format(name=self.name, id=self.id))
|
||
|
||
@asyncio.coroutine
|
||
def reload(self):
|
||
"""
|
||
Reloads this VMware VM.
|
||
"""
|
||
|
||
yield from self._control_vm("reset")
|
||
log.info("VMware VM '{name}' [{id}] reloaded".format(name=self.name, id=self.id))
|
||
|
||
@asyncio.coroutine
|
||
def close(self):
|
||
"""
|
||
Closes this VMware VM.
|
||
"""
|
||
|
||
if self._closed:
|
||
# VM is already closed
|
||
return
|
||
|
||
log.debug("VMware VM '{name}' [{id}] is closing".format(name=self.name, id=self.id))
|
||
if self._console:
|
||
self._manager.port_manager.release_tcp_port(self._console, self._project)
|
||
self._console = None
|
||
|
||
for adapter in self._ethernet_adapters.values():
|
||
if adapter is not None:
|
||
for nio in adapter.ports.values():
|
||
if nio and isinstance(nio, NIOUDP):
|
||
self.manager.port_manager.release_udp_port(nio.lport, self._project)
|
||
if nio and isinstance(nio, NIOVMNET) and nio.vmnet in self._vmnets:
|
||
self._vmnets.remove(nio.vmnet)
|
||
try:
|
||
self.acpi_shutdown = False
|
||
yield from self.stop()
|
||
except VMwareError:
|
||
pass
|
||
|
||
if self._linked_clone:
|
||
# clean the VMware inventory path from this linked clone
|
||
inventory_path = self.manager.get_vmware_inventory_path()
|
||
inventory_pairs = {}
|
||
if os.path.exists(inventory_path):
|
||
try:
|
||
inventory_pairs = self.manager.parse_vmware_file(inventory_path)
|
||
except OSError as e:
|
||
log.warning('Could not read VMware inventory file "{}": {}'.format(inventory_path, e))
|
||
return
|
||
|
||
vmlist_entry = None
|
||
for name, value in inventory_pairs.items():
|
||
if value == self._vmx_path:
|
||
vmlist_entry = name.split(".", 1)[0]
|
||
break
|
||
|
||
if vmlist_entry is not None:
|
||
for name in inventory_pairs.keys():
|
||
if name.startswith(vmlist_entry):
|
||
del inventory_pairs[name]
|
||
|
||
try:
|
||
self.manager.write_vmware_file(inventory_path, inventory_pairs)
|
||
except OSError as e:
|
||
raise VMwareError('Could not write VMware inventory file "{}": {}'.format(inventory_path, e))
|
||
|
||
log.info("VirtualBox VM '{name}' [{id}] closed".format(name=self.name, id=self.id))
|
||
self._closed = True
|
||
|
||
@property
|
||
def headless(self):
|
||
"""
|
||
Returns either the VM will start in headless mode
|
||
|
||
:returns: boolean
|
||
"""
|
||
|
||
return self._headless
|
||
|
||
@headless.setter
|
||
def headless(self, headless):
|
||
"""
|
||
Sets either the VM will start in headless mode
|
||
|
||
:param headless: boolean
|
||
"""
|
||
|
||
if headless:
|
||
log.info("VMware VM '{name}' [{id}] has enabled the headless mode".format(name=self.name, id=self.id))
|
||
else:
|
||
log.info("VMware VM '{name}' [{id}] has disabled the headless mode".format(name=self.name, id=self.id))
|
||
self._headless = headless
|
||
|
||
@property
|
||
def acpi_shutdown(self):
|
||
"""
|
||
Returns either the VM will use ACPI shutdown
|
||
|
||
:returns: boolean
|
||
"""
|
||
|
||
return self._acpi_shutdown
|
||
|
||
@acpi_shutdown.setter
|
||
def acpi_shutdown(self, acpi_shutdown):
|
||
"""
|
||
Sets either the VM will use ACPI shutdown
|
||
|
||
:param acpi_shutdown: boolean
|
||
"""
|
||
|
||
if acpi_shutdown:
|
||
log.info("VMware VM '{name}' [{id}] has enabled the ACPI shutdown mode".format(name=self.name, id=self.id))
|
||
else:
|
||
log.info("VMware VM '{name}' [{id}] has disabled the ACPI shutdown mode".format(name=self.name, id=self.id))
|
||
self._acpi_shutdown = acpi_shutdown
|
||
|
||
@property
|
||
def vmx_path(self):
|
||
"""
|
||
Returns the path to the vmx file.
|
||
|
||
:returns: VMware vmx file
|
||
"""
|
||
|
||
return self._vmx_path
|
||
|
||
@vmx_path.setter
|
||
def vmx_path(self, vmx_path):
|
||
"""
|
||
Sets the path to the vmx file.
|
||
|
||
:param vmx_path: VMware vmx file
|
||
"""
|
||
|
||
log.info("VMware VM '{name}' [{id}] has set the vmx file path to '{vmx}'".format(name=self.name, id=self.id, vmx=vmx_path))
|
||
self._vmx_path = vmx_path
|
||
|
||
@property
|
||
def enable_remote_console(self):
|
||
"""
|
||
Returns either the remote console is enabled or not
|
||
|
||
:returns: boolean
|
||
"""
|
||
|
||
return self._enable_remote_console
|
||
|
||
@enable_remote_console.setter
|
||
def enable_remote_console(self, enable_remote_console):
|
||
"""
|
||
Sets either the console is enabled or not
|
||
|
||
:param enable_remote_console: boolean
|
||
"""
|
||
|
||
if enable_remote_console:
|
||
log.info("VMware VM '{name}' [{id}] has enabled the console".format(name=self.name, id=self.id))
|
||
if self._started:
|
||
self._start_remote_console()
|
||
else:
|
||
log.info("VMware VM '{name}' [{id}] has disabled the console".format(name=self.name, id=self.id))
|
||
self._stop_remote_console()
|
||
self._enable_remote_console = enable_remote_console
|
||
|
||
@property
|
||
def adapters(self):
|
||
"""
|
||
Returns the number of adapters configured for this VMware VM.
|
||
|
||
:returns: number of adapters
|
||
"""
|
||
|
||
return self._adapters
|
||
|
||
@adapters.setter
|
||
def adapters(self, adapters):
|
||
"""
|
||
Sets the number of Ethernet adapters for this VMware VM instance.
|
||
|
||
:param adapters: number of adapters
|
||
"""
|
||
|
||
# VMware VMs are limited to 10 adapters
|
||
if adapters > 10:
|
||
raise VMwareError("Number of adapters above the maximum supported of 10")
|
||
|
||
self._ethernet_adapters.clear()
|
||
for adapter_number in range(0, adapters):
|
||
self._ethernet_adapters[adapter_number] = EthernetAdapter()
|
||
|
||
self._adapters = len(self._ethernet_adapters)
|
||
log.info("VMware VM '{name}' [{id}] has changed the number of Ethernet adapters to {adapters}".format(name=self.name,
|
||
id=self.id,
|
||
adapters=adapters))
|
||
|
||
@property
|
||
def adapter_type(self):
|
||
"""
|
||
Returns the adapter type for this VMware VM instance.
|
||
|
||
:returns: adapter type (string)
|
||
"""
|
||
|
||
return self._adapter_type
|
||
|
||
@adapter_type.setter
|
||
def adapter_type(self, adapter_type):
|
||
"""
|
||
Sets the adapter type for this VMware VM instance.
|
||
|
||
:param adapter_type: adapter type (string)
|
||
"""
|
||
|
||
self._adapter_type = adapter_type
|
||
log.info("VMware VM '{name}' [{id}]: adapter type changed to {adapter_type}".format(name=self.name,
|
||
id=self.id,
|
||
adapter_type=adapter_type))
|
||
|
||
@property
|
||
def use_ubridge(self):
|
||
"""
|
||
Returns either GNS3 can use uBridge for network connections.
|
||
|
||
:returns: boolean
|
||
"""
|
||
|
||
return self._use_ubridge
|
||
|
||
@use_ubridge.setter
|
||
def use_ubridge(self, use_ubridge):
|
||
"""
|
||
Allows GNS3 to use uBridge for network connections.
|
||
|
||
:param use_ubridge: boolean
|
||
"""
|
||
|
||
if use_ubridge:
|
||
log.info("VMware VM '{name}' [{id}] will use uBridge for network connections".format(name=self.name, id=self.id))
|
||
else:
|
||
log.info("VMware VM '{name}' [{id}] will not use uBridge for network connections".format(name=self.name, id=self.id))
|
||
self._use_ubridge = use_ubridge
|
||
|
||
@property
|
||
def use_any_adapter(self):
|
||
"""
|
||
Returns either GNS3 can use any VMware adapter on this instance.
|
||
|
||
:returns: boolean
|
||
"""
|
||
|
||
return self._use_any_adapter
|
||
|
||
@use_any_adapter.setter
|
||
def use_any_adapter(self, use_any_adapter):
|
||
"""
|
||
Allows GNS3 to use any VMware adapter on this instance.
|
||
|
||
:param use_any_adapter: boolean
|
||
"""
|
||
|
||
if use_any_adapter:
|
||
log.info("VMware VM '{name}' [{id}] is allowed to use any adapter".format(name=self.name, id=self.id))
|
||
else:
|
||
log.info("VMware VM '{name}' [{id}] is not allowed to use any adapter".format(name=self.name, id=self.id))
|
||
self._use_any_adapter = use_any_adapter
|
||
|
||
@asyncio.coroutine
|
||
def adapter_add_nio_binding(self, adapter_number, nio):
|
||
"""
|
||
Adds an adapter NIO binding.
|
||
|
||
:param adapter_number: adapter number
|
||
:param nio: NIO instance to add to the slot/port
|
||
"""
|
||
|
||
try:
|
||
adapter = self._ethernet_adapters[adapter_number]
|
||
except IndexError:
|
||
raise VMwareError("Adapter {adapter_number} doesn't exist on VMware VM '{name}'".format(name=self.name,
|
||
adapter_number=adapter_number))
|
||
|
||
self._read_vmx_file()
|
||
# check if trying to connect to a nat, bridged or host-only adapter
|
||
if self._ethernet_adapters[adapter_number].get_nio(0) and not self._use_any_adapter:
|
||
if self._get_vmx_setting("ethernet{}.present".format(adapter_number), "TRUE"):
|
||
# check for the connection type
|
||
connection_type = "ethernet{}.connectiontype".format(adapter_number)
|
||
if connection_type in self._vmx_pairs and self._vmx_pairs[connection_type] in ("nat", "bridged", "hostonly"):
|
||
raise VMwareError("Attachment ({}) already configured on network adapter {}. "
|
||
"Please remove it or allow GNS3 to use any adapter.".format(self._vmx_pairs[connection_type],
|
||
adapter_number))
|
||
|
||
if isinstance(nio, NIOVMNET):
|
||
if self._started:
|
||
raise VMwareError("Sorry, adding a link to a started VMware VM is not supported without uBridge enabled")
|
||
self._vmx_pairs["ethernet{}.vnet".format(adapter_number)] = nio.vmnet
|
||
self._write_vmx_file()
|
||
self._vmnets.append(nio.vmnet)
|
||
adapter.add_nio(0, nio)
|
||
if self._started and self._use_ubridge:
|
||
yield from self._add_ubridge_connection(nio, adapter_number)
|
||
|
||
log.info("VMware VM '{name}' [{id}]: {nio} added to adapter {adapter_number}".format(name=self.name,
|
||
id=self.id,
|
||
nio=nio,
|
||
adapter_number=adapter_number))
|
||
|
||
|
||
@asyncio.coroutine
|
||
def adapter_remove_nio_binding(self, adapter_number):
|
||
"""
|
||
Removes an adapter NIO binding.
|
||
|
||
:param adapter_number: adapter number
|
||
|
||
:returns: NIO instance
|
||
"""
|
||
|
||
try:
|
||
adapter = self._ethernet_adapters[adapter_number]
|
||
except IndexError:
|
||
raise VMwareError("Adapter {adapter_number} doesn't exist on VMware VM '{name}'".format(name=self.name,
|
||
adapter_number=adapter_number))
|
||
|
||
nio = adapter.get_nio(0)
|
||
if isinstance(nio, NIOUDP):
|
||
self.manager.port_manager.release_udp_port(nio.lport, self._project)
|
||
if isinstance(nio, NIOVMNET):
|
||
self._read_vmx_file()
|
||
vnet = "ethernet{}.vnet".format(adapter_number)
|
||
if vnet in self._vmx_pairs:
|
||
del self._vmx_pairs[vnet]
|
||
self._write_vmx_file()
|
||
if nio.vmnet in self._vmnets:
|
||
self._vmnets.remove(nio.vmnet)
|
||
adapter.remove_nio(0)
|
||
if self._started and self._use_ubridge:
|
||
yield from self._delete_ubridge_connection(adapter_number)
|
||
|
||
log.info("VMware VM '{name}' [{id}]: {nio} removed from adapter {adapter_number}".format(name=self.name,
|
||
id=self.id,
|
||
nio=nio,
|
||
adapter_number=adapter_number))
|
||
|
||
return nio
|
||
|
||
def _get_pipe_name(self):
|
||
"""
|
||
Returns the pipe name to create a serial connection.
|
||
|
||
:returns: pipe path (string)
|
||
"""
|
||
|
||
if sys.platform.startswith("win"):
|
||
pipe_name = r"\\.\pipe\gns3_vmware\{}".format(self.id)
|
||
else:
|
||
pipe_name = os.path.join(tempfile.gettempdir(), "gns3_vmware", "{}".format(self.id))
|
||
try:
|
||
os.makedirs(os.path.dirname(pipe_name), exist_ok=True)
|
||
except OSError as e:
|
||
raise VMwareError("Could not create the VMware pipe directory: {}".format(e))
|
||
return pipe_name
|
||
|
||
def _set_serial_console(self):
|
||
"""
|
||
Configures the first serial port to allow a serial console connection.
|
||
"""
|
||
|
||
pipe_name = self._get_pipe_name()
|
||
serial_port = {"serial0.present": "TRUE",
|
||
"serial0.filetype": "pipe",
|
||
"serial0.filename": pipe_name,
|
||
"serial0.pipe.endpoint": "server"}
|
||
self._vmx_pairs.update(serial_port)
|
||
|
||
def _start_remote_console(self):
|
||
"""
|
||
Starts remote console support for this VM.
|
||
"""
|
||
|
||
# starts the Telnet to pipe thread
|
||
pipe_name = self._get_pipe_name()
|
||
if sys.platform.startswith("win"):
|
||
try:
|
||
self._serial_pipe = open(pipe_name, "a+b")
|
||
except OSError as e:
|
||
raise VMwareError("Could not open the pipe {}: {}".format(pipe_name, e))
|
||
try:
|
||
self._telnet_server_thread = TelnetServer(self.name, msvcrt.get_osfhandle(self._serial_pipe.fileno()), self._manager.port_manager.console_host, self._console)
|
||
except OSError as e:
|
||
raise VMwareError("Unable to create Telnet server: {}".format(e))
|
||
self._telnet_server_thread.start()
|
||
else:
|
||
try:
|
||
self._serial_pipe = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
||
self._serial_pipe.connect(pipe_name)
|
||
except OSError as e:
|
||
raise VMwareError("Could not connect to the pipe {}: {}".format(pipe_name, e))
|
||
try:
|
||
self._telnet_server_thread = TelnetServer(self.name, self._serial_pipe, self._manager.port_manager.console_host, self._console)
|
||
except OSError as e:
|
||
raise VMwareError("Unable to create Telnet server: {}".format(e))
|
||
self._telnet_server_thread.start()
|
||
|
||
def _stop_remote_console(self):
|
||
"""
|
||
Stops remote console support for this VM.
|
||
"""
|
||
|
||
if self._telnet_server_thread:
|
||
if self._telnet_server_thread.is_alive():
|
||
self._telnet_server_thread.stop()
|
||
self._telnet_server_thread.join(timeout=3)
|
||
if self._telnet_server_thread.is_alive():
|
||
log.warn("Serial pipe thread is still alive!")
|
||
self._telnet_server_thread = None
|
||
|
||
if self._serial_pipe:
|
||
if sys.platform.startswith("win"):
|
||
win32file.CloseHandle(msvcrt.get_osfhandle(self._serial_pipe.fileno()))
|
||
else:
|
||
self._serial_pipe.close()
|
||
self._serial_pipe = None
|