VirtualBox

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

Last change on this file since 74942 was 72949, checked in by vboxsync, 6 years ago

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

© 2023 Oracle
Contact – Privacy policy – Terms of Use