vboxshell.py revision 63702c0d2795cf416c91489cd9042d5d1063e159
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync#!/usr/bin/python
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync#
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# Copyright (C) 2009 Sun Microsystems, Inc.
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync#
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# This file is part of VirtualBox Open Source Edition (OSE), as
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# available from http://www.virtualbox.org. This file is free software;
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# you can redistribute it and/or modify it under the terms of the GNU
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# General Public License (GPL) as published by the Free Software
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# Foundation, in version 2 as it comes in the "COPYING" file of the
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync#
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# Clara, CA 95054 USA or visit http://www.sun.com if you need
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# additional information or have any questions.
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync#
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync#################################################################################
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# This program is a simple interactive shell for VirtualBox. You can query #
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# information and issue commands from a simple command line. #
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# #
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# It also provides you with examples on how to use VirtualBox's Python API. #
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# This shell is even somewhat documented and supports TAB-completion and #
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# history if you have Python readline installed. #
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# #
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# Enjoy. #
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync################################################################################
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsyncimport os,sys
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsyncimport traceback
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsyncimport shlex
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsyncimport time
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# Simple implementation of IConsoleCallback, one can use it as skeleton
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync# for custom implementations
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsyncclass GuestMonitor:
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync def __init__(self, mach):
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync self.mach = mach
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync def onMousePointerShapeChange(self, visible, alpha, xHot, yHot, width, height, shape):
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync print "%s: onMousePointerShapeChange: visible=%d" %(self.mach.name, visible)
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync def onMouseCapabilityChange(self, supportsAbsolute, supportsRelative, needsHostCursor):
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync print "%s: onMouseCapabilityChange: supportsAbsolute = %d, supportsRelative = %d, needsHostCursor = %d" %(self.mach.name, supportsAbsolute, supportsRelative, needsHostCursor)
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync def onKeyboardLedsChange(self, numLock, capsLock, scrollLock):
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync print "%s: onKeyboardLedsChange capsLock=%d" %(self.mach.name, capsLock)
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync def onStateChange(self, state):
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync print "%s: onStateChange state=%d" %(self.mach.name, state)
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync def onAdditionsStateChange(self):
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync print "%s: onAdditionsStateChange" %(self.mach.name)
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync
a54b8f61d5d9f7e6f13cc710f4d1906ee7778322vboxsync def onNetworkAdapterChange(self, adapter):
print "%s: onNetworkAdapterChange" %(self.mach.name)
def onSerialPortChange(self, port):
print "%s: onSerialPortChange" %(self.mach.name)
def onParallelPortChange(self, port):
print "%s: onParallelPortChange" %(self.mach.name)
def onStorageControllerChange(self):
print "%s: onStorageControllerChange" %(self.mach.name)
def onMediumChange(self, attachment):
print "%s: onMediumChange" %(self.mach.name)
def onVRDPServerChange(self):
print "%s: onVRDPServerChange" %(self.mach.name)
def onUSBControllerChange(self):
print "%s: onUSBControllerChange" %(self.mach.name)
def onUSBDeviceStateChange(self, device, attached, error):
print "%s: onUSBDeviceStateChange" %(self.mach.name)
def onSharedFolderChange(self, scope):
print "%s: onSharedFolderChange" %(self.mach.name)
def onRuntimeError(self, fatal, id, message):
print "%s: onRuntimeError fatal=%d message=%s" %(self.mach.name, fatal, message)
def onCanShowWindow(self):
print "%s: onCanShowWindow" %(self.mach.name)
return True
def onShowWindow(self, winId):
print "%s: onShowWindow: %d" %(self.mach.name, winId)
class VBoxMonitor:
def __init__(self, params):
self.vbox = params[0]
self.isMscom = params[1]
pass
def onMachineStateChange(self, id, state):
print "onMachineStateChange: %s %d" %(id, state)
def onMachineDataChange(self,id):
print "onMachineDataChange: %s" %(id)
def onExtraDataCanChange(self, id, key, value):
print "onExtraDataCanChange: %s %s=>%s" %(id, key, value)
# Witty COM bridge thinks if someone wishes to return tuple, hresult
# is one of values we want to return
if self.isMscom:
return "", 0, True
else:
return True, ""
def onExtraDataChange(self, id, key, value):
print "onExtraDataChange: %s %s=>%s" %(id, key, value)
def onMediaRegistered(self, id, type, registered):
print "onMediaRegistered: %s" %(id)
def onMachineRegistered(self, id, registred):
print "onMachineRegistered: %s" %(id)
def onSessionStateChange(self, id, state):
print "onSessionStateChange: %s %d" %(id, state)
def onSnapshotTaken(self, mach, id):
print "onSnapshotTaken: %s %s" %(mach, id)
def onSnapshotDiscarded(self, mach, id):
print "onSnapshotDiscarded: %s %s" %(mach, id)
def onSnapshotChange(self, mach, id):
print "onSnapshotChange: %s %s" %(mach, id)
def onGuestPropertyChange(self, id, name, newValue, flags):
print "onGuestPropertyChange: %s: %s=%s" %(id, name, newValue)
g_hasreadline = 1
try:
import readline
import rlcompleter
except:
g_hasreadline = 0
if g_hasreadline:
class CompleterNG(rlcompleter.Completer):
def __init__(self, dic, ctx):
self.ctx = ctx
return rlcompleter.Completer.__init__(self,dic)
def complete(self, text, state):
"""
taken from:
http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/496812
"""
if text == "":
return ['\t',None][state]
else:
return rlcompleter.Completer.complete(self,text,state)
def global_matches(self, text):
"""
Compute matches when text is a simple name.
Return a list of all names currently defined
in self.namespace that match.
"""
matches = []
n = len(text)
for list in [ self.namespace ]:
for word in list:
if word[:n] == text:
matches.append(word)
try:
for m in getMachines(self.ctx):
# although it has autoconversion, we need to cast
# explicitly for subscripts to work
word = str(m.name)
if word[:n] == text:
matches.append(word)
word = str(m.id)
if word[0] == '{':
word = word[1:-1]
if word[:n] == text:
matches.append(word)
except Exception,e:
traceback.print_exc()
print e
return matches
def autoCompletion(commands, ctx):
if not g_hasreadline:
return
comps = {}
for (k,v) in commands.items():
comps[k] = None
completer = CompleterNG(comps, ctx)
readline.set_completer(completer.complete)
readline.parse_and_bind("tab: complete")
g_verbose = True
def split_no_quotes(s):
return shlex.split(s)
def progressBar(ctx,p,wait=1000):
try:
while not p.completed:
print "%d %%\r" %(p.percent),
sys.stdout.flush()
p.waitForCompletion(wait)
ctx['global'].waitForEvents(0)
except KeyboardInterrupt:
print "Interrupted."
def reportError(ctx,session,rc):
if not ctx['remote']:
print session.QueryErrorObject(rc)
def createVm(ctx,name,kind,base):
mgr = ctx['mgr']
vb = ctx['vb']
mach = vb.createMachine(name, kind, base, "")
mach.saveSettings()
print "created machine with UUID",mach.id
vb.registerMachine(mach)
# update cache
getMachines(ctx, True)
def removeVm(ctx,mach):
mgr = ctx['mgr']
vb = ctx['vb']
id = mach.id
print "removing machine ",mach.name,"with UUID",id
session = ctx['global'].openMachineSession(id)
try:
mach = session.machine
for d in ctx['global'].getArray(mach, 'mediumAttachments'):
mach.detachDevice(d.controller, d.port, d.device)
except:
traceback.print_exc()
mach.saveSettings()
ctx['global'].closeMachineSession(session)
mach = vb.unregisterMachine(id)
if mach:
mach.deleteSettings()
# update cache
getMachines(ctx, True)
def startVm(ctx,mach,type):
mgr = ctx['mgr']
vb = ctx['vb']
perf = ctx['perf']
session = mgr.getSessionObject(vb)
uuid = mach.id
progress = vb.openRemoteSession(session, uuid, type, "")
progressBar(ctx, progress, 100)
completed = progress.completed
rc = int(progress.resultCode)
print "Completed:", completed, "rc:",hex(rc&0xffffffff)
if rc == 0:
# we ignore exceptions to allow starting VM even if
# perf collector cannot be started
if perf:
try:
perf.setup(['*'], [mach], 10, 15)
except Exception,e:
print e
if g_verbose:
traceback.print_exc()
pass
# if session not opened, close doesn't make sense
session.close()
else:
reportError(ctx,session,rc)
def getMachines(ctx, invalidate = False):
if ctx['vb'] is not None:
if ctx['_machlist'] is None or invalidate:
ctx['_machlist'] = ctx['global'].getArray(ctx['vb'], 'machines')
return ctx['_machlist']
else:
return []
def asState(var):
if var:
return 'on'
else:
return 'off'
def perfStats(ctx,mach):
if not ctx['perf']:
return
for metric in ctx['perf'].query(["*"], [mach]):
print metric['name'], metric['values_as_string']
def guestExec(ctx, machine, console, cmds):
exec cmds
def monitorGuest(ctx, machine, console, dur):
cb = ctx['global'].createCallback('IConsoleCallback', GuestMonitor, machine)
console.registerCallback(cb)
if dur == -1:
# not infinity, but close enough
dur = 100000
try:
end = time.time() + dur
while time.time() < end:
ctx['global'].waitForEvents(500)
# We need to catch all exceptions here, otherwise callback will never be unregistered
except:
pass
console.unregisterCallback(cb)
def monitorVBox(ctx, dur):
vbox = ctx['vb']
isMscom = (ctx['global'].type == 'MSCOM')
cb = ctx['global'].createCallback('IVirtualBoxCallback', VBoxMonitor, [vbox, isMscom])
vbox.registerCallback(cb)
if dur == -1:
# not infinity, but close enough
dur = 100000
try:
end = time.time() + dur
while time.time() < end:
ctx['global'].waitForEvents(500)
# We need to catch all exceptions here, otherwise callback will never be unregistered
except:
pass
vbox.unregisterCallback(cb)
def takeScreenshot(ctx,console,args):
from PIL import Image
display = console.display
if len(args) > 0:
f = args[0]
else:
f = "/tmp/screenshot.png"
if len(args) > 1:
w = args[1]
else:
w = console.display.width
if len(args) > 2:
h = args[2]
else:
h = console.display.height
print "Saving screenshot (%d x %d) in %s..." %(w,h,f)
data = display.takeScreenShotSlow(w,h)
size = (w,h)
mode = "RGBA"
im = Image.frombuffer(mode, size, data, "raw", mode, 0, 1)
im.save(f, "PNG")
def teleport(ctx,session,console,args):
if args[0].find(":") == -1:
print "Use host:port format for teleport target"
return
(host,port) = args[0].split(":")
if len(args) > 1:
passwd = args[1]
else:
passwd = ""
port = int(port)
print "Teleporting to %s:%d..." %(host,port)
progress = console.teleport(host, port, passwd)
progressBar(ctx, progress, 100)
completed = progress.completed
rc = int(progress.resultCode)
if rc == 0:
print "Success!"
else:
reportError(ctx,session,rc)
def guestStats(ctx,console,args):
guest = console.guest
# we need to set up guest statistics
if len(args) > 0 :
update = args[0]
else:
update = 1
if guest.statisticsUpdateInterval != update:
guest.statisticsUpdateInterval = update
try:
time.sleep(float(update)+0.1)
except:
# to allow sleep interruption
pass
all_stats = ctx['ifaces'].all_values('GuestStatisticType')
cpu = 0
for s in all_stats.keys():
try:
val = guest.getStatistic( cpu, all_stats[s])
print "%s: %d" %(s, val)
except:
# likely not implemented
pass
def plugCpu(ctx,machine,session,args):
cpu = int(args)
print "Adding CPU %d..." %(cpu)
machine.HotPlugCPU(cpu)
def unplugCpu(ctx,machine,session,args):
cpu = int(args)
print "Removing CPU %d..." %(cpu)
machine.HotUnplugCPU(cpu)
def cmdExistingVm(ctx,mach,cmd,args):
mgr=ctx['mgr']
vb=ctx['vb']
session = mgr.getSessionObject(vb)
uuid = mach.id
try:
progress = vb.openExistingSession(session, uuid)
except Exception,e:
print "Session to '%s' not open: %s" %(mach.name,e)
if g_verbose:
traceback.print_exc()
return
if str(session.state) != str(ctx['ifaces'].SessionState_Open):
print "Session to '%s' in wrong state: %s" %(mach.name, session.state)
return
# this could be an example how to handle local only (i.e. unavailable
# in Webservices) functionality
if ctx['remote'] and cmd == 'some_local_only_command':
print 'Trying to use local only functionality, ignored'
return
console=session.console
ops={'pause': lambda: console.pause(),
'resume': lambda: console.resume(),
'powerdown': lambda: console.powerDown(),
'powerbutton': lambda: console.powerButton(),
'stats': lambda: perfStats(ctx, mach),
'guest': lambda: guestExec(ctx, mach, console, args),
'monitorGuest': lambda: monitorGuest(ctx, mach, console, args),
'save': lambda: progressBar(ctx,console.saveState()),
'screenshot': lambda: takeScreenshot(ctx,console,args),
'teleport': lambda: teleport(ctx,session,console,args),
'gueststats': lambda: guestStats(ctx, console, args),
'plugcpu': lambda: plugCpu(ctx, session.machine, session, args),
'unplugcpu': lambda: unplugCpu(ctx, session.machine, session, args),
}
try:
ops[cmd]()
except Exception, e:
print 'failed: ',e
if g_verbose:
traceback.print_exc()
session.close()
def machById(ctx,id):
mach = None
for m in getMachines(ctx):
if m.name == id:
mach = m
break
mid = str(m.id)
if mid[0] == '{':
mid = mid[1:-1]
if mid == id:
mach = m
break
return mach
def argsToMach(ctx,args):
if len(args) < 2:
print "usage: %s [vmname|uuid]" %(args[0])
return None
id = args[1]
m = machById(ctx, id)
if m == None:
print "Machine '%s' is unknown, use list command to find available machines" %(id)
return m
def helpSingleCmd(cmd,h,sp):
if sp != 0:
spec = " [ext from "+sp+"]"
else:
spec = ""
print " %s: %s%s" %(cmd,h,spec)
def helpCmd(ctx, args):
if len(args) == 1:
print "Help page:"
names = commands.keys()
names.sort()
for i in names:
helpSingleCmd(i, commands[i][0], commands[i][2])
else:
cmd = args[1]
c = commands.get(cmd)
if c == None:
print "Command '%s' not known" %(cmd)
else:
helpSingleCmd(cmd, c[0], c[2])
return 0
def listCmd(ctx, args):
for m in getMachines(ctx, True):
if m.teleporterEnabled:
tele = "[T] "
else:
tele = " "
print "%sMachine '%s' [%s], state=%s" %(tele,m.name,m.id,m.sessionState)
return 0
def getControllerType(type):
if type == 0:
return "Null"
elif type == 1:
return "LsiLogic"
elif type == 2:
return "BusLogic"
elif type == 3:
return "IntelAhci"
elif type == 4:
return "PIIX3"
elif type == 5:
return "PIIX4"
elif type == 6:
return "ICH6"
else:
return "Unknown"
def getFirmwareType(type):
if type == 0:
return "invalid"
elif type == 1:
return "bios"
elif type == 2:
return "efi"
elif type == 3:
return "efi64"
elif type == 4:
return "efidual"
else:
return "Unknown"
def asEnumElem(ctx,enum,elem):
all = ctx['ifaces'].all_values(enum)
for e in all.keys():
if elem == all[e]:
return e
return "<unknown>"
def infoCmd(ctx,args):
if (len(args) < 2):
print "usage: info [vmname|uuid]"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
os = ctx['vb'].getGuestOSType(mach.OSTypeId)
print " One can use setvar <mach> <var> <value> to change variable, using name in []."
print " Name [name]: %s" %(mach.name)
print " ID [n/a]: %s" %(mach.id)
print " OS Type [n/a]: %s" %(os.description)
print " Firmware [firmwareType]: %s (%s)" %(getFirmwareType(mach.firmwareType),mach.firmwareType)
print
print " CPUs [CPUCount]: %d" %(mach.CPUCount)
print " RAM [memorySize]: %dM" %(mach.memorySize)
print " VRAM [VRAMSize]: %dM" %(mach.VRAMSize)
print " Monitors [monitorCount]: %d" %(mach.monitorCount)
print
print " Clipboard mode [clipboardMode]: %d" %(mach.clipboardMode)
print " Machine status [n/a]: %d" % (mach.sessionState)
print
if mach.teleporterEnabled:
print " Teleport target on port %d (%s)" %(mach.teleporterPort, mach.teleporterPassword)
print
bios = mach.BIOSSettings
print " ACPI [BIOSSettings.ACPIEnabled]: %s" %(asState(bios.ACPIEnabled))
print " APIC [BIOSSettings.IOAPICEnabled]: %s" %(asState(bios.IOAPICEnabled))
hwVirtEnabled = mach.getHWVirtExProperty(ctx['global'].constants.HWVirtExPropertyType_Enabled)
print " Hardware virtualization [mach.setHWVirtExProperty(ctx['global'].constants.HWVirtExPropertyType_Enabled,value)]: " + asState(hwVirtEnabled)
hwVirtVPID = mach.getHWVirtExProperty(ctx['global'].constants.HWVirtExPropertyType_VPID)
print " VPID support [mach.setHWVirtExProperty(ctx['global'].constants.HWVirtExPropertyType_VPID,value)]: " + asState(hwVirtVPID)
hwVirtNestedPaging = mach.getHWVirtExProperty(ctx['global'].constants.HWVirtExPropertyType_NestedPaging)
print " Nested paging [mach.setHWVirtExProperty(ctx['global'].constants.HWVirtExPropertyType_NestedPaging,value)]: " + asState(hwVirtNestedPaging)
print " Hardware 3d acceleration[accelerate3DEnabled]: " + asState(mach.accelerate3DEnabled)
print " Hardware 2d video acceleration[accelerate2DVideoEnabled]: " + asState(mach.accelerate2DVideoEnabled)
print " HPET [hpetEnabled]: %s" %(asState(mach.hpetEnabled))
print " Keyboard [keyboardHidType]: %s (%s)" %(asEnumElem(ctx,"KeyboardHidType", mach.keyboardHidType), mach.keyboardHidType)
print " Pointing device [pointingHidType]: %s (%s)" %(asEnumElem(ctx,"PointingHidType", mach.pointingHidType), mach.pointingHidType)
print " Last changed [n/a]: " + time.asctime(time.localtime(long(mach.lastStateChange)/1000))
print " VRDP server [VRDPServer.enabled]: %s" %(asState(mach.VRDPServer.enabled))
controllers = ctx['global'].getArray(mach, 'storageControllers')
if controllers:
print
print " Controllers:"
for controller in controllers:
print " %s %s bus: %d" % (controller.name, getControllerType(controller.controllerType), controller.bus)
attaches = ctx['global'].getArray(mach, 'mediumAttachments')
if attaches:
print
print " Mediums:"
for a in attaches:
print " Controller: %s port: %d device: %d type: %s:" % (a.controller, a.port, a.device, a.type)
m = a.medium
if a.type == ctx['global'].constants.DeviceType_HardDisk:
print " HDD:"
print " Id: %s" %(m.id)
print " Location: %s" %(m.location)
print " Name: %s" %(m.name)
print " Format: %s" %(m.format)
if a.type == ctx['global'].constants.DeviceType_DVD:
print " DVD:"
if m:
print " Id: %s" %(m.id)
print " Name: %s" %(m.name)
if m.hostDrive:
print " Host DVD %s" %(m.location)
if a.passthrough:
print " [passthrough mode]"
else:
print " Virtual image at %s" %(m.location)
print " Size: %s" %(m.size)
if a.type == ctx['global'].constants.DeviceType_Floppy:
print " Floppy:"
if m:
print " Id: %s" %(m.id)
print " Name: %s" %(m.name)
if m.hostDrive:
print " Host floppy %s" %(m.location)
else:
print " Virtual image at %s" %(m.location)
print " Size: %s" %(m.size)
return 0
def startCmd(ctx, args):
mach = argsToMach(ctx,args)
if mach == None:
return 0
if len(args) > 2:
type = args[2]
else:
type = "gui"
startVm(ctx, mach, type)
return 0
def createCmd(ctx, args):
if (len(args) < 3 or len(args) > 4):
print "usage: create name ostype <basefolder>"
return 0
name = args[1]
oskind = args[2]
if len(args) == 4:
base = args[3]
else:
base = ''
try:
ctx['vb'].getGuestOSType(oskind)
except Exception, e:
print 'Unknown OS type:',oskind
return 0
createVm(ctx, name, oskind, base)
return 0
def removeCmd(ctx, args):
mach = argsToMach(ctx,args)
if mach == None:
return 0
removeVm(ctx, mach)
return 0
def pauseCmd(ctx, args):
mach = argsToMach(ctx,args)
if mach == None:
return 0
cmdExistingVm(ctx, mach, 'pause', '')
return 0
def powerdownCmd(ctx, args):
mach = argsToMach(ctx,args)
if mach == None:
return 0
cmdExistingVm(ctx, mach, 'powerdown', '')
return 0
def powerbuttonCmd(ctx, args):
mach = argsToMach(ctx,args)
if mach == None:
return 0
cmdExistingVm(ctx, mach, 'powerbutton', '')
return 0
def resumeCmd(ctx, args):
mach = argsToMach(ctx,args)
if mach == None:
return 0
cmdExistingVm(ctx, mach, 'resume', '')
return 0
def saveCmd(ctx, args):
mach = argsToMach(ctx,args)
if mach == None:
return 0
cmdExistingVm(ctx, mach, 'save', '')
return 0
def statsCmd(ctx, args):
mach = argsToMach(ctx,args)
if mach == None:
return 0
cmdExistingVm(ctx, mach, 'stats', '')
return 0
def guestCmd(ctx, args):
if (len(args) < 3):
print "usage: guest name commands"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
cmdExistingVm(ctx, mach, 'guest', ' '.join(args[2:]))
return 0
def screenshotCmd(ctx, args):
if (len(args) < 3):
print "usage: screenshot name file <width> <height>"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
cmdExistingVm(ctx, mach, 'screenshot', args[2:])
return 0
def teleportCmd(ctx, args):
if (len(args) < 3):
print "usage: teleport name host:port <password>"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
cmdExistingVm(ctx, mach, 'teleport', args[2:])
return 0
def openportalCmd(ctx, args):
if (len(args) < 3):
print "usage: openportal name port <password>"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
port = int(args[2])
if (len(args) > 3):
passwd = args[3]
else:
passwd = ""
if not mach.teleporterEnabled or mach.teleporterPort != port or passwd:
session = ctx['global'].openMachineSession(mach.id)
mach1 = session.machine
mach1.teleporterEnabled = True
mach1.teleporterPort = port
mach1.teleporterPassword = passwd
mach1.saveSettings()
session.close()
startVm(ctx, mach, "gui")
return 0
def closeportalCmd(ctx, args):
if (len(args) < 2):
print "usage: closeportal name"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
if mach.teleporterEnabled:
session = ctx['global'].openMachineSession(mach.id)
mach1 = session.machine
mach1.teleporterEnabled = False
mach1.saveSettings()
session.close()
return 0
def gueststatsCmd(ctx, args):
if (len(args) < 2):
print "usage: gueststats name <check interval>"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
cmdExistingVm(ctx, mach, 'gueststats', args[2:])
return 0
def plugcpuCmd(ctx, args):
if (len(args) < 2):
print "usage: plugcpu name cpuid"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
cmdExistingVm(ctx, mach, 'plugcpu', args[2])
return 0
def unplugcpuCmd(ctx, args):
if (len(args) < 2):
print "usage: unplugcpu name cpuid"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
cmdExistingVm(ctx, mach, 'unplugcpu', args[2])
return 0
def setvarCmd(ctx, args):
if (len(args) < 4):
print "usage: setvar [vmname|uuid] expr value"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
session = ctx['global'].openMachineSession(mach.id)
mach = session.machine
expr = 'mach.'+args[2]+' = '+args[3]
print "Executing",expr
try:
exec expr
except Exception, e:
print 'failed: ',e
if g_verbose:
traceback.print_exc()
mach.saveSettings()
session.close()
return 0
def setExtraDataCmd(ctx, args):
if (len(args) < 3):
print "usage: setextra [vmname|uuid|global] key <value>"
return 0
key = args[2]
if len(args) == 4:
value = args[3]
else:
value = None
if args[1] == 'global':
ctx['vb'].setExtraData(key, value)
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
session = ctx['global'].openMachineSession(mach.id)
mach = session.machine
mach.setExtraData(key, value)
mach.saveSettings()
session.close()
return 0
def printExtraKey(obj, key, value):
print "%s: '%s' = '%s'" %(obj, key, value)
def getExtraDataCmd(ctx, args):
if (len(args) < 2):
print "usage: getextra [vmname|uuid|global] <key>"
return 0
if len(args) == 3:
key = args[2]
else:
key = None
if args[1] == 'global':
obj = ctx['vb']
else:
obj = argsToMach(ctx,args)
if obj == None:
return 0
if key == None:
keys = obj.getExtraDataKeys()
else:
keys = [ key ]
for k in keys:
printExtraKey(args[1], k, ctx['vb'].getExtraData(k))
return 0
def quitCmd(ctx, args):
return 1
def aliasCmd(ctx, args):
if (len(args) == 3):
aliases[args[1]] = args[2]
return 0
for (k,v) in aliases.items():
print "'%s' is an alias for '%s'" %(k,v)
return 0
def verboseCmd(ctx, args):
global g_verbose
g_verbose = not g_verbose
return 0
def getUSBStateString(state):
if state == 0:
return "NotSupported"
elif state == 1:
return "Unavailable"
elif state == 2:
return "Busy"
elif state == 3:
return "Available"
elif state == 4:
return "Held"
elif state == 5:
return "Captured"
else:
return "Unknown"
def hostCmd(ctx, args):
host = ctx['vb'].host
cnt = host.processorCount
print "Processor count:",cnt
for i in range(0,cnt):
print "Processor #%d speed: %dMHz %s" %(i,host.getProcessorSpeed(i), host.getProcessorDescription(i))
print "RAM: %dM (free %dM)" %(host.memorySize, host.memoryAvailable)
print "OS: %s (%s)" %(host.operatingSystem, host.OSVersion)
if host.Acceleration3DAvailable:
print "3D acceleration available"
else:
print "3D acceleration NOT available"
print "Network interfaces:"
for ni in ctx['global'].getArray(host, 'networkInterfaces'):
print " %s (%s)" %(ni.name, ni.IPAddress)
print "DVD drives:"
for dd in ctx['global'].getArray(host, 'DVDDrives'):
print " %s - %s" %(dd.name, dd.description)
print "USB devices:"
for ud in ctx['global'].getArray(host, 'USBDevices'):
print " %s (vendorId=%d productId=%d serial=%s) %s" %(ud.product, ud.vendorId, ud.productId, ud.serialNumber, getUSBStateString(ud.state))
if ctx['perf']:
for metric in ctx['perf'].query(["*"], [host]):
print metric['name'], metric['values_as_string']
return 0
def monitorGuestCmd(ctx, args):
if (len(args) < 2):
print "usage: monitorGuest name (duration)"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
dur = 5
if len(args) > 2:
dur = float(args[2])
cmdExistingVm(ctx, mach, 'monitorGuest', dur)
return 0
def monitorVBoxCmd(ctx, args):
if (len(args) > 2):
print "usage: monitorVBox (duration)"
return 0
dur = 5
if len(args) > 1:
dur = float(args[1])
monitorVBox(ctx, dur)
return 0
def getAdapterType(ctx, type):
if (type == ctx['global'].constants.NetworkAdapterType_Am79C970A or
type == ctx['global'].constants.NetworkAdapterType_Am79C973):
return "pcnet"
elif (type == ctx['global'].constants.NetworkAdapterType_I82540EM or
type == ctx['global'].constants.NetworkAdapterType_I82545EM or
type == ctx['global'].constants.NetworkAdapterType_I82543GC):
return "e1000"
elif (type == ctx['global'].constants.NetworkAdapterType_Virtio):
return "virtio"
elif (type == ctx['global'].constants.NetworkAdapterType_Null):
return None
else:
raise Exception("Unknown adapter type: "+type)
def portForwardCmd(ctx, args):
if (len(args) != 5):
print "usage: portForward <vm> <adapter> <hostPort> <guestPort>"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
adapterNum = int(args[2])
hostPort = int(args[3])
guestPort = int(args[4])
proto = "TCP"
session = ctx['global'].openMachineSession(mach.id)
mach = session.machine
adapter = mach.getNetworkAdapter(adapterNum)
adapterType = getAdapterType(ctx, adapter.adapterType)
profile_name = proto+"_"+str(hostPort)+"_"+str(guestPort)
config = "VBoxInternal/Devices/" + adapterType + "/"
config = config + str(adapter.slot) +"/LUN#0/Config/" + profile_name
mach.setExtraData(config + "/Protocol", proto)
mach.setExtraData(config + "/HostPort", str(hostPort))
mach.setExtraData(config + "/GuestPort", str(guestPort))
mach.saveSettings()
session.close()
return 0
def showLogCmd(ctx, args):
if (len(args) < 2):
print "usage: showLog <vm> <num>"
return 0
mach = argsToMach(ctx,args)
if mach == None:
return 0
log = "VBox.log"
if (len(args) > 2):
log += "."+args[2]
fileName = os.path.join(mach.logFolder, log)
try:
lf = open(fileName, 'r')
except IOError,e:
print "cannot open: ",e
return 0
for line in lf:
print line,
lf.close()
return 0
def evalCmd(ctx, args):
expr = ' '.join(args[1:])
try:
exec expr
except Exception, e:
print 'failed: ',e
if g_verbose:
traceback.print_exc()
return 0
def reloadExtCmd(ctx, args):
# maybe will want more args smartness
checkUserExtensions(ctx, commands, getHomeFolder(ctx))
autoCompletion(commands, ctx)
return 0
def runScriptCmd(ctx, args):
if (len(args) != 2):
print "usage: runScript <script>"
return 0
try:
lf = open(args[1], 'r')
except IOError,e:
print "cannot open:",args[1], ":",e
return 0
try:
for line in lf:
done = runCommand(ctx, line)
if done != 0: break
except Exception,e:
print "error:",e
if g_verbose:
traceback.print_exc()
lf.close()
return 0
def sleepCmd(ctx, args):
if (len(args) != 2):
print "usage: sleep <secs>"
return 0
try:
time.sleep(float(args[1]))
except:
# to allow sleep interrupt
pass
return 0
def shellCmd(ctx, args):
if (len(args) < 2):
print "usage: shell <commands>"
return 0
cmd = ' '.join(args[1:])
try:
os.system(cmd)
except KeyboardInterrupt:
# to allow shell command interruption
pass
return 0
def connectCmd(ctx, args):
if (len(args) > 4):
print "usage: connect [url] [username] [passwd]"
return 0
if ctx['vb'] is not None:
print "Already connected, disconnect first..."
return 0
if (len(args) > 1):
url = args[1]
else:
url = None
if (len(args) > 2):
user = args[2]
else:
user = ""
if (len(args) > 3):
passwd = args[3]
else:
passwd = ""
vbox = ctx['global'].platform.connect(url, user, passwd)
ctx['vb'] = vbox
print "Running VirtualBox version %s" %(vbox.version)
ctx['perf'] = ctx['global'].getPerfCollector(ctx['vb'])
return 0
def disconnectCmd(ctx, args):
if (len(args) != 1):
print "usage: disconnect"
return 0
if ctx['vb'] is None:
print "Not connected yet."
return 0
try:
ctx['global'].platform.disconnect()
except:
ctx['vb'] = None
raise
ctx['vb'] = None
return 0
def exportVMCmd(ctx, args):
import sys
if len(args) < 3:
print "usage: exportVm <machine> <path> <format> <license>"
return 0
mach = ctx['machById'](args[1])
if mach is None:
return 0
path = args[2]
if (len(args) > 3):
format = args[3]
else:
format = "ovf-1.0"
if (len(args) > 4):
license = args[4]
else:
license = "GPL"
app = ctx['vb'].createAppliance()
desc = mach.export(app)
desc.addDescription(ctx['global'].constants.VirtualSystemDescriptionType_License, license, "")
p = app.write(format, path)
progressBar(ctx, p)
print "Exported to %s in format %s" %(path, format)
return 0
aliases = {'s':'start',
'i':'info',
'l':'list',
'h':'help',
'a':'alias',
'q':'quit', 'exit':'quit',
'v':'verbose'}
commands = {'help':['Prints help information', helpCmd, 0],
'start':['Start virtual machine by name or uuid: start Linux', startCmd, 0],
'create':['Create virtual machine', createCmd, 0],
'remove':['Remove virtual machine', removeCmd, 0],
'pause':['Pause virtual machine', pauseCmd, 0],
'resume':['Resume virtual machine', resumeCmd, 0],
'save':['Save execution state of virtual machine', saveCmd, 0],
'stats':['Stats for virtual machine', statsCmd, 0],
'powerdown':['Power down virtual machine', powerdownCmd, 0],
'powerbutton':['Effectively press power button', powerbuttonCmd, 0],
'list':['Shows known virtual machines', listCmd, 0],
'info':['Shows info on machine', infoCmd, 0],
'alias':['Control aliases', aliasCmd, 0],
'verbose':['Toggle verbosity', verboseCmd, 0],
'setvar':['Set VMs variable: setvar Fedora BIOSSettings.ACPIEnabled True', setvarCmd, 0],
'eval':['Evaluate arbitrary Python construction: eval \'for m in getMachines(ctx): print m.name,"has",m.memorySize,"M"\'', evalCmd, 0],
'quit':['Exits', quitCmd, 0],
'host':['Show host information', hostCmd, 0],
'guest':['Execute command for guest: guest Win32 \'console.mouse.putMouseEvent(20, 20, 0, 0)\'', guestCmd, 0],
'monitorGuest':['Monitor what happens with the guest for some time: monitorGuest Win32 10', monitorGuestCmd, 0],
'monitorVBox':['Monitor what happens with Virtual Box for some time: monitorVBox 10', monitorVBoxCmd, 0],
'portForward':['Setup permanent port forwarding for a VM, takes adapter number host port and guest port: portForward Win32 0 8080 80', portForwardCmd, 0],
'showLog':['Show log file of the VM, : showLog Win32', showLogCmd, 0],
'reloadExt':['Reload custom extensions: reloadExt', reloadExtCmd, 0],
'runScript':['Run VBox script: runScript script.vbox', runScriptCmd, 0],
'sleep':['Sleep for specified number of seconds: sleep 3.14159', sleepCmd, 0],
'shell':['Execute external shell command: shell "ls /etc/rc*"', shellCmd, 0],
'exportVm':['Export VM in OVF format: export Win /tmp/win.ovf', exportVMCmd, 0],
'screenshot':['Take VM screenshot to a file: screenshot Win /tmp/win.png 1024 768', screenshotCmd, 0],
'teleport':['Teleport VM to another box (see openportal): teleport Win anotherhost:8000 <passwd>', teleportCmd, 0],
'openportal':['Open portal for teleportation of VM from another box (see teleport): openportal Win 8000 <passwd>', openportalCmd, 0],
'closeportal':['Close teleportation portal (see openportal,teleport): closeportal Win', closeportalCmd, 0],
'getextra':['Get extra data, empty key lists all: getextra <vm|global> <key>', getExtraDataCmd, 0],
'setextra':['Set extra data, empty value removes key: setextra <vm|global> <key> <value>', setExtraDataCmd, 0],
'gueststats':['Print available guest stats (only Windows guests with additions so far): gueststats Win32', gueststatsCmd, 0],
'plugcpu':['Add a CPU to a running VM: plugcpu Win 1', plugcpuCmd, 0],
'unplugcpu':['Remove a CPU from a running VM: plugcpu Win 1', unplugcpuCmd, 0],
}
def runCommandArgs(ctx, args):
c = args[0]
if aliases.get(c, None) != None:
c = aliases[c]
ci = commands.get(c,None)
if ci == None:
print "Unknown command: '%s', type 'help' for list of known commands" %(c)
return 0
return ci[1](ctx, args)
def runCommand(ctx, cmd):
if len(cmd) == 0: return 0
args = split_no_quotes(cmd)
if len(args) == 0: return 0
return runCommandArgs(ctx, args)
#
# To write your own custom commands to vboxshell, create
# file ~/.VirtualBox/shellext.py with content like
#
# def runTestCmd(ctx, args):
# print "Testy test", ctx['vb']
# return 0
#
# commands = {
# 'test': ['Test help', runTestCmd]
# }
# and issue reloadExt shell command.
# This file also will be read automatically on startup or 'reloadExt'.
#
# Also one can put shell extensions into ~/.VirtualBox/shexts and
# they will also be picked up, so this way one can exchange
# shell extensions easily.
def addExtsFromFile(ctx, cmds, file):
if not os.path.isfile(file):
return
d = {}
try:
execfile(file, d, d)
for (k,v) in d['commands'].items():
if g_verbose:
print "customize: adding \"%s\" - %s" %(k, v[0])
cmds[k] = [v[0], v[1], file]
except:
print "Error loading user extensions from %s" %(file)
traceback.print_exc()
def checkUserExtensions(ctx, cmds, folder):
folder = str(folder)
name = os.path.join(folder, "shellext.py")
addExtsFromFile(ctx, cmds, name)
# also check 'exts' directory for all files
shextdir = os.path.join(folder, "shexts")
if not os.path.isdir(shextdir):
return
exts = os.listdir(shextdir)
for e in exts:
addExtsFromFile(ctx, cmds, os.path.join(shextdir,e))
def getHomeFolder(ctx):
if ctx['remote'] or ctx['vb'] is None:
return os.path.join(os.path.expanduser("~"), ".VirtualBox")
else:
return ctx['vb'].homeFolder
def interpret(ctx):
if ctx['remote']:
commands['connect'] = ["Connect to remote VBox instance", connectCmd, 0]
commands['disconnect'] = ["Disconnect from remote VBox instance", disconnectCmd, 0]
vbox = ctx['vb']
if vbox is not None:
print "Running VirtualBox version %s" %(vbox.version)
ctx['perf'] = ctx['global'].getPerfCollector(vbox)
else:
ctx['perf'] = None
home = getHomeFolder(ctx)
checkUserExtensions(ctx, commands, home)
autoCompletion(commands, ctx)
# to allow to print actual host information, we collect info for
# last 150 secs maximum, (sample every 10 secs and keep up to 15 samples)
if ctx['perf']:
try:
ctx['perf'].setup(['*'], [vbox.host], 10, 15)
except:
pass
while True:
try:
cmd = raw_input("vbox> ")
done = runCommand(ctx, cmd)
if done != 0: break
except KeyboardInterrupt:
print '====== You can type quit or q to leave'
break
except EOFError:
break;
except Exception,e:
print e
if g_verbose:
traceback.print_exc()
ctx['global'].waitForEvents(0)
try:
# There is no need to disable metric collection. This is just an example.
if ct['perf']:
ctx['perf'].disable(['*'], [vbox.host])
except:
pass
def runCommandCb(ctx, cmd, args):
args.insert(0, cmd)
return runCommandArgs(ctx, args)
def main(argv):
style = None
autopath = False
argv.pop(0)
while len(argv) > 0:
if argv[0] == "-w":
style = "WEBSERVICE"
if argv[0] == "-a":
autopath = True
argv.pop(0)
if autopath:
cwd = os.getcwd()
vpp = os.environ.get("VBOX_PROGRAM_PATH")
if vpp is None and (os.path.isfile(os.path.join(cwd, "VirtualBox")) or os.path.isfile(os.path.join(cwd, "VirtualBox.exe"))) :
vpp = cwd
print "Autodetected VBOX_PROGRAM_PATH as",vpp
os.environ["VBOX_PROGRAM_PATH"] = cwd
sys.path.append(os.path.join(vpp, "sdk", "installer"))
from vboxapi import VirtualBoxManager
g_virtualBoxManager = VirtualBoxManager(style, None)
ctx = {'global':g_virtualBoxManager,
'mgr':g_virtualBoxManager.mgr,
'vb':g_virtualBoxManager.vbox,
'ifaces':g_virtualBoxManager.constants,
'remote':g_virtualBoxManager.remote,
'type':g_virtualBoxManager.type,
'run': lambda cmd,args: runCommandCb(ctx, cmd, args),
'machById': lambda id: machById(ctx,id),
'argsToMach': lambda args: argsToMach(ctx,args),
'progressBar': lambda p: progressBar(ctx,p),
'_machlist':None
}
interpret(ctx)
g_virtualBoxManager.deinit()
del g_virtualBoxManager
if __name__ == '__main__':
main(sys.argv)