VirtualBox

source: vbox/trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h@ 36784

Last change on this file since 36784 was 36067, checked in by vboxsync, 14 years ago

VBoxManage: added internal command gueststats
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.8 KB
Line 
1/* $Id: VBoxManage.h 36067 2011-02-24 09:10:09Z vboxsync $ */
2/** @file
3 * VBoxManage - VirtualBox command-line interface, internal header file.
4 */
5
6/*
7 * Copyright (C) 2006-2010 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#ifndef ___H_VBOXMANAGE
19#define ___H_VBOXMANAGE
20
21#ifndef VBOX_ONLY_DOCS
22#include <VBox/com/com.h>
23#include <VBox/com/ptr.h>
24#include <VBox/com/VirtualBox.h>
25#include <VBox/com/string.h>
26#endif /* !VBOX_ONLY_DOCS */
27
28#include <iprt/types.h>
29#include <iprt/message.h>
30#include <iprt/stream.h>
31
32////////////////////////////////////////////////////////////////////////////////
33//
34// definitions
35//
36////////////////////////////////////////////////////////////////////////////////
37
38/** @name Syntax diagram category.
39 * @{ */
40#define USAGE_DUMPOPTS 0
41#define USAGE_LIST RT_BIT_64(0)
42#define USAGE_SHOWVMINFO RT_BIT_64(1)
43#define USAGE_REGISTERVM RT_BIT_64(2)
44#define USAGE_UNREGISTERVM RT_BIT_64(3)
45#define USAGE_CREATEVM RT_BIT_64(4)
46#define USAGE_MODIFYVM RT_BIT_64(5)
47#define USAGE_STARTVM RT_BIT_64(6)
48#define USAGE_CONTROLVM RT_BIT_64(7)
49#define USAGE_DISCARDSTATE RT_BIT_64(8)
50#define USAGE_SNAPSHOT RT_BIT_64(9)
51#define USAGE_CLOSEMEDIUM RT_BIT_64(11)
52#define USAGE_SHOWHDINFO RT_BIT_64(12)
53#define USAGE_CREATEHD RT_BIT_64(13)
54#define USAGE_MODIFYHD RT_BIT_64(14)
55#define USAGE_CLONEHD RT_BIT_64(15)
56#define USAGE_CREATEHOSTIF RT_BIT_64(17)
57#define USAGE_REMOVEHOSTIF RT_BIT_64(18)
58#define USAGE_GETEXTRADATA RT_BIT_64(19)
59#define USAGE_SETEXTRADATA RT_BIT_64(20)
60#define USAGE_SETPROPERTY RT_BIT_64(21)
61#define USAGE_USBFILTER (RT_BIT_64(22) | RT_BIT_64(23) | RT_BIT_64(24))
62#define USAGE_USBFILTER_ADD RT_BIT_64(22)
63#define USAGE_USBFILTER_MODIFY RT_BIT_64(23)
64#define USAGE_USBFILTER_REMOVE RT_BIT_64(24)
65#define USAGE_SHAREDFOLDER (RT_BIT_64(25) | RT_BIT_64(26))
66#define USAGE_SHAREDFOLDER_ADD RT_BIT_64(25)
67#define USAGE_SHAREDFOLDER_REMOVE RT_BIT_64(26)
68#define USAGE_LOADSYMS RT_BIT_64(29)
69#define USAGE_UNLOADSYMS RT_BIT_64(30)
70#define USAGE_SETHDUUID RT_BIT_64(31)
71#define USAGE_CONVERTFROMRAW RT_BIT_64(32)
72#define USAGE_LISTPARTITIONS RT_BIT_64(33)
73#define USAGE_CREATERAWVMDK RT_BIT_64(34)
74#define USAGE_DEBUGVM RT_BIT_64(35)
75#define USAGE_ADOPTSTATE RT_BIT_64(36)
76#define USAGE_MODINSTALL RT_BIT_64(37)
77#define USAGE_MODUNINSTALL RT_BIT_64(38)
78#define USAGE_RENAMEVMDK RT_BIT_64(39)
79#ifdef VBOX_WITH_GUEST_PROPS
80# define USAGE_GUESTPROPERTY RT_BIT_64(40)
81#endif /* VBOX_WITH_GUEST_PROPS defined */
82#define USAGE_CONVERTTORAW RT_BIT_64(41)
83#define USAGE_METRICS RT_BIT_64(42)
84#define USAGE_CONVERTHD RT_BIT_64(43)
85#define USAGE_IMPORTAPPLIANCE RT_BIT_64(44)
86#define USAGE_EXPORTAPPLIANCE RT_BIT_64(45)
87#define USAGE_HOSTONLYIFS RT_BIT_64(46)
88#define USAGE_DHCPSERVER RT_BIT_64(47)
89#define USAGE_DUMPHDINFO RT_BIT_64(48)
90#define USAGE_STORAGEATTACH RT_BIT_64(49)
91#define USAGE_STORAGECONTROLLER RT_BIT_64(50)
92#ifdef VBOX_WITH_GUEST_CONTROL
93# define USAGE_GUESTCONTROL RT_BIT_64(51)
94#endif /* VBOX_WITH_GUEST_CONTROL defined */
95#define USAGE_DEBUGLOG RT_BIT_64(52)
96#define USAGE_SETHDPARENTUUID RT_BIT_64(53)
97#define USAGE_PASSWORDHASH RT_BIT_64(54)
98#define USAGE_EXTPACK RT_BIT_64(55)
99#define USAGE_BANDWIDTHCONTROL RT_BIT_64(56)
100#define USAGE_GUESTSTATS RT_BIT_64(57)
101#define USAGE_ALL (~(uint64_t)0)
102/** @} */
103
104typedef uint64_t USAGECATEGORY;
105
106/** command handler argument */
107struct HandlerArg
108{
109 int argc;
110 char **argv;
111
112#ifndef VBOX_ONLY_DOCS
113 ComPtr<IVirtualBox> virtualBox;
114 ComPtr<ISession> session;
115#endif
116};
117
118/** flag whether we're in internal mode */
119extern bool g_fInternalMode;
120
121/** showVMInfo details */
122typedef enum
123{
124 VMINFO_NONE = 0,
125 VMINFO_STANDARD = 1, /**< standard details */
126 VMINFO_FULL = 2, /**< both */
127 VMINFO_MACHINEREADABLE = 3, /**< both, and make it machine readable */
128 VMINFO_COMPACT = 4
129} VMINFO_DETAILS;
130
131////////////////////////////////////////////////////////////////////////////////
132//
133// global variables
134//
135////////////////////////////////////////////////////////////////////////////////
136
137extern bool g_fDetailedProgress; // in VBoxManage.cpp
138
139////////////////////////////////////////////////////////////////////////////////
140//
141// prototypes
142//
143////////////////////////////////////////////////////////////////////////////////
144
145/* VBoxManageHelp.cpp */
146void printUsage(USAGECATEGORY u64Cmd, PRTSTREAM pStrm);
147RTEXITCODE errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...);
148RTEXITCODE errorGetOpt(USAGECATEGORY u64Cmd, int rc, union RTGETOPTUNION const *pValueUnion);
149RTEXITCODE errorArgument(const char *pszFormat, ...);
150
151void printUsageInternal(USAGECATEGORY u64Cmd, PRTSTREAM pStrm);
152
153#ifndef VBOX_ONLY_DOCS
154HRESULT showProgress(ComPtr<IProgress> progress);
155#endif
156
157/* VBoxManage.cpp */
158void showLogo(PRTSTREAM pStrm);
159
160#ifndef VBOX_ONLY_DOCS
161int handleInternalCommands(HandlerArg *a);
162#endif /* !VBOX_ONLY_DOCS */
163
164/* VBoxManageControlVM.cpp */
165int handleControlVM(HandlerArg *a);
166#ifndef VBOX_ONLY_DOCS
167unsigned int getMaxNics(IVirtualBox* vbox, IMachine* mach);
168#endif
169
170/* VBoxManageModifyVM.cpp */
171int handleModifyVM(HandlerArg *a);
172
173/* VBoxManageDebugVM.cpp */
174int handleDebugVM(HandlerArg *a);
175
176/* VBoxManageGuestProp.cpp */
177extern void usageGuestProperty(PRTSTREAM pStrm);
178
179/* VBoxManageGuestCtrl.cpp */
180extern void usageGuestControl(PRTSTREAM pStrm);
181
182#ifndef VBOX_ONLY_DOCS
183/* VBoxManageGuestProp.cpp */
184extern int handleGuestProperty(HandlerArg *a);
185
186/* VBoxManageGuestCtrl.cpp */
187extern int handleGuestControl(HandlerArg *a);
188
189/* VBoxManageVMInfo.cpp */
190void showSnapshots(ComPtr<ISnapshot> &rootSnapshot,
191 ComPtr<ISnapshot> &currentSnapshot,
192 VMINFO_DETAILS details,
193 const com::Bstr &prefix = "",
194 int level = 0);
195int handleShowVMInfo(HandlerArg *a);
196HRESULT showVMInfo(ComPtr<IVirtualBox> virtualBox,
197 ComPtr<IMachine> machine,
198 VMINFO_DETAILS details = VMINFO_NONE,
199 ComPtr <IConsole> console = ComPtr<IConsole>());
200const char *machineStateToName(MachineState_T machineState, bool fShort);
201
202/* VBoxManageList.cpp */
203int handleList(HandlerArg *a);
204
205/* VBoxManageMetrics.cpp */
206int handleMetrics(HandlerArg *a);
207
208/* VBoxManageMisc.cpp */
209int handleRegisterVM(HandlerArg *a);
210int handleUnregisterVM(HandlerArg *a);
211int handleCreateVM(HandlerArg *a);
212int handleStartVM(HandlerArg *a);
213int handleDiscardState(HandlerArg *a);
214int handleAdoptState(HandlerArg *a);
215int handleGetExtraData(HandlerArg *a);
216int handleSetExtraData(HandlerArg *a);
217int handleSetProperty(HandlerArg *a);
218int handleSharedFolder(HandlerArg *a);
219int handleExtPack(HandlerArg *a);
220
221/* VBoxManageDisk.cpp */
222HRESULT findMedium(HandlerArg *a, const char *pszFilenameOrUuid,
223 DeviceType_T enmDevType, bool fSilent,
224 ComPtr<IMedium> &pMedium);
225HRESULT findOrOpenMedium(HandlerArg *a, const char *pszFilenameOrUuid,
226 DeviceType_T enmDevType, ComPtr<IMedium> &pMedium,
227 bool *pfWasUnknown);
228int handleCreateHardDisk(HandlerArg *a);
229int handleModifyHardDisk(HandlerArg *a);
230int handleCloneHardDisk(HandlerArg *a);
231RTEXITCODE handleConvertFromRaw(int argc, char *argv[]);
232int handleShowHardDiskInfo(HandlerArg *a);
233int handleCloseMedium(HandlerArg *a);
234int parseDiskType(const char *psz, MediumType_T *pDiskType);
235
236/* VBoxManageStorageController.cpp */
237int handleStorageAttach(HandlerArg *a);
238int handleStorageController(HandlerArg *a);
239
240// VBoxManageImport.cpp
241int handleImportAppliance(HandlerArg *a);
242int handleExportAppliance(HandlerArg *a);
243
244// VBoxManageSnapshot.cpp
245int handleSnapshot(HandlerArg *a);
246
247/* VBoxManageUSB.cpp */
248int handleUSBFilter(HandlerArg *a);
249
250/* VBoxManageHostonly.cpp */
251int handleHostonlyIf(HandlerArg *a);
252
253/* VBoxManageHostonly.cpp */
254int handleDHCPServer(HandlerArg *a);
255
256/* VBoxManageBandwidthControl.cpp */
257int handleBandwidthControl(HandlerArg *a);
258
259#endif /* !VBOX_ONLY_DOCS */
260
261#endif /* !___H_VBOXMANAGE */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette