VirtualBox

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

Last change on this file since 55118 was 54885, checked in by vboxsync, 10 years ago

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