/* $Id: VBoxManage.cpp 13835 2008-11-05 02:34:43Z vboxsync $ */ /** @file * VBoxManage - VirtualBox's command-line interface. */ /* * Copyright (C) 2006-2007 Sun Microsystems, Inc. * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; * you can redistribute it and/or modify it under the terms of the GNU * General Public License (GPL) as published by the Free Software * Foundation, in version 2 as it comes in the "COPYING" file of the * VirtualBox OSE distribution. VirtualBox OSE is distributed in the * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. * * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa * Clara, CA 95054 USA or visit http://www.sun.com if you need * additional information or have any questions. */ /******************************************************************************* * Header Files * *******************************************************************************/ #ifndef VBOX_ONLY_DOCS #include #include #include #include #include #include #include #include #include #include #include #endif /* !VBOX_ONLY_DOCS */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "VBoxManage.h" #ifndef VBOX_ONLY_DOCS using namespace com; /* missing XPCOM <-> COM wrappers */ #ifndef STDMETHOD_ # define STDMETHOD_(ret, meth) NS_IMETHOD_(ret) meth #endif #ifndef NS_GET_IID # define NS_GET_IID(I) IID_##I #endif #ifndef RT_OS_WINDOWS #define IUnknown nsISupports #endif /** command handler type */ typedef DECLCALLBACK(int) FNHANDLER(int argc, char *argv[], ComPtr aVirtualBox, ComPtr aSession); typedef FNHANDLER *PFNHANDLER; /** * Quick IUSBDevice implementation for detaching / attaching * devices to the USB Controller. */ class MyUSBDevice : public IUSBDevice { public: // public initializer/uninitializer for internal purposes only MyUSBDevice(uint16_t a_u16VendorId, uint16_t a_u16ProductId, uint16_t a_bcdRevision, uint64_t a_u64SerialHash, const char *a_pszComment) : m_usVendorId(a_u16VendorId), m_usProductId(a_u16ProductId), m_bcdRevision(a_bcdRevision), m_u64SerialHash(a_u64SerialHash), m_bstrComment(a_pszComment), m_cRefs(0) { } STDMETHOD_(ULONG, AddRef)(void) { return ASMAtomicIncU32(&m_cRefs); } STDMETHOD_(ULONG, Release)(void) { ULONG cRefs = ASMAtomicDecU32(&m_cRefs); if (!cRefs) delete this; return cRefs; } STDMETHOD(QueryInterface)(const IID &iid, void **ppvObject) { Guid guid(iid); if (guid == Guid(NS_GET_IID(IUnknown))) *ppvObject = (IUnknown *)this; else if (guid == Guid(NS_GET_IID(IUSBDevice))) *ppvObject = (IUSBDevice *)this; else return E_NOINTERFACE; AddRef(); return S_OK; } STDMETHOD(COMGETTER(Id))(GUIDPARAMOUT a_pId) { return E_NOTIMPL; } STDMETHOD(COMGETTER(VendorId))(USHORT *a_pusVendorId) { *a_pusVendorId = m_usVendorId; return S_OK; } STDMETHOD(COMGETTER(ProductId))(USHORT *a_pusProductId) { *a_pusProductId = m_usProductId; return S_OK; } STDMETHOD(COMGETTER(Revision))(USHORT *a_pusRevision) { *a_pusRevision = m_bcdRevision; return S_OK; } STDMETHOD(COMGETTER(SerialHash))(ULONG64 *a_pullSerialHash) { *a_pullSerialHash = m_u64SerialHash; return S_OK; } STDMETHOD(COMGETTER(Manufacturer))(BSTR *a_pManufacturer) { return E_NOTIMPL; } STDMETHOD(COMGETTER(Product))(BSTR *a_pProduct) { return E_NOTIMPL; } STDMETHOD(COMGETTER(SerialNumber))(BSTR *a_pSerialNumber) { return E_NOTIMPL; } STDMETHOD(COMGETTER(Address))(BSTR *a_pAddress) { return E_NOTIMPL; } private: /** The vendor id of this USB device. */ USHORT m_usVendorId; /** The product id of this USB device. */ USHORT m_usProductId; /** The product revision number of this USB device. * (high byte = integer; low byte = decimal) */ USHORT m_bcdRevision; /** The USB serial hash of the device. */ uint64_t m_u64SerialHash; /** The user comment string. */ Bstr m_bstrComment; /** Reference counter. */ uint32_t volatile m_cRefs; }; // types /////////////////////////////////////////////////////////////////////////////// template class Nullable { public: Nullable() : mIsNull (true) {} Nullable (const T &aValue, bool aIsNull = false) : mIsNull (aIsNull), mValue (aValue) {} bool isNull() const { return mIsNull; }; void setNull (bool aIsNull = true) { mIsNull = aIsNull; } operator const T&() const { return mValue; } Nullable &operator= (const T &aValue) { mValue = aValue; mIsNull = false; return *this; } private: bool mIsNull; T mValue; }; /** helper structure to encapsulate USB filter manipulation commands */ struct USBFilterCmd { struct USBFilter { USBFilter () : mAction (USBDeviceFilterAction_Null) {} Bstr mName; Nullable mActive; Bstr mVendorId; Bstr mProductId; Bstr mRevision; Bstr mManufacturer; Bstr mProduct; Bstr mRemote; Bstr mSerialNumber; Nullable mMaskedInterfaces; USBDeviceFilterAction_T mAction; }; enum Action { Invalid, Add, Modify, Remove }; USBFilterCmd() : mAction (Invalid), mIndex (0), mGlobal (false) {} Action mAction; ULONG mIndex; /** flag whether the command target is a global filter */ bool mGlobal; /** machine this command is targeted at (null for global filters) */ ComPtr mMachine; USBFilter mFilter; }; #endif /* !VBOX_ONLY_DOCS */ // funcs /////////////////////////////////////////////////////////////////////////////// static void showLogo(void) { static bool fShown; /* show only once */ if (!fShown) { RTPrintf("VirtualBox Command Line Management Interface Version " VBOX_VERSION_STRING "\n" "(C) 2005-2008 Sun Microsystems, Inc.\n" "All rights reserved.\n" "\n"); fShown = true; } } static void printUsage(USAGECATEGORY u64Cmd) { #ifdef RT_OS_LINUX bool fLinux = true; #else bool fLinux = false; #endif #ifdef RT_OS_WINDOWS bool fWin = true; #else bool fWin = false; #endif #ifdef RT_OS_SOLARIS bool fSolaris = true; #else bool fSolaris = false; #endif #ifdef RT_OS_DARWIN bool fDarwin = true; #else bool fDarwin = false; #endif #ifdef VBOX_WITH_VRDP bool fVRDP = true; #else bool fVRDP = false; #endif if (u64Cmd == USAGE_DUMPOPTS) { fLinux = true; fWin = true; fSolaris = true; fDarwin = true; fVRDP = true; u64Cmd = USAGE_ALL; } RTPrintf("Usage:\n" "\n"); if (u64Cmd == USAGE_ALL) { RTPrintf("VBoxManage [-v|-version] print version number and exit\n" "VBoxManage -nologo ... suppress the logo\n" "\n" "VBoxManage -convertSettings ... allow to auto-convert settings files\n" "VBoxManage -convertSettingsBackup ... allow to auto-convert settings files\n" " but create backup copies before\n" "VBoxManage -convertSettingsIgnore ... allow to auto-convert settings files\n" " but don't explicitly save the results\n" "\n"); } if (u64Cmd & USAGE_LIST) { RTPrintf("VBoxManage list vms|runningvms|ostypes|hostdvds|hostfloppies|\n" " hostifs|hostinfo|hdds|dvds|floppies|\n" " usbhost|usbfilters|systemproperties\n" "\n"); } if (u64Cmd & USAGE_SHOWVMINFO) { RTPrintf("VBoxManage showvminfo |\n" " [-details]\n" " [-statistics]\n" " [-machinereadable]\n" "\n"); } if (u64Cmd & USAGE_REGISTERVM) { RTPrintf("VBoxManage registervm \n" "\n"); } if (u64Cmd & USAGE_UNREGISTERVM) { RTPrintf("VBoxManage unregistervm |\n" " [-delete]\n" "\n"); } if (u64Cmd & USAGE_CREATEVM) { RTPrintf("VBoxManage createvm -name \n" " [-register]\n" " [-basefolder | -settingsfile ]\n" " [-uuid ]\n" " \n" "\n"); } if (u64Cmd & USAGE_MODIFYVM) { RTPrintf("VBoxManage modifyvm \n" " [-name ]\n" " [-ostype ]\n" " [-memory ]\n" " [-vram ]\n" " [-acpi on|off]\n" " [-ioapic on|off]\n" " [-pae on|off]\n" " [-hwvirtex on|off|default]\n" " [-nestedpaging on|off]\n" " [-vtxvpid on|off]\n" " [-monitorcount ]\n" " [-bioslogofadein on|off]\n" " [-bioslogofadeout on|off]\n" " [-bioslogodisplaytime ]\n" " [-bioslogoimagepath ]\n" " [-biosbootmenu disabled|menuonly|messageandmenu]\n" " [-biossystemtimeoffset ]\n" " [-biospxedebug on|off]\n" " [-boot<1-4> none|floppy|dvd|disk|net>]\n" " [-hd none||]\n" " [-idecontroller PIIX3|PIIX4]\n" #ifdef VBOX_WITH_AHCI " [-sata on|off]\n" " [-sataportcount <1-30>]\n" " [-sataport<1-30> none||]\n" " [-sataideemulation<1-4> <1-30>]\n" #endif " [-dvd none|||host:]\n" " [-dvdpassthrough on|off]\n" " [-floppy disabled|empty||\n" " |host:]\n" " [-nic<1-N> none|null|nat|hostif|intnet]\n" " [-nictype<1-N> Am79C970A|Am79C973" #ifdef VBOX_WITH_E1000 "|82540EM|82543GC" #endif "]\n" " [-cableconnected<1-N> on|off]\n" " [-nictrace<1-N> on|off]\n" " [-nictracefile<1-N> ]\n" " [-nicspeed<1-N> ]\n" " [-hostifdev<1-N> none|]\n" " [-intnet<1-N> ]\n" " [-natnet<1-N> |default]\n" " [-macaddress<1-N> auto|]\n" " [-uart<1-N> off| ]\n" " [-uartmode<1-N> disconnected|\n" " server |\n" " client |\n" " ]\n" #ifdef VBOX_WITH_MEM_BALLOONING " [-guestmemoryballoon ]\n" #endif " [-gueststatisticsinterval ]\n" ); if (fLinux) { RTPrintf(" [-tapsetup<1-N> none|]\n" " [-tapterminate<1-N> none|]\n"); } RTPrintf(" [-audio none|null"); if (fWin) { #ifdef VBOX_WITH_WINMM RTPrintf( "|winmm|dsound"); #else RTPrintf( "|dsound"); #endif } if (fSolaris) { RTPrintf( "|solaudio"); } if (fLinux) { RTPrintf( "|oss" #ifdef VBOX_WITH_ALSA "|alsa" #endif #ifdef VBOX_WITH_PULSE "|pulse" #endif ); } if (fDarwin) { RTPrintf( "|coreaudio"); } RTPrintf( "]\n"); RTPrintf(" [-audiocontroller ac97|sb16]\n" " [-clipboard disabled|hosttoguest|guesttohost|\n" " bidirectional]\n"); if (fVRDP) { RTPrintf(" [-vrdp on|off]\n" " [-vrdpport default|]\n" " [-vrdpaddress ]\n" " [-vrdpauthtype null|external|guest]\n" " [-vrdpmulticon on|off]\n" " [-vrdpreusecon on|off]\n"); } RTPrintf(" [-usb on|off]\n" " [-usbehci on|off]\n" " [-snapshotfolder default|]\n"); RTPrintf("\n"); } if (u64Cmd & USAGE_STARTVM) { RTPrintf("VBoxManage startvm |\n"); if (fVRDP) RTPrintf(" [-type gui|vrdp]\n"); RTPrintf("\n"); } if (u64Cmd & USAGE_CONTROLVM) { RTPrintf("VBoxManage controlvm |\n" " pause|resume|reset|poweroff|savestate|\n" " acpipowerbutton|acpisleepbutton|\n" " keyboardputscancode [ ...]|\n" " setlinkstate<1-4> on|off |\n" " usbattach |
|\n" " usbdetach |
|\n" " dvdattach none|||host: |\n" " floppyattach none|||host: |\n" " setvideomodehint [display]|\n" " setcredentials \n" " [-allowlocallogon ]\n" "\n"); } if (u64Cmd & USAGE_DISCARDSTATE) { RTPrintf("VBoxManage discardstate |\n" "\n"); } if (u64Cmd & USAGE_ADOPTSTATE) { RTPrintf("VBoxManage adoptstate | \n" "\n"); } if (u64Cmd & USAGE_SNAPSHOT) { RTPrintf("VBoxManage snapshot |\n" " take [-desc ] |\n" " discard | |\n" " discardcurrent -state|-all |\n" " edit ||-current\n" " [-newname ]\n" " [-newdesc ] |\n" " showvminfo |\n" "\n"); } if (u64Cmd & USAGE_REGISTERIMAGE) { RTPrintf("VBoxManage openmedium disk|dvd|floppy \n" " [-type normal|immutable|writethrough] (disk only)\n" "\n"); } if (u64Cmd & USAGE_UNREGISTERIMAGE) { RTPrintf("VBoxManage closemedium disk|dvd|floppy |\n" "\n"); } if (u64Cmd & USAGE_SHOWHDINFO) { RTPrintf("VBoxManage showhdinfo |\n" "\n"); } if (u64Cmd & USAGE_CREATEHD) { /// @todo NEWMEDIA add -format to specify the hard disk backend RTPrintf("VBoxManage createhd -filename \n" " -size \n" " [-static]\n" " [-comment ]\n" " [-register]\n" " [-type normal|writethrough] (default: normal)\n" "\n"); } if (u64Cmd & USAGE_MODIFYHD) { RTPrintf("VBoxManage modifyhd |\n" " settype normal|writethrough|immutable |\n" " compact\n" "\n"); } if (u64Cmd & USAGE_CLONEHD) { RTPrintf("VBoxManage clonehd | \n" "\n"); } if (u64Cmd & USAGE_CONVERTDD) { RTPrintf("VBoxManage convertdd [-static] \n" "VBoxManage convertdd [-static] stdin \n" "\n"); } if (u64Cmd & USAGE_ADDISCSIDISK) { RTPrintf("VBoxManage addiscsidisk -server |\n" " -target \n" " [-port ]\n" " [-lun ]\n" " [-encodedlun ]\n" " [-username ]\n" " [-password ]\n" " [-comment ]\n" "\n"); } if (u64Cmd & USAGE_CREATEHOSTIF && fWin) { RTPrintf("VBoxManage createhostif \n" "\n"); } if (u64Cmd & USAGE_REMOVEHOSTIF && fWin) { RTPrintf("VBoxManage removehostif |\n" "\n"); } if (u64Cmd & USAGE_GETEXTRADATA) { RTPrintf("VBoxManage getextradata global||\n" " |enumerate\n" "\n"); } if (u64Cmd & USAGE_SETEXTRADATA) { RTPrintf("VBoxManage setextradata global||\n" " \n" " [] (no value deletes key)\n" "\n"); } if (u64Cmd & USAGE_SETPROPERTY) { RTPrintf("VBoxManage setproperty hdfolder default| |\n" " machinefolder default| |\n" " vrdpauthlibrary default| |\n" " websrvauthlibrary default|null| |\n" " hwvirtexenabled yes|no\n" " loghistorycount \n" "\n"); } if (u64Cmd & USAGE_USBFILTER_ADD) { RTPrintf("VBoxManage usbfilter add \n" " -target ||global\n" " -name \n" " -action ignore|hold (global filters only)\n" " [-active yes|no] (yes)\n" " [-vendorid ] (null)\n" " [-productid ] (null)\n" " [-revision ] (null)\n" " [-manufacturer ] (null)\n" " [-product ] (null)\n" " [-remote yes|no] (null, VM filters only)\n" " [-serialnumber ] (null)\n" " [-maskedinterfaces ]\n" "\n"); } if (u64Cmd & USAGE_USBFILTER_MODIFY) { RTPrintf("VBoxManage usbfilter modify \n" " -target ||global\n" " [-name ]\n" " [-action ignore|hold] (global filters only)\n" " [-active yes|no]\n" " [-vendorid |\"\"]\n" " [-productid |\"\"]\n" " [-revision |\"\"]\n" " [-manufacturer |\"\"]\n" " [-product |\"\"]\n" " [-remote yes|no] (null, VM filters only)\n" " [-serialnumber |\"\"]\n" " [-maskedinterfaces ]\n" "\n"); } if (u64Cmd & USAGE_USBFILTER_REMOVE) { RTPrintf("VBoxManage usbfilter remove \n" " -target ||global\n" "\n"); } if (u64Cmd & USAGE_SHAREDFOLDER_ADD) { RTPrintf("VBoxManage sharedfolder add |\n" " -name -hostpath \n" " [-transient] [-readonly]\n" "\n"); } if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE) { RTPrintf("VBoxManage sharedfolder remove |\n" " -name [-transient]\n" "\n"); } if (u64Cmd & USAGE_VM_STATISTICS) { RTPrintf("VBoxManage vmstatistics | [-reset]\n" " [-pattern ] [-descriptions]\n" "\n"); } #ifdef VBOX_WITH_GUEST_PROPS if (u64Cmd & USAGE_GUESTPROPERTY) usageGuestProperty(); #endif /* VBOX_WITH_GUEST_PROPS defined */ if (u64Cmd & USAGE_METRICS) { RTPrintf("VBoxManage metrics list [*|host| []] (comma-separated)\n\n" "VBoxManage metrics setup\n" " [-period ]\n" " [-samples ]\n" " [-list]\n" " [*|host| []]\n\n" "VBoxManage metrics query [*|host| []]\n\n" "VBoxManage metrics collect\n" " [-period ]\n" " [-samples ]\n" " [-list]\n" " [-detach]\n" " [*|host| []]\n" "\n"); } } /** * Print a usage synopsis and the syntax error message. */ int errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...) { va_list args; showLogo(); // show logo even if suppressed #ifndef VBOX_ONLY_DOCS if (g_fInternalMode) printUsageInternal(u64Cmd); else printUsage(u64Cmd); #endif /* !VBOX_ONLY_DOCS */ va_start(args, pszFormat); RTPrintf("\n" "Syntax error: %N\n", pszFormat, &args); va_end(args); return 1; } /** * Print an error message without the syntax stuff. */ int errorArgument(const char *pszFormat, ...) { va_list args; va_start(args, pszFormat); RTPrintf("error: %N\n", pszFormat, &args); va_end(args); return 1; } #ifndef VBOX_ONLY_DOCS /** * Print out progress on the console */ static void showProgress(ComPtr progress) { BOOL fCompleted; LONG currentPercent; LONG lastPercent = 0; RTPrintf("0%%..."); RTStrmFlush(g_pStdOut); while (SUCCEEDED(progress->COMGETTER(Completed(&fCompleted)))) { progress->COMGETTER(Percent(¤tPercent)); /* did we cross a 10% mark? */ if (((currentPercent / 10) > (lastPercent / 10))) { /* make sure to also print out missed steps */ for (LONG curVal = (lastPercent / 10) * 10 + 10; curVal <= (currentPercent / 10) * 10; curVal += 10) { if (curVal < 100) { RTPrintf("%ld%%...", curVal); RTStrmFlush(g_pStdOut); } } lastPercent = (currentPercent / 10) * 10; } if (fCompleted) break; /* make sure the loop is not too tight */ progress->WaitForCompletion(100); } /* complete the line. */ HRESULT rc; if (SUCCEEDED(progress->COMGETTER(ResultCode)(&rc))) { if (SUCCEEDED(rc)) RTPrintf("100%%\n"); else RTPrintf("FAILED\n"); } else RTPrintf("\n"); RTStrmFlush(g_pStdOut); } static void showSnapshots(ComPtr rootSnapshot, VMINFO_DETAILS details, const Bstr &prefix = "", int level = 0) { /* start with the root */ Bstr name; Guid uuid; rootSnapshot->COMGETTER(Name)(name.asOutParam()); rootSnapshot->COMGETTER(Id)(uuid.asOutParam()); if (details == VMINFO_MACHINEREADABLE) { /* print with hierarchical numbering */ RTPrintf("SnapshotName%lS=\"%lS\"\n", prefix.raw(), name.raw()); RTPrintf("SnapshotUUID%lS=\"%s\"\n", prefix.raw(), uuid.toString().raw()); } else { /* print with indentation */ RTPrintf(" %lSName: %lS (UUID: %s)\n", prefix.raw(), name.raw(), uuid.toString().raw()); } /* get the children */ ComPtr coll; rootSnapshot->COMGETTER(Children)(coll.asOutParam()); if (coll) { ComPtr enumerator; coll->Enumerate(enumerator.asOutParam()); ULONG index = 0; BOOL hasMore = FALSE; while (enumerator->HasMore(&hasMore), hasMore) { ComPtr snapshot; enumerator->GetNext(snapshot.asOutParam()); if (snapshot) { Bstr newPrefix; if (details == VMINFO_MACHINEREADABLE) newPrefix = Utf8StrFmt("%lS-%d", prefix.raw(), index + 1); else newPrefix = Utf8StrFmt("%lS ", prefix.raw()); /* recursive call */ showSnapshots(snapshot, details, newPrefix, level + 1); } index++; } } } static void makeTimeStr (char *s, int cb, int64_t millies) { RTTIME t; RTTIMESPEC ts; RTTimeSpecSetMilli(&ts, millies); RTTimeExplode (&t, &ts); RTStrPrintf(s, cb, "%04d/%02d/%02d %02d:%02d:%02d UTC", t.i32Year, t.u8Month, t.u8MonthDay, t.u8Hour, t.u8Minute, t.u8Second); } static HRESULT showVMInfo (ComPtr virtualBox, ComPtr machine, ComPtr console = ComPtr (), VMINFO_DETAILS details = VMINFO_NONE) { HRESULT rc; /* * The rules for output in -argdump format: * 1) the key part (the [0-9a-zA-Z_]+ string before the '=' delimiter) * is all lowercase for "VBoxManage modifyvm" parameters. Any * other values printed are in CamelCase. * 2) strings (anything non-decimal) are printed surrounded by * double quotes '"'. If the strings themselves contain double * quotes, these characters are escaped by '\'. Any '\' character * in the original string is also escaped by '\'. * 3) numbers (containing just [0-9\-]) are written out unchanged. */ /** @todo the quoting is not yet implemented! */ BOOL accessible = FALSE; CHECK_ERROR (machine, COMGETTER(Accessible) (&accessible)); CheckComRCReturnRC (rc); if (!accessible) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("name=\"\"\n"); else RTPrintf ("Name: \n"); Guid uuid; rc = machine->COMGETTER(Id) (uuid.asOutParam()); if (details == VMINFO_MACHINEREADABLE) RTPrintf ("UUID=\"%s\"\n", uuid.toString().raw()); else RTPrintf ("UUID: %s\n", uuid.toString().raw()); if (details != VMINFO_MACHINEREADABLE) { Bstr settingsFilePath; rc = machine->COMGETTER(SettingsFilePath) (settingsFilePath.asOutParam()); RTPrintf ("Config file: %lS\n", settingsFilePath.raw()); ComPtr accessError; rc = machine->COMGETTER(AccessError) (accessError.asOutParam()); RTPrintf ("Access error details:\n"); ErrorInfo ei (accessError); PRINT_ERROR_INFO (ei); RTPrintf ("\n"); } return S_OK; } Bstr machineName; rc = machine->COMGETTER(Name)(machineName.asOutParam()); if (details == VMINFO_MACHINEREADABLE) RTPrintf("name=\"%lS\"\n", machineName.raw()); else RTPrintf("Name: %lS\n", machineName.raw()); Bstr osTypeId; rc = machine->COMGETTER(OSTypeId)(osTypeId.asOutParam()); ComPtr osType; rc = virtualBox->GetGuestOSType (osTypeId, osType.asOutParam()); Bstr osName; rc = osType->COMGETTER(Description)(osName.asOutParam()); if (details == VMINFO_MACHINEREADABLE) RTPrintf("ostype=\"%lS\"\n", osTypeId.raw()); else RTPrintf("Guest OS: %lS\n", osName.raw()); Guid uuid; rc = machine->COMGETTER(Id)(uuid.asOutParam()); if (details == VMINFO_MACHINEREADABLE) RTPrintf("UUID=\"%s\"\n", uuid.toString().raw()); else RTPrintf("UUID: %s\n", uuid.toString().raw()); Bstr settingsFilePath; rc = machine->COMGETTER(SettingsFilePath)(settingsFilePath.asOutParam()); if (details == VMINFO_MACHINEREADABLE) RTPrintf("CfgFile=\"%lS\"\n", settingsFilePath.raw()); else RTPrintf("Config file: %lS\n", settingsFilePath.raw()); ULONG memorySize; rc = machine->COMGETTER(MemorySize)(&memorySize); if (details == VMINFO_MACHINEREADABLE) RTPrintf("memory=%u\n", memorySize); else RTPrintf("Memory size: %uMB\n", memorySize); ULONG vramSize; rc = machine->COMGETTER(VRAMSize)(&vramSize); if (details == VMINFO_MACHINEREADABLE) RTPrintf("vram=%u\n", vramSize); else RTPrintf("VRAM size: %uMB\n", vramSize); ComPtr biosSettings; machine->COMGETTER(BIOSSettings)(biosSettings.asOutParam()); BIOSBootMenuMode_T bootMenuMode; biosSettings->COMGETTER(BootMenuMode)(&bootMenuMode); const char *pszBootMenu = NULL; switch (bootMenuMode) { case BIOSBootMenuMode_Disabled: pszBootMenu = "disabled"; break; case BIOSBootMenuMode_MenuOnly: if (details == VMINFO_MACHINEREADABLE) pszBootMenu = "menuonly"; else pszBootMenu = "menu only"; break; default: if (details == VMINFO_MACHINEREADABLE) pszBootMenu = "messageandmenu"; else pszBootMenu = "message and menu"; } if (details == VMINFO_MACHINEREADABLE) RTPrintf("bootmenu=\"%s\"\n", pszBootMenu); else RTPrintf("Boot menu mode: %s\n", pszBootMenu); BOOL acpiEnabled; biosSettings->COMGETTER(ACPIEnabled)(&acpiEnabled); if (details == VMINFO_MACHINEREADABLE) RTPrintf("acpi=\"%s\"\n", acpiEnabled ? "on" : "off"); else RTPrintf("ACPI: %s\n", acpiEnabled ? "on" : "off"); BOOL ioapicEnabled; biosSettings->COMGETTER(IOAPICEnabled)(&ioapicEnabled); if (details == VMINFO_MACHINEREADABLE) RTPrintf("ioapic=\"%s\"\n", ioapicEnabled ? "on" : "off"); else RTPrintf("IOAPIC: %s\n", ioapicEnabled ? "on" : "off"); BOOL PAEEnabled; machine->COMGETTER(PAEEnabled)(&PAEEnabled); if (details == VMINFO_MACHINEREADABLE) RTPrintf("pae=\"%s\"\n", PAEEnabled ? "on" : "off"); else RTPrintf("PAE: %s\n", PAEEnabled ? "on" : "off"); LONG64 timeOffset; biosSettings->COMGETTER(TimeOffset)(&timeOffset); if (details == VMINFO_MACHINEREADABLE) RTPrintf("biossystemtimeoffset=%lld\n", timeOffset); else RTPrintf("Time offset: %lld ms\n", timeOffset); TSBool_T hwVirtExEnabled; machine->COMGETTER(HWVirtExEnabled)(&hwVirtExEnabled); if (hwVirtExEnabled == TSBool_Default) { BOOL fHWVirtExEnabled; ComPtr systemProperties; virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam()); systemProperties->COMGETTER(HWVirtExEnabled)(&fHWVirtExEnabled); if (details == VMINFO_MACHINEREADABLE) RTPrintf("hwvirtex=\"default\"\n"); else RTPrintf("Hardw. virt.ext: Default (%s)\n", fHWVirtExEnabled ? "on" : "off"); } else { if (details == VMINFO_MACHINEREADABLE) RTPrintf("hwvirtex=\"%s\"\n", hwVirtExEnabled == TSBool_True ? "on" : "off"); else RTPrintf("Hardw. virt.ext: %s\n", hwVirtExEnabled == TSBool_True ? "on" : "off"); } BOOL HWVirtExNestedPagingEnabled; machine->COMGETTER(HWVirtExNestedPagingEnabled)(&HWVirtExNestedPagingEnabled); if (details == VMINFO_MACHINEREADABLE) RTPrintf("nestedpaging=\"%s\"\n", HWVirtExNestedPagingEnabled ? "on" : "off"); else RTPrintf("Nested Paging: %s\n", HWVirtExNestedPagingEnabled ? "on" : "off"); BOOL HWVirtExVPIDEnabled; machine->COMGETTER(HWVirtExVPIDEnabled)(&HWVirtExVPIDEnabled); if (details == VMINFO_MACHINEREADABLE) RTPrintf("vtxvpid=\"%s\"\n", HWVirtExVPIDEnabled ? "on" : "off"); else RTPrintf("VT-x VPID: %s\n", HWVirtExVPIDEnabled ? "on" : "off"); MachineState_T machineState; const char *pszState = NULL; rc = machine->COMGETTER(State)(&machineState); switch (machineState) { case MachineState_PoweredOff: if (details == VMINFO_MACHINEREADABLE) pszState = "poweroff"; else pszState = "powered off"; break; case MachineState_Saved: pszState = "saved"; break; case MachineState_Aborted: pszState = "aborted"; break; case MachineState_Running: pszState = "running"; break; case MachineState_Paused: pszState = "paused"; break; case MachineState_Starting: pszState = "starting"; break; case MachineState_Stopping: pszState = "stopping"; break; case MachineState_Saving: pszState = "saving"; break; case MachineState_Restoring: pszState = "restoring"; break; default: pszState = "unknown"; break; } LONG64 stateSince; machine->COMGETTER(LastStateChange)(&stateSince); RTTIMESPEC timeSpec; RTTimeSpecSetMilli(&timeSpec, stateSince); char pszTime[30] = {0}; RTTimeSpecToString(&timeSpec, pszTime, sizeof(pszTime)); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("VMState=\"%s\"\n", pszState); RTPrintf("VMStateChangeTime=\"%s\"\n", pszTime); } else RTPrintf("State: %s (since %s)\n", pszState, pszTime); ULONG numMonitors; machine->COMGETTER(MonitorCount)(&numMonitors); if (details == VMINFO_MACHINEREADABLE) RTPrintf("monitorcount=%d\n", numMonitors); else RTPrintf("Monitor count: %d\n", numMonitors); ComPtr floppyDrive; rc = machine->COMGETTER(FloppyDrive)(floppyDrive.asOutParam()); if (SUCCEEDED(rc) && floppyDrive) { BOOL fFloppyEnabled; floppyDrive->COMGETTER(Enabled)(&fFloppyEnabled); Utf8Str pszFloppy = "invalid"; if (fFloppyEnabled) { DriveState_T floppyState; floppyDrive->COMGETTER(State)(&floppyState); switch (floppyState) { case DriveState_ImageMounted: { ComPtr floppyImage; rc = floppyDrive->GetImage(floppyImage.asOutParam()); if (SUCCEEDED(rc) && floppyImage) { Bstr imagePath; floppyImage->COMGETTER(Location)(imagePath.asOutParam()); Guid imageGuid; floppyImage->COMGETTER(Id)(imageGuid.asOutParam()); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("FloppyImageUUID=\"%s\"\n", imageGuid.toString().raw()); pszFloppy = Utf8StrFmt("%lS", imagePath.raw()); } else pszFloppy = Utf8StrFmt("%lS (UUID: %s)", imagePath.raw(), imageGuid.toString().raw()); } break; } case DriveState_HostDriveCaptured: { ComPtr hostFloppyDrive; rc = floppyDrive->GetHostDrive(hostFloppyDrive.asOutParam()); if (SUCCEEDED(rc) && floppyDrive) { Bstr driveName; hostFloppyDrive->COMGETTER(Name)(driveName.asOutParam()); if (details == VMINFO_MACHINEREADABLE) pszFloppy = Utf8StrFmt("host:%lS", driveName.raw()); else pszFloppy = Utf8StrFmt("Host drive %lS", driveName.raw()); } break; } case DriveState_NotMounted: { pszFloppy = "empty"; break; } } } else { pszFloppy = "disabled"; } if (details == VMINFO_MACHINEREADABLE) RTPrintf("floppy=\"%s\"\n", pszFloppy.raw()); else RTPrintf("Floppy: %s\n", pszFloppy.raw()); } /* * SATA. */ ComPtr SATACtl; rc = machine->COMGETTER(SATAController)(SATACtl.asOutParam()); if (SUCCEEDED(rc)) { BOOL fEnabled; rc = SATACtl->COMGETTER(Enabled)(&fEnabled); if (FAILED(rc)) fEnabled = false; if (details == VMINFO_MACHINEREADABLE) RTPrintf("sata=\"%s\"\n", fEnabled ? "on" : "off"); else RTPrintf("SATA: %s\n", fEnabled ? "enabled" : "disabled"); } /* * Hard disks */ ComPtr hardDisk; Bstr filePath; rc = machine->GetHardDisk2(StorageBus_IDE, 0, 0, hardDisk.asOutParam()); if (SUCCEEDED(rc) && hardDisk) { hardDisk->COMGETTER(Location)(filePath.asOutParam()); hardDisk->COMGETTER(Id)(uuid.asOutParam()); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("hda=\"%lS\"\n", filePath.raw()); RTPrintf("HdaImageUUID=\"%s\"\n", uuid.toString().raw()); } else RTPrintf("Primary master: %lS (UUID: %s)\n", filePath.raw(), uuid.toString().raw()); } else { if (details == VMINFO_MACHINEREADABLE) RTPrintf("hda=\"none\"\n"); } rc = machine->GetHardDisk2(StorageBus_IDE, 0, 1, hardDisk.asOutParam()); if (SUCCEEDED(rc) && hardDisk) { hardDisk->COMGETTER(Location)(filePath.asOutParam()); hardDisk->COMGETTER(Id)(uuid.asOutParam()); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("hdb=\"%lS\"\n", filePath.raw()); RTPrintf("HdbImageUUID=\"%s\"\n", uuid.toString().raw()); } else RTPrintf("Primary slave: %lS (UUID: %s)\n", filePath.raw(), uuid.toString().raw()); } else { if (details == VMINFO_MACHINEREADABLE) RTPrintf("hdb=\"none\"\n"); } rc = machine->GetHardDisk2(StorageBus_IDE, 1, 1, hardDisk.asOutParam()); if (SUCCEEDED(rc) && hardDisk) { hardDisk->COMGETTER(Location)(filePath.asOutParam()); hardDisk->COMGETTER(Id)(uuid.asOutParam()); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("hdd=\"%lS\"\n", filePath.raw()); RTPrintf("HddImageUUID=\"%s\"\n", uuid.toString().raw()); } else RTPrintf("Secondary slave: %lS (UUID: %s)\n", filePath.raw(), uuid.toString().raw()); } else { if (details == VMINFO_MACHINEREADABLE) RTPrintf("hdd=\"none\"\n"); } ComPtr dvdDrive; rc = machine->COMGETTER(DVDDrive)(dvdDrive.asOutParam()); if (SUCCEEDED(rc) && dvdDrive) { ComPtr dvdImage; rc = dvdDrive->GetImage(dvdImage.asOutParam()); if (SUCCEEDED(rc) && dvdImage) { rc = dvdImage->COMGETTER(Location)(filePath.asOutParam()); if (SUCCEEDED(rc) && filePath) { rc = dvdImage->COMGETTER(Id)(uuid.asOutParam()); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("dvd=\"%lS\"\n", filePath.raw()); RTPrintf("DvdImageUUID=\"%s\"\n", uuid.toString().raw()); } else RTPrintf("DVD: %lS (UUID: %s)\n", filePath.raw(), uuid.toString().raw()); } } else { ComPtr hostDVDDrive; rc = dvdDrive->GetHostDrive(hostDVDDrive.asOutParam()); if (SUCCEEDED(rc) && hostDVDDrive) { Bstr name; hostDVDDrive->COMGETTER(Name)(name.asOutParam()); if (details == VMINFO_MACHINEREADABLE) RTPrintf("dvd=\"host:%lS\"\n", name.raw()); else RTPrintf("DVD: Host drive %lS", name.raw()); } else { if (details == VMINFO_MACHINEREADABLE) RTPrintf("dvd=\"none\"\n"); else RTPrintf("DVD: empty"); } BOOL fPassthrough; dvdDrive->COMGETTER(Passthrough)(&fPassthrough); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("dvdpassthrough=\"%s\"\n", fPassthrough ? "on" : "off"); } else { if (fPassthrough) RTPrintf(" (passthrough enabled)"); RTPrintf("\n"); } } } /* get the maximum amount of NICS */ ComPtr sysProps; virtualBox->COMGETTER(SystemProperties)(sysProps.asOutParam()); ULONG maxNICs = 0; sysProps->COMGETTER(NetworkAdapterCount)(&maxNICs); for (ULONG currentNIC = 0; currentNIC < maxNICs; currentNIC++) { ComPtr nic; rc = machine->GetNetworkAdapter(currentNIC, nic.asOutParam()); if (SUCCEEDED(rc) && nic) { BOOL fEnabled; nic->COMGETTER(Enabled)(&fEnabled); if (!fEnabled) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("nic%d=\"none\"\n", currentNIC + 1); else RTPrintf("NIC %d: disabled\n", currentNIC + 1); } else { Bstr strMACAddress; nic->COMGETTER(MACAddress)(strMACAddress.asOutParam()); Utf8Str strAttachment; NetworkAttachmentType_T attachment; nic->COMGETTER(AttachmentType)(&attachment); switch (attachment) { case NetworkAttachmentType_Null: if (details == VMINFO_MACHINEREADABLE) strAttachment = "null"; else strAttachment = "none"; break; case NetworkAttachmentType_NAT: { Bstr strNetwork; nic->COMGETTER(NATNetwork)(strNetwork.asOutParam()); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("natnet%d=\"%lS\"\n", currentNIC + 1, strNetwork.raw()); strAttachment = "nat"; } else if (!strNetwork.isEmpty()) strAttachment = Utf8StrFmt("NAT (%lS)", strNetwork.raw()); else strAttachment = "NAT"; break; } case NetworkAttachmentType_HostInterface: { Bstr strHostIfDev; nic->COMGETTER(HostInterface)(strHostIfDev.asOutParam()); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("hostifdev%d=\"%lS\"\n", currentNIC + 1, strHostIfDev.raw()); strAttachment = "hostif"; } else strAttachment = Utf8StrFmt("Host Interface '%lS'", strHostIfDev.raw()); break; } case NetworkAttachmentType_Internal: { Bstr strNetwork; nic->COMGETTER(InternalNetwork)(strNetwork.asOutParam()); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("intnet%d=\"%lS\"\n", currentNIC + 1, strNetwork.raw()); strAttachment = "intnet"; } else strAttachment = Utf8StrFmt("Internal Network '%s'", Utf8Str(strNetwork).raw()); break; } default: strAttachment = "unknown"; break; } /* cable connected */ BOOL fConnected; nic->COMGETTER(CableConnected)(&fConnected); /* trace stuff */ BOOL fTraceEnabled; nic->COMGETTER(TraceEnabled)(&fTraceEnabled); Bstr traceFile; nic->COMGETTER(TraceFile)(traceFile.asOutParam()); /* NIC type */ Utf8Str strNICType; NetworkAdapterType_T NICType; nic->COMGETTER(AdapterType)(&NICType); switch (NICType) { case NetworkAdapterType_Am79C970A: strNICType = "Am79C970A"; break; case NetworkAdapterType_Am79C973: strNICType = "Am79C973"; break; #ifdef VBOX_WITH_E1000 case NetworkAdapterType_I82540EM: strNICType = "82540EM"; break; case NetworkAdapterType_I82543GC: strNICType = "82543GC"; break; #endif default: strNICType = "unknown"; break; } /* reported line speed */ ULONG ulLineSpeed; nic->COMGETTER(LineSpeed)(&ulLineSpeed); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("macaddress%d=\"%lS\"\n", currentNIC + 1, strMACAddress.raw()); RTPrintf("cableconnected%d=\"%s\"\n", currentNIC + 1, fConnected ? "on" : "off"); RTPrintf("nic%d=\"%s\"\n", currentNIC + 1, strAttachment.raw()); } else RTPrintf("NIC %d: MAC: %lS, Attachment: %s, Cable connected: %s, Trace: %s (file: %lS), Type: %s, Reported speed: %d Mbps\n", currentNIC + 1, strMACAddress.raw(), strAttachment.raw(), fConnected ? "on" : "off", fTraceEnabled ? "on" : "off", traceFile.isEmpty() ? Bstr("none").raw() : traceFile.raw(), strNICType.raw(), ulLineSpeed / 1000); } } } /* get the maximum amount of UARTs */ ULONG maxUARTs = 0; sysProps->COMGETTER(SerialPortCount)(&maxUARTs); for (ULONG currentUART = 0; currentUART < maxUARTs; currentUART++) { ComPtr uart; rc = machine->GetSerialPort(currentUART, uart.asOutParam()); if (SUCCEEDED(rc) && uart) { BOOL fEnabled; uart->COMGETTER(Enabled)(&fEnabled); if (!fEnabled) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("uart%d=\"off\"\n", currentUART + 1); else RTPrintf("UART %d: disabled\n", currentUART + 1); } else { ULONG ulIRQ, ulIOBase; PortMode_T HostMode; Bstr path; BOOL fServer; uart->COMGETTER(IRQ)(&ulIRQ); uart->COMGETTER(IOBase)(&ulIOBase); uart->COMGETTER(Path)(path.asOutParam()); uart->COMGETTER(Server)(&fServer); uart->COMGETTER(HostMode)(&HostMode); if (details == VMINFO_MACHINEREADABLE) RTPrintf("uart%d=\"%#06x,%d\"\n", currentUART + 1, ulIOBase, ulIRQ); else RTPrintf("UART %d: I/O base: 0x%04x, IRQ: %d", currentUART + 1, ulIOBase, ulIRQ); switch (HostMode) { default: case PortMode_Disconnected: if (details == VMINFO_MACHINEREADABLE) RTPrintf("uartmode%d=\"disconnected\"\n", currentUART + 1); else RTPrintf(", disconnected\n"); break; case PortMode_HostPipe: if (details == VMINFO_MACHINEREADABLE) RTPrintf("uartmode%d=\"%s,%lS\"\n", currentUART + 1, fServer ? "server" : "client", path.raw()); else RTPrintf(", attached to pipe (%s) '%lS'\n", fServer ? "server" : "client", path.raw()); break; case PortMode_HostDevice: if (details == VMINFO_MACHINEREADABLE) RTPrintf("uartmode%d=\"%lS\"\n", currentUART + 1, path.raw()); else RTPrintf(", attached to device '%lS'\n", path.raw()); break; } } } } ComPtr AudioAdapter; rc = machine->COMGETTER(AudioAdapter)(AudioAdapter.asOutParam()); if (SUCCEEDED(rc)) { const char *pszDrv = "Unknown"; const char *pszCtrl = "Unknown"; BOOL fEnabled; rc = AudioAdapter->COMGETTER(Enabled)(&fEnabled); if (SUCCEEDED(rc) && fEnabled) { AudioDriverType_T enmDrvType; rc = AudioAdapter->COMGETTER(AudioDriver)(&enmDrvType); switch (enmDrvType) { case AudioDriverType_Null: if (details == VMINFO_MACHINEREADABLE) pszDrv = "null"; else pszDrv = "Null"; break; case AudioDriverType_WinMM: if (details == VMINFO_MACHINEREADABLE) pszDrv = "winmm"; else pszDrv = "WINMM"; break; case AudioDriverType_DirectSound: if (details == VMINFO_MACHINEREADABLE) pszDrv = "dsound"; else pszDrv = "DSOUND"; break; case AudioDriverType_OSS: if (details == VMINFO_MACHINEREADABLE) pszDrv = "oss"; else pszDrv = "OSS"; break; case AudioDriverType_ALSA: if (details == VMINFO_MACHINEREADABLE) pszDrv = "alsa"; else pszDrv = "ALSA"; break; case AudioDriverType_Pulse: if (details == VMINFO_MACHINEREADABLE) pszDrv = "pulse"; else pszDrv = "PulseAudio"; break; case AudioDriverType_CoreAudio: if (details == VMINFO_MACHINEREADABLE) pszDrv = "coreaudio"; else pszDrv = "CoreAudio"; break; case AudioDriverType_SolAudio: if (details == VMINFO_MACHINEREADABLE) pszDrv = "solaudio"; else pszDrv = "SolAudio"; break; default: if (details == VMINFO_MACHINEREADABLE) pszDrv = "unknown"; break; } AudioControllerType_T enmCtrlType; rc = AudioAdapter->COMGETTER(AudioController)(&enmCtrlType); switch (enmCtrlType) { case AudioControllerType_AC97: if (details == VMINFO_MACHINEREADABLE) pszCtrl = "ac97"; else pszCtrl = "AC97"; break; case AudioControllerType_SB16: if (details == VMINFO_MACHINEREADABLE) pszCtrl = "sb16"; else pszCtrl = "SB16"; break; } } else fEnabled = FALSE; if (details == VMINFO_MACHINEREADABLE) { if (fEnabled) RTPrintf("audio=\"%s\"\n", pszDrv); else RTPrintf("audio=\"none\"\n"); } else RTPrintf("Audio: %s (Driver: %s, Controller: %s)\n", fEnabled ? "enabled" : "disabled", pszDrv, pszCtrl); } /* Shared clipboard */ { const char *psz = "Unknown"; ClipboardMode_T enmMode; rc = machine->COMGETTER(ClipboardMode)(&enmMode); switch (enmMode) { case ClipboardMode_Disabled: if (details == VMINFO_MACHINEREADABLE) psz = "disabled"; else psz = "disabled"; break; case ClipboardMode_HostToGuest: if (details == VMINFO_MACHINEREADABLE) psz = "hosttoguest"; else psz = "HostToGuest"; break; case ClipboardMode_GuestToHost: if (details == VMINFO_MACHINEREADABLE) psz = "guesttohost"; else psz = "GuestToHost"; break; case ClipboardMode_Bidirectional: if (details == VMINFO_MACHINEREADABLE) psz = "bidirectional"; else psz = "Bidirectional"; break; default: if (details == VMINFO_MACHINEREADABLE) psz = "unknown"; break; } if (details == VMINFO_MACHINEREADABLE) RTPrintf("clipboard=\"%s\"\n", psz); else RTPrintf("Clipboard Mode: %s\n", psz); } if (console) { ComPtr display; CHECK_ERROR_RET(console, COMGETTER(Display)(display.asOutParam()), rc); do { ULONG xRes, yRes, bpp; rc = display->COMGETTER(Width)(&xRes); if (rc == E_ACCESSDENIED) break; /* VM not powered up */ if (FAILED(rc)) { com::ErrorInfo info (display); PRINT_ERROR_INFO (info); return rc; } rc = display->COMGETTER(Height)(&yRes); if (rc == E_ACCESSDENIED) break; /* VM not powered up */ if (FAILED(rc)) { com::ErrorInfo info (display); PRINT_ERROR_INFO (info); return rc; } rc = display->COMGETTER(BitsPerPixel)(&bpp); if (rc == E_ACCESSDENIED) break; /* VM not powered up */ if (FAILED(rc)) { com::ErrorInfo info (display); PRINT_ERROR_INFO (info); return rc; } if (details == VMINFO_MACHINEREADABLE) RTPrintf("VideoMode=\"%d,%d,%d\"\n", xRes, yRes, bpp); else RTPrintf("Video mode: %dx%dx%d\n", xRes, yRes, bpp); } while (0); } /* * VRDP */ ComPtr vrdpServer; rc = machine->COMGETTER(VRDPServer)(vrdpServer.asOutParam()); if (SUCCEEDED(rc) && vrdpServer) { BOOL fEnabled = false; vrdpServer->COMGETTER(Enabled)(&fEnabled); if (fEnabled) { ULONG port; vrdpServer->COMGETTER(Port)(&port); Bstr address; vrdpServer->COMGETTER(NetAddress)(address.asOutParam()); BOOL fMultiCon; vrdpServer->COMGETTER(AllowMultiConnection)(&fMultiCon); BOOL fReuseCon; vrdpServer->COMGETTER(ReuseSingleConnection)(&fReuseCon); VRDPAuthType_T vrdpAuthType; const char *strAuthType; vrdpServer->COMGETTER(AuthType)(&vrdpAuthType); switch (vrdpAuthType) { case VRDPAuthType_Null: strAuthType = "null"; break; case VRDPAuthType_External: strAuthType = "external"; break; case VRDPAuthType_Guest: strAuthType = "guest"; break; default: strAuthType = "unknown"; break; } if (details == VMINFO_MACHINEREADABLE) { RTPrintf("vrdp=\"on\"\n"); RTPrintf("vrdpport=%d\n", port); RTPrintf("vrdpaddress=\"%lS\"\n", address.raw()); RTPrintf("vrdpauthtype=\"%s\"\n", strAuthType); RTPrintf("vrdpmulticon=\"%s\"\n", fMultiCon ? "on" : "off"); RTPrintf("vrdpreusecon=\"%s\"\n", fReuseCon ? "on" : "off"); } else { if (address.isEmpty()) address = "0.0.0.0"; RTPrintf("VRDP: enabled (Address %lS, Port %d, MultiConn: %s, ReuseSingleConn: %s, Authentication type: %s)\n", address.raw(), port, fMultiCon ? "on" : "off", fReuseCon ? "on" : "off", strAuthType); } } else { if (details == VMINFO_MACHINEREADABLE) RTPrintf("vrdp=\"off\"\n"); else RTPrintf("VRDP: disabled\n"); } } /* * USB. */ ComPtr USBCtl; rc = machine->COMGETTER(USBController)(USBCtl.asOutParam()); if (SUCCEEDED(rc)) { BOOL fEnabled; rc = USBCtl->COMGETTER(Enabled)(&fEnabled); if (FAILED(rc)) fEnabled = false; if (details == VMINFO_MACHINEREADABLE) RTPrintf("usb=\"%s\"\n", fEnabled ? "on" : "off"); else RTPrintf("USB: %s\n", fEnabled ? "enabled" : "disabled"); if (details != VMINFO_MACHINEREADABLE) RTPrintf("\nUSB Device Filters:\n\n"); ComPtr Coll; CHECK_ERROR_RET (USBCtl, COMGETTER(DeviceFilters)(Coll.asOutParam()), rc); ComPtr Enum; CHECK_ERROR_RET (Coll, Enumerate(Enum.asOutParam()), rc); ULONG index = 0; BOOL fMore = FALSE; rc = Enum->HasMore (&fMore); ASSERT_RET (SUCCEEDED (rc), rc); if (!fMore) { if (details != VMINFO_MACHINEREADABLE) RTPrintf("\n\n"); } else while (fMore) { ComPtr DevPtr; rc = Enum->GetNext(DevPtr.asOutParam()); ASSERT_RET (SUCCEEDED (rc), rc); /* Query info. */ if (details != VMINFO_MACHINEREADABLE) RTPrintf("Index: %lu\n", index); BOOL bActive = FALSE; CHECK_ERROR_RET (DevPtr, COMGETTER (Active) (&bActive), rc); if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBFilterActive%d=\"%s\"\n", index + 1, bActive ? "on" : "off"); else RTPrintf("Active: %s\n", bActive ? "yes" : "no"); Bstr bstr; CHECK_ERROR_RET (DevPtr, COMGETTER (Name) (bstr.asOutParam()), rc); if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBFilterName%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("Name: %lS\n", bstr.raw()); CHECK_ERROR_RET (DevPtr, COMGETTER (VendorId) (bstr.asOutParam()), rc); if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBFilterVendorId%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("VendorId: %lS\n", bstr.raw()); CHECK_ERROR_RET (DevPtr, COMGETTER (ProductId) (bstr.asOutParam()), rc); if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBFilterProductId%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("ProductId: %lS\n", bstr.raw()); CHECK_ERROR_RET (DevPtr, COMGETTER (Revision) (bstr.asOutParam()), rc); if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBFilterRevision%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("Revision: %lS\n", bstr.raw()); CHECK_ERROR_RET (DevPtr, COMGETTER (Manufacturer) (bstr.asOutParam()), rc); if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBFilterManufacturer%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("Manufacturer: %lS\n", bstr.raw()); CHECK_ERROR_RET (DevPtr, COMGETTER (Product) (bstr.asOutParam()), rc); if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBFilterProduct%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("Product: %lS\n", bstr.raw()); CHECK_ERROR_RET (DevPtr, COMGETTER (Remote) (bstr.asOutParam()), rc); if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBFilterRemote%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("Remote: %lS\n", bstr.raw()); CHECK_ERROR_RET (DevPtr, COMGETTER (SerialNumber) (bstr.asOutParam()), rc); if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBFilterSerialNumber%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("Serial Number: %lS\n", bstr.raw()); if (details != VMINFO_MACHINEREADABLE) { ULONG fMaskedIfs; CHECK_ERROR_RET (DevPtr, COMGETTER (MaskedInterfaces) (&fMaskedIfs), rc); if (fMaskedIfs) RTPrintf("Masked Interfaces: 0x%08x\n", fMaskedIfs); RTPrintf("\n"); } rc = Enum->HasMore (&fMore); ASSERT_RET (SUCCEEDED (rc), rc); index ++; } if (console) { index = 0; /* scope */ { if (details != VMINFO_MACHINEREADABLE) RTPrintf("Available remote USB devices:\n\n"); ComPtr coll; CHECK_ERROR_RET (console, COMGETTER(RemoteUSBDevices) (coll.asOutParam()), rc); ComPtr en; CHECK_ERROR_RET (coll, Enumerate (en.asOutParam()), rc); BOOL more = FALSE; rc = en->HasMore (&more); ASSERT_RET (SUCCEEDED (rc), rc); if (!more) { if (details != VMINFO_MACHINEREADABLE) RTPrintf("\n\n"); } else while (more) { ComPtr dev; rc = en->GetNext (dev.asOutParam()); ASSERT_RET (SUCCEEDED (rc), rc); /* Query info. */ Guid id; CHECK_ERROR_RET (dev, COMGETTER(Id)(id.asOutParam()), rc); USHORT usVendorId; CHECK_ERROR_RET (dev, COMGETTER(VendorId)(&usVendorId), rc); USHORT usProductId; CHECK_ERROR_RET (dev, COMGETTER(ProductId)(&usProductId), rc); USHORT bcdRevision; CHECK_ERROR_RET (dev, COMGETTER(Revision)(&bcdRevision), rc); if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBRemoteUUID%d=\"%S\"\n" "USBRemoteVendorId%d=\"%#06x\"\n" "USBRemoteProductId%d=\"%#06x\"\n" "USBRemoteRevision%d=\"%#04x%02x\"\n", index + 1, id.toString().raw(), index + 1, usVendorId, index + 1, usProductId, index + 1, bcdRevision >> 8, bcdRevision & 0xff); else RTPrintf("UUID: %S\n" "VendorId: 0x%04x (%04X)\n" "ProductId: 0x%04x (%04X)\n" "Revision: %u.%u (%02u%02u)\n", id.toString().raw(), usVendorId, usVendorId, usProductId, usProductId, bcdRevision >> 8, bcdRevision & 0xff, bcdRevision >> 8, bcdRevision & 0xff); /* optional stuff. */ Bstr bstr; CHECK_ERROR_RET (dev, COMGETTER(Manufacturer)(bstr.asOutParam()), rc); if (!bstr.isEmpty()) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBRemoteManufacturer%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("Manufacturer: %lS\n", bstr.raw()); } CHECK_ERROR_RET (dev, COMGETTER(Product)(bstr.asOutParam()), rc); if (!bstr.isEmpty()) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBRemoteProduct%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("Product: %lS\n", bstr.raw()); } CHECK_ERROR_RET (dev, COMGETTER(SerialNumber)(bstr.asOutParam()), rc); if (!bstr.isEmpty()) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBRemoteSerialNumber%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("SerialNumber: %lS\n", bstr.raw()); } CHECK_ERROR_RET (dev, COMGETTER(Address)(bstr.asOutParam()), rc); if (!bstr.isEmpty()) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBRemoteAddress%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("Address: %lS\n", bstr.raw()); } if (details != VMINFO_MACHINEREADABLE) RTPrintf("\n"); rc = en->HasMore (&more); ASSERT_RET (SUCCEEDED (rc), rc); index ++; } } index = 0; /* scope */ { if (details != VMINFO_MACHINEREADABLE) RTPrintf ("Currently Attached USB Devices:\n\n"); ComPtr coll; CHECK_ERROR_RET (console, COMGETTER(USBDevices) (coll.asOutParam()), rc); ComPtr en; CHECK_ERROR_RET (coll, Enumerate (en.asOutParam()), rc); BOOL more = FALSE; rc = en->HasMore (&more); ASSERT_RET (SUCCEEDED (rc), rc); if (!more) { if (details != VMINFO_MACHINEREADABLE) RTPrintf("\n\n"); } else while (more) { ComPtr dev; rc = en->GetNext (dev.asOutParam()); ASSERT_RET (SUCCEEDED (rc), rc); /* Query info. */ Guid id; CHECK_ERROR_RET (dev, COMGETTER(Id)(id.asOutParam()), rc); USHORT usVendorId; CHECK_ERROR_RET (dev, COMGETTER(VendorId)(&usVendorId), rc); USHORT usProductId; CHECK_ERROR_RET (dev, COMGETTER(ProductId)(&usProductId), rc); USHORT bcdRevision; CHECK_ERROR_RET (dev, COMGETTER(Revision)(&bcdRevision), rc); if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBAttachedUUID%d=\"%S\"\n" "USBAttachedVendorId%d=\"%#06x\"\n" "USBAttachedProductId%d=\"%#06x\"\n" "USBAttachedRevision%d=\"%#04x%02x\"\n", index + 1, id.toString().raw(), index + 1, usVendorId, index + 1, usProductId, index + 1, bcdRevision >> 8, bcdRevision & 0xff); else RTPrintf("UUID: %S\n" "VendorId: 0x%04x (%04X)\n" "ProductId: 0x%04x (%04X)\n" "Revision: %u.%u (%02u%02u)\n", id.toString().raw(), usVendorId, usVendorId, usProductId, usProductId, bcdRevision >> 8, bcdRevision & 0xff, bcdRevision >> 8, bcdRevision & 0xff); /* optional stuff. */ Bstr bstr; CHECK_ERROR_RET (dev, COMGETTER(Manufacturer)(bstr.asOutParam()), rc); if (!bstr.isEmpty()) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBAttachedManufacturer%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("Manufacturer: %lS\n", bstr.raw()); } CHECK_ERROR_RET (dev, COMGETTER(Product)(bstr.asOutParam()), rc); if (!bstr.isEmpty()) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBAttachedProduct%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("Product: %lS\n", bstr.raw()); } CHECK_ERROR_RET (dev, COMGETTER(SerialNumber)(bstr.asOutParam()), rc); if (!bstr.isEmpty()) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBAttachedSerialNumber%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("SerialNumber: %lS\n", bstr.raw()); } CHECK_ERROR_RET (dev, COMGETTER(Address)(bstr.asOutParam()), rc); if (!bstr.isEmpty()) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("USBAttachedAddress%d=\"%lS\"\n", index + 1, bstr.raw()); else RTPrintf("Address: %lS\n", bstr.raw()); } if (details != VMINFO_MACHINEREADABLE) RTPrintf("\n"); rc = en->HasMore (&more); ASSERT_RET (SUCCEEDED (rc), rc); index ++; } } } } /* USB */ /* * Shared folders */ if (details != VMINFO_MACHINEREADABLE) RTPrintf("Shared folders: "); uint32_t numSharedFolders = 0; #if 0 // not yet implemented /* globally shared folders first */ { ComPtr sfColl; ComPtr sfEnum; CHECK_ERROR_RET(virtualBox, COMGETTER(SharedFolders)(sfColl.asOutParam()), rc); CHECK_ERROR_RET(sfColl, Enumerate(sfEnum.asOutParam()), rc); BOOL fMore; sfEnum->HasMore(&fMore); while (fMore) { ComPtr sf; CHECK_ERROR_RET(sfEnum, GetNext(sf.asOutParam()), rc); Bstr name, hostPath; sf->COMGETTER(Name)(name.asOutParam()); sf->COMGETTER(HostPath)(hostPath.asOutParam()); RTPrintf("Name: '%lS', Host path: '%lS' (global mapping)\n", name.raw(), hostPath.raw()); ++numSharedFolders; CHECK_ERROR_RET(sfEnum, HasMore(&fMore), rc); } } #endif /* now VM mappings */ { ComPtr sfColl; ComPtr sfEnum; CHECK_ERROR_RET(machine, COMGETTER(SharedFolders)(sfColl.asOutParam()), rc); CHECK_ERROR_RET(sfColl, Enumerate(sfEnum.asOutParam()), rc); ULONG index = 0; BOOL fMore; sfEnum->HasMore(&fMore); while (fMore) { ComPtr sf; CHECK_ERROR_RET(sfEnum, GetNext(sf.asOutParam()), rc); Bstr name, hostPath; BOOL writable; sf->COMGETTER(Name)(name.asOutParam()); sf->COMGETTER(HostPath)(hostPath.asOutParam()); sf->COMGETTER(Writable)(&writable); if (!numSharedFolders && details != VMINFO_MACHINEREADABLE) RTPrintf("\n\n"); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("SharedFolderNameMachineMapping%d=\"%lS\"\n", index + 1, name.raw()); RTPrintf("SharedFolderPathMachineMapping%d=\"%lS\"\n", index + 1, hostPath.raw()); } else RTPrintf("Name: '%lS', Host path: '%lS' (machine mapping), %s\n", name.raw(), hostPath.raw(), writable ? "writable" : "readonly"); ++numSharedFolders; CHECK_ERROR_RET(sfEnum, HasMore(&fMore), rc); } } /* transient mappings */ if (console) { ComPtr sfColl; ComPtr sfEnum; CHECK_ERROR_RET(console, COMGETTER(SharedFolders)(sfColl.asOutParam()), rc); CHECK_ERROR_RET(sfColl, Enumerate(sfEnum.asOutParam()), rc); ULONG index = 0; BOOL fMore; sfEnum->HasMore(&fMore); while (fMore) { ComPtr sf; CHECK_ERROR_RET(sfEnum, GetNext(sf.asOutParam()), rc); Bstr name, hostPath; sf->COMGETTER(Name)(name.asOutParam()); sf->COMGETTER(HostPath)(hostPath.asOutParam()); if (!numSharedFolders && details != VMINFO_MACHINEREADABLE) RTPrintf("\n\n"); if (details == VMINFO_MACHINEREADABLE) { RTPrintf("SharedFolderNameTransientMapping%d=\"%lS\"\n", index + 1, name.raw()); RTPrintf("SharedFolderPathTransientMapping%d=\"%lS\"\n", index + 1, hostPath.raw()); } else RTPrintf("Name: '%lS', Host path: '%lS' (transient mapping)\n", name.raw(), hostPath.raw()); ++numSharedFolders; CHECK_ERROR_RET(sfEnum, HasMore(&fMore), rc); } } if (!numSharedFolders && details != VMINFO_MACHINEREADABLE) RTPrintf("\n"); if (details != VMINFO_MACHINEREADABLE) RTPrintf("\n"); if (console) { /* * Live VRDP info. */ ComPtr remoteDisplayInfo; CHECK_ERROR_RET(console, COMGETTER(RemoteDisplayInfo)(remoteDisplayInfo.asOutParam()), rc); BOOL Active; ULONG NumberOfClients; LONG64 BeginTime; LONG64 EndTime; ULONG64 BytesSent; ULONG64 BytesSentTotal; ULONG64 BytesReceived; ULONG64 BytesReceivedTotal; Bstr User; Bstr Domain; Bstr ClientName; Bstr ClientIP; ULONG ClientVersion; ULONG EncryptionStyle; CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(Active) (&Active), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(NumberOfClients) (&NumberOfClients), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(BeginTime) (&BeginTime), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(EndTime) (&EndTime), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(BytesSent) (&BytesSent), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(BytesSentTotal) (&BytesSentTotal), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(BytesReceived) (&BytesReceived), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(BytesReceivedTotal) (&BytesReceivedTotal), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(User) (User.asOutParam ()), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(Domain) (Domain.asOutParam ()), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(ClientName) (ClientName.asOutParam ()), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(ClientIP) (ClientIP.asOutParam ()), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(ClientVersion) (&ClientVersion), rc); CHECK_ERROR_RET(remoteDisplayInfo, COMGETTER(EncryptionStyle) (&EncryptionStyle), rc); if (details == VMINFO_MACHINEREADABLE) RTPrintf("VRDPActiveConnection=\"%s\"\n", Active ? "on": "off"); else RTPrintf("VRDP Connection: %s\n", Active? "active": "not active"); if (details == VMINFO_MACHINEREADABLE) RTPrintf("VRDPClients=%d\n", NumberOfClients); else RTPrintf("Clients so far: %d\n", NumberOfClients); if (NumberOfClients > 0) { char timestr[128]; if (Active) { makeTimeStr (timestr, sizeof (timestr), BeginTime); if (details == VMINFO_MACHINEREADABLE) RTPrintf("VRDPStartTime=\"%s\"\n", timestr); else RTPrintf("Start time: %s\n", timestr); } else { makeTimeStr (timestr, sizeof (timestr), BeginTime); if (details == VMINFO_MACHINEREADABLE) RTPrintf("VRDPLastStartTime=\"%s\"\n", timestr); else RTPrintf("Last started: %s\n", timestr); makeTimeStr (timestr, sizeof (timestr), EndTime); if (details == VMINFO_MACHINEREADABLE) RTPrintf("VRDPLastEndTime=\"%s\"\n", timestr); else RTPrintf("Last ended: %s\n", timestr); } uint64_t ThroughputSend = 0; uint64_t ThroughputReceive = 0; if (EndTime != BeginTime) { ThroughputSend = (BytesSent * 1000) / (EndTime - BeginTime); ThroughputReceive = (BytesReceived * 1000) / (EndTime - BeginTime); } if (details == VMINFO_MACHINEREADABLE) { RTPrintf("VRDPBytesSent=%llu\n", BytesSent); RTPrintf("VRDPThroughputSend=%llu\n", ThroughputSend); RTPrintf("VRDPBytesSentTotal=%llu\n", BytesSentTotal); RTPrintf("VRDPBytesReceived=%llu\n", BytesReceived); RTPrintf("VRDPThroughputReceive=%llu\n", ThroughputReceive); RTPrintf("VRDPBytesReceivedTotal=%llu\n", BytesReceivedTotal); } else { RTPrintf("Sent: %llu Bytes\n", BytesSent); RTPrintf("Average speed: %llu B/s\n", ThroughputSend); RTPrintf("Sent total: %llu Bytes\n", BytesSentTotal); RTPrintf("Received: %llu Bytes\n", BytesReceived); RTPrintf("Speed: %llu B/s\n", ThroughputReceive); RTPrintf("Received total: %llu Bytes\n", BytesReceivedTotal); } if (Active) { if (details == VMINFO_MACHINEREADABLE) { RTPrintf("VRDPUserName=\"%lS\"\n", User.raw()); RTPrintf("VRDPDomain=\"%lS\"\n", Domain.raw()); RTPrintf("VRDPClientName=\"%lS\"\n", ClientName.raw()); RTPrintf("VRDPClientIP=\"%lS\"\n", ClientIP.raw()); RTPrintf("VRDPClientVersion=%d\n", ClientVersion); RTPrintf("VRDPEncryption=\"%s\"\n", EncryptionStyle == 0? "RDP4": "RDP5 (X.509)"); } else { RTPrintf("User name: %lS\n", User.raw()); RTPrintf("Domain: %lS\n", Domain.raw()); RTPrintf("Client name: %lS\n", ClientName.raw()); RTPrintf("Client IP: %lS\n", ClientIP.raw()); RTPrintf("Client version: %d\n", ClientVersion); RTPrintf("Encryption: %s\n", EncryptionStyle == 0? "RDP4": "RDP5 (X.509)"); } } } if (details != VMINFO_MACHINEREADABLE) RTPrintf("\n"); } if ( details == VMINFO_STANDARD || details == VMINFO_FULL || details == VMINFO_MACHINEREADABLE) { Bstr description; machine->COMGETTER(Description)(description.asOutParam()); if (!description.isEmpty()) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("description=\"%lS\"\n", description.raw()); else RTPrintf("Description:\n%lS\n", description.raw()); } } ULONG guestVal; if (details != VMINFO_MACHINEREADABLE) RTPrintf("Guest:\n\n"); #ifdef VBOX_WITH_MEM_BALLOONING rc = machine->COMGETTER(MemoryBalloonSize)(&guestVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("GuestMemoryBalloon=%d\n", guestVal); else RTPrintf("Configured memory balloon size: %d MB\n", guestVal); } #endif rc = machine->COMGETTER(StatisticsUpdateInterval)(&guestVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("GuestStatisticsUpdateInterval=%d\n", guestVal); else { if (guestVal == 0) RTPrintf("Statistics update: disabled\n"); else RTPrintf("Statistics update interval: %d seconds\n", guestVal); } } if (details != VMINFO_MACHINEREADABLE) RTPrintf("\n"); if ( console && ( details == VMINFO_STATISTICS || details == VMINFO_FULL || details == VMINFO_MACHINEREADABLE)) { ComPtr guest; rc = console->COMGETTER(Guest)(guest.asOutParam()); if (SUCCEEDED(rc)) { ULONG statVal; rc = guest->GetStatistic(0, GuestStatisticType_SampleNumber, &statVal); if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestSample=%d\n", statVal); else RTPrintf("Guest statistics for sample %d:\n\n", statVal); rc = guest->GetStatistic(0, GuestStatisticType_CPULoad_Idle, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestLoadIdleCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: CPU Load Idle %-3d%%\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_CPULoad_Kernel, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestLoadKernelCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: CPU Load Kernel %-3d%%\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_CPULoad_User, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestLoadUserCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: CPU Load User %-3d%%\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_Threads, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestThreadsCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: Threads %d\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_Processes, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestProcessesCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: Processes %d\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_Handles, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestHandlesCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: Handles %d\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_MemoryLoad, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestMemoryLoadCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: Memory Load %d%%\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_PhysMemTotal, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestMemoryTotalPhysCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: Total physical memory %-4d MB\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_PhysMemAvailable, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestMemoryFreePhysCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: Free physical memory %-4d MB\n", 0, statVal); } #ifdef VBOX_WITH_MEM_BALLOONING rc = guest->GetStatistic(0, GuestStatisticType_PhysMemBalloon, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestMemoryBalloonCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: Memory balloon size %-4d MB\n", 0, statVal); } #endif rc = guest->GetStatistic(0, GuestStatisticType_MemCommitTotal, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestMemoryCommittedCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: Committed memory %-4d MB\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_MemKernelTotal, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestMemoryTotalKernelCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: Total kernel memory %-4d MB\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_MemKernelPaged, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestMemoryPagedKernelCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: Paged kernel memory %-4d MB\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_MemKernelNonpaged, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestMemoryNonpagedKernelCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: Nonpaged kernel memory %-4d MB\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_MemSystemCache, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestSystemCacheSizeCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: System cache size %-4d MB\n", 0, statVal); } rc = guest->GetStatistic(0, GuestStatisticType_PageFileSize, &statVal); if (SUCCEEDED(rc)) { if (details == VMINFO_MACHINEREADABLE) RTPrintf("StatGuestPageFileSizeCPU%d=%d\n", 0, statVal); else RTPrintf("CPU%d: Page file size %-4d MB\n", 0, statVal); } RTPrintf("\n"); } else { if (details != VMINFO_MACHINEREADABLE) { RTPrintf("[!] FAILED calling console->getGuest at line %d!\n", __LINE__); PRINT_RC_MESSAGE(rc); } } } /* * snapshots */ ComPtr snapshot; rc = machine->GetSnapshot(Guid(), snapshot.asOutParam()); if (SUCCEEDED(rc) && snapshot) { if (details != VMINFO_MACHINEREADABLE) RTPrintf("Snapshots:\n\n"); showSnapshots(snapshot, details); } if (details != VMINFO_MACHINEREADABLE) RTPrintf("\n"); return S_OK; } static int handleShowVMInfo(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; /* at least one option: the UUID or name of the VM */ if (argc < 1) return errorSyntax(USAGE_SHOWVMINFO, "Incorrect number of parameters"); /* try to find the given machine */ ComPtr machine; Guid uuid (argv[0]); if (!uuid.isEmpty()) { CHECK_ERROR (virtualBox, GetMachine (uuid, machine.asOutParam())); } else { CHECK_ERROR (virtualBox, FindMachine (Bstr(argv[0]), machine.asOutParam())); if (SUCCEEDED (rc)) machine->COMGETTER(Id) (uuid.asOutParam()); } if (FAILED (rc)) return 1; /* 2nd option can be -details, -statistics or -argdump */ VMINFO_DETAILS details = VMINFO_NONE; bool fDetails = false; bool fStatistics = false; bool fMachinereadable = false; for (int i=1;i console; /* open an existing session for the VM */ rc = virtualBox->OpenExistingSession (session, uuid); if (SUCCEEDED(rc)) /* get the session machine */ rc = session->COMGETTER(Machine)(machine.asOutParam()); if (SUCCEEDED(rc)) /* get the session console */ rc = session->COMGETTER(Console)(console.asOutParam()); rc = showVMInfo (virtualBox, machine, console, details); if (console) session->Close(); return SUCCEEDED (rc) ? 0 : 1; } static int handleList(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc = S_OK; /* exactly one option: the object */ if (argc != 1) return errorSyntax(USAGE_LIST, "Incorrect number of parameters"); /* which object? */ if (strcmp(argv[0], "vms") == 0) { /* * Get the list of all registered VMs */ com::SafeIfaceArray machines; rc = virtualBox->COMGETTER(Machines2)(ComSafeArrayAsOutParam (machines)); if (SUCCEEDED(rc)) { /* * Iterate through the collection */ for (size_t i = 0; i < machines.size(); ++ i) { if (machines [i]) rc = showVMInfo(virtualBox, machines [i]); } } } else if (strcmp(argv[0], "runningvms") == 0) { /* * Get the list of all _running_ VMs */ com::SafeIfaceArray machines; rc = virtualBox->COMGETTER(Machines2)(ComSafeArrayAsOutParam (machines)); if (SUCCEEDED(rc)) { /* * Iterate through the collection */ for (size_t i = 0; i < machines.size(); ++ i) { if (machines [i]) { MachineState_T machineState; rc = machines [i]->COMGETTER(State)(&machineState); if (SUCCEEDED(rc)) { switch (machineState) { case MachineState_Running: case MachineState_Paused: { Guid uuid; rc = machines [i]->COMGETTER(Id) (uuid.asOutParam()); if (SUCCEEDED(rc)) RTPrintf ("%s\n", uuid.toString().raw()); break; } } } } } } } else if (strcmp(argv[0], "ostypes") == 0) { ComPtr coll; ComPtr enumerator; CHECK_ERROR(virtualBox, COMGETTER(GuestOSTypes)(coll.asOutParam())); if (SUCCEEDED(rc) && coll) { CHECK_ERROR(coll, Enumerate(enumerator.asOutParam())); BOOL hasMore; while (SUCCEEDED(enumerator->HasMore(&hasMore)) && hasMore) { ComPtr guestOS; CHECK_RC_BREAK(enumerator->GetNext(guestOS.asOutParam())); Bstr guestId; guestOS->COMGETTER(Id)(guestId.asOutParam()); RTPrintf("ID: %lS\n", guestId.raw()); Bstr guestDescription; guestOS->COMGETTER(Description)(guestDescription.asOutParam()); RTPrintf("Description: %lS\n\n", guestDescription.raw()); } } } else if (strcmp(argv[0], "hostdvds") == 0) { ComPtr host; CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam())); ComPtr coll; ComPtr enumerator; CHECK_ERROR(host, COMGETTER(DVDDrives)(coll.asOutParam())); if (SUCCEEDED(rc) && coll) { CHECK_ERROR(coll, Enumerate(enumerator.asOutParam())); BOOL hasMore; while (SUCCEEDED(enumerator->HasMore(&hasMore)) && hasMore) { ComPtr dvdDrive; CHECK_RC_BREAK(enumerator->GetNext(dvdDrive.asOutParam())); Bstr name; dvdDrive->COMGETTER(Name)(name.asOutParam()); RTPrintf("Name: %lS\n\n", name.raw()); } } } else if (strcmp(argv[0], "hostfloppies") == 0) { ComPtr host; CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam())); ComPtr coll; ComPtr enumerator; CHECK_ERROR(host, COMGETTER(FloppyDrives)(coll.asOutParam())); if (SUCCEEDED(rc) && coll) { CHECK_ERROR(coll, Enumerate(enumerator.asOutParam())); BOOL hasMore; while (SUCCEEDED(enumerator->HasMore(&hasMore)) && hasMore) { ComPtr floppyDrive; CHECK_RC_BREAK(enumerator->GetNext(floppyDrive.asOutParam())); Bstr name; floppyDrive->COMGETTER(Name)(name.asOutParam()); RTPrintf("Name: %lS\n\n", name.raw()); } } } else if (strcmp(argv[0], "hostifs") == 0) { ComPtr host; CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam())); ComPtr coll; ComPtr enumerator; CHECK_ERROR(host, COMGETTER(NetworkInterfaces)(coll.asOutParam())); if (SUCCEEDED(rc) && coll) { CHECK_ERROR(coll, Enumerate(enumerator.asOutParam())); BOOL hasMore; while (SUCCEEDED(enumerator->HasMore(&hasMore)) && hasMore) { ComPtr networkInterface; CHECK_RC_BREAK(enumerator->GetNext(networkInterface.asOutParam())); Bstr interfaceName; networkInterface->COMGETTER(Name)(interfaceName.asOutParam()); RTPrintf("Name: %lS\n", interfaceName.raw()); Guid interfaceGuid; networkInterface->COMGETTER(Id)(interfaceGuid.asOutParam()); RTPrintf("GUID: %lS\n\n", Bstr(interfaceGuid.toString()).raw()); } } } else if (strcmp(argv[0], "hostinfo") == 0) { ComPtr Host; CHECK_ERROR (virtualBox, COMGETTER(Host)(Host.asOutParam())); RTPrintf("Host Information:\n\n"); LONG64 uTCTime = 0; CHECK_ERROR (Host, COMGETTER(UTCTime)(&uTCTime)); RTTIMESPEC timeSpec; RTTimeSpecSetMilli(&timeSpec, uTCTime); char pszTime[30] = {0}; RTTimeSpecToString(&timeSpec, pszTime, sizeof(pszTime)); RTPrintf("Host time: %s\n", pszTime); ULONG processorOnlineCount = 0; CHECK_ERROR (Host, COMGETTER(ProcessorOnlineCount)(&processorOnlineCount)); RTPrintf("Processor online count: %lu\n", processorOnlineCount); ULONG processorCount = 0; CHECK_ERROR (Host, COMGETTER(ProcessorCount)(&processorCount)); RTPrintf("Processor count: %lu\n", processorCount); ULONG processorSpeed = 0; Bstr processorDescription; for (ULONG i = 0; i < processorCount; i++) { CHECK_ERROR (Host, GetProcessorSpeed(i, &processorSpeed)); if (processorSpeed) RTPrintf("Processor#%u speed: %lu MHz\n", i, processorSpeed); else RTPrintf("Processor#%u speed: unknown\n", i, processorSpeed); #if 0 /* not yet implemented in Main */ CHECK_ERROR (Host, GetProcessorDescription(i, processorDescription.asOutParam())); RTPrintf("Processor#%u description: %lS\n", i, processorDescription.raw()); #endif } #if 0 /* not yet implemented in Main */ ULONG memorySize = 0; CHECK_ERROR (Host, COMGETTER(MemorySize)(&memorySize)); RTPrintf("Memory size: %lu MByte\n", memorySize); ULONG memoryAvailable = 0; CHECK_ERROR (Host, COMGETTER(MemoryAvailable)(&memoryAvailable)); RTPrintf("Memory available: %lu MByte\n", memoryAvailable); Bstr operatingSystem; CHECK_ERROR (Host, COMGETTER(OperatingSystem)(operatingSystem.asOutParam())); RTPrintf("Operating system: %lS\n", operatingSystem.raw()); Bstr oSVersion; CHECK_ERROR (Host, COMGETTER(OSVersion)(oSVersion.asOutParam())); RTPrintf("Operating system version: %lS\n", oSVersion.raw()); #endif } else if (strcmp(argv[0], "hdds") == 0) { com::SafeIfaceArray hdds; CHECK_ERROR(virtualBox, COMGETTER(HardDisks2)(ComSafeArrayAsOutParam (hdds))); for (size_t i = 0; i < hdds.size(); ++ i) { ComPtr hdd = hdds[i]; Guid uuid; hdd->COMGETTER(Id)(uuid.asOutParam()); RTPrintf("UUID: %s\n", uuid.toString().raw()); Bstr format; hdd->COMGETTER(Format)(format.asOutParam()); RTPrintf("Format: %lS\n", format.raw()); Bstr filepath; hdd->COMGETTER(Location)(filepath.asOutParam()); RTPrintf("Location: %lS\n", filepath.raw()); MediaState_T enmState; /// @todo NEWMEDIA check accessibility of all parents /// @todo NEWMEDIA print the full state value hdd->COMGETTER(State)(&enmState); RTPrintf("Accessible: %s\n", enmState != MediaState_Inaccessible ? "yes" : "no"); com::SafeGUIDArray machineIds; hdd->COMGETTER(MachineIds)(ComSafeArrayAsOutParam(machineIds)); for (size_t j = 0; j < machineIds.size(); ++ j) { ComPtr machine; CHECK_ERROR(virtualBox, GetMachine(machineIds[j], machine.asOutParam())); ASSERT(machine); Bstr name; machine->COMGETTER(Name)(name.asOutParam()); machine->COMGETTER(Id)(uuid.asOutParam()); RTPrintf("%s%lS (UUID: %Vuuid)\n", j == 0 ? "Usage: " : " ", name.raw(), &machineIds[j]); } /// @todo NEWMEDIA check usage in snapshots too /// @todo NEWMEDIA also list children and say 'differencing' for /// hard disks with the parent or 'base' otherwise. RTPrintf("\n"); } } else if (strcmp(argv[0], "dvds") == 0) { com::SafeIfaceArray dvds; CHECK_ERROR(virtualBox, COMGETTER(DVDImages)(ComSafeArrayAsOutParam(dvds))); for (size_t i = 0; i < dvds.size(); ++ i) { ComPtr dvdImage = dvds[i]; Guid uuid; dvdImage->COMGETTER(Id)(uuid.asOutParam()); RTPrintf("UUID: %s\n", uuid.toString().raw()); Bstr filePath; dvdImage->COMGETTER(Location)(filePath.asOutParam()); RTPrintf("Path: %lS\n", filePath.raw()); MediaState_T enmState; dvdImage->COMGETTER(State)(&enmState); RTPrintf("Accessible: %s\n", enmState != MediaState_Inaccessible ? "yes" : "no"); /** @todo usage */ RTPrintf("\n"); } } else if (strcmp(argv[0], "floppies") == 0) { com::SafeIfaceArray floppies; CHECK_ERROR(virtualBox, COMGETTER(FloppyImages)(ComSafeArrayAsOutParam(floppies))); for (size_t i = 0; i < floppies.size(); ++ i) { ComPtr floppyImage = floppies[i]; Guid uuid; floppyImage->COMGETTER(Id)(uuid.asOutParam()); RTPrintf("UUID: %s\n", uuid.toString().raw()); Bstr filePath; floppyImage->COMGETTER(Location)(filePath.asOutParam()); RTPrintf("Path: %lS\n", filePath.raw()); MediaState_T enmState; floppyImage->COMGETTER(State)(&enmState); RTPrintf("Accessible: %s\n", enmState != MediaState_Inaccessible ? "yes" : "no"); /** @todo usage */ RTPrintf("\n"); } } else if (strcmp(argv[0], "usbhost") == 0) { ComPtr Host; CHECK_ERROR_RET (virtualBox, COMGETTER(Host)(Host.asOutParam()), 1); ComPtr CollPtr; CHECK_ERROR_RET (Host, COMGETTER(USBDevices)(CollPtr.asOutParam()), 1); ComPtr EnumPtr; CHECK_ERROR_RET (CollPtr, Enumerate(EnumPtr.asOutParam()), 1); RTPrintf("Host USB Devices:\n\n"); BOOL fMore = FALSE; rc = EnumPtr->HasMore (&fMore); ASSERT_RET (SUCCEEDED (rc), 1); if (!fMore) { RTPrintf("\n\n"); } else while (fMore) { ComPtr dev; rc = EnumPtr->GetNext (dev.asOutParam()); ASSERT_RET (SUCCEEDED (rc), 1); /* Query info. */ Guid id; CHECK_ERROR_RET (dev, COMGETTER(Id)(id.asOutParam()), 1); USHORT usVendorId; CHECK_ERROR_RET (dev, COMGETTER(VendorId)(&usVendorId), 1); USHORT usProductId; CHECK_ERROR_RET (dev, COMGETTER(ProductId)(&usProductId), 1); USHORT bcdRevision; CHECK_ERROR_RET (dev, COMGETTER(Revision)(&bcdRevision), 1); RTPrintf("UUID: %S\n" "VendorId: 0x%04x (%04X)\n" "ProductId: 0x%04x (%04X)\n" "Revision: %u.%u (%02u%02u)\n", id.toString().raw(), usVendorId, usVendorId, usProductId, usProductId, bcdRevision >> 8, bcdRevision & 0xff, bcdRevision >> 8, bcdRevision & 0xff); /* optional stuff. */ Bstr bstr; CHECK_ERROR_RET (dev, COMGETTER(Manufacturer)(bstr.asOutParam()), 1); if (!bstr.isEmpty()) RTPrintf("Manufacturer: %lS\n", bstr.raw()); CHECK_ERROR_RET (dev, COMGETTER(Product)(bstr.asOutParam()), 1); if (!bstr.isEmpty()) RTPrintf("Product: %lS\n", bstr.raw()); CHECK_ERROR_RET (dev, COMGETTER(SerialNumber)(bstr.asOutParam()), 1); if (!bstr.isEmpty()) RTPrintf("SerialNumber: %lS\n", bstr.raw()); CHECK_ERROR_RET (dev, COMGETTER(Address)(bstr.asOutParam()), 1); if (!bstr.isEmpty()) RTPrintf("Address: %lS\n", bstr.raw()); /* current state */ USBDeviceState_T state; CHECK_ERROR_RET (dev, COMGETTER(State)(&state), 1); const char *pszState = "?"; switch (state) { case USBDeviceState_NotSupported: pszState = "Not supported"; break; case USBDeviceState_Unavailable: pszState = "Unavailable"; break; case USBDeviceState_Busy: pszState = "Busy"; break; case USBDeviceState_Available: pszState = "Available"; break; case USBDeviceState_Held: pszState = "Held"; break; case USBDeviceState_Captured: pszState = "Captured"; break; default: ASSERT (false); break; } RTPrintf("Current State: %s\n\n", pszState); rc = EnumPtr->HasMore (&fMore); ASSERT_RET (SUCCEEDED (rc), rc); } } else if (strcmp(argv[0], "usbfilters") == 0) { RTPrintf("Global USB Device Filters:\n\n"); ComPtr host; CHECK_ERROR_RET (virtualBox, COMGETTER(Host) (host.asOutParam()), 1); ComPtr coll; CHECK_ERROR_RET (host, COMGETTER (USBDeviceFilters)(coll.asOutParam()), 1); ComPtr en; CHECK_ERROR_RET (coll, Enumerate(en.asOutParam()), 1); ULONG index = 0; BOOL more = FALSE; rc = en->HasMore (&more); ASSERT_RET (SUCCEEDED (rc), 1); if (!more) { RTPrintf("\n\n"); } else while (more) { ComPtr flt; rc = en->GetNext (flt.asOutParam()); ASSERT_RET (SUCCEEDED (rc), 1); /* Query info. */ RTPrintf("Index: %lu\n", index); BOOL active = FALSE; CHECK_ERROR_RET (flt, COMGETTER (Active) (&active), 1); RTPrintf("Active: %s\n", active ? "yes" : "no"); USBDeviceFilterAction_T action; CHECK_ERROR_RET (flt, COMGETTER (Action) (&action), 1); const char *pszAction = ""; switch (action) { case USBDeviceFilterAction_Ignore: pszAction = "Ignore"; break; case USBDeviceFilterAction_Hold: pszAction = "Hold"; break; default: break; } RTPrintf("Action: %s\n", pszAction); Bstr bstr; CHECK_ERROR_RET (flt, COMGETTER (Name) (bstr.asOutParam()), 1); RTPrintf("Name: %lS\n", bstr.raw()); CHECK_ERROR_RET (flt, COMGETTER (VendorId) (bstr.asOutParam()), 1); RTPrintf("VendorId: %lS\n", bstr.raw()); CHECK_ERROR_RET (flt, COMGETTER (ProductId) (bstr.asOutParam()), 1); RTPrintf("ProductId: %lS\n", bstr.raw()); CHECK_ERROR_RET (flt, COMGETTER (Revision) (bstr.asOutParam()), 1); RTPrintf("Revision: %lS\n", bstr.raw()); CHECK_ERROR_RET (flt, COMGETTER (Manufacturer) (bstr.asOutParam()), 1); RTPrintf("Manufacturer: %lS\n", bstr.raw()); CHECK_ERROR_RET (flt, COMGETTER (Product) (bstr.asOutParam()), 1); RTPrintf("Product: %lS\n", bstr.raw()); CHECK_ERROR_RET (flt, COMGETTER (SerialNumber) (bstr.asOutParam()), 1); RTPrintf("Serial Number: %lS\n\n", bstr.raw()); rc = en->HasMore (&more); ASSERT_RET (SUCCEEDED (rc), 1); index ++; } } else if (strcmp(argv[0], "systemproperties") == 0) { ComPtr systemProperties; virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam()); Bstr str; ULONG ulValue; ULONG64 ul64Value; BOOL flag; systemProperties->COMGETTER(MinGuestRAM)(&ulValue); RTPrintf("Minimum guest RAM size: %u Megabytes\n", ulValue); systemProperties->COMGETTER(MaxGuestRAM)(&ulValue); RTPrintf("Maximum guest RAM size: %u Megabytes\n", ulValue); systemProperties->COMGETTER(MaxGuestVRAM)(&ulValue); RTPrintf("Maximum video RAM size: %u Megabytes\n", ulValue); systemProperties->COMGETTER(MaxVDISize)(&ul64Value); RTPrintf("Maximum VDI size: %lu Megabytes\n", ul64Value); systemProperties->COMGETTER(DefaultHardDiskFolder)(str.asOutParam()); RTPrintf("Default hard disk filder: %lS\n", str.raw()); systemProperties->COMGETTER(DefaultMachineFolder)(str.asOutParam()); RTPrintf("Default machine folder: %lS\n", str.raw()); systemProperties->COMGETTER(RemoteDisplayAuthLibrary)(str.asOutParam()); RTPrintf("VRDP authentication library: %lS\n", str.raw()); systemProperties->COMGETTER(WebServiceAuthLibrary)(str.asOutParam()); RTPrintf("Webservice auth. library: %lS\n", str.raw()); systemProperties->COMGETTER(HWVirtExEnabled)(&flag); RTPrintf("Hardware virt. extensions: %s\n", flag ? "yes" : "no"); systemProperties->COMGETTER(LogHistoryCount)(&ulValue); RTPrintf("Log history count: %u\n", ulValue); } else return errorSyntax(USAGE_LIST, "Invalid parameter '%s'", Utf8Str(argv[0]).raw()); return SUCCEEDED(rc) ? 0 : 1; } static int handleRegisterVM(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; if (argc != 1) return errorSyntax(USAGE_REGISTERVM, "Incorrect number of parameters"); ComPtr machine; CHECK_ERROR(virtualBox, OpenMachine(Bstr(argv[0]), machine.asOutParam())); if (SUCCEEDED(rc)) { ASSERT(machine); CHECK_ERROR(virtualBox, RegisterMachine(machine)); } return SUCCEEDED(rc) ? 0 : 1; } static int handleUnregisterVM(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; if ((argc != 1) && (argc != 2)) return errorSyntax(USAGE_UNREGISTERVM, "Incorrect number of parameters"); ComPtr machine; /* assume it's a UUID */ rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam()); if (FAILED(rc) || !machine) { /* must be a name */ CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam())); } if (machine) { Guid uuid; machine->COMGETTER(Id)(uuid.asOutParam()); machine = NULL; CHECK_ERROR(virtualBox, UnregisterMachine(uuid, machine.asOutParam())); if (SUCCEEDED(rc) && machine) { /* are we supposed to delete the config file? */ if ((argc == 2) && (strcmp(argv[1], "-delete") == 0)) { CHECK_ERROR(machine, DeleteSettings()); } } } return SUCCEEDED(rc) ? 0 : 1; } static int handleCreateHardDisk(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; Bstr filename; uint64_t sizeMB = 0; bool fStatic = false; Bstr comment; bool fRegister = false; const char *type = "normal"; /* let's have a closer look at the arguments */ for (int i = 0; i < argc; i++) { if (strcmp(argv[i], "-filename") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; filename = argv[i]; } else if (strcmp(argv[i], "-size") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; sizeMB = RTStrToUInt64(argv[i]); } else if (strcmp(argv[i], "-static") == 0) { fStatic = true; } else if (strcmp(argv[i], "-comment") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; comment = argv[i]; } else if (strcmp(argv[i], "-register") == 0) { fRegister = true; } else if (strcmp(argv[i], "-type") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; type = argv[i]; } else return errorSyntax(USAGE_CREATEHD, "Invalid parameter '%s'", Utf8Str(argv[i]).raw()); } /* check the outcome */ if (!filename || (sizeMB == 0)) return errorSyntax(USAGE_CREATEHD, "Parameters -filename and -size are required"); if (strcmp(type, "normal") && strcmp(type, "writethrough")) return errorArgument("Invalid hard disk type '%s' specified", Utf8Str(type).raw()); ComPtr hardDisk; CHECK_ERROR(virtualBox, CreateHardDisk2(Bstr("VDI"), filename, hardDisk.asOutParam())); if (SUCCEEDED(rc) && hardDisk) { /* we will close the hard disk after the storage has been successfully * created unless fRegister is set */ bool doClose = false; CHECK_ERROR(hardDisk,COMSETTER(Description)(comment)); ComPtr progress; if (fStatic) { CHECK_ERROR(hardDisk, CreateFixedStorage(sizeMB, progress.asOutParam())); } else { CHECK_ERROR(hardDisk, CreateDynamicStorage(sizeMB, progress.asOutParam())); } if (SUCCEEDED(rc) && progress) { if (fStatic) showProgress(progress); else CHECK_ERROR(progress, WaitForCompletion(-1)); if (SUCCEEDED(rc)) { progress->COMGETTER(ResultCode)(&rc); if (FAILED(rc)) { com::ProgressErrorInfo info(progress); if (info.isBasicAvailable()) RTPrintf("Error: failed to create hard disk. Error message: %lS\n", info.getText().raw()); else RTPrintf("Error: failed to create hard disk. No error message available!\n"); } else { doClose = !fRegister; Guid uuid; CHECK_ERROR(hardDisk, COMGETTER(Id)(uuid.asOutParam())); if (strcmp(type, "normal") == 0) { /* nothing required, default */ } else if (strcmp(type, "writethrough") == 0) { CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Writethrough)); } RTPrintf("Disk image created. UUID: %s\n", uuid.toString().raw()); } } } if (doClose) { CHECK_ERROR(hardDisk, Close()); } } return SUCCEEDED(rc) ? 0 : 1; } static DECLCALLBACK(int) hardDiskProgressCallback(PVM pVM, unsigned uPercent, void *pvUser) { unsigned *pPercent = (unsigned *)pvUser; if (*pPercent != uPercent) { *pPercent = uPercent; RTPrintf("."); if ((uPercent % 10) == 0 && uPercent) RTPrintf("%d%%", uPercent); RTStrmFlush(g_pStdOut); } return VINF_SUCCESS; } static int handleModifyHardDisk(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; /* The uuid/filename and a command */ if (argc < 2) return errorSyntax(USAGE_MODIFYHD, "Incorrect number of parameters"); ComPtr hardDisk; Bstr filepath; /* first guess is that it's a UUID */ Guid uuid(argv[0]); rc = virtualBox->GetHardDisk2(uuid, hardDisk.asOutParam()); /* no? then it must be a filename */ if (!hardDisk) { filepath = argv[0]; CHECK_ERROR(virtualBox, FindHardDisk2(filepath, hardDisk.asOutParam())); } /* let's find out which command */ if (strcmp(argv[1], "settype") == 0) { /* hard disk must be registered */ if (SUCCEEDED(rc) && hardDisk) { char *type = NULL; if (argc <= 2) return errorArgument("Missing argument to for settype"); type = argv[2]; HardDiskType_T hddType; CHECK_ERROR(hardDisk, COMGETTER(Type)(&hddType)); if (strcmp(type, "normal") == 0) { if (hddType != HardDiskType_Normal) CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Normal)); } else if (strcmp(type, "writethrough") == 0) { if (hddType != HardDiskType_Writethrough) CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Writethrough)); } else if (strcmp(type, "immutable") == 0) { if (hddType != HardDiskType_Immutable) CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Immutable)); } else { return errorArgument("Invalid hard disk type '%s' specified", Utf8Str(type).raw()); } } else return errorArgument("Hard disk image not registered"); } else if (strcmp(argv[1], "compact") == 0) { /* the hard disk image might not be registered */ if (!hardDisk) { virtualBox->OpenHardDisk2(Bstr(argv[0]), hardDisk.asOutParam()); if (!hardDisk) return errorArgument("Hard disk image not found"); } Bstr format; hardDisk->COMGETTER(Format)(format.asOutParam()); if (format != "VDI") return errorArgument("Invalid hard disk type. The command only works on VDI files\n"); Bstr fileName; hardDisk->COMGETTER(Location)(fileName.asOutParam()); /* make sure the object reference is released */ hardDisk = NULL; unsigned uProcent; RTPrintf("Shrinking '%lS': 0%%", fileName.raw()); int vrc = VDIShrinkImage(Utf8Str(fileName).raw(), hardDiskProgressCallback, &uProcent); if (RT_FAILURE(vrc)) { RTPrintf("Error while shrinking hard disk image: %Vrc\n", vrc); rc = E_FAIL; } } else return errorSyntax(USAGE_MODIFYHD, "Invalid parameter '%s'", Utf8Str(argv[1]).raw()); return SUCCEEDED(rc) ? 0 : 1; } static int handleCloneHardDisk(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { #if 1 RTPrintf("Error: Clone hard disk operation is temporarily unavailable!\n"); return 1; #else /// @todo NEWMEDIA use IHardDisk2::cloneTo/flattenTo (not yet implemented) HRESULT rc; /* source hard disk and target path */ if (argc != 2) return errorSyntax(USAGE_CLONEHD, "Incorrect number of parameters"); /* first guess is that it's a UUID */ Guid uuid(argv[0]); ComPtr hardDisk; rc = virtualBox->GetHardDisk2(uuid, hardDisk.asOutParam()); if (!hardDisk) { /* not successful? Then it must be a filename */ CHECK_ERROR(virtualBox, OpenHardDisk2(Bstr(argv[0]), hardDisk.asOutParam())); } if (hardDisk) { ComPtr progress; CHECK_ERROR(hardDisk, CloneToImage(Bstr(argv[1]), hardDisk.asOutParam(), progress.asOutParam())); if (SUCCEEDED(rc)) { showProgress(progress); progress->COMGETTER(ResultCode)(&rc); if (FAILED(rc)) { com::ProgressErrorInfo info(progress); if (info.isBasicAvailable()) { RTPrintf("Error: failed to clone disk image. Error message: %lS\n", info.getText().raw()); } else { RTPrintf("Error: failed to clone disk image. No error message available!\n"); } } } } return SUCCEEDED(rc) ? 0 : 1; #endif } static int handleConvertDDImage(int argc, char *argv[]) { int arg = 0; VDIIMAGETYPE enmImgType = VDI_IMAGE_TYPE_NORMAL; if (argc >= 1 && !strcmp(argv[arg], "-static")) { arg++; enmImgType = VDI_IMAGE_TYPE_FIXED; } #if defined(RT_OS_LINUX) || defined(RT_OS_DARWIN) || defined(RT_OS_SOLARIS) const bool fReadFromStdIn = (argc >= arg + 1) && !strcmp(argv[arg], "stdin"); #else const bool fReadFromStdIn = false; #endif if ((!fReadFromStdIn && argc != arg + 2) || (fReadFromStdIn && argc != arg + 3)) return errorSyntax(USAGE_CONVERTDD, "Incorrect number of parameters"); RTPrintf("Converting VDI: from DD image file=\"%s\" to file=\"%s\"...\n", argv[arg], argv[arg + 1]); /* open raw image file. */ RTFILE File; int rc = VINF_SUCCESS; if (fReadFromStdIn) File = 0; else rc = RTFileOpen(&File, argv[arg], RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_WRITE); if (RT_FAILURE(rc)) { RTPrintf("File=\"%s\" open error: %Rrf\n", argv[arg], rc); return rc; } uint64_t cbFile; /* get image size. */ if (fReadFromStdIn) cbFile = RTStrToUInt64(argv[arg + 2]); else rc = RTFileGetSize(File, &cbFile); if (RT_SUCCESS(rc)) { RTPrintf("Creating %s image with size %RU64 bytes (%RU64MB)...\n", (enmImgType == VDI_IMAGE_TYPE_FIXED) ? "fixed" : "dynamic", cbFile, (cbFile + _1M - 1) / _1M); char pszComment[256]; RTStrPrintf(pszComment, sizeof(pszComment), "Converted image from %s", argv[arg]); rc = VDICreateBaseImage(argv[arg + 1], enmImgType, cbFile, pszComment, NULL, NULL); if (RT_SUCCESS(rc)) { PVDIDISK pVdi = VDIDiskCreate(); rc = VDIDiskOpenImage(pVdi, argv[arg + 1], VDI_OPEN_FLAGS_NORMAL); if (RT_SUCCESS(rc)) { /* alloc work buffer. */ size_t cbBuffer = VDIDiskGetBufferSize(pVdi); void *pvBuf = RTMemAlloc(cbBuffer); if (pvBuf) { uint64_t offFile = 0; while (offFile < cbFile) { size_t cbRead = 0; size_t cbToRead = cbFile - offFile >= (uint64_t) cbBuffer ? cbBuffer : (size_t) (cbFile - offFile); rc = RTFileRead(File, pvBuf, cbToRead, &cbRead); if (RT_FAILURE(rc) || !cbRead) break; rc = VDIDiskWrite(pVdi, offFile, pvBuf, cbRead); if (RT_FAILURE(rc)) break; offFile += cbRead; } RTMemFree(pvBuf); } else rc = VERR_NO_MEMORY; VDIDiskCloseImage(pVdi); } if (RT_FAILURE(rc)) { /* delete image on error */ RTPrintf("Failed (%Vrc)!\n", rc); VDIDeleteImage(argv[arg + 1]); } } else RTPrintf("Failed to create output file (%Vrc)!\n", rc); } RTFileClose(File); return rc; } static int handleAddiSCSIDisk(int argc, char *argv[], ComPtr aVirtualBox, ComPtr aSession) { #if 1 RTPrintf("Error: Create iSCSI hard disk operation is temporarily unavailable!\n"); return 1; #else HRESULT rc; Bstr server; Bstr target; uint16_t port = UINT16_MAX; uint64_t lun = UINT64_MAX; Bstr username; Bstr password; Bstr comment; /* at least server and target */ if (argc < 4) return errorSyntax(USAGE_ADDISCSIDISK, "Not enough parameters"); /* let's have a closer look at the arguments */ for (int i = 0; i < argc; i++) { if (strcmp(argv[i], "-server") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; server = argv[i]; } else if (strcmp(argv[i], "-target") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; target = argv[i]; } else if (strcmp(argv[i], "-port") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; port = atoi(argv[i]); } else if (strcmp(argv[i], "-lun") == 0) { /** @todo move the LUN encoding algorithm into IISCSIHardDisk, add decoding */ if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; char *pszNext; int rc = RTStrToUInt64Ex(argv[i], &pszNext, 0, &lun); if (RT_FAILURE(rc) || *pszNext != '\0' || lun >= 16384) return errorArgument("Invalid LUN number '%s'", argv[i]); if (lun <= 255) { /* Assume bus identifier = 0. */ lun = (lun << 48); /* uses peripheral device addressing method */ } else { /* Check above already limited the LUN to 14 bits. */ lun = (lun << 48) | RT_BIT_64(62); /* uses flat space addressing method */ } } else if (strcmp(argv[i], "-encodedlun") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; char *pszNext; int rc = RTStrToUInt64Ex(argv[i], &pszNext, 0, &lun); if (RT_FAILURE(rc) || *pszNext != '\0') return errorArgument("Invalid encoded LUN number '%s'", argv[i]); } else if (strcmp(argv[i], "-username") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; username = argv[i]; } else if (strcmp(argv[i], "-password") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; password = argv[i]; } else if (strcmp(argv[i], "-comment") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; comment = argv[i]; } else return errorSyntax(USAGE_ADDISCSIDISK, "Invalid parameter '%s'", Utf8Str(argv[i]).raw()); } /* check for required options */ if (!server || !target) return errorSyntax(USAGE_ADDISCSIDISK, "Parameters -server and -target are required"); ComPtr hardDisk; CHECK_ERROR(aVirtualBox, CreateHardDisk(HardDiskStorageType_ISCSIHardDisk, hardDisk.asOutParam())); if (SUCCEEDED(rc) && hardDisk) { CHECK_ERROR(hardDisk, COMSETTER(Description)(comment)); ComPtr iSCSIDisk = hardDisk; CHECK_ERROR(iSCSIDisk, COMSETTER(Server)(server)); if (port != UINT16_MAX) CHECK_ERROR(iSCSIDisk, COMSETTER(Port)(port)); CHECK_ERROR(iSCSIDisk, COMSETTER(Target)(target)); if (lun != UINT64_MAX) CHECK_ERROR(iSCSIDisk, COMSETTER(Lun)(lun)); CHECK_ERROR(iSCSIDisk, COMSETTER(UserName)(username)); CHECK_ERROR(iSCSIDisk, COMSETTER(Password)(password)); if (SUCCEEDED(rc)) { CHECK_ERROR(aVirtualBox, RegisterHardDisk(hardDisk)); } if (SUCCEEDED(rc)) { Guid guid; CHECK_ERROR(hardDisk, COMGETTER(Id)(guid.asOutParam())); RTPrintf("iSCSI disk created. UUID: %s\n", guid.toString().raw()); } } return SUCCEEDED(rc) ? 0 : 1; #endif } static int handleCreateVM(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; Bstr baseFolder; Bstr settingsFile; Bstr name; RTUUID id; bool fRegister = false; RTUuidClear(&id); for (int i = 0; i < argc; i++) { if (strcmp(argv[i], "-basefolder") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; baseFolder = argv[i]; } else if (strcmp(argv[i], "-settingsfile") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; settingsFile = argv[i]; } else if (strcmp(argv[i], "-name") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; name = argv[i]; } else if (strcmp(argv[i], "-uuid") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; if (RT_FAILURE(RTUuidFromStr(&id, argv[i]))) return errorArgument("Invalid UUID format %s\n", argv[i]); } else if (strcmp(argv[i], "-register") == 0) { fRegister = true; } else return errorSyntax(USAGE_CREATEVM, "Invalid parameter '%s'", Utf8Str(argv[i]).raw()); } if (!name) return errorSyntax(USAGE_CREATEVM, "Parameter -name is required"); if (!!baseFolder && !!settingsFile) return errorSyntax(USAGE_CREATEVM, "Either -basefolder or -settingsfile must be specified"); do { ComPtr machine; if (!settingsFile) CHECK_ERROR_BREAK(virtualBox, CreateMachine(baseFolder, name, Guid(id), machine.asOutParam())); else CHECK_ERROR_BREAK(virtualBox, CreateLegacyMachine(settingsFile, name, Guid(id), machine.asOutParam())); CHECK_ERROR_BREAK(machine, SaveSettings()); if (fRegister) { CHECK_ERROR_BREAK(virtualBox, RegisterMachine(machine)); } Guid uuid; CHECK_ERROR_BREAK(machine, COMGETTER(Id)(uuid.asOutParam())); CHECK_ERROR_BREAK(machine, COMGETTER(SettingsFilePath)(settingsFile.asOutParam())); RTPrintf("Virtual machine '%ls' is created%s.\n" "UUID: %s\n" "Settings file: '%ls'\n", name.raw(), fRegister ? " and registered" : "", uuid.toString().raw(), settingsFile.raw()); } while (0); return SUCCEEDED(rc) ? 0 : 1; } /** * Parses a number. * * @returns Valid number on success. * @returns 0 if invalid number. All necesary bitching has been done. * @param psz Pointer to the nic number. */ static unsigned parseNum(const char *psz, unsigned cMaxNum, const char *name) { uint32_t u32; char *pszNext; int rc = RTStrToUInt32Ex(psz, &pszNext, 10, &u32); if ( RT_SUCCESS(rc) && *pszNext == '\0' && u32 >= 1 && u32 <= cMaxNum) return (unsigned)u32; errorArgument("Invalid %s number '%s'", name, psz); return 0; } static int handleModifyVM(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; Bstr name; Bstr ostype; ULONG memorySize = 0; ULONG vramSize = 0; char *acpi = NULL; char *hwvirtex = NULL; char *nestedpaging = NULL; char *vtxvpid = NULL; char *pae = NULL; char *ioapic = NULL; int monitorcount = -1; char *bioslogofadein = NULL; char *bioslogofadeout = NULL; uint32_t bioslogodisplaytime = ~0; char *bioslogoimagepath = NULL; char *biosbootmenumode = NULL; char *biossystemtimeoffset = NULL; char *biospxedebug = NULL; DeviceType_T bootDevice[4]; int bootDeviceChanged[4] = { false }; char *hdds[34] = {0}; char *dvd = NULL; char *dvdpassthrough = NULL; char *idecontroller = NULL; char *floppy = NULL; char *audio = NULL; char *audiocontroller = NULL; char *clipboard = NULL; #ifdef VBOX_WITH_VRDP char *vrdp = NULL; uint16_t vrdpport = UINT16_MAX; char *vrdpaddress = NULL; char *vrdpauthtype = NULL; char *vrdpmulticon = NULL; char *vrdpreusecon = NULL; #endif int fUsbEnabled = -1; int fUsbEhciEnabled = -1; char *snapshotFolder = NULL; ULONG guestMemBalloonSize = (ULONG)-1; ULONG guestStatInterval = (ULONG)-1; int fSataEnabled = -1; int sataPortCount = -1; int sataBootDevices[4] = {-1,-1,-1,-1}; /* VM ID + at least one parameter. Parameter arguments are checked * individually. */ if (argc < 2) return errorSyntax(USAGE_MODIFYVM, "Not enough parameters"); /* Get the number of network adapters */ ULONG NetworkAdapterCount = 0; { ComPtr info; CHECK_ERROR_RET (virtualBox, COMGETTER(SystemProperties) (info.asOutParam()), 1); CHECK_ERROR_RET (info, COMGETTER(NetworkAdapterCount) (&NetworkAdapterCount), 1); } ULONG SerialPortCount = 0; { ComPtr info; CHECK_ERROR_RET (virtualBox, COMGETTER(SystemProperties) (info.asOutParam()), 1); CHECK_ERROR_RET (info, COMGETTER(SerialPortCount) (&SerialPortCount), 1); } std::vector nics (NetworkAdapterCount, 0); std::vector nictype (NetworkAdapterCount, 0); std::vector cableconnected (NetworkAdapterCount, 0); std::vector nictrace (NetworkAdapterCount, 0); std::vector nictracefile (NetworkAdapterCount, 0); std::vector nicspeed (NetworkAdapterCount, 0); std::vector hostifdev (NetworkAdapterCount, 0); std::vector intnet (NetworkAdapterCount, 0); std::vector natnet (NetworkAdapterCount, 0); #ifdef RT_OS_LINUX std::vector tapsetup (NetworkAdapterCount, 0); std::vector tapterm (NetworkAdapterCount, 0); #endif std::vector macs (NetworkAdapterCount, 0); std::vector uarts_mode (SerialPortCount, 0); std::vector uarts_base (SerialPortCount, 0); std::vector uarts_irq (SerialPortCount, 0); std::vector uarts_path (SerialPortCount, 0); for (int i = 1; i < argc; i++) { if (strcmp(argv[i], "-name") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; name = argv[i]; } else if (strcmp(argv[i], "-ostype") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; ostype = argv[i]; } else if (strcmp(argv[i], "-memory") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; memorySize = atoi(argv[i]); } else if (strcmp(argv[i], "-vram") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; vramSize = atoi(argv[i]); } else if (strcmp(argv[i], "-acpi") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; acpi = argv[i]; } else if (strcmp(argv[i], "-ioapic") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; ioapic = argv[i]; } else if (strcmp(argv[i], "-hwvirtex") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; hwvirtex = argv[i]; } else if (strcmp(argv[i], "-nestedpaging") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; nestedpaging = argv[i]; } else if (strcmp(argv[i], "-vtxvpid") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; vtxvpid = argv[i]; } else if (strcmp(argv[i], "-pae") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; pae = argv[i]; } else if (strcmp(argv[i], "-monitorcount") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; monitorcount = atoi(argv[i]); } else if (strcmp(argv[i], "-bioslogofadein") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; bioslogofadein = argv[i]; } else if (strcmp(argv[i], "-bioslogofadeout") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; bioslogofadeout = argv[i]; } else if (strcmp(argv[i], "-bioslogodisplaytime") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; bioslogodisplaytime = atoi(argv[i]); } else if (strcmp(argv[i], "-bioslogoimagepath") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; bioslogoimagepath = argv[i]; } else if (strcmp(argv[i], "-biosbootmenu") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; biosbootmenumode = argv[i]; } else if (strcmp(argv[i], "-biossystemtimeoffset") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; biossystemtimeoffset = argv[i]; } else if (strcmp(argv[i], "-biospxedebug") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; biospxedebug = argv[i]; } else if (strncmp(argv[i], "-boot", 5) == 0) { ULONG n = 0; if (!argv[i][5]) return errorSyntax(USAGE_MODIFYVM, "Missing boot slot number in '%s'", argv[i]); if ((n = strtoul(&argv[i][5], NULL, 10)) < 1) return errorSyntax(USAGE_MODIFYVM, "Invalid boot slot number in '%s'", argv[i]); if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; if (strcmp(argv[i], "none") == 0) { bootDevice[n - 1] = DeviceType_Null; } else if (strcmp(argv[i], "floppy") == 0) { bootDevice[n - 1] = DeviceType_Floppy; } else if (strcmp(argv[i], "dvd") == 0) { bootDevice[n - 1] = DeviceType_DVD; } else if (strcmp(argv[i], "disk") == 0) { bootDevice[n - 1] = DeviceType_HardDisk; } else if (strcmp(argv[i], "net") == 0) { bootDevice[n - 1] = DeviceType_Network; } else return errorArgument("Invalid boot device '%s'", argv[i]); bootDeviceChanged[n - 1] = true; } else if (strcmp(argv[i], "-hda") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; hdds[0] = argv[i]; } else if (strcmp(argv[i], "-hdb") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; hdds[1] = argv[i]; } else if (strcmp(argv[i], "-hdd") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; hdds[2] = argv[i]; } else if (strcmp(argv[i], "-dvd") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; dvd = argv[i]; } else if (strcmp(argv[i], "-dvdpassthrough") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; dvdpassthrough = argv[i]; } else if (strcmp(argv[i], "-idecontroller") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; idecontroller = argv[i]; } else if (strcmp(argv[i], "-floppy") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; floppy = argv[i]; } else if (strcmp(argv[i], "-audio") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; audio = argv[i]; } else if (strcmp(argv[i], "-audiocontroller") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; audiocontroller = argv[i]; } else if (strcmp(argv[i], "-clipboard") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; clipboard = argv[i]; } else if (strncmp(argv[i], "-cableconnected", 15) == 0) { unsigned n = parseNum(&argv[i][15], NetworkAdapterCount, "NIC"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); cableconnected[n - 1] = argv[i + 1]; i++; } /* watch for the right order of these -nic* comparisons! */ else if (strncmp(argv[i], "-nictracefile", 13) == 0) { unsigned n = parseNum(&argv[i][13], NetworkAdapterCount, "NIC"); if (!n) return 1; if (argc <= i + 1) { return errorArgument("Missing argument to '%s'", argv[i]); } nictracefile[n - 1] = argv[i + 1]; i++; } else if (strncmp(argv[i], "-nictrace", 9) == 0) { unsigned n = parseNum(&argv[i][9], NetworkAdapterCount, "NIC"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); nictrace[n - 1] = argv[i + 1]; i++; } else if (strncmp(argv[i], "-nictype", 8) == 0) { unsigned n = parseNum(&argv[i][8], NetworkAdapterCount, "NIC"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); nictype[n - 1] = argv[i + 1]; i++; } else if (strncmp(argv[i], "-nicspeed", 9) == 0) { unsigned n = parseNum(&argv[i][9], NetworkAdapterCount, "NIC"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); nicspeed[n - 1] = argv[i + 1]; i++; } else if (strncmp(argv[i], "-nic", 4) == 0) { unsigned n = parseNum(&argv[i][4], NetworkAdapterCount, "NIC"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); nics[n - 1] = argv[i + 1]; i++; } else if (strncmp(argv[i], "-hostifdev", 10) == 0) { unsigned n = parseNum(&argv[i][10], NetworkAdapterCount, "NIC"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); hostifdev[n - 1] = argv[i + 1]; i++; } else if (strncmp(argv[i], "-intnet", 7) == 0) { unsigned n = parseNum(&argv[i][7], NetworkAdapterCount, "NIC"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); intnet[n - 1] = argv[i + 1]; i++; } else if (strncmp(argv[i], "-natnet", 7) == 0) { unsigned n = parseNum(&argv[i][7], NetworkAdapterCount, "NIC"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); if (!strcmp(argv[i + 1], "default")) natnet[n - 1] = ""; else { RTIPV4ADDR Network; RTIPV4ADDR Netmask; int rc = RTCidrStrToIPv4(argv[i + 1], &Network, &Netmask); if (RT_FAILURE(rc)) return errorArgument("Invalid IPv4 network '%s' specified -- CIDR notation expected.\n", argv[i + 1]); if (Netmask & 0x1f) return errorArgument("Prefix length of the NAT network must be less than 28.\n"); natnet[n - 1] = argv[i + 1]; } i++; } #ifdef RT_OS_LINUX else if (strncmp(argv[i], "-tapsetup", 9) == 0) { unsigned n = parseNum(&argv[i][9], NetworkAdapterCount, "NIC"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); tapsetup[n - 1] = argv[i + 1]; i++; } else if (strncmp(argv[i], "-tapterminate", 13) == 0) { unsigned n = parseNum(&argv[i][13], NetworkAdapterCount, "NIC"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); tapterm[n - 1] = argv[i + 1]; i++; } #endif /* RT_OS_LINUX */ else if (strncmp(argv[i], "-macaddress", 11) == 0) { unsigned n = parseNum(&argv[i][11], NetworkAdapterCount, "NIC"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); macs[n - 1] = argv[i + 1]; i++; } #ifdef VBOX_WITH_VRDP else if (strcmp(argv[i], "-vrdp") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; vrdp = argv[i]; } else if (strcmp(argv[i], "-vrdpport") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; if (strcmp(argv[i], "default") == 0) vrdpport = 0; else vrdpport = atoi(argv[i]); } else if (strcmp(argv[i], "-vrdpaddress") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; vrdpaddress = argv[i]; } else if (strcmp(argv[i], "-vrdpauthtype") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; vrdpauthtype = argv[i]; } else if (strcmp(argv[i], "-vrdpmulticon") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; vrdpmulticon = argv[i]; } else if (strcmp(argv[i], "-vrdpreusecon") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; vrdpreusecon = argv[i]; } #endif /* VBOX_WITH_VRDP */ else if (strcmp(argv[i], "-usb") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; if (strcmp(argv[i], "on") == 0 || strcmp(argv[i], "enable") == 0) fUsbEnabled = 1; else if (strcmp(argv[i], "off") == 0 || strcmp(argv[i], "disable") == 0) fUsbEnabled = 0; else return errorArgument("Invalid -usb argument '%s'", argv[i]); } else if (strcmp(argv[i], "-usbehci") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; if (strcmp(argv[i], "on") == 0 || strcmp(argv[i], "enable") == 0) fUsbEhciEnabled = 1; else if (strcmp(argv[i], "off") == 0 || strcmp(argv[i], "disable") == 0) fUsbEhciEnabled = 0; else return errorArgument("Invalid -usbehci argument '%s'", argv[i]); } else if (strcmp(argv[i], "-snapshotfolder") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; snapshotFolder = argv[i]; } else if (strncmp(argv[i], "-uartmode", 9) == 0) { unsigned n = parseNum(&argv[i][9], SerialPortCount, "UART"); if (!n) return 1; i++; if (strcmp(argv[i], "disconnected") == 0) { uarts_mode[n - 1] = argv[i]; } else { if (strcmp(argv[i], "server") == 0 || strcmp(argv[i], "client") == 0) { uarts_mode[n - 1] = argv[i]; i++; #ifdef RT_OS_WINDOWS if (strncmp(argv[i], "\\\\.\\pipe\\", 9)) return errorArgument("Uart pipe must start with \\\\.\\pipe\\"); #endif } else { uarts_mode[n - 1] = (char*)"device"; } if (argc <= i) return errorArgument("Missing argument to -uartmode"); uarts_path[n - 1] = argv[i]; } } else if (strncmp(argv[i], "-uart", 5) == 0) { unsigned n = parseNum(&argv[i][5], SerialPortCount, "UART"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; if (strcmp(argv[i], "off") == 0 || strcmp(argv[i], "disable") == 0) { uarts_base[n - 1] = (ULONG)-1; } else { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i-1]); uint32_t uVal; int vrc; vrc = RTStrToUInt32Ex(argv[i], NULL, 0, &uVal); if (vrc != VINF_SUCCESS || uVal == 0) return errorArgument("Error parsing UART I/O base '%s'", argv[i]); uarts_base[n - 1] = uVal; i++; vrc = RTStrToUInt32Ex(argv[i], NULL, 0, &uVal); if (vrc != VINF_SUCCESS) return errorArgument("Error parsing UART IRQ '%s'", argv[i]); uarts_irq[n - 1] = uVal; } } #ifdef VBOX_WITH_MEM_BALLOONING else if (strncmp(argv[i], "-guestmemoryballoon", 19) == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; uint32_t uVal; int vrc; vrc = RTStrToUInt32Ex(argv[i], NULL, 0, &uVal); if (vrc != VINF_SUCCESS) return errorArgument("Error parsing guest memory balloon size '%s'", argv[i]); guestMemBalloonSize = uVal; } #endif else if (strncmp(argv[i], "-gueststatisticsinterval", 24) == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; uint32_t uVal; int vrc; vrc = RTStrToUInt32Ex(argv[i], NULL, 0, &uVal); if (vrc != VINF_SUCCESS) return errorArgument("Error parsing guest statistics interval '%s'", argv[i]); guestStatInterval = uVal; } else if (strcmp(argv[i], "-sata") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; if (strcmp(argv[i], "on") == 0 || strcmp(argv[i], "enable") == 0) fSataEnabled = 1; else if (strcmp(argv[i], "off") == 0 || strcmp(argv[i], "disable") == 0) fSataEnabled = 0; else return errorArgument("Invalid -usb argument '%s'", argv[i]); } else if (strcmp(argv[i], "-sataportcount") == 0) { unsigned n; if (argc <= i + 1) return errorArgument("Missing arguments to '%s'", argv[i]); i++; n = parseNum(argv[i], 30, "SATA"); if (!n) return 1; sataPortCount = n; } else if (strncmp(argv[i], "-sataport", 9) == 0) { unsigned n = parseNum(&argv[i][9], 30, "SATA"); if (!n) return 1; if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; hdds[n-1+4] = argv[i]; } else if (strncmp(argv[i], "-sataideemulation", 17) == 0) { unsigned bootDevicePos = 0; unsigned n; bootDevicePos = parseNum(&argv[i][17], 4, "SATA"); if (!bootDevicePos) return 1; bootDevicePos--; if (argc <= i + 1) return errorArgument("Missing arguments to '%s'", argv[i]); i++; n = parseNum(argv[i], 30, "SATA"); if (!n) return 1; sataBootDevices[bootDevicePos] = n-1; } else return errorSyntax(USAGE_MODIFYVM, "Invalid parameter '%s'", Utf8Str(argv[i]).raw()); } /* try to find the given machine */ ComPtr machine; Guid uuid (argv[0]); if (!uuid.isEmpty()) { CHECK_ERROR (virtualBox, GetMachine (uuid, machine.asOutParam())); } else { CHECK_ERROR (virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam())); if (SUCCEEDED (rc)) machine->COMGETTER(Id)(uuid.asOutParam()); } if (FAILED (rc)) return 1; /* open a session for the VM */ CHECK_ERROR_RET (virtualBox, OpenSession(session, uuid), 1); do { /* get the mutable session machine */ session->COMGETTER(Machine)(machine.asOutParam()); ComPtr biosSettings; machine->COMGETTER(BIOSSettings)(biosSettings.asOutParam()); if (name) CHECK_ERROR(machine, COMSETTER(Name)(name)); if (ostype) { ComPtr guestOSType; CHECK_ERROR(virtualBox, GetGuestOSType(ostype, guestOSType.asOutParam())); if (SUCCEEDED(rc) && guestOSType) { CHECK_ERROR(machine, COMSETTER(OSTypeId)(ostype)); } else { errorArgument("Invalid guest OS type '%s'", Utf8Str(ostype).raw()); rc = E_FAIL; break; } } if (memorySize > 0) CHECK_ERROR(machine, COMSETTER(MemorySize)(memorySize)); if (vramSize > 0) CHECK_ERROR(machine, COMSETTER(VRAMSize)(vramSize)); if (acpi) { if (strcmp(acpi, "on") == 0) { CHECK_ERROR(biosSettings, COMSETTER(ACPIEnabled)(true)); } else if (strcmp(acpi, "off") == 0) { CHECK_ERROR(biosSettings, COMSETTER(ACPIEnabled)(false)); } else { errorArgument("Invalid -acpi argument '%s'", acpi); rc = E_FAIL; break; } } if (ioapic) { if (strcmp(ioapic, "on") == 0) { CHECK_ERROR(biosSettings, COMSETTER(IOAPICEnabled)(true)); } else if (strcmp(ioapic, "off") == 0) { CHECK_ERROR(biosSettings, COMSETTER(IOAPICEnabled)(false)); } else { errorArgument("Invalid -ioapic argument '%s'", ioapic); rc = E_FAIL; break; } } if (hwvirtex) { if (strcmp(hwvirtex, "on") == 0) { CHECK_ERROR(machine, COMSETTER(HWVirtExEnabled)(TSBool_True)); } else if (strcmp(hwvirtex, "off") == 0) { CHECK_ERROR(machine, COMSETTER(HWVirtExEnabled)(TSBool_False)); } else if (strcmp(hwvirtex, "default") == 0) { CHECK_ERROR(machine, COMSETTER(HWVirtExEnabled)(TSBool_Default)); } else { errorArgument("Invalid -hwvirtex argument '%s'", hwvirtex); rc = E_FAIL; break; } } if (nestedpaging) { if (strcmp(nestedpaging, "on") == 0) { CHECK_ERROR(machine, COMSETTER(HWVirtExNestedPagingEnabled)(true)); } else if (strcmp(nestedpaging, "off") == 0) { CHECK_ERROR(machine, COMSETTER(HWVirtExNestedPagingEnabled)(false)); } else { errorArgument("Invalid -nestedpaging argument '%s'", ioapic); rc = E_FAIL; break; } } if (vtxvpid) { if (strcmp(vtxvpid, "on") == 0) { CHECK_ERROR(machine, COMSETTER(HWVirtExVPIDEnabled)(true)); } else if (strcmp(vtxvpid, "off") == 0) { CHECK_ERROR(machine, COMSETTER(HWVirtExVPIDEnabled)(false)); } else { errorArgument("Invalid -vtxvpid argument '%s'", ioapic); rc = E_FAIL; break; } } if (pae) { if (strcmp(pae, "on") == 0) { CHECK_ERROR(machine, COMSETTER(PAEEnabled)(true)); } else if (strcmp(pae, "off") == 0) { CHECK_ERROR(machine, COMSETTER(PAEEnabled)(false)); } else { errorArgument("Invalid -pae argument '%s'", ioapic); rc = E_FAIL; break; } } if (monitorcount != -1) { CHECK_ERROR(machine, COMSETTER(MonitorCount)(monitorcount)); } if (bioslogofadein) { if (strcmp(bioslogofadein, "on") == 0) { CHECK_ERROR(biosSettings, COMSETTER(LogoFadeIn)(true)); } else if (strcmp(bioslogofadein, "off") == 0) { CHECK_ERROR(biosSettings, COMSETTER(LogoFadeIn)(false)); } else { errorArgument("Invalid -bioslogofadein argument '%s'", bioslogofadein); rc = E_FAIL; break; } } if (bioslogofadeout) { if (strcmp(bioslogofadeout, "on") == 0) { CHECK_ERROR(biosSettings, COMSETTER(LogoFadeOut)(true)); } else if (strcmp(bioslogofadeout, "off") == 0) { CHECK_ERROR(biosSettings, COMSETTER(LogoFadeOut)(false)); } else { errorArgument("Invalid -bioslogofadeout argument '%s'", bioslogofadeout); rc = E_FAIL; break; } } if (bioslogodisplaytime != ~0U) { CHECK_ERROR(biosSettings, COMSETTER(LogoDisplayTime)(bioslogodisplaytime)); } if (bioslogoimagepath) { CHECK_ERROR(biosSettings, COMSETTER(LogoImagePath)(Bstr(bioslogoimagepath))); } if (biosbootmenumode) { if (strcmp(biosbootmenumode, "disabled") == 0) CHECK_ERROR(biosSettings, COMSETTER(BootMenuMode)(BIOSBootMenuMode_Disabled)); else if (strcmp(biosbootmenumode, "menuonly") == 0) CHECK_ERROR(biosSettings, COMSETTER(BootMenuMode)(BIOSBootMenuMode_MenuOnly)); else if (strcmp(biosbootmenumode, "messageandmenu") == 0) CHECK_ERROR(biosSettings, COMSETTER(BootMenuMode)(BIOSBootMenuMode_MessageAndMenu)); else { errorArgument("Invalid -biosbootmenu argument '%s'", biosbootmenumode); rc = E_FAIL; break; } } if (biossystemtimeoffset) { LONG64 timeOffset = RTStrToInt64(biossystemtimeoffset); CHECK_ERROR(biosSettings, COMSETTER(TimeOffset)(timeOffset)); } if (biospxedebug) { if (strcmp(biospxedebug, "on") == 0) { CHECK_ERROR(biosSettings, COMSETTER(PXEDebugEnabled)(true)); } else if (strcmp(biospxedebug, "off") == 0) { CHECK_ERROR(biosSettings, COMSETTER(PXEDebugEnabled)(false)); } else { errorArgument("Invalid -biospxedebug argument '%s'", biospxedebug); rc = E_FAIL; break; } } for (int curBootDev = 0; curBootDev < 4; curBootDev++) { if (bootDeviceChanged[curBootDev]) CHECK_ERROR(machine, SetBootOrder (curBootDev + 1, bootDevice[curBootDev])); } if (hdds[0]) { if (strcmp(hdds[0], "none") == 0) { machine->DetachHardDisk2(StorageBus_IDE, 0, 0); } else { /* first guess is that it's a UUID */ Guid uuid(hdds[0]); ComPtr hardDisk; rc = virtualBox->GetHardDisk2(uuid, hardDisk.asOutParam()); /* not successful? Then it must be a filename */ if (!hardDisk) { CHECK_ERROR(virtualBox, FindHardDisk2(Bstr(hdds[0]), hardDisk.asOutParam())); if (FAILED(rc)) { /* open the new hard disk object */ CHECK_ERROR(virtualBox, OpenHardDisk2(Bstr(hdds[0]), hardDisk.asOutParam())); } } if (hardDisk) { hardDisk->COMGETTER(Id)(uuid.asOutParam()); CHECK_ERROR(machine, AttachHardDisk2(uuid, StorageBus_IDE, 0, 0)); } else rc = E_FAIL; if (FAILED(rc)) break; } } if (hdds[1]) { if (strcmp(hdds[1], "none") == 0) { machine->DetachHardDisk2(StorageBus_IDE, 0, 1); } else { /* first guess is that it's a UUID */ Guid uuid(hdds[1]); ComPtr hardDisk; rc = virtualBox->GetHardDisk2(uuid, hardDisk.asOutParam()); /* not successful? Then it must be a filename */ if (!hardDisk) { CHECK_ERROR(virtualBox, FindHardDisk2(Bstr(hdds[1]), hardDisk.asOutParam())); if (FAILED(rc)) { /* open the new hard disk object */ CHECK_ERROR(virtualBox, OpenHardDisk2(Bstr(hdds[1]), hardDisk.asOutParam())); } } if (hardDisk) { hardDisk->COMGETTER(Id)(uuid.asOutParam()); CHECK_ERROR(machine, AttachHardDisk2(uuid, StorageBus_IDE, 0, 1)); } else rc = E_FAIL; if (FAILED(rc)) break; } } if (hdds[2]) { if (strcmp(hdds[2], "none") == 0) { machine->DetachHardDisk2(StorageBus_IDE, 1, 1); } else { /* first guess is that it's a UUID */ Guid uuid(hdds[2]); ComPtr hardDisk; rc = virtualBox->GetHardDisk2(uuid, hardDisk.asOutParam()); /* not successful? Then it must be a filename */ if (!hardDisk) { CHECK_ERROR(virtualBox, FindHardDisk2(Bstr(hdds[2]), hardDisk.asOutParam())); if (FAILED(rc)) { /* open the new hard disk object */ CHECK_ERROR(virtualBox, OpenHardDisk2(Bstr(hdds[2]), hardDisk.asOutParam())); } } if (hardDisk) { hardDisk->COMGETTER(Id)(uuid.asOutParam()); CHECK_ERROR(machine, AttachHardDisk2(uuid, StorageBus_IDE, 1, 1)); } else rc = E_FAIL; if (FAILED(rc)) break; } } if (dvd) { ComPtr dvdDrive; machine->COMGETTER(DVDDrive)(dvdDrive.asOutParam()); ASSERT(dvdDrive); /* unmount? */ if (strcmp(dvd, "none") == 0) { CHECK_ERROR(dvdDrive, Unmount()); } /* host drive? */ else if (strncmp(dvd, "host:", 5) == 0) { ComPtr host; CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam())); ComPtr hostDVDs; CHECK_ERROR(host, COMGETTER(DVDDrives)(hostDVDs.asOutParam())); ComPtr hostDVDDrive; rc = hostDVDs->FindByName(Bstr(dvd + 5), hostDVDDrive.asOutParam()); if (!hostDVDDrive) { /* 2nd try: try with the real name, important on Linux+libhal */ char szPathReal[RTPATH_MAX]; if (RT_FAILURE(RTPathReal(dvd + 5, szPathReal, sizeof(szPathReal)))) { errorArgument("Invalid host DVD drive name"); rc = E_FAIL; break; } rc = hostDVDs->FindByName(Bstr(szPathReal), hostDVDDrive.asOutParam()); if (!hostDVDDrive) { errorArgument("Invalid host DVD drive name"); rc = E_FAIL; break; } } CHECK_ERROR(dvdDrive, CaptureHostDrive(hostDVDDrive)); } else { /* first assume it's a UUID */ Guid uuid(dvd); ComPtr dvdImage; rc = virtualBox->GetDVDImage(uuid, dvdImage.asOutParam()); if (FAILED(rc) || !dvdImage) { /* must be a filename, check if it's in the collection */ rc = virtualBox->FindDVDImage(Bstr(dvd), dvdImage.asOutParam()); /* not registered, do that on the fly */ if (!dvdImage) { Guid emptyUUID; CHECK_ERROR(virtualBox, OpenDVDImage(Bstr(dvd), emptyUUID, dvdImage.asOutParam())); } } if (!dvdImage) { rc = E_FAIL; break; } dvdImage->COMGETTER(Id)(uuid.asOutParam()); CHECK_ERROR(dvdDrive, MountImage(uuid)); } } if (dvdpassthrough) { ComPtr dvdDrive; machine->COMGETTER(DVDDrive)(dvdDrive.asOutParam()); ASSERT(dvdDrive); CHECK_ERROR(dvdDrive, COMSETTER(Passthrough)(strcmp(dvdpassthrough, "on") == 0)); } if (idecontroller) { if (RTStrICmp(idecontroller, "PIIX3") == 0) { CHECK_ERROR(biosSettings, COMSETTER(IDEControllerType)(IDEControllerType_PIIX3)); } else if (RTStrICmp(idecontroller, "PIIX4") == 0) { CHECK_ERROR(biosSettings, COMSETTER(IDEControllerType)(IDEControllerType_PIIX4)); } else { errorArgument("Invalid -idecontroller argument '%s'", idecontroller); rc = E_FAIL; break; } } if (floppy) { ComPtr floppyDrive; machine->COMGETTER(FloppyDrive)(floppyDrive.asOutParam()); ASSERT(floppyDrive); /* disable? */ if (strcmp(floppy, "disabled") == 0) { /* disable the controller */ CHECK_ERROR(floppyDrive, COMSETTER(Enabled)(false)); } else { /* enable the controller */ CHECK_ERROR(floppyDrive, COMSETTER(Enabled)(true)); /* unmount? */ if (strcmp(floppy, "empty") == 0) { CHECK_ERROR(floppyDrive, Unmount()); } /* host drive? */ else if (strncmp(floppy, "host:", 5) == 0) { ComPtr host; CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam())); ComPtr hostFloppies; CHECK_ERROR(host, COMGETTER(FloppyDrives)(hostFloppies.asOutParam())); ComPtr hostFloppyDrive; rc = hostFloppies->FindByName(Bstr(floppy + 5), hostFloppyDrive.asOutParam()); if (!hostFloppyDrive) { errorArgument("Invalid host floppy drive name"); rc = E_FAIL; break; } CHECK_ERROR(floppyDrive, CaptureHostDrive(hostFloppyDrive)); } else { /* first assume it's a UUID */ Guid uuid(floppy); ComPtr floppyImage; rc = virtualBox->GetFloppyImage(uuid, floppyImage.asOutParam()); if (FAILED(rc) || !floppyImage) { /* must be a filename, check if it's in the collection */ rc = virtualBox->FindFloppyImage(Bstr(floppy), floppyImage.asOutParam()); /* not registered, do that on the fly */ if (!floppyImage) { Guid emptyUUID; CHECK_ERROR(virtualBox, OpenFloppyImage(Bstr(floppy), emptyUUID, floppyImage.asOutParam())); } } if (!floppyImage) { rc = E_FAIL; break; } floppyImage->COMGETTER(Id)(uuid.asOutParam()); CHECK_ERROR(floppyDrive, MountImage(uuid)); } } } if (audio || audiocontroller) { ComPtr audioAdapter; machine->COMGETTER(AudioAdapter)(audioAdapter.asOutParam()); ASSERT(audioAdapter); if (audio) { /* disable? */ if (strcmp(audio, "none") == 0) { CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(false)); } else if (strcmp(audio, "null") == 0) { CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_Null)); CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true)); } #ifdef RT_OS_WINDOWS #ifdef VBOX_WITH_WINMM else if (strcmp(audio, "winmm") == 0) { CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_WinMM)); CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true)); } #endif else if (strcmp(audio, "dsound") == 0) { CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_DirectSound)); CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true)); } #endif /* RT_OS_WINDOWS */ #ifdef RT_OS_LINUX else if (strcmp(audio, "oss") == 0) { CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_OSS)); CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true)); } # ifdef VBOX_WITH_ALSA else if (strcmp(audio, "alsa") == 0) { CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_ALSA)); CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true)); } # endif # ifdef VBOX_WITH_PULSE else if (strcmp(audio, "pulse") == 0) { CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_Pulse)); CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true)); } # endif #endif /* !RT_OS_LINUX */ #ifdef RT_OS_SOLARIS else if (strcmp(audio, "solaudio") == 0) { CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_SolAudio)); CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true)); } #endif /* !RT_OS_SOLARIS */ #ifdef RT_OS_DARWIN else if (strcmp(audio, "coreaudio") == 0) { CHECK_ERROR(audioAdapter, COMSETTER(AudioDriver)(AudioDriverType_CoreAudio)); CHECK_ERROR(audioAdapter, COMSETTER(Enabled)(true)); } #endif /* !RT_OS_DARWIN */ else { errorArgument("Invalid -audio argument '%s'", audio); rc = E_FAIL; break; } } if (audiocontroller) { if (strcmp(audiocontroller, "sb16") == 0) CHECK_ERROR(audioAdapter, COMSETTER(AudioController)(AudioControllerType_SB16)); else if (strcmp(audiocontroller, "ac97") == 0) CHECK_ERROR(audioAdapter, COMSETTER(AudioController)(AudioControllerType_AC97)); else { errorArgument("Invalid -audiocontroller argument '%s'", audiocontroller); rc = E_FAIL; break; } } } /* Shared clipboard state */ if (clipboard) { /* ComPtr clipboardMode; machine->COMGETTER(ClipboardMode)(clipboardMode.asOutParam()); ASSERT(clipboardMode); */ if (strcmp(clipboard, "disabled") == 0) { CHECK_ERROR(machine, COMSETTER(ClipboardMode)(ClipboardMode_Disabled)); } else if (strcmp(clipboard, "hosttoguest") == 0) { CHECK_ERROR(machine, COMSETTER(ClipboardMode)(ClipboardMode_HostToGuest)); } else if (strcmp(clipboard, "guesttohost") == 0) { CHECK_ERROR(machine, COMSETTER(ClipboardMode)(ClipboardMode_GuestToHost)); } else if (strcmp(clipboard, "bidirectional") == 0) { CHECK_ERROR(machine, COMSETTER(ClipboardMode)(ClipboardMode_Bidirectional)); } else { errorArgument("Invalid -clipboard argument '%s'", clipboard); rc = E_FAIL; break; } } /* iterate through all possible NICs */ for (ULONG n = 0; n < NetworkAdapterCount; n ++) { ComPtr nic; CHECK_ERROR_RET (machine, GetNetworkAdapter (n, nic.asOutParam()), 1); ASSERT(nic); /* something about the NIC? */ if (nics[n]) { if (strcmp(nics[n], "none") == 0) { CHECK_ERROR_RET(nic, COMSETTER(Enabled) (FALSE), 1); } else if (strcmp(nics[n], "null") == 0) { CHECK_ERROR_RET(nic, COMSETTER(Enabled) (TRUE), 1); CHECK_ERROR_RET(nic, Detach(), 1); } else if (strcmp(nics[n], "nat") == 0) { CHECK_ERROR_RET(nic, COMSETTER(Enabled) (TRUE), 1); CHECK_ERROR_RET(nic, AttachToNAT(), 1); } else if (strcmp(nics[n], "hostif") == 0) { CHECK_ERROR_RET(nic, COMSETTER(Enabled) (TRUE), 1); CHECK_ERROR_RET(nic, AttachToHostInterface(), 1); } else if (strcmp(nics[n], "intnet") == 0) { CHECK_ERROR_RET(nic, COMSETTER(Enabled) (TRUE), 1); CHECK_ERROR_RET(nic, AttachToInternalNetwork(), 1); } else { errorArgument("Invalid type '%s' specfied for NIC %lu", nics[n], n + 1); rc = E_FAIL; break; } } /* something about the NIC type? */ if (nictype[n]) { if (strcmp(nictype[n], "Am79C970A") == 0) { CHECK_ERROR_RET(nic, COMSETTER(AdapterType)(NetworkAdapterType_Am79C970A), 1); } else if (strcmp(nictype[n], "Am79C973") == 0) { CHECK_ERROR_RET(nic, COMSETTER(AdapterType)(NetworkAdapterType_Am79C973), 1); } #ifdef VBOX_WITH_E1000 else if (strcmp(nictype[n], "82540EM") == 0) { CHECK_ERROR_RET(nic, COMSETTER(AdapterType)(NetworkAdapterType_I82540EM), 1); } else if (strcmp(nictype[n], "82543GC") == 0) { CHECK_ERROR_RET(nic, COMSETTER(AdapterType)(NetworkAdapterType_I82543GC), 1); } #endif else { errorArgument("Invalid NIC type '%s' specified for NIC %lu", nictype[n], n + 1); rc = E_FAIL; break; } } /* something about the MAC address? */ if (macs[n]) { /* generate one? */ if (strcmp(macs[n], "auto") == 0) { CHECK_ERROR_RET(nic, COMSETTER(MACAddress)(NULL), 1); } else { CHECK_ERROR_RET(nic, COMSETTER(MACAddress)(Bstr(macs[n])), 1); } } /* something about the reported link speed? */ if (nicspeed[n]) { uint32_t u32LineSpeed; u32LineSpeed = atoi(nicspeed[n]); if (u32LineSpeed < 1000 || u32LineSpeed > 4000000) { errorArgument("Invalid -nicspeed%lu argument '%s'", n + 1, nicspeed[n]); rc = E_FAIL; break; } CHECK_ERROR_RET(nic, COMSETTER(LineSpeed)(u32LineSpeed), 1); } /* the link status flag? */ if (cableconnected[n]) { if (strcmp(cableconnected[n], "on") == 0) { CHECK_ERROR_RET(nic, COMSETTER(CableConnected)(TRUE), 1); } else if (strcmp(cableconnected[n], "off") == 0) { CHECK_ERROR_RET(nic, COMSETTER(CableConnected)(FALSE), 1); } else { errorArgument("Invalid -cableconnected%lu argument '%s'", n + 1, cableconnected[n]); rc = E_FAIL; break; } } /* the trace flag? */ if (nictrace[n]) { if (strcmp(nictrace[n], "on") == 0) { CHECK_ERROR_RET(nic, COMSETTER(TraceEnabled)(TRUE), 1); } else if (strcmp(nictrace[n], "off") == 0) { CHECK_ERROR_RET(nic, COMSETTER(TraceEnabled)(FALSE), 1); } else { errorArgument("Invalid -nictrace%lu argument '%s'", n + 1, nictrace[n]); rc = E_FAIL; break; } } /* the tracefile flag? */ if (nictracefile[n]) { CHECK_ERROR_RET(nic, COMSETTER(TraceFile)(Bstr(nictracefile[n])), 1); } /* the host interface device? */ if (hostifdev[n]) { /* remove it? */ if (strcmp(hostifdev[n], "none") == 0) { CHECK_ERROR_RET(nic, COMSETTER(HostInterface)(NULL), 1); } else { CHECK_ERROR_RET(nic, COMSETTER(HostInterface)(Bstr(hostifdev[n])), 1); } } /* the internal network name? */ if (intnet[n]) { /* remove it? */ if (strcmp(intnet[n], "none") == 0) { CHECK_ERROR_RET(nic, COMSETTER(InternalNetwork)(NULL), 1); } else { CHECK_ERROR_RET(nic, COMSETTER(InternalNetwork)(Bstr(intnet[n])), 1); } } /* the network of the NAT */ if (natnet[n]) { CHECK_ERROR_RET(nic, COMSETTER(NATNetwork)(Bstr(natnet[n])), 1); } #ifdef RT_OS_LINUX /* the TAP setup application? */ if (tapsetup[n]) { /* remove it? */ if (strcmp(tapsetup[n], "none") == 0) { CHECK_ERROR_RET(nic, COMSETTER(TAPSetupApplication)(NULL), 1); } else { CHECK_ERROR_RET(nic, COMSETTER(TAPSetupApplication)(Bstr(tapsetup[n])), 1); } } /* the TAP terminate application? */ if (tapterm[n]) { /* remove it? */ if (strcmp(tapterm[n], "none") == 0) { CHECK_ERROR_RET(nic, COMSETTER(TAPTerminateApplication)(NULL), 1); } else { CHECK_ERROR_RET(nic, COMSETTER(TAPTerminateApplication)(Bstr(tapterm[n])), 1); } } #endif /* RT_OS_LINUX */ } if (FAILED(rc)) break; /* iterate through all possible serial ports */ for (ULONG n = 0; n < SerialPortCount; n ++) { ComPtr uart; CHECK_ERROR_RET (machine, GetSerialPort (n, uart.asOutParam()), 1); ASSERT(uart); if (uarts_base[n]) { if (uarts_base[n] == (ULONG)-1) { CHECK_ERROR_RET(uart, COMSETTER(Enabled) (FALSE), 1); } else { CHECK_ERROR_RET(uart, COMSETTER(IOBase) (uarts_base[n]), 1); CHECK_ERROR_RET(uart, COMSETTER(IRQ) (uarts_irq[n]), 1); CHECK_ERROR_RET(uart, COMSETTER(Enabled) (TRUE), 1); } } if (uarts_mode[n]) { if (strcmp(uarts_mode[n], "disconnected") == 0) { CHECK_ERROR_RET(uart, COMSETTER(HostMode) (PortMode_Disconnected), 1); } else { if (strcmp(uarts_mode[n], "server") == 0) { CHECK_ERROR_RET(uart, COMSETTER(HostMode) (PortMode_HostPipe), 1); CHECK_ERROR_RET(uart, COMSETTER(Server) (TRUE), 1); } else if (strcmp(uarts_mode[n], "client") == 0) { CHECK_ERROR_RET(uart, COMSETTER(HostMode) (PortMode_HostPipe), 1); CHECK_ERROR_RET(uart, COMSETTER(Server) (FALSE), 1); } else { CHECK_ERROR_RET(uart, COMSETTER(HostMode) (PortMode_HostDevice), 1); } CHECK_ERROR_RET(uart, COMSETTER(Path) (Bstr(uarts_path[n])), 1); } } } if (FAILED(rc)) break; #ifdef VBOX_WITH_VRDP if (vrdp || (vrdpport != UINT16_MAX) || vrdpaddress || vrdpauthtype || vrdpmulticon || vrdpreusecon) { ComPtr vrdpServer; machine->COMGETTER(VRDPServer)(vrdpServer.asOutParam()); ASSERT(vrdpServer); if (vrdpServer) { if (vrdp) { if (strcmp(vrdp, "on") == 0) { CHECK_ERROR(vrdpServer, COMSETTER(Enabled)(true)); } else if (strcmp(vrdp, "off") == 0) { CHECK_ERROR(vrdpServer, COMSETTER(Enabled)(false)); } else { errorArgument("Invalid -vrdp argument '%s'", vrdp); rc = E_FAIL; break; } } if (vrdpport != UINT16_MAX) { CHECK_ERROR(vrdpServer, COMSETTER(Port)(vrdpport)); } if (vrdpaddress) { CHECK_ERROR(vrdpServer, COMSETTER(NetAddress)(Bstr(vrdpaddress))); } if (vrdpauthtype) { if (strcmp(vrdpauthtype, "null") == 0) { CHECK_ERROR(vrdpServer, COMSETTER(AuthType)(VRDPAuthType_Null)); } else if (strcmp(vrdpauthtype, "external") == 0) { CHECK_ERROR(vrdpServer, COMSETTER(AuthType)(VRDPAuthType_External)); } else if (strcmp(vrdpauthtype, "guest") == 0) { CHECK_ERROR(vrdpServer, COMSETTER(AuthType)(VRDPAuthType_Guest)); } else { errorArgument("Invalid -vrdpauthtype argument '%s'", vrdpauthtype); rc = E_FAIL; break; } } if (vrdpmulticon) { if (strcmp(vrdpmulticon, "on") == 0) { CHECK_ERROR(vrdpServer, COMSETTER(AllowMultiConnection)(true)); } else if (strcmp(vrdpmulticon, "off") == 0) { CHECK_ERROR(vrdpServer, COMSETTER(AllowMultiConnection)(false)); } else { errorArgument("Invalid -vrdpmulticon argument '%s'", vrdpmulticon); rc = E_FAIL; break; } } if (vrdpreusecon) { if (strcmp(vrdpreusecon, "on") == 0) { CHECK_ERROR(vrdpServer, COMSETTER(ReuseSingleConnection)(true)); } else if (strcmp(vrdpreusecon, "off") == 0) { CHECK_ERROR(vrdpServer, COMSETTER(ReuseSingleConnection)(false)); } else { errorArgument("Invalid -vrdpreusecon argument '%s'", vrdpreusecon); rc = E_FAIL; break; } } } } #endif /* VBOX_WITH_VRDP */ /* * USB enable/disable */ if (fUsbEnabled != -1) { ComPtr UsbCtl; CHECK_ERROR(machine, COMGETTER(USBController)(UsbCtl.asOutParam())); if (SUCCEEDED(rc)) { CHECK_ERROR(UsbCtl, COMSETTER(Enabled)(!!fUsbEnabled)); } } /* * USB EHCI enable/disable */ if (fUsbEhciEnabled != -1) { ComPtr UsbCtl; CHECK_ERROR(machine, COMGETTER(USBController)(UsbCtl.asOutParam())); if (SUCCEEDED(rc)) { CHECK_ERROR(UsbCtl, COMSETTER(EnabledEhci)(!!fUsbEhciEnabled)); } } if (snapshotFolder) { if (strcmp(snapshotFolder, "default") == 0) { CHECK_ERROR(machine, COMSETTER(SnapshotFolder)(NULL)); } else { CHECK_ERROR(machine, COMSETTER(SnapshotFolder)(Bstr(snapshotFolder))); } } if (guestMemBalloonSize != (ULONG)-1) CHECK_ERROR(machine, COMSETTER(MemoryBalloonSize)(guestMemBalloonSize)); if (guestStatInterval != (ULONG)-1) CHECK_ERROR(machine, COMSETTER(StatisticsUpdateInterval)(guestStatInterval)); /* * SATA controller enable/disable */ if (fSataEnabled != -1) { ComPtr SataCtl; CHECK_ERROR(machine, COMGETTER(SATAController)(SataCtl.asOutParam())); if (SUCCEEDED(rc)) { CHECK_ERROR(SataCtl, COMSETTER(Enabled)(!!fSataEnabled)); } } for (uint32_t i = 4; i < 34; i++) { if (hdds[i]) { if (strcmp(hdds[i], "none") == 0) { machine->DetachHardDisk2(StorageBus_SATA, i-4, 0); } else { /* first guess is that it's a UUID */ Guid uuid(hdds[i]); ComPtr hardDisk; rc = virtualBox->GetHardDisk2(uuid, hardDisk.asOutParam()); /* not successful? Then it must be a filename */ if (!hardDisk) { CHECK_ERROR(virtualBox, FindHardDisk2(Bstr(hdds[i]), hardDisk.asOutParam())); if (FAILED(rc)) { /* open the new hard disk object */ CHECK_ERROR(virtualBox, OpenHardDisk2(Bstr(hdds[i]), hardDisk.asOutParam())); } } if (hardDisk) { hardDisk->COMGETTER(Id)(uuid.asOutParam()); CHECK_ERROR(machine, AttachHardDisk2(uuid, StorageBus_SATA, i-4, 0)); } else rc = E_FAIL; if (FAILED(rc)) break; } } } for (uint32_t i = 0; i < 4; i++) { if (sataBootDevices[i] != -1) { ComPtr SataCtl; CHECK_ERROR(machine, COMGETTER(SATAController)(SataCtl.asOutParam())); if (SUCCEEDED(rc)) { CHECK_ERROR(SataCtl, SetIDEEmulationPort(i, sataBootDevices[i])); } } } if (sataPortCount != -1) { ComPtr SataCtl; CHECK_ERROR(machine, COMGETTER(SATAController)(SataCtl.asOutParam())); if (SUCCEEDED(rc)) { CHECK_ERROR(SataCtl, COMSETTER(PortCount)(sataPortCount)); } } /* commit changes */ CHECK_ERROR(machine, SaveSettings()); } while (0); /* it's important to always close sessions */ session->Close(); return SUCCEEDED(rc) ? 0 : 1; } static int handleStartVM(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; if (argc < 1) return errorSyntax(USAGE_STARTVM, "Not enough parameters"); ComPtr machine; /* assume it's a UUID */ rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam()); if (FAILED(rc) || !machine) { /* must be a name */ CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam())); } if (machine) { Guid uuid; machine->COMGETTER(Id)(uuid.asOutParam()); /* default to GUI session type */ Bstr sessionType = "gui"; /* has a session type been specified? */ if ((argc > 2) && (strcmp(argv[1], "-type") == 0)) { if (strcmp(argv[2], "gui") == 0) { sessionType = "gui"; } else if (strcmp(argv[2], "vrdp") == 0) { sessionType = "vrdp"; } else if (strcmp(argv[2], "capture") == 0) { sessionType = "capture"; } else return errorArgument("Invalid session type argument '%s'", argv[2]); } Bstr env; #ifdef RT_OS_LINUX /* make sure the VM process will start on the same display as VBoxManage */ { const char *display = RTEnvGet ("DISPLAY"); if (display) env = Utf8StrFmt ("DISPLAY=%s", display); } #endif ComPtr progress; CHECK_ERROR_RET(virtualBox, OpenRemoteSession(session, uuid, sessionType, env, progress.asOutParam()), rc); RTPrintf("Waiting for the remote session to open...\n"); CHECK_ERROR_RET(progress, WaitForCompletion (-1), 1); BOOL completed; CHECK_ERROR_RET(progress, COMGETTER(Completed)(&completed), rc); ASSERT(completed); HRESULT resultCode; CHECK_ERROR_RET(progress, COMGETTER(ResultCode)(&resultCode), rc); if (FAILED(resultCode)) { ComPtr errorInfo; CHECK_ERROR_RET(progress, COMGETTER(ErrorInfo)(errorInfo.asOutParam()), 1); ErrorInfo info (errorInfo); PRINT_ERROR_INFO(info); } else { RTPrintf("Remote session has been successfully opened.\n"); } } /* it's important to always close sessions */ session->Close(); return SUCCEEDED(rc) ? 0 : 1; } static int handleControlVM(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; if (argc < 2) return errorSyntax(USAGE_CONTROLVM, "Not enough parameters"); /* try to find the given machine */ ComPtr machine; Guid uuid (argv[0]); if (!uuid.isEmpty()) { CHECK_ERROR (virtualBox, GetMachine (uuid, machine.asOutParam())); } else { CHECK_ERROR (virtualBox, FindMachine (Bstr(argv[0]), machine.asOutParam())); if (SUCCEEDED (rc)) machine->COMGETTER(Id) (uuid.asOutParam()); } if (FAILED (rc)) return 1; /* open a session for the VM */ CHECK_ERROR_RET (virtualBox, OpenExistingSession (session, uuid), 1); do { /* get the associated console */ ComPtr console; CHECK_ERROR_BREAK (session, COMGETTER(Console)(console.asOutParam())); /* ... and session machine */ ComPtr sessionMachine; CHECK_ERROR_BREAK (session, COMGETTER(Machine)(sessionMachine.asOutParam())); /* which command? */ if (strcmp(argv[1], "pause") == 0) { CHECK_ERROR_BREAK (console, Pause()); } else if (strcmp(argv[1], "resume") == 0) { CHECK_ERROR_BREAK (console, Resume()); } else if (strcmp(argv[1], "reset") == 0) { CHECK_ERROR_BREAK (console, Reset()); } else if (strcmp(argv[1], "poweroff") == 0) { CHECK_ERROR_BREAK (console, PowerDown()); } else if (strcmp(argv[1], "savestate") == 0) { ComPtr progress; CHECK_ERROR_BREAK (console, SaveState(progress.asOutParam())); showProgress(progress); progress->COMGETTER(ResultCode)(&rc); if (FAILED(rc)) { com::ProgressErrorInfo info(progress); if (info.isBasicAvailable()) { RTPrintf("Error: failed to save machine state. Error message: %lS\n", info.getText().raw()); } else { RTPrintf("Error: failed to save machine state. No error message available!\n"); } } } else if (strcmp(argv[1], "acpipowerbutton") == 0) { CHECK_ERROR_BREAK (console, PowerButton()); } else if (strcmp(argv[1], "acpisleepbutton") == 0) { CHECK_ERROR_BREAK (console, SleepButton()); } else if (strcmp(argv[1], "keyboardputscancode") == 0) { ComPtr keyboard; CHECK_ERROR_BREAK(console, COMGETTER(Keyboard)(keyboard.asOutParam())); if (argc <= 1 + 1) { errorArgument("Missing argument to '%s'. Expected IBM PC AT set 2 keyboard scancode(s) as hex byte(s).", argv[1]); rc = E_FAIL; break; } /* Arbitrary restrict the length of a sequence of scancodes to 1024. */ LONG alScancodes[1024]; int cScancodes = 0; /* Process the command line. */ int i; for (i = 1 + 1; i < argc && cScancodes < (int)RT_ELEMENTS(alScancodes); i++, cScancodes++) { if ( isxdigit (argv[i][0]) && isxdigit (argv[i][1]) && argv[i][2] == 0) { uint8_t u8Scancode; int rc = RTStrToUInt8Ex(argv[i], NULL, 16, &u8Scancode); if (RT_FAILURE (rc)) { RTPrintf("Error: converting '%s' returned %Vrc!\n", argv[i], rc); rc = E_FAIL; break; } alScancodes[cScancodes] = u8Scancode; } else { RTPrintf("Error: '%s' is not a hex byte!\n", argv[i]); rc = E_FAIL; break; } } if (FAILED(rc)) break; if ( cScancodes == RT_ELEMENTS(alScancodes) && i < argc) { RTPrintf("Error: too many scancodes, maximum %d allowed!\n", RT_ELEMENTS(alScancodes)); rc = E_FAIL; break; } /* Send scancodes to the VM. * Note: 'PutScancodes' did not work here. Only the first scancode was transmitted. */ for (i = 0; i < cScancodes; i++) { CHECK_ERROR_BREAK(keyboard, PutScancode(alScancodes[i])); RTPrintf("Scancode[%d]: 0x%02X\n", i, alScancodes[i]); } } else if (strncmp(argv[1], "setlinkstate", 12) == 0) { /* Get the number of network adapters */ ULONG NetworkAdapterCount = 0; ComPtr info; CHECK_ERROR_BREAK (virtualBox, COMGETTER(SystemProperties) (info.asOutParam())); CHECK_ERROR_BREAK (info, COMGETTER(NetworkAdapterCount) (&NetworkAdapterCount)); unsigned n = parseNum(&argv[1][12], NetworkAdapterCount, "NIC"); if (!n) { rc = E_FAIL; break; } if (argc <= 1 + 1) { errorArgument("Missing argument to '%s'", argv[1]); rc = E_FAIL; break; } /* get the corresponding network adapter */ ComPtr adapter; CHECK_ERROR_BREAK (sessionMachine, GetNetworkAdapter(n - 1, adapter.asOutParam())); if (adapter) { if (strcmp(argv[2], "on") == 0) { CHECK_ERROR_BREAK (adapter, COMSETTER(CableConnected)(TRUE)); } else if (strcmp(argv[2], "off") == 0) { CHECK_ERROR_BREAK (adapter, COMSETTER(CableConnected)(FALSE)); } else { errorArgument("Invalid link state '%s'", Utf8Str(argv[2]).raw()); rc = E_FAIL; break; } } } else if (strcmp (argv[1], "usbattach") == 0 || strcmp (argv[1], "usbdetach") == 0) { if (argc < 3) { errorSyntax(USAGE_CONTROLVM, "Not enough parameters"); rc = E_FAIL; break; } bool attach = strcmp (argv[1], "usbattach") == 0; Guid usbId = argv [2]; if (usbId.isEmpty()) { // assume address if (attach) { ComPtr host; CHECK_ERROR_BREAK (virtualBox, COMGETTER(Host) (host.asOutParam())); ComPtr coll; CHECK_ERROR_BREAK (host, COMGETTER(USBDevices) (coll.asOutParam())); ComPtr dev; CHECK_ERROR_BREAK (coll, FindByAddress (Bstr (argv [2]), dev.asOutParam())); CHECK_ERROR_BREAK (dev, COMGETTER(Id) (usbId.asOutParam())); } else { ComPtr coll; CHECK_ERROR_BREAK (console, COMGETTER(USBDevices)(coll.asOutParam())); ComPtr dev; CHECK_ERROR_BREAK (coll, FindByAddress (Bstr (argv [2]), dev.asOutParam())); CHECK_ERROR_BREAK (dev, COMGETTER(Id) (usbId.asOutParam())); } } if (attach) CHECK_ERROR_BREAK (console, AttachUSBDevice (usbId)); else { ComPtr dev; CHECK_ERROR_BREAK (console, DetachUSBDevice (usbId, dev.asOutParam())); } } else if (strcmp(argv[1], "setvideomodehint") == 0) { if (argc != 5 && argc != 6) { errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters"); rc = E_FAIL; break; } uint32_t xres = atoi(argv[2]); uint32_t yres = atoi(argv[3]); uint32_t bpp = atoi(argv[4]); uint32_t displayIdx = 0; if (argc == 6) displayIdx = atoi(argv[5]); ComPtr display; CHECK_ERROR_BREAK(console, COMGETTER(Display)(display.asOutParam())); CHECK_ERROR_BREAK(display, SetVideoModeHint(xres, yres, bpp, displayIdx)); } else if (strcmp(argv[1], "setcredentials") == 0) { bool fAllowLocalLogon = true; if (argc == 7) { if (strcmp(argv[5], "-allowlocallogon") != 0) { errorArgument("Invalid parameter '%s'", argv[5]); rc = E_FAIL; break; } if (strcmp(argv[6], "no") == 0) fAllowLocalLogon = false; } else if (argc != 5) { errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters"); rc = E_FAIL; break; } ComPtr guest; CHECK_ERROR_BREAK(console, COMGETTER(Guest)(guest.asOutParam())); CHECK_ERROR_BREAK(guest, SetCredentials(Bstr(argv[2]), Bstr(argv[3]), Bstr(argv[4]), fAllowLocalLogon)); } else if (strcmp(argv[1], "dvdattach") == 0) { if (argc != 3) { errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters"); rc = E_FAIL; break; } ComPtr dvdDrive; sessionMachine->COMGETTER(DVDDrive)(dvdDrive.asOutParam()); ASSERT(dvdDrive); /* unmount? */ if (strcmp(argv[2], "none") == 0) { CHECK_ERROR(dvdDrive, Unmount()); } /* host drive? */ else if (strncmp(argv[2], "host:", 5) == 0) { ComPtr host; CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam())); ComPtr hostDVDs; CHECK_ERROR(host, COMGETTER(DVDDrives)(hostDVDs.asOutParam())); ComPtr hostDVDDrive; rc = hostDVDs->FindByName(Bstr(argv[2] + 5), hostDVDDrive.asOutParam()); if (!hostDVDDrive) { errorArgument("Invalid host DVD drive name"); rc = E_FAIL; break; } CHECK_ERROR(dvdDrive, CaptureHostDrive(hostDVDDrive)); } else { /* first assume it's a UUID */ Guid uuid(argv[2]); ComPtr dvdImage; rc = virtualBox->GetDVDImage(uuid, dvdImage.asOutParam()); if (FAILED(rc) || !dvdImage) { /* must be a filename, check if it's in the collection */ rc = virtualBox->FindDVDImage(Bstr(argv[2]), dvdImage.asOutParam()); /* not registered, do that on the fly */ if (!dvdImage) { Guid emptyUUID; CHECK_ERROR(virtualBox, OpenDVDImage(Bstr(argv[2]), emptyUUID, dvdImage.asOutParam())); } } if (!dvdImage) { rc = E_FAIL; break; } dvdImage->COMGETTER(Id)(uuid.asOutParam()); CHECK_ERROR(dvdDrive, MountImage(uuid)); } } else if (strcmp(argv[1], "floppyattach") == 0) { if (argc != 3) { errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters"); rc = E_FAIL; break; } ComPtr floppyDrive; sessionMachine->COMGETTER(FloppyDrive)(floppyDrive.asOutParam()); ASSERT(floppyDrive); /* unmount? */ if (strcmp(argv[2], "none") == 0) { CHECK_ERROR(floppyDrive, Unmount()); } /* host drive? */ else if (strncmp(argv[2], "host:", 5) == 0) { ComPtr host; CHECK_ERROR(virtualBox, COMGETTER(Host)(host.asOutParam())); ComPtr hostFloppies; CHECK_ERROR(host, COMGETTER(FloppyDrives)(hostFloppies.asOutParam())); ComPtr hostFloppyDrive; rc = hostFloppies->FindByName(Bstr(argv[2] + 5), hostFloppyDrive.asOutParam()); if (!hostFloppyDrive) { errorArgument("Invalid host floppy drive name"); rc = E_FAIL; break; } CHECK_ERROR(floppyDrive, CaptureHostDrive(hostFloppyDrive)); } else { /* first assume it's a UUID */ Guid uuid(argv[2]); ComPtr floppyImage; rc = virtualBox->GetFloppyImage(uuid, floppyImage.asOutParam()); if (FAILED(rc) || !floppyImage) { /* must be a filename, check if it's in the collection */ rc = virtualBox->FindFloppyImage(Bstr(argv[2]), floppyImage.asOutParam()); /* not registered, do that on the fly */ if (!floppyImage) { Guid emptyUUID; CHECK_ERROR(virtualBox, OpenFloppyImage(Bstr(argv[2]), emptyUUID, floppyImage.asOutParam())); } } if (!floppyImage) { rc = E_FAIL; break; } floppyImage->COMGETTER(Id)(uuid.asOutParam()); CHECK_ERROR(floppyDrive, MountImage(uuid)); } } #ifdef VBOX_WITH_MEM_BALLOONING else if (strncmp(argv[1], "-guestmemoryballoon", 19) == 0) { if (argc != 3) { errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters"); rc = E_FAIL; break; } uint32_t uVal; int vrc; vrc = RTStrToUInt32Ex(argv[2], NULL, 0, &uVal); if (vrc != VINF_SUCCESS) { errorArgument("Error parsing guest memory balloon size '%s'", argv[2]); rc = E_FAIL; break; } /* guest is running; update IGuest */ ComPtr guest; rc = console->COMGETTER(Guest)(guest.asOutParam()); if (SUCCEEDED(rc)) CHECK_ERROR(guest, COMSETTER(MemoryBalloonSize)(uVal)); } #endif else if (strncmp(argv[1], "-gueststatisticsinterval", 24) == 0) { if (argc != 3) { errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters"); rc = E_FAIL; break; } uint32_t uVal; int vrc; vrc = RTStrToUInt32Ex(argv[2], NULL, 0, &uVal); if (vrc != VINF_SUCCESS) { errorArgument("Error parsing guest statistics interval '%s'", argv[2]); rc = E_FAIL; break; } /* guest is running; update IGuest */ ComPtr guest; rc = console->COMGETTER(Guest)(guest.asOutParam()); if (SUCCEEDED(rc)) CHECK_ERROR(guest, COMSETTER(StatisticsUpdateInterval)(uVal)); } else { errorSyntax(USAGE_CONTROLVM, "Invalid parameter '%s'", Utf8Str(argv[1]).raw()); rc = E_FAIL; } } while (0); session->Close(); return SUCCEEDED (rc) ? 0 : 1; } static int handleDiscardState(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; if (argc != 1) return errorSyntax(USAGE_DISCARDSTATE, "Incorrect number of parameters"); ComPtr machine; /* assume it's a UUID */ rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam()); if (FAILED(rc) || !machine) { /* must be a name */ CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam())); } if (machine) { do { /* we have to open a session for this task */ Guid guid; machine->COMGETTER(Id)(guid.asOutParam()); CHECK_ERROR_BREAK(virtualBox, OpenSession(session, guid)); do { ComPtr console; CHECK_ERROR_BREAK(session, COMGETTER(Console)(console.asOutParam())); CHECK_ERROR_BREAK(console, DiscardSavedState()); } while (0); CHECK_ERROR_BREAK(session, Close()); } while (0); } return SUCCEEDED(rc) ? 0 : 1; } static int handleAdoptdState(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; if (argc != 2) return errorSyntax(USAGE_ADOPTSTATE, "Incorrect number of parameters"); ComPtr machine; /* assume it's a UUID */ rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam()); if (FAILED(rc) || !machine) { /* must be a name */ CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam())); } if (machine) { do { /* we have to open a session for this task */ Guid guid; machine->COMGETTER(Id)(guid.asOutParam()); CHECK_ERROR_BREAK(virtualBox, OpenSession(session, guid)); do { ComPtr console; CHECK_ERROR_BREAK(session, COMGETTER(Console)(console.asOutParam())); CHECK_ERROR_BREAK(console, AdoptSavedState (Bstr (argv[1]))); } while (0); CHECK_ERROR_BREAK(session, Close()); } while (0); } return SUCCEEDED(rc) ? 0 : 1; } static int handleSnapshot(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; /* we need at least a VM and a command */ if (argc < 2) return errorSyntax(USAGE_SNAPSHOT, "Not enough parameters"); /* the first argument must be the VM */ ComPtr machine; /* assume it's a UUID */ rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam()); if (FAILED(rc) || !machine) { /* must be a name */ CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam())); } if (!machine) return 1; Guid guid; machine->COMGETTER(Id)(guid.asOutParam()); do { /* we have to open a session for this task. First try an existing session */ rc = virtualBox->OpenExistingSession(session, guid); if (FAILED(rc)) CHECK_ERROR_BREAK(virtualBox, OpenSession(session, guid)); ComPtr console; CHECK_ERROR_BREAK(session, COMGETTER(Console)(console.asOutParam())); /* switch based on the command */ if (strcmp(argv[1], "take") == 0) { /* there must be a name */ if (argc < 3) { errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name"); rc = E_FAIL; break; } Bstr name(argv[2]); if ((argc > 3) && ((argc != 5) || (strcmp(argv[3], "-desc") != 0))) { errorSyntax(USAGE_SNAPSHOT, "Incorrect description format"); rc = E_FAIL; break; } Bstr desc; if (argc == 5) desc = argv[4]; ComPtr progress; CHECK_ERROR_BREAK(console, TakeSnapshot(name, desc, progress.asOutParam())); showProgress(progress); progress->COMGETTER(ResultCode)(&rc); if (FAILED(rc)) { com::ProgressErrorInfo info(progress); if (info.isBasicAvailable()) RTPrintf("Error: failed to take snapshot. Error message: %lS\n", info.getText().raw()); else RTPrintf("Error: failed to take snapshot. No error message available!\n"); } } else if (strcmp(argv[1], "discard") == 0) { /* exactly one parameter: snapshot name */ if (argc != 3) { errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only"); rc = E_FAIL; break; } ComPtr snapshot; /* assume it's a UUID */ Guid guid(argv[2]); if (!guid.isEmpty()) { CHECK_ERROR_BREAK(machine, GetSnapshot(guid, snapshot.asOutParam())); } else { /* then it must be a name */ CHECK_ERROR_BREAK(machine, FindSnapshot(Bstr(argv[2]), snapshot.asOutParam())); } snapshot->COMGETTER(Id)(guid.asOutParam()); ComPtr progress; CHECK_ERROR_BREAK(console, DiscardSnapshot(guid, progress.asOutParam())); showProgress(progress); progress->COMGETTER(ResultCode)(&rc); if (FAILED(rc)) { com::ProgressErrorInfo info(progress); if (info.isBasicAvailable()) RTPrintf("Error: failed to discard snapshot. Error message: %lS\n", info.getText().raw()); else RTPrintf("Error: failed to discard snapshot. No error message available!\n"); } } else if (strcmp(argv[1], "discardcurrent") == 0) { if ( (argc != 3) || ( (strcmp(argv[2], "-state") != 0) && (strcmp(argv[2], "-all") != 0))) { errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(argv[2]).raw()); rc = E_FAIL; break; } bool fAll = false; if (strcmp(argv[2], "-all") == 0) fAll = true; ComPtr progress; if (fAll) { CHECK_ERROR_BREAK(console, DiscardCurrentSnapshotAndState(progress.asOutParam())); } else { CHECK_ERROR_BREAK(console, DiscardCurrentState(progress.asOutParam())); } showProgress(progress); progress->COMGETTER(ResultCode)(&rc); if (FAILED(rc)) { com::ProgressErrorInfo info(progress); if (info.isBasicAvailable()) RTPrintf("Error: failed to discard. Error message: %lS\n", info.getText().raw()); else RTPrintf("Error: failed to discard. No error message available!\n"); } } else if (strcmp(argv[1], "edit") == 0) { if (argc < 3) { errorSyntax(USAGE_SNAPSHOT, "Missing snapshot name"); rc = E_FAIL; break; } ComPtr snapshot; if (strcmp(argv[2], "-current") == 0) { CHECK_ERROR_BREAK(machine, COMGETTER(CurrentSnapshot)(snapshot.asOutParam())); } else { /* assume it's a UUID */ Guid guid(argv[2]); if (!guid.isEmpty()) { CHECK_ERROR_BREAK(machine, GetSnapshot(guid, snapshot.asOutParam())); } else { /* then it must be a name */ CHECK_ERROR_BREAK(machine, FindSnapshot(Bstr(argv[2]), snapshot.asOutParam())); } } /* parse options */ for (int i = 3; i < argc; i++) { if (strcmp(argv[i], "-newname") == 0) { if (argc <= i + 1) { errorArgument("Missing argument to '%s'", argv[i]); rc = E_FAIL; break; } i++; snapshot->COMSETTER(Name)(Bstr(argv[i])); } else if (strcmp(argv[i], "-newdesc") == 0) { if (argc <= i + 1) { errorArgument("Missing argument to '%s'", argv[i]); rc = E_FAIL; break; } i++; snapshot->COMSETTER(Description)(Bstr(argv[i])); } else { errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(argv[i]).raw()); rc = E_FAIL; break; } } } else if (strcmp(argv[1], "showvminfo") == 0) { /* exactly one parameter: snapshot name */ if (argc != 3) { errorSyntax(USAGE_SNAPSHOT, "Expecting snapshot name only"); rc = E_FAIL; break; } ComPtr snapshot; /* assume it's a UUID */ Guid guid(argv[2]); if (!guid.isEmpty()) { CHECK_ERROR_BREAK(machine, GetSnapshot(guid, snapshot.asOutParam())); } else { /* then it must be a name */ CHECK_ERROR_BREAK(machine, FindSnapshot(Bstr(argv[2]), snapshot.asOutParam())); } /* get the machine of the given snapshot */ ComPtr machine; snapshot->COMGETTER(Machine)(machine.asOutParam()); showVMInfo(virtualBox, machine, console); } else { errorSyntax(USAGE_SNAPSHOT, "Invalid parameter '%s'", Utf8Str(argv[1]).raw()); rc = E_FAIL; } } while (0); session->Close(); return SUCCEEDED(rc) ? 0 : 1; } static int handleShowHardDiskInfo(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; if (argc != 1) return errorSyntax(USAGE_SHOWHDINFO, "Incorrect number of parameters"); ComPtr hardDisk; Bstr filepath; bool unknown = false; /* first guess is that it's a UUID */ Guid uuid(argv[0]); rc = virtualBox->GetHardDisk2(uuid, hardDisk.asOutParam()); /* no? then it must be a filename */ if (FAILED (rc)) { filepath = argv[0]; rc = virtualBox->FindHardDisk2(filepath, hardDisk.asOutParam()); /* no? well, then it's an unkwnown image */ if (FAILED (rc)) { CHECK_ERROR(virtualBox, OpenHardDisk2(filepath, hardDisk.asOutParam())); if (SUCCEEDED (rc)) { unknown = true; } } } do { if (!SUCCEEDED(rc)) break; hardDisk->COMGETTER(Id)(uuid.asOutParam()); RTPrintf("UUID: %s\n", uuid.toString().raw()); /* check for accessibility */ /// @todo NEWMEDIA check accessibility of all parents /// @todo NEWMEDIA print the full state value MediaState_T state; CHECK_ERROR_BREAK (hardDisk, COMGETTER(State)(&state)); RTPrintf("Accessible: %s\n", state != MediaState_Inaccessible ? "yes" : "no"); if (state == MediaState_Inaccessible) { Bstr err; CHECK_ERROR_BREAK (hardDisk, COMGETTER(LastAccessError)(err.asOutParam())); RTPrintf("Access Error: %lS\n", err.raw()); } Bstr description; hardDisk->COMGETTER(Description)(description.asOutParam()); if (description) { RTPrintf("Description: %lS\n", description.raw()); } ULONG64 logicalSize; hardDisk->COMGETTER(LogicalSize)(&logicalSize); RTPrintf("Logical size: %llu MBytes\n", logicalSize); ULONG64 actualSize; hardDisk->COMGETTER(Size)(&actualSize); RTPrintf("Current size on disk: %llu MBytes\n", actualSize >> 20); HardDiskType_T type; hardDisk->COMGETTER(Type)(&type); const char *typeStr = "unknown"; switch (type) { case HardDiskType_Normal: typeStr = "normal"; break; case HardDiskType_Immutable: typeStr = "immutable"; break; case HardDiskType_Writethrough: typeStr = "writethrough"; break; } RTPrintf("Type: %s\n", typeStr); Bstr format; hardDisk->COMGETTER(Format)(format.asOutParam()); RTPrintf("Storage format: %lS\n", format.raw()); if (!unknown) { com::SafeGUIDArray machineIds; hardDisk->COMGETTER(MachineIds)(ComSafeArrayAsOutParam(machineIds)); for (size_t j = 0; j < machineIds.size(); ++ j) { ComPtr machine; CHECK_ERROR(virtualBox, GetMachine(machineIds[j], machine.asOutParam())); ASSERT(machine); Bstr name; machine->COMGETTER(Name)(name.asOutParam()); machine->COMGETTER(Id)(uuid.asOutParam()); RTPrintf("%s%lS (UUID: %Vuuid)\n", j == 0 ? "In use by VMs: " : " ", name.raw(), &machineIds[j]); } /// @todo NEWMEDIA check usage in snapshots too /// @todo NEWMEDIA also list children and say 'differencing' for /// hard disks with the parent or 'base' otherwise. } Bstr loc; hardDisk->COMGETTER(Location)(loc.asOutParam()); RTPrintf("Location: %lS\n", loc.raw()); } while (0); if (unknown) { /* close the unknown hard disk to forget it again */ hardDisk->Close(); } return SUCCEEDED(rc) ? 0 : 1; } static int handleOpenMedium(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; if (argc < 2) return errorSyntax(USAGE_REGISTERIMAGE, "Not enough parameters"); Bstr filepath(argv[1]); if (strcmp(argv[0], "disk") == 0) { const char *type = NULL; /* there can be a type parameter */ if ((argc > 2) && (argc != 4)) return errorSyntax(USAGE_REGISTERIMAGE, "Incorrect number of parameters"); if (argc == 4) { if (strcmp(argv[2], "-type") != 0) return errorSyntax(USAGE_REGISTERIMAGE, "Invalid parameter '%s'", Utf8Str(argv[2]).raw()); if ( (strcmp(argv[3], "normal") != 0) && (strcmp(argv[3], "immutable") != 0) && (strcmp(argv[3], "writethrough") != 0)) return errorArgument("Invalid hard disk type '%s' specified", Utf8Str(argv[3]).raw()); type = argv[3]; } ComPtr hardDisk; CHECK_ERROR(virtualBox, OpenHardDisk2(filepath, hardDisk.asOutParam())); if (SUCCEEDED(rc) && hardDisk) { /* change the type if requested */ if (type) { if (strcmp(type, "normal") == 0) CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Normal)); else if (strcmp(type, "immutable") == 0) CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Immutable)); else if (strcmp(type, "writethrough") == 0) CHECK_ERROR(hardDisk, COMSETTER(Type)(HardDiskType_Writethrough)); } } } else if (strcmp(argv[0], "dvd") == 0) { ComPtr dvdImage; CHECK_ERROR(virtualBox, OpenDVDImage(filepath, Guid(), dvdImage.asOutParam())); } else if (strcmp(argv[0], "floppy") == 0) { ComPtr floppyImage; CHECK_ERROR(virtualBox, OpenFloppyImage(filepath, Guid(), floppyImage.asOutParam())); } else return errorSyntax(USAGE_REGISTERIMAGE, "Invalid parameter '%s'", Utf8Str(argv[1]).raw()); return SUCCEEDED(rc) ? 0 : 1; } static int handleCloseMedium(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; if (argc != 2) return errorSyntax(USAGE_UNREGISTERIMAGE, "Incorrect number of parameters"); /* first guess is that it's a UUID */ Guid uuid(argv[1]); if (strcmp(argv[0], "disk") == 0) { ComPtr hardDisk; rc = virtualBox->GetHardDisk2(uuid, hardDisk.asOutParam()); /* not a UUID or not registered? Then it must be a filename */ if (!hardDisk) { CHECK_ERROR(virtualBox, FindHardDisk2(Bstr(argv[1]), hardDisk.asOutParam())); } if (SUCCEEDED(rc) && hardDisk) { CHECK_ERROR(hardDisk, Close()); } } else if (strcmp(argv[0], "dvd") == 0) { ComPtr dvdImage; rc = virtualBox->GetDVDImage(uuid, dvdImage.asOutParam()); /* not a UUID or not registered? Then it must be a filename */ if (!dvdImage) { CHECK_ERROR(virtualBox, FindDVDImage(Bstr(argv[1]), dvdImage.asOutParam())); } if (SUCCEEDED(rc) && dvdImage) { CHECK_ERROR(dvdImage, Close()); } } else if (strcmp(argv[0], "floppy") == 0) { ComPtr floppyImage; rc = virtualBox->GetFloppyImage(uuid, floppyImage.asOutParam()); /* not a UUID or not registered? Then it must be a filename */ if (!floppyImage) { CHECK_ERROR(virtualBox, FindFloppyImage(Bstr(argv[1]), floppyImage.asOutParam())); } if (SUCCEEDED(rc) && floppyImage) { CHECK_ERROR(floppyImage, Close()); } } else return errorSyntax(USAGE_UNREGISTERIMAGE, "Invalid parameter '%s'", Utf8Str(argv[1]).raw()); return SUCCEEDED(rc) ? 0 : 1; } #ifdef RT_OS_WINDOWS static int handleCreateHostIF(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { if (argc != 1) return errorSyntax(USAGE_CREATEHOSTIF, "Incorrect number of parameters"); HRESULT rc = S_OK; do { ComPtr host; CHECK_ERROR_BREAK(virtualBox, COMGETTER(Host)(host.asOutParam())); ComPtr hostif; ComPtr progress; CHECK_ERROR_BREAK(host, CreateHostNetworkInterface(Bstr(argv[0]), hostif.asOutParam(), progress.asOutParam())); showProgress(progress); HRESULT result; CHECK_ERROR_BREAK(progress, COMGETTER(ResultCode)(&result)); if (FAILED(result)) { com::ProgressErrorInfo info(progress); PRINT_ERROR_INFO(info); rc = result; } } while (0); return SUCCEEDED(rc) ? 0 : 1; } static int handleRemoveHostIF(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { if (argc != 1) return errorSyntax(USAGE_REMOVEHOSTIF, "Incorrect number of parameters"); HRESULT rc = S_OK; do { ComPtr host; CHECK_ERROR_BREAK(virtualBox, COMGETTER(Host)(host.asOutParam())); ComPtr hostif; /* first guess is that it's a UUID */ Guid uuid(argv[0]); if (uuid.isEmpty()) { /* not a valid UUID, search for it */ ComPtr coll; CHECK_ERROR_BREAK(host, COMGETTER(NetworkInterfaces)(coll.asOutParam())); CHECK_ERROR_BREAK(coll, FindByName(Bstr(argv[0]), hostif.asOutParam())); CHECK_ERROR_BREAK(hostif, COMGETTER(Id)(uuid.asOutParam())); } ComPtr progress; CHECK_ERROR_BREAK(host, RemoveHostNetworkInterface(uuid, hostif.asOutParam(), progress.asOutParam())); showProgress(progress); HRESULT result; CHECK_ERROR_BREAK(progress, COMGETTER(ResultCode)(&result)); if (FAILED(result)) { com::ProgressErrorInfo info(progress); PRINT_ERROR_INFO(info); rc = result; } } while (0); return SUCCEEDED(rc) ? 0 : 1; } #endif /* RT_OS_WINDOWS */ static int handleGetExtraData(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc = S_OK; if (argc != 2) return errorSyntax(USAGE_GETEXTRADATA, "Incorrect number of parameters"); /* global data? */ if (strcmp(argv[0], "global") == 0) { /* enumeration? */ if (strcmp(argv[1], "enumerate") == 0) { Bstr extraDataKey; do { Bstr nextExtraDataKey; Bstr nextExtraDataValue; HRESULT rcEnum = virtualBox->GetNextExtraDataKey(extraDataKey, nextExtraDataKey.asOutParam(), nextExtraDataValue.asOutParam()); extraDataKey = nextExtraDataKey; if (SUCCEEDED(rcEnum) && extraDataKey) RTPrintf("Key: %lS, Value: %lS\n", nextExtraDataKey.raw(), nextExtraDataValue.raw()); } while (extraDataKey); } else { Bstr value; CHECK_ERROR(virtualBox, GetExtraData(Bstr(argv[1]), value.asOutParam())); if (value) RTPrintf("Value: %lS\n", value.raw()); else RTPrintf("No value set!\n"); } } else { ComPtr machine; /* assume it's a UUID */ rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam()); if (FAILED(rc) || !machine) { /* must be a name */ CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam())); } if (machine) { /* enumeration? */ if (strcmp(argv[1], "enumerate") == 0) { Bstr extraDataKey; do { Bstr nextExtraDataKey; Bstr nextExtraDataValue; HRESULT rcEnum = machine->GetNextExtraDataKey(extraDataKey, nextExtraDataKey.asOutParam(), nextExtraDataValue.asOutParam()); extraDataKey = nextExtraDataKey; if (SUCCEEDED(rcEnum) && extraDataKey) { RTPrintf("Key: %lS, Value: %lS\n", nextExtraDataKey.raw(), nextExtraDataValue.raw()); } } while (extraDataKey); } else { Bstr value; CHECK_ERROR(machine, GetExtraData(Bstr(argv[1]), value.asOutParam())); if (value) RTPrintf("Value: %lS\n", value.raw()); else RTPrintf("No value set!\n"); } } } return SUCCEEDED(rc) ? 0 : 1; } static int handleSetExtraData(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc = S_OK; if (argc < 2) return errorSyntax(USAGE_SETEXTRADATA, "Not enough parameters"); /* global data? */ if (strcmp(argv[0], "global") == 0) { if (argc < 3) CHECK_ERROR(virtualBox, SetExtraData(Bstr(argv[1]), NULL)); else if (argc == 3) CHECK_ERROR(virtualBox, SetExtraData(Bstr(argv[1]), Bstr(argv[2]))); else return errorSyntax(USAGE_SETEXTRADATA, "Too many parameters"); } else { ComPtr machine; /* assume it's a UUID */ rc = virtualBox->GetMachine(Guid(argv[0]), machine.asOutParam()); if (FAILED(rc) || !machine) { /* must be a name */ CHECK_ERROR(virtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam())); } if (machine) { if (argc < 3) CHECK_ERROR(machine, SetExtraData(Bstr(argv[1]), NULL)); else if (argc == 3) CHECK_ERROR(machine, SetExtraData(Bstr(argv[1]), Bstr(argv[2]))); else return errorSyntax(USAGE_SETEXTRADATA, "Too many parameters"); } } return SUCCEEDED(rc) ? 0 : 1; } static int handleSetProperty(int argc, char *argv[], ComPtr virtualBox, ComPtr session) { HRESULT rc; /* there must be two arguments: property name and value */ if (argc != 2) return errorSyntax(USAGE_SETPROPERTY, "Incorrect number of parameters"); ComPtr systemProperties; virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam()); if (strcmp(argv[0], "hdfolder") == 0) { /* reset to default? */ if (strcmp(argv[1], "default") == 0) CHECK_ERROR(systemProperties, COMSETTER(DefaultHardDiskFolder)(NULL)); else CHECK_ERROR(systemProperties, COMSETTER(DefaultHardDiskFolder)(Bstr(argv[1]))); } else if (strcmp(argv[0], "machinefolder") == 0) { /* reset to default? */ if (strcmp(argv[1], "default") == 0) CHECK_ERROR(systemProperties, COMSETTER(DefaultMachineFolder)(NULL)); else CHECK_ERROR(systemProperties, COMSETTER(DefaultMachineFolder)(Bstr(argv[1]))); } else if (strcmp(argv[0], "vrdpauthlibrary") == 0) { /* reset to default? */ if (strcmp(argv[1], "default") == 0) CHECK_ERROR(systemProperties, COMSETTER(RemoteDisplayAuthLibrary)(NULL)); else CHECK_ERROR(systemProperties, COMSETTER(RemoteDisplayAuthLibrary)(Bstr(argv[1]))); } else if (strcmp(argv[0], "websrvauthlibrary") == 0) { /* reset to default? */ if (strcmp(argv[1], "default") == 0) CHECK_ERROR(systemProperties, COMSETTER(WebServiceAuthLibrary)(NULL)); else CHECK_ERROR(systemProperties, COMSETTER(WebServiceAuthLibrary)(Bstr(argv[1]))); } else if (strcmp(argv[0], "hwvirtexenabled") == 0) { if (strcmp(argv[1], "yes") == 0) CHECK_ERROR(systemProperties, COMSETTER(HWVirtExEnabled)(TRUE)); else if (strcmp(argv[1], "no") == 0) CHECK_ERROR(systemProperties, COMSETTER(HWVirtExEnabled)(FALSE)); else return errorArgument("Invalid value '%s' for hardware virtualization extension flag", argv[1]); } else if (strcmp(argv[0], "loghistorycount") == 0) { uint32_t uVal; int vrc; vrc = RTStrToUInt32Ex(argv[1], NULL, 0, &uVal); if (vrc != VINF_SUCCESS) return errorArgument("Error parsing Log history count '%s'", argv[1]); CHECK_ERROR(systemProperties, COMSETTER(LogHistoryCount)(uVal)); } else return errorSyntax(USAGE_SETPROPERTY, "Invalid parameter '%s'", argv[0]); return SUCCEEDED(rc) ? 0 : 1; } static int handleUSBFilter (int argc, char *argv[], ComPtr aVirtualBox, ComPtr aSession) { HRESULT rc = S_OK; USBFilterCmd cmd; /* at least: 0: command, 1: index, 2: -target, 3: */ if (argc < 4) return errorSyntax(USAGE_USBFILTER, "Not enough parameters"); /* which command? */ cmd.mAction = USBFilterCmd::Invalid; if (strcmp (argv [0], "add") == 0) cmd.mAction = USBFilterCmd::Add; else if (strcmp (argv [0], "modify") == 0) cmd.mAction = USBFilterCmd::Modify; else if (strcmp (argv [0], "remove") == 0) cmd.mAction = USBFilterCmd::Remove; if (cmd.mAction == USBFilterCmd::Invalid) return errorSyntax(USAGE_USBFILTER, "Invalid parameter '%s'", argv[0]); /* which index? */ char *endptr = NULL; cmd.mIndex = strtoul (argv[1], &endptr, 10); if (!endptr || *endptr) return errorSyntax(USAGE_USBFILTER, "Invalid index '%s'", argv[1]); switch (cmd.mAction) { case USBFilterCmd::Add: case USBFilterCmd::Modify: { /* at least: 0: command, 1: index, 2: -target, 3: , 4: -name, 5: */ if (argc < 6) { if (cmd.mAction == USBFilterCmd::Add) return errorSyntax(USAGE_USBFILTER_ADD, "Not enough parameters"); return errorSyntax(USAGE_USBFILTER_MODIFY, "Not enough parameters"); } // set Active to true by default // (assuming that the user sets up all necessary attributes // at once and wants the filter to be active immediately) if (cmd.mAction == USBFilterCmd::Add) cmd.mFilter.mActive = true; for (int i = 2; i < argc; i++) { if (strcmp(argv [i], "-target") == 0) { if (argc <= i + 1 || !*argv[i+1]) return errorArgument("Missing argument to '%s'", argv[i]); i++; if (strcmp (argv [i], "global") == 0) cmd.mGlobal = true; else { /* assume it's a UUID of a machine */ rc = aVirtualBox->GetMachine(Guid(argv[i]), cmd.mMachine.asOutParam()); if (FAILED(rc) || !cmd.mMachine) { /* must be a name */ CHECK_ERROR_RET(aVirtualBox, FindMachine(Bstr(argv[i]), cmd.mMachine.asOutParam()), 1); } } } else if (strcmp(argv [i], "-name") == 0) { if (argc <= i + 1 || !*argv[i+1]) return errorArgument("Missing argument to '%s'", argv[i]); i++; cmd.mFilter.mName = argv [i]; } else if (strcmp(argv [i], "-active") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; if (strcmp (argv [i], "yes") == 0) cmd.mFilter.mActive = true; else if (strcmp (argv [i], "no") == 0) cmd.mFilter.mActive = false; else return errorArgument("Invalid -active argument '%s'", argv[i]); } else if (strcmp(argv [i], "-vendorid") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; cmd.mFilter.mVendorId = argv [i]; } else if (strcmp(argv [i], "-productid") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; cmd.mFilter.mProductId = argv [i]; } else if (strcmp(argv [i], "-revision") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; cmd.mFilter.mRevision = argv [i]; } else if (strcmp(argv [i], "-manufacturer") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; cmd.mFilter.mManufacturer = argv [i]; } else if (strcmp(argv [i], "-product") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; cmd.mFilter.mProduct = argv [i]; } else if (strcmp(argv [i], "-remote") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; cmd.mFilter.mRemote = argv[i]; } else if (strcmp(argv [i], "-serialnumber") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; cmd.mFilter.mSerialNumber = argv [i]; } else if (strcmp(argv [i], "-maskedinterfaces") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; uint32_t u32; rc = RTStrToUInt32Full(argv[i], 0, &u32); if (RT_FAILURE(rc)) return errorArgument("Failed to convert the -maskedinterfaces value '%s' to a number, rc=%Rrc", argv[i], rc); cmd.mFilter.mMaskedInterfaces = u32; } else if (strcmp(argv [i], "-action") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); i++; if (strcmp (argv [i], "ignore") == 0) cmd.mFilter.mAction = USBDeviceFilterAction_Ignore; else if (strcmp (argv [i], "hold") == 0) cmd.mFilter.mAction = USBDeviceFilterAction_Hold; else return errorArgument("Invalid USB filter action '%s'", argv[i]); } else return errorSyntax(cmd.mAction == USBFilterCmd::Add ? USAGE_USBFILTER_ADD : USAGE_USBFILTER_MODIFY, "Unknown option '%s'", argv[i]); } if (cmd.mAction == USBFilterCmd::Add) { // mandatory/forbidden options if ( cmd.mFilter.mName.isEmpty() || ( cmd.mGlobal && cmd.mFilter.mAction == USBDeviceFilterAction_Null ) || ( !cmd.mGlobal && !cmd.mMachine) || ( cmd.mGlobal && cmd.mFilter.mRemote) ) { return errorSyntax(USAGE_USBFILTER_ADD, "Mandatory options not supplied"); } } break; } case USBFilterCmd::Remove: { /* at least: 0: command, 1: index, 2: -target, 3: */ if (argc < 4) return errorSyntax(USAGE_USBFILTER_REMOVE, "Not enough parameters"); for (int i = 2; i < argc; i++) { if (strcmp(argv [i], "-target") == 0) { if (argc <= i + 1 || !*argv[i+1]) return errorArgument("Missing argument to '%s'", argv[i]); i++; if (strcmp (argv [i], "global") == 0) cmd.mGlobal = true; else { /* assume it's a UUID of a machine */ rc = aVirtualBox->GetMachine(Guid(argv[i]), cmd.mMachine.asOutParam()); if (FAILED(rc) || !cmd.mMachine) { /* must be a name */ CHECK_ERROR_RET(aVirtualBox, FindMachine(Bstr(argv[i]), cmd.mMachine.asOutParam()), 1); } } } } // mandatory options if (!cmd.mGlobal && !cmd.mMachine) return errorSyntax(USAGE_USBFILTER_REMOVE, "Mandatory options not supplied"); break; } default: break; } USBFilterCmd::USBFilter &f = cmd.mFilter; ComPtr host; ComPtr ctl; if (cmd.mGlobal) CHECK_ERROR_RET (aVirtualBox, COMGETTER(Host) (host.asOutParam()), 1); else { Guid uuid; cmd.mMachine->COMGETTER(Id)(uuid.asOutParam()); /* open a session for the VM */ CHECK_ERROR_RET (aVirtualBox, OpenSession(aSession, uuid), 1); /* get the mutable session machine */ aSession->COMGETTER(Machine)(cmd.mMachine.asOutParam()); /* and get the USB controller */ CHECK_ERROR_RET (cmd.mMachine, COMGETTER(USBController) (ctl.asOutParam()), 1); } switch (cmd.mAction) { case USBFilterCmd::Add: { if (cmd.mGlobal) { ComPtr flt; CHECK_ERROR_BREAK (host, CreateUSBDeviceFilter (f.mName, flt.asOutParam())); if (!f.mActive.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Active) (f.mActive)); if (!f.mVendorId.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(VendorId) (f.mVendorId.setNullIfEmpty())); if (!f.mProductId.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(ProductId) (f.mProductId.setNullIfEmpty())); if (!f.mRevision.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Revision) (f.mRevision.setNullIfEmpty())); if (!f.mManufacturer.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Manufacturer) (f.mManufacturer.setNullIfEmpty())); if (!f.mSerialNumber.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(SerialNumber) (f.mSerialNumber.setNullIfEmpty())); if (!f.mMaskedInterfaces.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(MaskedInterfaces) (f.mMaskedInterfaces)); if (f.mAction != USBDeviceFilterAction_Null) CHECK_ERROR_BREAK (flt, COMSETTER(Action) (f.mAction)); CHECK_ERROR_BREAK (host, InsertUSBDeviceFilter (cmd.mIndex, flt)); } else { ComPtr flt; CHECK_ERROR_BREAK (ctl, CreateDeviceFilter (f.mName, flt.asOutParam())); if (!f.mActive.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Active) (f.mActive)); if (!f.mVendorId.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(VendorId) (f.mVendorId.setNullIfEmpty())); if (!f.mProductId.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(ProductId) (f.mProductId.setNullIfEmpty())); if (!f.mRevision.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Revision) (f.mRevision.setNullIfEmpty())); if (!f.mManufacturer.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Manufacturer) (f.mManufacturer.setNullIfEmpty())); if (!f.mRemote.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Remote) (f.mRemote.setNullIfEmpty())); if (!f.mSerialNumber.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(SerialNumber) (f.mSerialNumber.setNullIfEmpty())); if (!f.mMaskedInterfaces.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(MaskedInterfaces) (f.mMaskedInterfaces)); CHECK_ERROR_BREAK (ctl, InsertDeviceFilter (cmd.mIndex, flt)); } break; } case USBFilterCmd::Modify: { if (cmd.mGlobal) { ComPtr coll; CHECK_ERROR_BREAK (host, COMGETTER(USBDeviceFilters) (coll.asOutParam())); ComPtr flt; CHECK_ERROR_BREAK (coll, GetItemAt (cmd.mIndex, flt.asOutParam())); if (!f.mName.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Name) (f.mName.setNullIfEmpty())); if (!f.mActive.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Active) (f.mActive)); if (!f.mVendorId.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(VendorId) (f.mVendorId.setNullIfEmpty())); if (!f.mProductId.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(ProductId) (f.mProductId.setNullIfEmpty())); if (!f.mRevision.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Revision) (f.mRevision.setNullIfEmpty())); if (!f.mManufacturer.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Manufacturer) (f.mManufacturer.setNullIfEmpty())); if (!f.mSerialNumber.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(SerialNumber) (f.mSerialNumber.setNullIfEmpty())); if (!f.mMaskedInterfaces.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(MaskedInterfaces) (f.mMaskedInterfaces)); if (f.mAction != USBDeviceFilterAction_Null) CHECK_ERROR_BREAK (flt, COMSETTER(Action) (f.mAction)); } else { ComPtr coll; CHECK_ERROR_BREAK (ctl, COMGETTER(DeviceFilters) (coll.asOutParam())); ComPtr flt; CHECK_ERROR_BREAK (coll, GetItemAt (cmd.mIndex, flt.asOutParam())); if (!f.mName.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Name) (f.mName.setNullIfEmpty())); if (!f.mActive.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Active) (f.mActive)); if (!f.mVendorId.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(VendorId) (f.mVendorId.setNullIfEmpty())); if (!f.mProductId.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(ProductId) (f.mProductId.setNullIfEmpty())); if (!f.mRevision.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Revision) (f.mRevision.setNullIfEmpty())); if (!f.mManufacturer.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Manufacturer) (f.mManufacturer.setNullIfEmpty())); if (!f.mRemote.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(Remote) (f.mRemote.setNullIfEmpty())); if (!f.mSerialNumber.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(SerialNumber) (f.mSerialNumber.setNullIfEmpty())); if (!f.mMaskedInterfaces.isNull()) CHECK_ERROR_BREAK (flt, COMSETTER(MaskedInterfaces) (f.mMaskedInterfaces)); } break; } case USBFilterCmd::Remove: { if (cmd.mGlobal) { ComPtr flt; CHECK_ERROR_BREAK (host, RemoveUSBDeviceFilter (cmd.mIndex, flt.asOutParam())); } else { ComPtr flt; CHECK_ERROR_BREAK (ctl, RemoveDeviceFilter (cmd.mIndex, flt.asOutParam())); } break; } default: break; } if (cmd.mMachine) { /* commit and close the session */ CHECK_ERROR(cmd.mMachine, SaveSettings()); aSession->Close(); } return SUCCEEDED (rc) ? 0 : 1; } static int handleSharedFolder (int argc, char *argv[], ComPtr aVirtualBox, ComPtr aSession) { HRESULT rc; /* we need at least a command and target */ if (argc < 2) return errorSyntax(USAGE_SHAREDFOLDER, "Not enough parameters"); ComPtr machine; /* assume it's a UUID */ rc = aVirtualBox->GetMachine(Guid(argv[1]), machine.asOutParam()); if (FAILED(rc) || !machine) { /* must be a name */ CHECK_ERROR(aVirtualBox, FindMachine(Bstr(argv[1]), machine.asOutParam())); } if (!machine) return 1; Guid uuid; machine->COMGETTER(Id)(uuid.asOutParam()); if (strcmp(argv[0], "add") == 0) { /* we need at least four more parameters */ if (argc < 5) return errorSyntax(USAGE_SHAREDFOLDER_ADD, "Not enough parameters"); char *name = NULL; char *hostpath = NULL; bool fTransient = false; bool fWritable = true; for (int i = 2; i < argc; i++) { if (strcmp(argv[i], "-name") == 0) { if (argc <= i + 1 || !*argv[i+1]) return errorArgument("Missing argument to '%s'", argv[i]); i++; name = argv[i]; } else if (strcmp(argv[i], "-hostpath") == 0) { if (argc <= i + 1 || !*argv[i+1]) return errorArgument("Missing argument to '%s'", argv[i]); i++; hostpath = argv[i]; } else if (strcmp(argv[i], "-readonly") == 0) { fWritable = false; } else if (strcmp(argv[i], "-transient") == 0) { fTransient = true; } else return errorSyntax(USAGE_SHAREDFOLDER_ADD, "Invalid parameter '%s'", Utf8Str(argv[i]).raw()); } if (NULL != strstr(name, " ")) return errorSyntax(USAGE_SHAREDFOLDER_ADD, "No spaces allowed in parameter '-name'!"); /* required arguments */ if (!name || !hostpath) { return errorSyntax(USAGE_SHAREDFOLDER_ADD, "Parameters -name and -hostpath are required"); } if (fTransient) { ComPtr console; /* open an existing session for the VM */ CHECK_ERROR_RET(aVirtualBox, OpenExistingSession (aSession, uuid), 1); /* get the session machine */ CHECK_ERROR_RET(aSession, COMGETTER(Machine)(machine.asOutParam()), 1); /* get the session console */ CHECK_ERROR_RET(aSession, COMGETTER(Console)(console.asOutParam()), 1); CHECK_ERROR(console, CreateSharedFolder(Bstr(name), Bstr(hostpath), fWritable)); if (console) aSession->Close(); } else { /* open a session for the VM */ CHECK_ERROR_RET (aVirtualBox, OpenSession(aSession, uuid), 1); /* get the mutable session machine */ aSession->COMGETTER(Machine)(machine.asOutParam()); CHECK_ERROR(machine, CreateSharedFolder(Bstr(name), Bstr(hostpath), fWritable)); if (SUCCEEDED(rc)) CHECK_ERROR(machine, SaveSettings()); aSession->Close(); } } else if (strcmp(argv[0], "remove") == 0) { /* we need at least two more parameters */ if (argc < 3) return errorSyntax(USAGE_SHAREDFOLDER_REMOVE, "Not enough parameters"); char *name = NULL; bool fTransient = false; for (int i = 2; i < argc; i++) { if (strcmp(argv[i], "-name") == 0) { if (argc <= i + 1 || !*argv[i+1]) return errorArgument("Missing argument to '%s'", argv[i]); i++; name = argv[i]; } else if (strcmp(argv[i], "-transient") == 0) { fTransient = true; } else return errorSyntax(USAGE_SHAREDFOLDER_REMOVE, "Invalid parameter '%s'", Utf8Str(argv[i]).raw()); } /* required arguments */ if (!name) return errorSyntax(USAGE_SHAREDFOLDER_REMOVE, "Parameter -name is required"); if (fTransient) { ComPtr console; /* open an existing session for the VM */ CHECK_ERROR_RET(aVirtualBox, OpenExistingSession (aSession, uuid), 1); /* get the session machine */ CHECK_ERROR_RET(aSession, COMGETTER(Machine)(machine.asOutParam()), 1); /* get the session console */ CHECK_ERROR_RET(aSession, COMGETTER(Console)(console.asOutParam()), 1); CHECK_ERROR(console, RemoveSharedFolder(Bstr(name))); if (console) aSession->Close(); } else { /* open a session for the VM */ CHECK_ERROR_RET (aVirtualBox, OpenSession(aSession, uuid), 1); /* get the mutable session machine */ aSession->COMGETTER(Machine)(machine.asOutParam()); CHECK_ERROR(machine, RemoveSharedFolder(Bstr(name))); /* commit and close the session */ CHECK_ERROR(machine, SaveSettings()); aSession->Close(); } } else return errorSyntax(USAGE_SETPROPERTY, "Invalid parameter '%s'", Utf8Str(argv[0]).raw()); return 0; } static int handleVMStatistics(int argc, char *argv[], ComPtr aVirtualBox, ComPtr aSession) { HRESULT rc; /* at least one option: the UUID or name of the VM */ if (argc < 1) return errorSyntax(USAGE_VM_STATISTICS, "Incorrect number of parameters"); /* try to find the given machine */ ComPtr machine; Guid uuid (argv[0]); if (!uuid.isEmpty()) CHECK_ERROR(aVirtualBox, GetMachine(uuid, machine.asOutParam())); else { CHECK_ERROR(aVirtualBox, FindMachine(Bstr(argv[0]), machine.asOutParam())); if (SUCCEEDED (rc)) machine->COMGETTER(Id)(uuid.asOutParam()); } if (FAILED(rc)) return 1; /* parse arguments. */ bool fReset = false; bool fWithDescriptions = false; const char *pszPattern = NULL; /* all */ for (int i = 1; i < argc; i++) { if (!strcmp(argv[i], "-pattern")) { if (pszPattern) return errorSyntax(USAGE_VM_STATISTICS, "Multiple -patterns options is not permitted"); if (i + 1 >= argc) return errorArgument("Missing argument to '%s'", argv[i]); pszPattern = argv[++i]; } else if (!strcmp(argv[i], "-descriptions")) fWithDescriptions = true; /* add: -file and -formatted */ else if (!strcmp(argv[i], "-reset")) fReset = true; else return errorSyntax(USAGE_VM_STATISTICS, "Unknown option '%s'", argv[i]); } if (fReset && fWithDescriptions) return errorSyntax(USAGE_VM_STATISTICS, "The -reset and -descriptions options does not mix"); /* open an existing session for the VM. */ CHECK_ERROR(aVirtualBox, OpenExistingSession(aSession, uuid)); if (SUCCEEDED(rc)) { /* get the session console. */ ComPtr console; CHECK_ERROR(aSession, COMGETTER(Console)(console.asOutParam())); if (SUCCEEDED(rc)) { /* get the machine debugger. */ ComPtr debugger; CHECK_ERROR(console, COMGETTER(Debugger)(debugger.asOutParam())); if (SUCCEEDED(rc)) { if (fReset) CHECK_ERROR(debugger, ResetStats(Bstr(pszPattern).raw())); else { Bstr stats; CHECK_ERROR(debugger, GetStats(Bstr(pszPattern).raw(), fWithDescriptions, stats.asOutParam())); if (SUCCEEDED(rc)) { /* if (fFormatted) { big mess } else */ RTPrintf("%ls\n", stats.raw()); } } } aSession->Close(); } } return SUCCEEDED(rc) ? 0 : 1; } static char *toBaseMetricNames(const char *metricList) { char *newList = (char*)RTMemAlloc(strlen(metricList) + 1); int cSlashes = 0; bool fSkip = false; const char *src = metricList; char c, *dst = newList; while ((c = *src++)) if (c == ':') fSkip = true; else if (c == '/' && ++cSlashes == 2) fSkip = true; else if (c == ',') { fSkip = false; cSlashes = 0; *dst++ = c; } else if (!fSkip) *dst++ = c; *dst = 0; return newList; } static int parseFilterParameters(int argc, char *argv[], ComPtr aVirtualBox, ComSafeArrayOut(BSTR, outMetrics), ComSafeArrayOut(BSTR, outBaseMetrics), ComSafeArrayOut(IUnknown *, outObjects)) { HRESULT rc = S_OK; com::SafeArray retMetrics(1); com::SafeArray retBaseMetrics(1); com::SafeIfaceArray retObjects; Bstr metricNames, baseNames; /* Metric list */ if (argc > 1) { metricNames = argv[1]; char *tmp = toBaseMetricNames(argv[1]); if (!tmp) return VERR_NO_MEMORY; baseNames = tmp; RTMemFree(tmp); } else { metricNames = L"*"; baseNames = L"*"; } metricNames.cloneTo(&retMetrics[0]); baseNames.cloneTo(&retBaseMetrics[0]); /* Object name */ if (argc > 0 && strcmp(argv[0], "*")) { if (!strcmp(argv[0], "host")) { ComPtr host; CHECK_ERROR(aVirtualBox, COMGETTER(Host)(host.asOutParam())); retObjects.reset(1); host.queryInterfaceTo(&retObjects[0]); } else { ComPtr machine; rc = aVirtualBox->FindMachine(Bstr(argv[0]), machine.asOutParam()); if (SUCCEEDED (rc)) { retObjects.reset(1); machine.queryInterfaceTo(&retObjects[0]); } else { errorArgument("Invalid machine name: '%s'", argv[0]); return rc; } } } retMetrics.detachTo(ComSafeArrayOutArg(outMetrics)); retBaseMetrics.detachTo(ComSafeArrayOutArg(outBaseMetrics)); retObjects.detachTo(ComSafeArrayOutArg(outObjects)); return rc; } static Bstr getObjectName(ComPtr aVirtualBox, ComPtr aObject) { HRESULT rc; ComPtr host = aObject; if (!host.isNull()) return Bstr("host"); ComPtr machine = aObject; if (!machine.isNull()) { Bstr name; CHECK_ERROR(machine, COMGETTER(Name)(name.asOutParam())); if (SUCCEEDED(rc)) return name; } return Bstr("unknown"); } static void listAffectedMetrics(ComPtr aVirtualBox, ComSafeArrayIn(IPerformanceMetric*, aMetrics)) { HRESULT rc; com::SafeIfaceArray metrics(ComSafeArrayInArg(aMetrics)); if (metrics.size()) { ComPtr object; Bstr metricName; RTPrintf("The following metrics were modified:\n\n" "Object Metric\n" "---------- --------------------\n"); for (size_t i = 0; i < metrics.size(); i++) { CHECK_ERROR(metrics[i], COMGETTER(Object)(object.asOutParam())); CHECK_ERROR(metrics[i], COMGETTER(MetricName)(metricName.asOutParam())); RTPrintf("%-10ls %-20ls\n", getObjectName(aVirtualBox, object).raw(), metricName.raw()); } RTPrintf("\n"); } else { RTPrintf("No metrics match the specified filter!\n"); } } /** * list * */ static int handleMetricsList(int argc, char *argv[], ComPtr aVirtualBox, ComPtr performanceCollector) { HRESULT rc; com::SafeArray metrics; com::SafeArray baseMetrics; com::SafeIfaceArray objects; rc = parseFilterParameters(argc - 1, &argv[1], aVirtualBox, ComSafeArrayAsOutParam(metrics), ComSafeArrayAsOutParam(baseMetrics), ComSafeArrayAsOutParam(objects)); if (FAILED(rc)) return 1; com::SafeIfaceArray metricInfo; CHECK_ERROR(performanceCollector, GetMetrics(ComSafeArrayAsInParam(metrics), ComSafeArrayAsInParam(objects), ComSafeArrayAsOutParam(metricInfo))); ComPtr object; Bstr metricName, unit, description; ULONG period, count; LONG minimum, maximum; RTPrintf( "Object Metric Unit Minimum Maximum Period Count Description\n" "---------- -------------------- ---- ---------- ---------- ---------- ---------- -----------\n"); for (size_t i = 0; i < metricInfo.size(); i++) { CHECK_ERROR(metricInfo[i], COMGETTER(Object)(object.asOutParam())); CHECK_ERROR(metricInfo[i], COMGETTER(MetricName)(metricName.asOutParam())); CHECK_ERROR(metricInfo[i], COMGETTER(Period)(&period)); CHECK_ERROR(metricInfo[i], COMGETTER(Count)(&count)); CHECK_ERROR(metricInfo[i], COMGETTER(MinimumValue)(&minimum)); CHECK_ERROR(metricInfo[i], COMGETTER(MaximumValue)(&maximum)); CHECK_ERROR(metricInfo[i], COMGETTER(Unit)(unit.asOutParam())); CHECK_ERROR(metricInfo[i], COMGETTER(Description)(description.asOutParam())); RTPrintf("%-10ls %-20ls %-4ls %10d %10d %10u %10u %ls\n", getObjectName(aVirtualBox, object).raw(), metricName.raw(), unit.raw(), minimum, maximum, period, count, description.raw()); } return 0; } /** * Metics setup */ static int handleMetricsSetup(int argc, char *argv[], ComPtr aVirtualBox, ComPtr performanceCollector) { HRESULT rc; com::SafeArray metrics; com::SafeArray baseMetrics; com::SafeIfaceArray objects; ULONG period = 1, samples = 1; bool listMatches = false; int i; for (i = 1; i < argc; i++) { if (strcmp(argv[i], "-period") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); char *endptr = NULL; period = strtoul (argv[++i], &endptr, 10); if (!endptr || *endptr || !period) return errorArgument("Invalid value for 'period' parameter: '%s'", argv[i]); } else if (strcmp(argv[i], "-samples") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); char *endptr = NULL; samples = strtoul (argv[++i], &endptr, 10); if (!endptr || *endptr) return errorArgument("Invalid value for 'samples' parameter: '%s'", argv[i]); } else if (strcmp(argv[i], "-list") == 0) listMatches = true; else break; /* The rest of params should define the filter */ } rc = parseFilterParameters(argc - i, &argv[i], aVirtualBox, ComSafeArrayAsOutParam(metrics), ComSafeArrayAsOutParam(baseMetrics), ComSafeArrayAsOutParam(objects)); if (FAILED(rc)) return 1; com::SafeIfaceArray affectedMetrics; CHECK_ERROR(performanceCollector, SetupMetrics(ComSafeArrayAsInParam(metrics), ComSafeArrayAsInParam(objects), period, samples, ComSafeArrayAsOutParam(affectedMetrics))); if (listMatches) listAffectedMetrics(aVirtualBox, ComSafeArrayAsInParam(affectedMetrics)); return 0; } /** * metrics query */ static int handleMetricsQuery(int argc, char *argv[], ComPtr aVirtualBox, ComPtr performanceCollector) { HRESULT rc; com::SafeArray metrics; com::SafeArray baseMetrics; com::SafeIfaceArray objects; rc = parseFilterParameters(argc - 1, &argv[1], aVirtualBox, ComSafeArrayAsOutParam(metrics), ComSafeArrayAsOutParam(baseMetrics), ComSafeArrayAsOutParam(objects)); if (FAILED(rc)) return 1; com::SafeArray retNames; com::SafeIfaceArray retObjects; com::SafeArray retUnits; com::SafeArray retScales; com::SafeArray retSequenceNumbers; com::SafeArray retIndices; com::SafeArray retLengths; com::SafeArray retData; CHECK_ERROR (performanceCollector, QueryMetricsData(ComSafeArrayAsInParam(metrics), ComSafeArrayAsInParam(objects), ComSafeArrayAsOutParam(retNames), ComSafeArrayAsOutParam(retObjects), ComSafeArrayAsOutParam(retUnits), ComSafeArrayAsOutParam(retScales), ComSafeArrayAsOutParam(retSequenceNumbers), ComSafeArrayAsOutParam(retIndices), ComSafeArrayAsOutParam(retLengths), ComSafeArrayAsOutParam(retData)) ); RTPrintf("Object Metric Values\n" "---------- -------------------- --------------------------------------------\n"); for (unsigned i = 0; i < retNames.size(); i++) { Bstr metricUnit(retUnits[i]); Bstr metricName(retNames[i]); RTPrintf("%-10ls %-20ls ", getObjectName(aVirtualBox, retObjects[i]).raw(), metricName.raw()); const char *separator = ""; for (unsigned j = 0; j < retLengths[i]; j++) { if (retScales[i] == 1) RTPrintf("%s%d %ls", separator, retData[retIndices[i] + j], metricUnit.raw()); else RTPrintf("%s%d.%02d%ls", separator, retData[retIndices[i] + j] / retScales[i], (retData[retIndices[i] + j] * 100 / retScales[i]) % 100, metricUnit.raw()); separator = ", "; } RTPrintf("\n"); } return 0; } static void getTimestamp(char *pts, size_t tsSize) { *pts = 0; AssertReturnVoid(tsSize >= 13); /* 3+3+3+3+1 */ RTTIMESPEC TimeSpec; RTTIME Time; RTTimeExplode(&Time, RTTimeNow(&TimeSpec)); pts += RTStrFormatNumber(pts, Time.u8Hour, 10, 2, 0, RTSTR_F_ZEROPAD); *pts++ = ':'; pts += RTStrFormatNumber(pts, Time.u8Minute, 10, 2, 0, RTSTR_F_ZEROPAD); *pts++ = ':'; pts += RTStrFormatNumber(pts, Time.u8Second, 10, 2, 0, RTSTR_F_ZEROPAD); *pts++ = '.'; pts += RTStrFormatNumber(pts, Time.u32Nanosecond / 1000000, 10, 3, 0, RTSTR_F_ZEROPAD); *pts = 0; } /** Used by the handleMetricsCollect loop. */ static bool volatile g_fKeepGoing = true; #ifdef RT_OS_WINDOWS /** * Handler routine for catching Ctrl-C, Ctrl-Break and closing of * the console. * * @returns true if handled, false if not handled. * @param dwCtrlType The type of control signal. * * @remarks This is called on a new thread. */ static BOOL WINAPI ctrlHandler(DWORD dwCtrlType) { switch (dwCtrlType) { /* Ctrl-C or Ctrl-Break or Close */ case CTRL_C_EVENT: case CTRL_BREAK_EVENT: case CTRL_CLOSE_EVENT: /* Let's shut down gracefully. */ ASMAtomicWriteBool(&g_fKeepGoing, false); return TRUE; } /* Don't care about the rest -- let it die a horrible death. */ return FALSE; } #endif /* RT_OS_WINDOWS */ /** * collect */ static int handleMetricsCollect(int argc, char *argv[], ComPtr aVirtualBox, ComPtr performanceCollector) { HRESULT rc; com::SafeArray metrics; com::SafeArray baseMetrics; com::SafeIfaceArray objects; ULONG period = 1, samples = 1; bool isDetached = false, listMatches = false; int i; for (i = 1; i < argc; i++) { if (strcmp(argv[i], "-period") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); char *endptr = NULL; period = strtoul (argv[++i], &endptr, 10); if (!endptr || *endptr || !period) return errorArgument("Invalid value for 'period' parameter: '%s'", argv[i]); } else if (strcmp(argv[i], "-samples") == 0) { if (argc <= i + 1) return errorArgument("Missing argument to '%s'", argv[i]); char *endptr = NULL; samples = strtoul (argv[++i], &endptr, 10); if (!endptr || *endptr || !samples) return errorArgument("Invalid value for 'samples' parameter: '%s'", argv[i]); } else if (strcmp(argv[i], "-list") == 0) listMatches = true; else if (strcmp(argv[i], "-detach") == 0) isDetached = true; else break; /* The rest of params should define the filter */ } rc = parseFilterParameters(argc - i, &argv[i], aVirtualBox, ComSafeArrayAsOutParam(metrics), ComSafeArrayAsOutParam(baseMetrics), ComSafeArrayAsOutParam(objects)); if (FAILED(rc)) return 1; com::SafeIfaceArray affectedMetrics; CHECK_ERROR(performanceCollector, SetupMetrics(ComSafeArrayAsInParam(baseMetrics), ComSafeArrayAsInParam(objects), period, samples, ComSafeArrayAsOutParam(affectedMetrics))); if (listMatches) listAffectedMetrics(aVirtualBox, ComSafeArrayAsInParam(affectedMetrics)); if (!affectedMetrics.size()) return 1; if (isDetached) { RTPrintf("Warning! The background process holding collected metrics will shutdown\n" "in few seconds, discarding all collected data and parameters.\n"); return 0; } #ifdef RT_OS_WINDOWS SetConsoleCtrlHandler(ctrlHandler, true); #endif /* RT_OS_WINDOWS */ RTPrintf("Time stamp Object Metric Value\n"); while (g_fKeepGoing) { RTPrintf("------------ ---------- -------------------- --------------------\n"); RTThreadSleep(period * 1000); // Sleep for 'period' seconds char ts[15]; getTimestamp(ts, sizeof(ts)); com::SafeArray retNames; com::SafeIfaceArray retObjects; com::SafeArray retUnits; com::SafeArray retScales; com::SafeArray retSequenceNumbers; com::SafeArray retIndices; com::SafeArray retLengths; com::SafeArray retData; CHECK_ERROR (performanceCollector, QueryMetricsData(ComSafeArrayAsInParam(metrics), ComSafeArrayAsInParam(objects), ComSafeArrayAsOutParam(retNames), ComSafeArrayAsOutParam(retObjects), ComSafeArrayAsOutParam(retUnits), ComSafeArrayAsOutParam(retScales), ComSafeArrayAsOutParam(retSequenceNumbers), ComSafeArrayAsOutParam(retIndices), ComSafeArrayAsOutParam(retLengths), ComSafeArrayAsOutParam(retData)) ); for (unsigned i = 0; i < retNames.size(); i++) { Bstr metricUnit(retUnits[i]); Bstr metricName(retNames[i]); RTPrintf("%-12s %-10ls %-20ls ", ts, getObjectName(aVirtualBox, retObjects[i]).raw(), metricName.raw()); const char *separator = ""; for (unsigned j = 0; j < retLengths[i]; j++) { if (retScales[i] == 1) RTPrintf("%s%d %ls", separator, retData[retIndices[i] + j], metricUnit.raw()); else RTPrintf("%s%d.%02d%ls", separator, retData[retIndices[i] + j] / retScales[i], (retData[retIndices[i] + j] * 100 / retScales[i]) % 100, metricUnit.raw()); separator = ", "; } RTPrintf("\n"); } } #ifdef RT_OS_WINDOWS SetConsoleCtrlHandler(ctrlHandler, false); #endif /* RT_OS_WINDOWS */ return 0; } static int handleMetrics(int argc, char *argv[], ComPtr aVirtualBox, ComPtr aSession) { int rc; /* at least one option: subcommand name */ if (argc < 1) return errorSyntax(USAGE_METRICS, "Subcommand missing"); ComPtr performanceCollector; CHECK_ERROR(aVirtualBox, COMGETTER(PerformanceCollector)(performanceCollector.asOutParam())); if (!strcmp(argv[0], "list")) rc = handleMetricsList(argc, argv, aVirtualBox, performanceCollector); else if (!strcmp(argv[0], "setup")) rc = handleMetricsSetup(argc, argv, aVirtualBox, performanceCollector); else if (!strcmp(argv[0], "query")) rc = handleMetricsQuery(argc, argv, aVirtualBox, performanceCollector); else if (!strcmp(argv[0], "collect")) rc = handleMetricsCollect(argc, argv, aVirtualBox, performanceCollector); else return errorSyntax(USAGE_METRICS, "Invalid subcommand '%s'", argv[0]); return rc; } #endif /* !VBOX_ONLY_DOCS */ enum ConvertSettings { ConvertSettings_No = 0, ConvertSettings_Yes = 1, ConvertSettings_Backup = 2, ConvertSettings_Ignore = 3, }; #ifndef VBOX_ONLY_DOCS /** * Checks if any of the settings files were auto-converted and informs the * user if so. * * @return @false if the program should terminate and @true otherwise. */ static bool checkForAutoConvertedSettings (ComPtr virtualBox, ComPtr session, ConvertSettings fConvertSettings) { /* return early if nothing to do */ if (fConvertSettings == ConvertSettings_Ignore) return true; HRESULT rc; do { Bstr formatVersion; CHECK_RC_BREAK (virtualBox-> COMGETTER(SettingsFormatVersion) (formatVersion.asOutParam())); bool isGlobalConverted = false; std::list > cvtMachines; std::list fileList; Bstr version; Bstr filePath; com::SafeIfaceArray machines; CHECK_RC_BREAK (virtualBox-> COMGETTER(Machines2) (ComSafeArrayAsOutParam (machines))); for (size_t i = 0; i < machines.size(); ++ i) { BOOL accessible; CHECK_RC_BREAK (machines [i]-> COMGETTER(Accessible) (&accessible)); if (!accessible) continue; CHECK_RC_BREAK (machines [i]-> COMGETTER(SettingsFileVersion) (version.asOutParam())); if (version != formatVersion) { cvtMachines.push_back (machines [i]); Bstr filePath; CHECK_RC_BREAK (machines [i]-> COMGETTER(SettingsFilePath) (filePath.asOutParam())); fileList.push_back (Utf8StrFmt ("%ls (%ls)", filePath.raw(), version.raw())); } } CHECK_RC_BREAK (rc); CHECK_RC_BREAK (virtualBox-> COMGETTER(SettingsFileVersion) (version.asOutParam())); if (version != formatVersion) { isGlobalConverted = true; CHECK_RC_BREAK (virtualBox-> COMGETTER(SettingsFilePath) (filePath.asOutParam())); fileList.push_back (Utf8StrFmt ("%ls (%ls)", filePath.raw(), version.raw())); } if (fileList.size() > 0) { switch (fConvertSettings) { case ConvertSettings_No: { RTPrintf ( "WARNING! The following VirtualBox settings files have been automatically\n" "converted to the new settings file format version '%ls':\n" "\n", formatVersion.raw()); for (std::list ::const_iterator f = fileList.begin(); f != fileList.end(); ++ f) RTPrintf (" %S\n", (*f).raw()); RTPrintf ( "\n" "The current command was aborted to prevent overwriting the above settings\n" "files with the results of the auto-conversion without your permission.\n" "Please put one of the following command line switches to the beginning of\n" "the VBoxManage command line and repeat the command:\n" "\n" " -convertSettings - to save all auto-converted files (it will not\n" " be possible to use these settings files with an\n" " older version of VirtualBox in the future);\n" " -convertSettingsBackup - to create backup copies of the settings files in\n" " the old format before saving them in the new format;\n" " -convertSettingsIgnore - to not save the auto-converted settings files.\n" "\n" "Note that if you use -convertSettingsIgnore, the auto-converted settings files\n" "will be implicitly saved in the new format anyway once you change a setting or\n" "start a virtual machine, but NO backup copies will be created in this case.\n"); return false; } case ConvertSettings_Yes: case ConvertSettings_Backup: { break; } default: AssertFailedReturn (false); } for (std::list >::const_iterator m = cvtMachines.begin(); m != cvtMachines.end(); ++ m) { Guid id; CHECK_RC_BREAK ((*m)->COMGETTER(Id) (id.asOutParam())); /* open a session for the VM */ CHECK_ERROR_BREAK (virtualBox, OpenSession (session, id)); ComPtr sm; CHECK_RC_BREAK (session->COMGETTER(Machine) (sm.asOutParam())); Bstr bakFileName; if (fConvertSettings == ConvertSettings_Backup) CHECK_ERROR (sm, SaveSettingsWithBackup (bakFileName.asOutParam())); else CHECK_ERROR (sm, SaveSettings()); session->Close(); CHECK_RC_BREAK (rc); } CHECK_RC_BREAK (rc); if (isGlobalConverted) { Bstr bakFileName; if (fConvertSettings == ConvertSettings_Backup) CHECK_ERROR (virtualBox, SaveSettingsWithBackup (bakFileName.asOutParam())); else CHECK_ERROR (virtualBox, SaveSettings()); } CHECK_RC_BREAK (rc); } } while (0); return SUCCEEDED (rc); } #endif /* !VBOX_ONLY_DOCS */ // main /////////////////////////////////////////////////////////////////////////////// int main(int argc, char *argv[]) { /* * Before we do anything, init the runtime without loading * the support driver. */ RTR3Init(); bool fShowLogo = true; int iCmd = 1; int iCmdArg; ConvertSettings fConvertSettings = ConvertSettings_No; /* global options */ for (int i = 1; i < argc || argc <= iCmd; i++) { if ( argc <= iCmd || (strcmp(argv[i], "help") == 0) || (strcmp(argv[i], "-?") == 0) || (strcmp(argv[i], "-h") == 0) || (strcmp(argv[i], "-help") == 0) || (strcmp(argv[i], "--help") == 0)) { showLogo(); printUsage(USAGE_ALL); return 0; } else if ( strcmp(argv[i], "-v") == 0 || strcmp(argv[i], "-version") == 0 || strcmp(argv[i], "-Version") == 0 || strcmp(argv[i], "--version") == 0) { /* Print version number, and do nothing else. */ RTPrintf("%sr%d\n", VBOX_VERSION_STRING, VBoxSVNRev ()); exit(0); } else if (strcmp(argv[i], "-dumpopts") == 0) { /* Special option to dump really all commands, * even the ones not understood on this platform. */ printUsage(USAGE_DUMPOPTS); return 0; } else if (strcmp(argv[i], "-nologo") == 0) { /* suppress the logo */ fShowLogo = false; iCmd++; } else if (strcmp(argv[i], "-convertSettings") == 0) { fConvertSettings = ConvertSettings_Yes; iCmd++; } else if (strcmp(argv[i], "-convertSettingsBackup") == 0) { fConvertSettings = ConvertSettings_Backup; iCmd++; } else if (strcmp(argv[i], "-convertSettingsIgnore") == 0) { fConvertSettings = ConvertSettings_Ignore; iCmd++; } else { break; } } iCmdArg = iCmd + 1; if (fShowLogo) showLogo(); #ifdef VBOX_ONLY_DOCS int rc = 0; #else /* !VBOX_ONLY_DOCS */ HRESULT rc = 0; CHECK_RC_RET (com::Initialize()); /* * The input is in the host OS'es codepage (NT guarantees ACP). * For VBox we use UTF-8 and convert to UCS-2 when calling (XP)COM APIs. * For simplicity, just convert the argv[] array here. */ for (int i = iCmdArg; i < argc; i++) { char *converted; RTStrCurrentCPToUtf8(&converted, argv[i]); argv[i] = converted; } do { // scopes all the stuff till shutdown //////////////////////////////////////////////////////////////////////////// /* convertdd: does not need a VirtualBox instantiation) */ if (argc >= iCmdArg && (strcmp(argv[iCmd], "convertdd") == 0)) { rc = handleConvertDDImage(argc - iCmdArg, argv + iCmdArg); break; } ComPtr virtualBox; ComPtr session; rc = virtualBox.createLocalObject (CLSID_VirtualBox); if (FAILED(rc)) { RTPrintf ("[!] Failed to create the VirtualBox object!\n"); PRINT_RC_MESSAGE (rc); com::ErrorInfo info; if (!info.isFullAvailable() && !info.isBasicAvailable()) RTPrintf ("[!] Most likely, the VirtualBox COM server is not running " "or failed to start.\n"); else PRINT_ERROR_INFO (info); break; } CHECK_RC_BREAK (session.createInprocObject (CLSID_Session)); /* create the event queue * (here it is necessary only to process remaining XPCOM/IPC events * after the session is closed) */ EventQueue eventQ; if (!checkForAutoConvertedSettings (virtualBox, session, fConvertSettings)) break; /* * All registered command handlers */ struct { const char *command; PFNHANDLER handler; } commandHandlers[] = { { "internalcommands", handleInternalCommands }, { "list", handleList }, { "showvminfo", handleShowVMInfo }, { "registervm", handleRegisterVM }, { "unregistervm", handleUnregisterVM }, { "createhd", handleCreateHardDisk }, { "createvdi", handleCreateHardDisk }, /* backward compatiblity */ { "modifyhd", handleModifyHardDisk }, { "modifyvdi", handleModifyHardDisk }, /* backward compatiblity */ { "addiscsidisk", handleAddiSCSIDisk }, { "createvm", handleCreateVM }, { "modifyvm", handleModifyVM }, { "clonehd", handleCloneHardDisk }, { "clonevdi", handleCloneHardDisk }, /* backward compatiblity */ { "startvm", handleStartVM }, { "controlvm", handleControlVM }, { "discardstate", handleDiscardState }, { "adoptstate", handleAdoptdState }, { "snapshot", handleSnapshot }, { "openmedium", handleOpenMedium }, { "registerimage", handleOpenMedium }, /* backward compatiblity */ { "closemedium", handleCloseMedium }, { "unregisterimage", handleCloseMedium }, /* backward compatiblity */ { "showhdinfo", handleShowHardDiskInfo }, { "showvdiinfo", handleShowHardDiskInfo }, /* backward compatiblity */ #ifdef RT_OS_WINDOWS { "createhostif", handleCreateHostIF }, { "removehostif", handleRemoveHostIF }, #endif { "getextradata", handleGetExtraData }, { "setextradata", handleSetExtraData }, { "setproperty", handleSetProperty }, { "usbfilter", handleUSBFilter }, { "sharedfolder", handleSharedFolder }, { "vmstatistics", handleVMStatistics }, #ifdef VBOX_WITH_GUEST_PROPS { "guestproperty", handleGuestProperty }, #endif /* VBOX_WITH_GUEST_PROPS defined */ { "metrics", handleMetrics }, { NULL, NULL } }; int commandIndex; for (commandIndex = 0; commandHandlers[commandIndex].command != NULL; commandIndex++) { if (strcmp(commandHandlers[commandIndex].command, argv[iCmd]) == 0) { rc = commandHandlers[commandIndex].handler(argc - iCmdArg, &argv[iCmdArg], virtualBox, session); break; } } if (!commandHandlers[commandIndex].command) { rc = errorSyntax(USAGE_ALL, "Invalid command '%s'", Utf8Str(argv[iCmd]).raw()); } /* Although all handlers should always close the session if they open it, * we do it here just in case if some of the handlers contains a bug -- * leaving the direct session not closed will turn the machine state to * Aborted which may have unwanted side effects like killing the saved * state file (if the machine was in the Saved state before). */ session->Close(); // end "all-stuff" scope //////////////////////////////////////////////////////////////////////////// } while (0); com::Shutdown(); #endif /* !VBOX_ONLY_DOCS */ /* * Free converted argument vector */ for (int i = iCmdArg; i < argc; i++) RTStrFree(argv[i]); return rc != 0; }