VirtualBox

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

Last change on this file since 61864 was 60089, checked in by vboxsync, 9 years ago

Main,VBoxManage: Add API to IHost for adding and removing USB device sources in addition to the default host one (only USB/IP backend supported so far which will be used in the future for automatic USB testing). Add support for it in VBoxManage
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.8 KB
Line 
1/* $Id: VBoxManage.h 60089 2016-03-18 10:51:02Z 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_USBDEVSOURCE RT_BIT_64(63)
115#define USAGE_ALL (~(uint64_t)0)
116/** @} */
117
118#ifdef VBOX_WITH_GUEST_CONTROL
119# define USAGE_GSTCTRL_RUN RT_BIT(0)
120# define USAGE_GSTCTRL_START RT_BIT(1)
121# define USAGE_GSTCTRL_COPYFROM RT_BIT(2)
122# define USAGE_GSTCTRL_COPYTO RT_BIT(3)
123# define USAGE_GSTCTRL_MKDIR RT_BIT(4)
124# define USAGE_GSTCTRL_RMDIR RT_BIT(5)
125# define USAGE_GSTCTRL_RM RT_BIT(6)
126# define USAGE_GSTCTRL_MV RT_BIT(7)
127# define USAGE_GSTCTRL_MKTEMP RT_BIT(8)
128# define USAGE_GSTCTRL_LIST RT_BIT(9)
129# define USAGE_GSTCTRL_CLOSEPROCESS RT_BIT(10)
130# define USAGE_GSTCTRL_CLOSESESSION RT_BIT(11)
131# define USAGE_GSTCTRL_STAT RT_BIT(12)
132# define USAGE_GSTCTRL_UPDATEGA RT_BIT(13)
133# define USAGE_GSTCTRL_WATCH RT_BIT(14)
134#endif
135
136typedef uint64_t USAGECATEGORY;
137
138/** command handler argument */
139struct HandlerArg
140{
141 int argc;
142 char **argv;
143
144#ifndef VBOX_ONLY_DOCS
145 ComPtr<IVirtualBox> virtualBox;
146 ComPtr<ISession> session;
147#endif
148};
149
150/** flag whether we're in internal mode */
151extern bool g_fInternalMode;
152
153/** showVMInfo details */
154typedef enum
155{
156 VMINFO_NONE = 0,
157 VMINFO_STANDARD = 1, /**< standard details */
158 VMINFO_FULL = 2, /**< both */
159 VMINFO_MACHINEREADABLE = 3, /**< both, and make it machine readable */
160 VMINFO_COMPACT = 4
161} VMINFO_DETAILS;
162
163
164////////////////////////////////////////////////////////////////////////////////
165//
166// global variables
167//
168////////////////////////////////////////////////////////////////////////////////
169
170extern bool g_fDetailedProgress; // in VBoxManage.cpp
171
172
173////////////////////////////////////////////////////////////////////////////////
174//
175// prototypes
176//
177////////////////////////////////////////////////////////////////////////////////
178
179/* VBoxManageHelp.cpp */
180void printUsage(USAGECATEGORY fCategory, uint32_t fSubCategory, PRTSTREAM pStrm);
181RTEXITCODE errorSyntax(USAGECATEGORY fCategory, const char *pszFormat, ...);
182RTEXITCODE errorSyntaxEx(USAGECATEGORY fCategory, uint32_t fSubCategory, const char *pszFormat, ...);
183RTEXITCODE errorGetOpt(USAGECATEGORY fCategory, int rc, union RTGETOPTUNION const *pValueUnion);
184RTEXITCODE errorGetOptEx(USAGECATEGORY fCategory, uint32_t fSubCategory, int rc, union RTGETOPTUNION const *pValueUnion);
185RTEXITCODE errorArgument(const char *pszFormat, ...);
186
187void printUsageInternal(USAGECATEGORY fCategory, PRTSTREAM pStrm);
188
189#ifndef VBOX_ONLY_DOCS
190void setCurrentCommand(enum HELP_CMD_VBOXMANAGE enmCommand);
191void setCurrentSubcommand(uint64_t fCurSubcommandScope);
192
193void printUsage(PRTSTREAM pStrm);
194void printHelp(PRTSTREAM pStrm);
195RTEXITCODE errorNoSubcommand(void);
196RTEXITCODE errorUnknownSubcommand(const char *pszSubCmd);
197RTEXITCODE errorTooManyParameters(char **papszArgs);
198RTEXITCODE errorGetOpt(int rcGetOpt, union RTGETOPTUNION const *pValueUnion);
199RTEXITCODE errorSyntax(const char *pszFormat, ...);
200
201HRESULT showProgress(ComPtr<IProgress> progress);
202#endif
203
204/* VBoxManage.cpp */
205void showLogo(PRTSTREAM pStrm);
206
207#ifndef VBOX_ONLY_DOCS
208RTEXITCODE readPasswordFile(const char *pszFilename, com::Utf8Str *pPasswd);
209RTEXITCODE readPasswordFromConsole(com::Utf8Str *pPassword, const char *pszPrompt, ...);
210
211RTEXITCODE handleInternalCommands(HandlerArg *a);
212#endif /* !VBOX_ONLY_DOCS */
213
214/* VBoxManageControlVM.cpp */
215RTEXITCODE handleControlVM(HandlerArg *a);
216#ifndef VBOX_ONLY_DOCS
217unsigned int getMaxNics(IVirtualBox* vbox, IMachine* mach);
218#endif
219
220/* VBoxManageModifyVM.cpp */
221#ifndef VBOX_ONLY_DOCS
222void parseGroups(const char *pcszGroups, com::SafeArray<BSTR> *pGroups);
223#endif
224RTEXITCODE handleModifyVM(HandlerArg *a);
225
226/* VBoxManageDebugVM.cpp */
227RTEXITCODE handleDebugVM(HandlerArg *a);
228
229/* VBoxManageGuestProp.cpp */
230extern void usageGuestProperty(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2);
231
232/* VBoxManageGuestCtrl.cpp */
233extern void usageGuestControl(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2, uint32_t fSubCategory);
234
235#ifndef VBOX_ONLY_DOCS
236/* VBoxManageGuestProp.cpp */
237RTEXITCODE handleGuestProperty(HandlerArg *a);
238
239/* VBoxManageGuestCtrl.cpp */
240RTEXITCODE handleGuestControl(HandlerArg *a);
241
242/* VBoxManageVMInfo.cpp */
243HRESULT showSnapshots(ComPtr<ISnapshot> &rootSnapshot,
244 ComPtr<ISnapshot> &currentSnapshot,
245 VMINFO_DETAILS details,
246 const com::Utf8Str &prefix = "",
247 int level = 0);
248RTEXITCODE handleShowVMInfo(HandlerArg *a);
249HRESULT showVMInfo(ComPtr<IVirtualBox> pVirtualBox,
250 ComPtr<IMachine> pMachine,
251 ComPtr<ISession> pSession,
252 VMINFO_DETAILS details = VMINFO_NONE);
253const char *machineStateToName(MachineState_T machineState, bool fShort);
254HRESULT showBandwidthGroups(ComPtr<IBandwidthControl> &bwCtrl,
255 VMINFO_DETAILS details);
256
257/* VBoxManageList.cpp */
258RTEXITCODE handleList(HandlerArg *a);
259
260/* VBoxManageMetrics.cpp */
261RTEXITCODE handleMetrics(HandlerArg *a);
262
263/* VBoxManageMisc.cpp */
264RTEXITCODE handleRegisterVM(HandlerArg *a);
265RTEXITCODE handleUnregisterVM(HandlerArg *a);
266RTEXITCODE handleCreateVM(HandlerArg *a);
267RTEXITCODE handleCloneVM(HandlerArg *a);
268RTEXITCODE handleStartVM(HandlerArg *a);
269RTEXITCODE handleDiscardState(HandlerArg *a);
270RTEXITCODE handleAdoptState(HandlerArg *a);
271RTEXITCODE handleGetExtraData(HandlerArg *a);
272RTEXITCODE handleSetExtraData(HandlerArg *a);
273RTEXITCODE handleSetProperty(HandlerArg *a);
274RTEXITCODE handleSharedFolder(HandlerArg *a);
275RTEXITCODE handleExtPack(HandlerArg *a);
276
277/* VBoxManageDisk.cpp */
278HRESULT openMedium(HandlerArg *a, const char *pszFilenameOrUuid,
279 DeviceType_T enmDevType, AccessMode_T enmAccessMode,
280 ComPtr<IMedium> &pMedium, bool fForceNewUuidOnOpen,
281 bool fSilent);
282RTEXITCODE handleCreateMedium(HandlerArg *a);
283RTEXITCODE handleModifyMedium(HandlerArg *a);
284RTEXITCODE handleCloneMedium(HandlerArg *a);
285RTEXITCODE handleMediumProperty(HandlerArg *a);
286RTEXITCODE handleEncryptMedium(HandlerArg *a);
287RTEXITCODE handleCheckMediumPassword(HandlerArg *a);
288RTEXITCODE handleConvertFromRaw(HandlerArg *a);
289HRESULT showMediumInfo(const ComPtr<IVirtualBox> &pVirtualBox,
290 const ComPtr<IMedium> &pMedium,
291 const char *pszParentUUID,
292 bool fOptLong);
293RTEXITCODE handleShowMediumInfo(HandlerArg *a);
294RTEXITCODE handleCloseMedium(HandlerArg *a);
295int parseMediumType(const char *psz, MediumType_T *penmMediumType);
296int parseBool(const char *psz, bool *pb);
297
298/* VBoxManageStorageController.cpp */
299RTEXITCODE handleStorageAttach(HandlerArg *a);
300RTEXITCODE handleStorageController(HandlerArg *a);
301
302// VBoxManageImport.cpp
303RTEXITCODE handleImportAppliance(HandlerArg *a);
304RTEXITCODE handleExportAppliance(HandlerArg *a);
305
306// VBoxManageSnapshot.cpp
307RTEXITCODE handleSnapshot(HandlerArg *a);
308
309/* VBoxManageUSB.cpp */
310RTEXITCODE handleUSBFilter(HandlerArg *a);
311RTEXITCODE handleUSBDevSource(HandlerArg *a);
312
313/* VBoxManageHostonly.cpp */
314RTEXITCODE handleHostonlyIf(HandlerArg *a);
315
316/* VBoxManageDHCPServer.cpp */
317RTEXITCODE handleDHCPServer(HandlerArg *a);
318
319/* VBoxManageNATNetwork.cpp */
320RTEXITCODE handleNATNetwork(HandlerArg *a);
321
322
323/* VBoxManageBandwidthControl.cpp */
324RTEXITCODE handleBandwidthControl(HandlerArg *a);
325
326#endif /* !VBOX_ONLY_DOCS */
327
328#endif /* !___H_VBOXMANAGE */
329
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