VirtualBox

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

Last change on this file since 69018 was 68140, checked in by vboxsync, 7 years ago

VBoxManage/unattended: Do the sub-command thing, moving the current operation to 'install' and adding a 'detect' sub-command for probing an ISO. Moved documentation to man_VBoxManage-unattended.xml (lots to do here).
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.9 KB
Line 
1/* $Id: VBoxManage.h 68140 2017-07-27 15:16:23Z vboxsync $ */
2/** @file
3 * VBoxManage - VirtualBox command-line interface, internal header file.
4 */
5
6/*
7 * Copyright (C) 2006-2016 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
136#define USAGE_UNATTENDEDINSTALL RT_BIT(27)
137
138typedef uint64_t USAGECATEGORY;
139
140/** command handler argument */
141struct HandlerArg
142{
143 int argc;
144 char **argv;
145
146#ifndef VBOX_ONLY_DOCS
147 ComPtr<IVirtualBox> virtualBox;
148 ComPtr<ISession> session;
149#endif
150};
151
152/** flag whether we're in internal mode */
153extern bool g_fInternalMode;
154
155/** showVMInfo details */
156typedef enum
157{
158 VMINFO_NONE = 0,
159 VMINFO_STANDARD = 1, /**< standard details */
160 VMINFO_FULL = 2, /**< both */
161 VMINFO_MACHINEREADABLE = 3, /**< both, and make it machine readable */
162 VMINFO_COMPACT = 4
163} VMINFO_DETAILS;
164
165
166////////////////////////////////////////////////////////////////////////////////
167//
168// global variables
169//
170////////////////////////////////////////////////////////////////////////////////
171
172extern bool g_fDetailedProgress; // in VBoxManage.cpp
173
174
175////////////////////////////////////////////////////////////////////////////////
176//
177// prototypes
178//
179////////////////////////////////////////////////////////////////////////////////
180
181/* VBoxManageHelp.cpp */
182void printUsage(USAGECATEGORY fCategory, uint32_t fSubCategory, PRTSTREAM pStrm);
183RTEXITCODE errorSyntax(USAGECATEGORY fCategory, const char *pszFormat, ...);
184RTEXITCODE errorSyntaxEx(USAGECATEGORY fCategory, uint32_t fSubCategory, const char *pszFormat, ...);
185RTEXITCODE errorGetOpt(USAGECATEGORY fCategory, int rc, union RTGETOPTUNION const *pValueUnion);
186RTEXITCODE errorGetOptEx(USAGECATEGORY fCategory, uint32_t fSubCategory, int rc, union RTGETOPTUNION const *pValueUnion);
187RTEXITCODE errorArgument(const char *pszFormat, ...);
188
189void printUsageInternal(USAGECATEGORY fCategory, PRTSTREAM pStrm);
190
191#ifndef VBOX_ONLY_DOCS
192void setCurrentCommand(enum HELP_CMD_VBOXMANAGE enmCommand);
193void setCurrentSubcommand(uint64_t fCurSubcommandScope);
194
195void printUsage(PRTSTREAM pStrm);
196void printHelp(PRTSTREAM pStrm);
197RTEXITCODE errorNoSubcommand(void);
198RTEXITCODE errorUnknownSubcommand(const char *pszSubCmd);
199RTEXITCODE errorTooManyParameters(char **papszArgs);
200RTEXITCODE errorGetOpt(int rcGetOpt, union RTGETOPTUNION const *pValueUnion);
201RTEXITCODE errorSyntax(const char *pszFormat, ...);
202
203HRESULT showProgress(ComPtr<IProgress> progress);
204#endif
205
206/* VBoxManage.cpp */
207void showLogo(PRTSTREAM pStrm);
208
209#ifndef VBOX_ONLY_DOCS
210RTEXITCODE readPasswordFile(const char *pszFilename, com::Utf8Str *pPasswd);
211RTEXITCODE readPasswordFromConsole(com::Utf8Str *pPassword, const char *pszPrompt, ...);
212
213RTEXITCODE handleInternalCommands(HandlerArg *a);
214#endif /* !VBOX_ONLY_DOCS */
215
216/* VBoxManageControlVM.cpp */
217RTEXITCODE handleControlVM(HandlerArg *a);
218#ifndef VBOX_ONLY_DOCS
219unsigned int getMaxNics(IVirtualBox* vbox, IMachine* mach);
220#endif
221
222/* VBoxManageModifyVM.cpp */
223#ifndef VBOX_ONLY_DOCS
224void parseGroups(const char *pcszGroups, com::SafeArray<BSTR> *pGroups);
225#endif
226RTEXITCODE handleModifyVM(HandlerArg *a);
227
228/* VBoxManageDebugVM.cpp */
229RTEXITCODE handleDebugVM(HandlerArg *a);
230
231/* VBoxManageGuestProp.cpp */
232extern void usageGuestProperty(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2);
233
234/* VBoxManageGuestCtrl.cpp */
235extern void usageGuestControl(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2, uint32_t fSubCategory);
236
237#ifndef VBOX_ONLY_DOCS
238/* VBoxManageGuestProp.cpp */
239RTEXITCODE handleGuestProperty(HandlerArg *a);
240
241/* VBoxManageGuestCtrl.cpp */
242RTEXITCODE handleGuestControl(HandlerArg *a);
243
244/* VBoxManageVMInfo.cpp */
245HRESULT showSnapshots(ComPtr<ISnapshot> &rootSnapshot,
246 ComPtr<ISnapshot> &currentSnapshot,
247 VMINFO_DETAILS details,
248 const com::Utf8Str &prefix = "",
249 int level = 0);
250RTEXITCODE handleShowVMInfo(HandlerArg *a);
251HRESULT showVMInfo(ComPtr<IVirtualBox> pVirtualBox,
252 ComPtr<IMachine> pMachine,
253 ComPtr<ISession> pSession,
254 VMINFO_DETAILS details = VMINFO_NONE);
255const char *machineStateToName(MachineState_T machineState, bool fShort);
256HRESULT showBandwidthGroups(ComPtr<IBandwidthControl> &bwCtrl,
257 VMINFO_DETAILS details);
258
259/* VBoxManageList.cpp */
260RTEXITCODE handleList(HandlerArg *a);
261
262/* VBoxManageMetrics.cpp */
263RTEXITCODE handleMetrics(HandlerArg *a);
264
265/* VBoxManageMisc.cpp */
266RTEXITCODE handleRegisterVM(HandlerArg *a);
267RTEXITCODE handleUnregisterVM(HandlerArg *a);
268RTEXITCODE handleCreateVM(HandlerArg *a);
269RTEXITCODE handleCloneVM(HandlerArg *a);
270RTEXITCODE handleStartVM(HandlerArg *a);
271RTEXITCODE handleDiscardState(HandlerArg *a);
272RTEXITCODE handleAdoptState(HandlerArg *a);
273RTEXITCODE handleGetExtraData(HandlerArg *a);
274RTEXITCODE handleSetExtraData(HandlerArg *a);
275RTEXITCODE handleSetProperty(HandlerArg *a);
276RTEXITCODE handleSharedFolder(HandlerArg *a);
277RTEXITCODE handleExtPack(HandlerArg *a);
278RTEXITCODE handleUnattended(HandlerArg *a);
279
280/* VBoxManageDisk.cpp */
281HRESULT openMedium(HandlerArg *a, const char *pszFilenameOrUuid,
282 DeviceType_T enmDevType, AccessMode_T enmAccessMode,
283 ComPtr<IMedium> &pMedium, bool fForceNewUuidOnOpen,
284 bool fSilent);
285RTEXITCODE handleCreateMedium(HandlerArg *a);
286RTEXITCODE handleModifyMedium(HandlerArg *a);
287RTEXITCODE handleCloneMedium(HandlerArg *a);
288RTEXITCODE handleMediumProperty(HandlerArg *a);
289RTEXITCODE handleEncryptMedium(HandlerArg *a);
290RTEXITCODE handleCheckMediumPassword(HandlerArg *a);
291RTEXITCODE handleConvertFromRaw(HandlerArg *a);
292HRESULT showMediumInfo(const ComPtr<IVirtualBox> &pVirtualBox,
293 const ComPtr<IMedium> &pMedium,
294 const char *pszParentUUID,
295 bool fOptLong);
296RTEXITCODE handleShowMediumInfo(HandlerArg *a);
297RTEXITCODE handleCloseMedium(HandlerArg *a);
298int parseMediumType(const char *psz, MediumType_T *penmMediumType);
299int parseBool(const char *psz, bool *pb);
300
301/* VBoxManageStorageController.cpp */
302RTEXITCODE handleStorageAttach(HandlerArg *a);
303RTEXITCODE handleStorageController(HandlerArg *a);
304
305// VBoxManageImport.cpp
306RTEXITCODE handleImportAppliance(HandlerArg *a);
307RTEXITCODE handleExportAppliance(HandlerArg *a);
308
309// VBoxManageSnapshot.cpp
310RTEXITCODE handleSnapshot(HandlerArg *a);
311
312/* VBoxManageUSB.cpp */
313RTEXITCODE handleUSBFilter(HandlerArg *a);
314RTEXITCODE handleUSBDevSource(HandlerArg *a);
315
316/* VBoxManageHostonly.cpp */
317RTEXITCODE handleHostonlyIf(HandlerArg *a);
318
319/* VBoxManageDHCPServer.cpp */
320RTEXITCODE handleDHCPServer(HandlerArg *a);
321
322/* VBoxManageNATNetwork.cpp */
323RTEXITCODE handleNATNetwork(HandlerArg *a);
324
325
326/* VBoxManageBandwidthControl.cpp */
327RTEXITCODE handleBandwidthControl(HandlerArg *a);
328
329#endif /* !VBOX_ONLY_DOCS */
330
331#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