VirtualBox

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

Last change on this file since 43421 was 42460, checked in by vboxsync, 12 years ago

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

© 2023 Oracle
Contact – Privacy policy – Terms of Use