VBoxManage.h revision 44f5fc51fcc90d4791f27f98ab3252b8fda92205
/* $Id$ */
/** @file
* VBoxManage - VirtualBox command-line interface, internal header file.
*/
/*
* 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.
*/
#ifndef ___H_VBOXMANAGE
#define ___H_VBOXMANAGE
#ifndef VBOX_ONLY_DOCS
#include <VBox/com/com.h>
#include <VBox/com/ptr.h>
#include <VBox/com/VirtualBox.h>
#include <VBox/com/EventQueue.h>
#include <VBox/com/string.h>
#endif /* !VBOX_ONLY_DOCS */
#include <iprt/types.h>
#if defined(VBOX_WITH_XPCOM) && !defined(RT_OS_DARWIN) && !defined(RT_OS_OS2)
# define USE_XPCOM_QUEUE
#endif
/** @name Syntax diagram category.
* @{ */
#define USAGE_DUMPOPTS 0
#define USAGE_LIST RT_BIT_64(0)
#define USAGE_SHOWVMINFO RT_BIT_64(1)
#define USAGE_REGISTERVM RT_BIT_64(2)
#define USAGE_UNREGISTERVM RT_BIT_64(3)
#define USAGE_CREATEVM RT_BIT_64(4)
#define USAGE_MODIFYVM RT_BIT_64(5)
#define USAGE_STARTVM RT_BIT_64(6)
#define USAGE_CONTROLVM RT_BIT_64(7)
#define USAGE_DISCARDSTATE RT_BIT_64(8)
#define USAGE_SNAPSHOT RT_BIT_64(9)
#define USAGE_REGISTERIMAGE RT_BIT_64(10)
#define USAGE_UNREGISTERIMAGE RT_BIT_64(11)
#define USAGE_SHOWHDINFO RT_BIT_64(12)
#define USAGE_CREATEHD RT_BIT_64(13)
#define USAGE_MODIFYHD RT_BIT_64(14)
#define USAGE_CLONEHD RT_BIT_64(15)
#define USAGE_ADDISCSIDISK RT_BIT_64(16)
#define USAGE_CREATEHOSTIF RT_BIT_64(17)
#define USAGE_REMOVEHOSTIF RT_BIT_64(18)
#define USAGE_GETEXTRADATA RT_BIT_64(19)
#define USAGE_SETEXTRADATA RT_BIT_64(20)
#define USAGE_SETPROPERTY RT_BIT_64(21)
#define USAGE_USBFILTER (RT_BIT_64(22) | RT_BIT_64(23) | RT_BIT_64(24))
#define USAGE_USBFILTER_ADD RT_BIT_64(22)
#define USAGE_USBFILTER_MODIFY RT_BIT_64(23)
#define USAGE_USBFILTER_REMOVE RT_BIT_64(24)
#define USAGE_SHAREDFOLDER (RT_BIT_64(25) | RT_BIT_64(26))
#define USAGE_SHAREDFOLDER_ADD RT_BIT_64(25)
#define USAGE_SHAREDFOLDER_REMOVE RT_BIT_64(26)
#define USAGE_LOADSYMS RT_BIT_64(29)
#define USAGE_UNLOADSYMS RT_BIT_64(30)
#define USAGE_SETHDUUID RT_BIT_64(31)
#define USAGE_CONVERTFROMRAW RT_BIT_64(32)
#define USAGE_LISTPARTITIONS RT_BIT_64(33)
#define USAGE_CREATERAWVMDK RT_BIT_64(34)
#define USAGE_VM_STATISTICS RT_BIT_64(35)
#define USAGE_ADOPTSTATE RT_BIT_64(36)
#define USAGE_MODINSTALL RT_BIT_64(37)
#define USAGE_MODUNINSTALL RT_BIT_64(38)
#define USAGE_RENAMEVMDK RT_BIT_64(39)
#ifdef VBOX_WITH_GUEST_PROPS
#define USAGE_GUESTPROPERTY RT_BIT_64(40)
#endif /* VBOX_WITH_GUEST_PROPS defined */
#define USAGE_CONVERTTORAW RT_BIT_64(41)
#define USAGE_METRICS RT_BIT_64(42)
#define USAGE_CONVERTHD RT_BIT_64(43)
#define USAGE_IMPORTAPPLIANCE RT_BIT_64(44)
#define USAGE_EXPORTAPPLIANCE RT_BIT_64(45)
#define USAGE_ALL (~(uint64_t)0)
/** @} */
typedef uint64_t USAGECATEGORY;
/** command handler argument */
struct HandlerArg
{
int argc;
char **argv;
#ifdef USE_XPCOM_QUEUE
nsCOMPtr<nsIEventQueue> eventQ;
#endif
#ifndef VBOX_ONLY_DOCS
ComPtr<IVirtualBox> virtualBox;
ComPtr<ISession> session;
#endif
};
/** flag whether we're in internal mode */
extern bool g_fInternalMode;
/** showVMInfo details */
typedef enum
{
VMINFO_NONE = 0,
VMINFO_STANDARD = 1, /**< standard details */
VMINFO_STATISTICS = 2, /**< guest statistics */
VMINFO_FULL = 3, /**< both */
VMINFO_MACHINEREADABLE = 4, /**< both, and make it machine readable */
VMINFO_COMPACT = 5
} VMINFO_DETAILS;
/*
* Prototypes
*/
/* VBoxManageHelp.cpp */
void printUsage(USAGECATEGORY u64Cmd);
int errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...);
int errorArgument(const char *pszFormat, ...);
void printUsageInternal(USAGECATEGORY u64Cmd);
#ifndef VBOX_ONLY_DOCS
void showProgress(ComPtr<IProgress> progress);
#endif
/* VBoxManage.cpp */
void showLogo(void);
#ifndef VBOX_ONLY_DOCS
int handleInternalCommands(HandlerArg *a);
unsigned parseNum(const char *psz, unsigned cMaxNum, const char *name);
#endif /* !VBOX_ONLY_DOCS */
/* VBoxManageModifyVM.cpp */
int handleModifyVM(HandlerArg *a);
/* VBoxManageGuestProp.cpp */
extern void usageGuestProperty(void);
#ifndef VBOX_ONLY_DOCS
extern int handleGuestProperty(HandlerArg *a);
/* VBoxManageVMInfo.cpp */
void showSnapshots(ComPtr<ISnapshot> rootSnapshot, VMINFO_DETAILS details, const com::Bstr &prefix = "", int level = 0);
int handleShowVMInfo(HandlerArg *a);
HRESULT showVMInfo(ComPtr<IVirtualBox> virtualBox,
ComPtr<IMachine> machine,
VMINFO_DETAILS details = VMINFO_NONE,
ComPtr <IConsole> console = ComPtr<IConsole>());
/* VBoxManageList.cpp */
int handleList(HandlerArg *a);
/* VBoxManageMetrics.cpp */
int handleMetrics(HandlerArg *a);
/* VBoxManageDisk.cpp */
int handleCreateHardDisk(HandlerArg *a);
int handleModifyHardDisk(HandlerArg *a);
int handleCloneHardDisk(HandlerArg *a);
int handleConvertFromRaw(int argc, char *argv[]);
int handleAddiSCSIDisk(HandlerArg *a);
int handleShowHardDiskInfo(HandlerArg *a);
int handleOpenMedium(HandlerArg *a);
int handleCloseMedium(HandlerArg *a);
// VBoxManageImport.cpp
int handleImportAppliance(HandlerArg *a);
int handleExportAppliance(HandlerArg *a);
// VBoxManageSnapshot.cpp
int handleSnapshot(HandlerArg *a);
/* VBoxManageUSB.cpp */
int handleUSBFilter(HandlerArg *a);
/* VBoxManageHostonly.cpp */
int handleHostonlyIf(HandlerArg *a);
#endif /* !VBOX_ONLY_DOCS */
unsigned long VBoxSVNRev();
#endif /* !___H_VBOXMANAGE */