VirtualBox

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

Last change on this file since 59381 was 56349, checked in by vboxsync, 10 years ago

VBoxManage: Let main() set the current command and made 'VBoxManage help extpack' work.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.7 KB
Line 
1/* $Id: VBoxManage.h 56349 2015-06-10 23:38:30Z vboxsync $ */
2/** @file
3 * VBoxManage - VirtualBox command-line interface, internal header file.
4 */
5
6/*
7 * Copyright (C) 2006-2015 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#include <iprt/getopt.h>
33
34#ifndef VBOX_ONLY_DOCS
35# include "VBoxManageBuiltInHelp.h"
36#endif
37
38
39////////////////////////////////////////////////////////////////////////////////
40//
41// definitions
42//
43////////////////////////////////////////////////////////////////////////////////
44
45/** @name Syntax diagram category.
46 * @{ */
47#define USAGE_DUMPOPTS 0
48#define USAGE_LIST RT_BIT_64(0)
49#define USAGE_SHOWVMINFO RT_BIT_64(1)
50#define USAGE_REGISTERVM RT_BIT_64(2)
51#define USAGE_UNREGISTERVM RT_BIT_64(3)
52#define USAGE_CREATEVM RT_BIT_64(4)
53#define USAGE_MODIFYVM RT_BIT_64(5)
54#define USAGE_CLONEVM RT_BIT_64(6)
55#define USAGE_STARTVM RT_BIT_64(7)
56#define USAGE_CONTROLVM RT_BIT_64(8)
57#define USAGE_DISCARDSTATE RT_BIT_64(9)
58#define USAGE_SNAPSHOT RT_BIT_64(10)
59#define USAGE_CLOSEMEDIUM RT_BIT_64(11)
60#define USAGE_SHOWMEDIUMINFO RT_BIT_64(12)
61#define USAGE_CREATEMEDIUM RT_BIT_64(13)
62#define USAGE_MODIFYMEDIUM RT_BIT_64(14)
63#define USAGE_CLONEMEDIUM RT_BIT_64(15)
64#define USAGE_CREATEHOSTIF RT_BIT_64(17)
65#define USAGE_REMOVEHOSTIF RT_BIT_64(18)
66#define USAGE_GETEXTRADATA RT_BIT_64(19)
67#define USAGE_SETEXTRADATA RT_BIT_64(20)
68#define USAGE_SETPROPERTY RT_BIT_64(21)
69#define USAGE_USBFILTER (RT_BIT_64(22) | RT_BIT_64(23) | RT_BIT_64(24))
70#define USAGE_USBFILTER_ADD RT_BIT_64(22)
71#define USAGE_USBFILTER_MODIFY RT_BIT_64(23)
72#define USAGE_USBFILTER_REMOVE RT_BIT_64(24)
73#define USAGE_SHAREDFOLDER (RT_BIT_64(25) | RT_BIT_64(26))
74#define USAGE_SHAREDFOLDER_ADD RT_BIT_64(25)
75#define USAGE_SHAREDFOLDER_REMOVE RT_BIT_64(26)
76#define USAGE_LOADSYMS RT_BIT_64(29)
77#define USAGE_LOADMAP RT_BIT_64(30)
78#define USAGE_SETHDUUID RT_BIT_64(31)
79#define USAGE_CONVERTFROMRAW RT_BIT_64(32)
80#define USAGE_LISTPARTITIONS RT_BIT_64(33)
81#define USAGE_CREATERAWVMDK RT_BIT_64(34)
82#define USAGE_DEBUGVM RT_BIT_64(35)
83#define USAGE_ADOPTSTATE RT_BIT_64(36)
84#define USAGE_MODINSTALL RT_BIT_64(37)
85#define USAGE_MODUNINSTALL RT_BIT_64(38)
86#define USAGE_RENAMEVMDK RT_BIT_64(39)
87#ifdef VBOX_WITH_GUEST_PROPS
88# define USAGE_GUESTPROPERTY RT_BIT_64(40)
89#endif /* VBOX_WITH_GUEST_PROPS defined */
90#define USAGE_CONVERTTORAW RT_BIT_64(41)
91#define USAGE_METRICS RT_BIT_64(42)
92#define USAGE_CONVERTHD RT_BIT_64(43)
93#define USAGE_IMPORTAPPLIANCE RT_BIT_64(44)
94#define USAGE_EXPORTAPPLIANCE RT_BIT_64(45)
95#define USAGE_HOSTONLYIFS RT_BIT_64(46)
96#define USAGE_DHCPSERVER RT_BIT_64(47)
97#define USAGE_DUMPHDINFO RT_BIT_64(48)
98#define USAGE_STORAGEATTACH RT_BIT_64(49)
99#define USAGE_STORAGECONTROLLER RT_BIT_64(50)
100#ifdef VBOX_WITH_GUEST_CONTROL
101# define USAGE_GUESTCONTROL RT_BIT_64(51)
102#endif /* VBOX_WITH_GUEST_CONTROL defined */
103#define USAGE_DEBUGLOG RT_BIT_64(52)
104#define USAGE_SETHDPARENTUUID RT_BIT_64(53)
105#define USAGE_PASSWORDHASH RT_BIT_64(54)
106#define USAGE_EXTPACK RT_BIT_64(55)
107#define USAGE_BANDWIDTHCONTROL RT_BIT_64(56)
108#define USAGE_GUESTSTATS RT_BIT_64(57)
109#define USAGE_REPAIRHD RT_BIT_64(58)
110#define USAGE_NATNETWORK RT_BIT_64(59)
111#define USAGE_MEDIUMPROPERTY RT_BIT_64(60)
112#define USAGE_ENCRYPTMEDIUM RT_BIT_64(61)
113#define USAGE_MEDIUMENCCHKPWD RT_BIT_64(62)
114#define USAGE_ALL (~(uint64_t)0)
115/** @} */
116
117#ifdef VBOX_WITH_GUEST_CONTROL
118# define USAGE_GSTCTRL_RUN RT_BIT(0)
119# define USAGE_GSTCTRL_START RT_BIT(1)
120# define USAGE_GSTCTRL_COPYFROM RT_BIT(2)
121# define USAGE_GSTCTRL_COPYTO RT_BIT(3)
122# define USAGE_GSTCTRL_MKDIR RT_BIT(4)
123# define USAGE_GSTCTRL_RMDIR RT_BIT(5)
124# define USAGE_GSTCTRL_RM RT_BIT(6)
125# define USAGE_GSTCTRL_MV RT_BIT(7)
126# define USAGE_GSTCTRL_MKTEMP RT_BIT(8)
127# define USAGE_GSTCTRL_LIST RT_BIT(9)
128# define USAGE_GSTCTRL_CLOSEPROCESS RT_BIT(10)
129# define USAGE_GSTCTRL_CLOSESESSION RT_BIT(11)
130# define USAGE_GSTCTRL_STAT RT_BIT(12)
131# define USAGE_GSTCTRL_UPDATEGA RT_BIT(13)
132# define USAGE_GSTCTRL_WATCH RT_BIT(14)
133#endif
134
135typedef uint64_t USAGECATEGORY;
136
137/** command handler argument */
138struct HandlerArg
139{
140 int argc;
141 char **argv;
142
143#ifndef VBOX_ONLY_DOCS
144 ComPtr<IVirtualBox> virtualBox;
145 ComPtr<ISession> session;
146#endif
147};
148
149/** flag whether we're in internal mode */
150extern bool g_fInternalMode;
151
152/** showVMInfo details */
153typedef enum
154{
155 VMINFO_NONE = 0,
156 VMINFO_STANDARD = 1, /**< standard details */
157 VMINFO_FULL = 2, /**< both */
158 VMINFO_MACHINEREADABLE = 3, /**< both, and make it machine readable */
159 VMINFO_COMPACT = 4
160} VMINFO_DETAILS;
161
162
163////////////////////////////////////////////////////////////////////////////////
164//
165// global variables
166//
167////////////////////////////////////////////////////////////////////////////////
168
169extern bool g_fDetailedProgress; // in VBoxManage.cpp
170
171
172////////////////////////////////////////////////////////////////////////////////
173//
174// prototypes
175//
176////////////////////////////////////////////////////////////////////////////////
177
178/* VBoxManageHelp.cpp */
179void printUsage(USAGECATEGORY fCategory, uint32_t fSubCategory, PRTSTREAM pStrm);
180RTEXITCODE errorSyntax(USAGECATEGORY fCategory, const char *pszFormat, ...);
181RTEXITCODE errorSyntaxEx(USAGECATEGORY fCategory, uint32_t fSubCategory, const char *pszFormat, ...);
182RTEXITCODE errorGetOpt(USAGECATEGORY fCategory, int rc, union RTGETOPTUNION const *pValueUnion);
183RTEXITCODE errorGetOptEx(USAGECATEGORY fCategory, uint32_t fSubCategory, int rc, union RTGETOPTUNION const *pValueUnion);
184RTEXITCODE errorArgument(const char *pszFormat, ...);
185
186void printUsageInternal(USAGECATEGORY fCategory, PRTSTREAM pStrm);
187
188#ifndef VBOX_ONLY_DOCS
189void setCurrentCommand(enum HELP_CMD_VBOXMANAGE enmCommand);
190void setCurrentSubcommand(uint64_t fCurSubcommandScope);
191
192void printUsage(PRTSTREAM pStrm);
193void printHelp(PRTSTREAM pStrm);
194RTEXITCODE errorNoSubcommand(void);
195RTEXITCODE errorUnknownSubcommand(const char *pszSubCmd);
196RTEXITCODE errorTooManyParameters(char **papszArgs);
197RTEXITCODE errorGetOpt(int rcGetOpt, union RTGETOPTUNION const *pValueUnion);
198RTEXITCODE errorSyntax(const char *pszFormat, ...);
199
200HRESULT showProgress(ComPtr<IProgress> progress);
201#endif
202
203/* VBoxManage.cpp */
204void showLogo(PRTSTREAM pStrm);
205
206#ifndef VBOX_ONLY_DOCS
207RTEXITCODE readPasswordFile(const char *pszFilename, com::Utf8Str *pPasswd);
208RTEXITCODE readPasswordFromConsole(com::Utf8Str *pPassword, const char *pszPrompt, ...);
209
210RTEXITCODE handleInternalCommands(HandlerArg *a);
211#endif /* !VBOX_ONLY_DOCS */
212
213/* VBoxManageControlVM.cpp */
214RTEXITCODE handleControlVM(HandlerArg *a);
215#ifndef VBOX_ONLY_DOCS
216unsigned int getMaxNics(IVirtualBox* vbox, IMachine* mach);
217#endif
218
219/* VBoxManageModifyVM.cpp */
220#ifndef VBOX_ONLY_DOCS
221void parseGroups(const char *pcszGroups, com::SafeArray<BSTR> *pGroups);
222#endif
223RTEXITCODE handleModifyVM(HandlerArg *a);
224
225/* VBoxManageDebugVM.cpp */
226RTEXITCODE handleDebugVM(HandlerArg *a);
227
228/* VBoxManageGuestProp.cpp */
229extern void usageGuestProperty(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2);
230
231/* VBoxManageGuestCtrl.cpp */
232extern void usageGuestControl(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2, uint32_t fSubCategory);
233
234#ifndef VBOX_ONLY_DOCS
235/* VBoxManageGuestProp.cpp */
236RTEXITCODE handleGuestProperty(HandlerArg *a);
237
238/* VBoxManageGuestCtrl.cpp */
239RTEXITCODE handleGuestControl(HandlerArg *a);
240
241/* VBoxManageVMInfo.cpp */
242HRESULT showSnapshots(ComPtr<ISnapshot> &rootSnapshot,
243 ComPtr<ISnapshot> &currentSnapshot,
244 VMINFO_DETAILS details,
245 const com::Utf8Str &prefix = "",
246 int level = 0);
247RTEXITCODE handleShowVMInfo(HandlerArg *a);
248HRESULT showVMInfo(ComPtr<IVirtualBox> pVirtualBox,
249 ComPtr<IMachine> pMachine,
250 ComPtr<ISession> pSession,
251 VMINFO_DETAILS details = VMINFO_NONE);
252const char *machineStateToName(MachineState_T machineState, bool fShort);
253HRESULT showBandwidthGroups(ComPtr<IBandwidthControl> &bwCtrl,
254 VMINFO_DETAILS details);
255
256/* VBoxManageList.cpp */
257RTEXITCODE handleList(HandlerArg *a);
258
259/* VBoxManageMetrics.cpp */
260RTEXITCODE handleMetrics(HandlerArg *a);
261
262/* VBoxManageMisc.cpp */
263RTEXITCODE handleRegisterVM(HandlerArg *a);
264RTEXITCODE handleUnregisterVM(HandlerArg *a);
265RTEXITCODE handleCreateVM(HandlerArg *a);
266RTEXITCODE handleCloneVM(HandlerArg *a);
267RTEXITCODE handleStartVM(HandlerArg *a);
268RTEXITCODE handleDiscardState(HandlerArg *a);
269RTEXITCODE handleAdoptState(HandlerArg *a);
270RTEXITCODE handleGetExtraData(HandlerArg *a);
271RTEXITCODE handleSetExtraData(HandlerArg *a);
272RTEXITCODE handleSetProperty(HandlerArg *a);
273RTEXITCODE handleSharedFolder(HandlerArg *a);
274RTEXITCODE handleExtPack(HandlerArg *a);
275
276/* VBoxManageDisk.cpp */
277HRESULT openMedium(HandlerArg *a, const char *pszFilenameOrUuid,
278 DeviceType_T enmDevType, AccessMode_T enmAccessMode,
279 ComPtr<IMedium> &pMedium, bool fForceNewUuidOnOpen,
280 bool fSilent);
281RTEXITCODE handleCreateMedium(HandlerArg *a);
282RTEXITCODE handleModifyMedium(HandlerArg *a);
283RTEXITCODE handleCloneMedium(HandlerArg *a);
284RTEXITCODE handleMediumProperty(HandlerArg *a);
285RTEXITCODE handleEncryptMedium(HandlerArg *a);
286RTEXITCODE handleCheckMediumPassword(HandlerArg *a);
287RTEXITCODE handleConvertFromRaw(HandlerArg *a);
288HRESULT showMediumInfo(const ComPtr<IVirtualBox> &pVirtualBox,
289 const ComPtr<IMedium> &pMedium,
290 const char *pszParentUUID,
291 bool fOptLong);
292RTEXITCODE handleShowMediumInfo(HandlerArg *a);
293RTEXITCODE handleCloseMedium(HandlerArg *a);
294int parseMediumType(const char *psz, MediumType_T *penmMediumType);
295int parseBool(const char *psz, bool *pb);
296
297/* VBoxManageStorageController.cpp */
298RTEXITCODE handleStorageAttach(HandlerArg *a);
299RTEXITCODE handleStorageController(HandlerArg *a);
300
301// VBoxManageImport.cpp
302RTEXITCODE handleImportAppliance(HandlerArg *a);
303RTEXITCODE handleExportAppliance(HandlerArg *a);
304
305// VBoxManageSnapshot.cpp
306RTEXITCODE handleSnapshot(HandlerArg *a);
307
308/* VBoxManageUSB.cpp */
309RTEXITCODE handleUSBFilter(HandlerArg *a);
310
311/* VBoxManageHostonly.cpp */
312RTEXITCODE handleHostonlyIf(HandlerArg *a);
313
314/* VBoxManageDHCPServer.cpp */
315RTEXITCODE handleDHCPServer(HandlerArg *a);
316
317/* VBoxManageNATNetwork.cpp */
318RTEXITCODE handleNATNetwork(HandlerArg *a);
319
320
321/* VBoxManageBandwidthControl.cpp */
322RTEXITCODE handleBandwidthControl(HandlerArg *a);
323
324#endif /* !VBOX_ONLY_DOCS */
325
326#endif /* !___H_VBOXMANAGE */
327
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