VirtualBox

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

Last change on this file since 37900 was 37525, checked in by vboxsync, 13 years ago

Main/VirtualBox+Medium: resurrect the feature of changing the medium UUID when opening the image, which allows to resolve duplicate UUIDs without using external tools. Also fixes Medium::setIDs, which wasn't correctly working.
Frontends/*: corresponding changes.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.9 KB
Line 
1/* $Id: VBoxManage.h 37525 2011-06-17 10:09:21Z vboxsync $ */
2/** @file
3 * VBoxManage - VirtualBox command-line interface, internal header file.
4 */
5
6/*
7 * Copyright (C) 2006-2011 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#endif /* !VBOX_ONLY_DOCS */
27
28#include <iprt/types.h>
29#include <iprt/message.h>
30#include <iprt/stream.h>
31
32////////////////////////////////////////////////////////////////////////////////
33//
34// definitions
35//
36////////////////////////////////////////////////////////////////////////////////
37
38/** @name Syntax diagram category.
39 * @{ */
40#define USAGE_DUMPOPTS 0
41#define USAGE_LIST RT_BIT_64(0)
42#define USAGE_SHOWVMINFO RT_BIT_64(1)
43#define USAGE_REGISTERVM RT_BIT_64(2)
44#define USAGE_UNREGISTERVM RT_BIT_64(3)
45#define USAGE_CREATEVM RT_BIT_64(4)
46#define USAGE_MODIFYVM RT_BIT_64(5)
47#define USAGE_CLONEVM RT_BIT_64(6)
48#define USAGE_STARTVM RT_BIT_64(7)
49#define USAGE_CONTROLVM RT_BIT_64(8)
50#define USAGE_DISCARDSTATE RT_BIT_64(9)
51#define USAGE_SNAPSHOT RT_BIT_64(10)
52#define USAGE_CLOSEMEDIUM RT_BIT_64(11)
53#define USAGE_SHOWHDINFO RT_BIT_64(12)
54#define USAGE_CREATEHD RT_BIT_64(13)
55#define USAGE_MODIFYHD RT_BIT_64(14)
56#define USAGE_CLONEHD RT_BIT_64(15)
57#define USAGE_CREATEHOSTIF RT_BIT_64(17)
58#define USAGE_REMOVEHOSTIF RT_BIT_64(18)
59#define USAGE_GETEXTRADATA RT_BIT_64(19)
60#define USAGE_SETEXTRADATA RT_BIT_64(20)
61#define USAGE_SETPROPERTY RT_BIT_64(21)
62#define USAGE_USBFILTER (RT_BIT_64(22) | RT_BIT_64(23) | RT_BIT_64(24))
63#define USAGE_USBFILTER_ADD RT_BIT_64(22)
64#define USAGE_USBFILTER_MODIFY RT_BIT_64(23)
65#define USAGE_USBFILTER_REMOVE RT_BIT_64(24)
66#define USAGE_SHAREDFOLDER (RT_BIT_64(25) | RT_BIT_64(26))
67#define USAGE_SHAREDFOLDER_ADD RT_BIT_64(25)
68#define USAGE_SHAREDFOLDER_REMOVE RT_BIT_64(26)
69#define USAGE_LOADSYMS RT_BIT_64(29)
70#define USAGE_UNLOADSYMS RT_BIT_64(30)
71#define USAGE_SETHDUUID RT_BIT_64(31)
72#define USAGE_CONVERTFROMRAW RT_BIT_64(32)
73#define USAGE_LISTPARTITIONS RT_BIT_64(33)
74#define USAGE_CREATERAWVMDK RT_BIT_64(34)
75#define USAGE_DEBUGVM RT_BIT_64(35)
76#define USAGE_ADOPTSTATE RT_BIT_64(36)
77#define USAGE_MODINSTALL RT_BIT_64(37)
78#define USAGE_MODUNINSTALL RT_BIT_64(38)
79#define USAGE_RENAMEVMDK RT_BIT_64(39)
80#ifdef VBOX_WITH_GUEST_PROPS
81# define USAGE_GUESTPROPERTY RT_BIT_64(40)
82#endif /* VBOX_WITH_GUEST_PROPS defined */
83#define USAGE_CONVERTTORAW RT_BIT_64(41)
84#define USAGE_METRICS RT_BIT_64(42)
85#define USAGE_CONVERTHD RT_BIT_64(43)
86#define USAGE_IMPORTAPPLIANCE RT_BIT_64(44)
87#define USAGE_EXPORTAPPLIANCE RT_BIT_64(45)
88#define USAGE_HOSTONLYIFS RT_BIT_64(46)
89#define USAGE_DHCPSERVER RT_BIT_64(47)
90#define USAGE_DUMPHDINFO RT_BIT_64(48)
91#define USAGE_STORAGEATTACH RT_BIT_64(49)
92#define USAGE_STORAGECONTROLLER RT_BIT_64(50)
93#ifdef VBOX_WITH_GUEST_CONTROL
94# define USAGE_GUESTCONTROL RT_BIT_64(51)
95#endif /* VBOX_WITH_GUEST_CONTROL defined */
96#define USAGE_DEBUGLOG RT_BIT_64(52)
97#define USAGE_SETHDPARENTUUID RT_BIT_64(53)
98#define USAGE_PASSWORDHASH RT_BIT_64(54)
99#define USAGE_EXTPACK RT_BIT_64(55)
100#define USAGE_BANDWIDTHCONTROL RT_BIT_64(56)
101#define USAGE_GUESTSTATS RT_BIT_64(57)
102#define USAGE_ALL (~(uint64_t)0)
103/** @} */
104
105typedef uint64_t USAGECATEGORY;
106
107/** command handler argument */
108struct HandlerArg
109{
110 int argc;
111 char **argv;
112
113#ifndef VBOX_ONLY_DOCS
114 ComPtr<IVirtualBox> virtualBox;
115 ComPtr<ISession> session;
116#endif
117};
118
119/** flag whether we're in internal mode */
120extern bool g_fInternalMode;
121
122/** showVMInfo details */
123typedef enum
124{
125 VMINFO_NONE = 0,
126 VMINFO_STANDARD = 1, /**< standard details */
127 VMINFO_FULL = 2, /**< both */
128 VMINFO_MACHINEREADABLE = 3, /**< both, and make it machine readable */
129 VMINFO_COMPACT = 4
130} VMINFO_DETAILS;
131
132////////////////////////////////////////////////////////////////////////////////
133//
134// global variables
135//
136////////////////////////////////////////////////////////////////////////////////
137
138extern bool g_fDetailedProgress; // in VBoxManage.cpp
139
140////////////////////////////////////////////////////////////////////////////////
141//
142// prototypes
143//
144////////////////////////////////////////////////////////////////////////////////
145
146/* VBoxManageHelp.cpp */
147void printUsage(USAGECATEGORY u64Cmd, PRTSTREAM pStrm);
148RTEXITCODE errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...);
149RTEXITCODE errorGetOpt(USAGECATEGORY u64Cmd, int rc, union RTGETOPTUNION const *pValueUnion);
150RTEXITCODE errorArgument(const char *pszFormat, ...);
151
152void printUsageInternal(USAGECATEGORY u64Cmd, PRTSTREAM pStrm);
153
154#ifndef VBOX_ONLY_DOCS
155HRESULT showProgress(ComPtr<IProgress> progress);
156#endif
157
158/* VBoxManage.cpp */
159void showLogo(PRTSTREAM pStrm);
160
161#ifndef VBOX_ONLY_DOCS
162int handleInternalCommands(HandlerArg *a);
163#endif /* !VBOX_ONLY_DOCS */
164
165/* VBoxManageControlVM.cpp */
166int handleControlVM(HandlerArg *a);
167#ifndef VBOX_ONLY_DOCS
168unsigned int getMaxNics(IVirtualBox* vbox, IMachine* mach);
169#endif
170
171/* VBoxManageModifyVM.cpp */
172int handleModifyVM(HandlerArg *a);
173
174/* VBoxManageDebugVM.cpp */
175int handleDebugVM(HandlerArg *a);
176
177/* VBoxManageGuestProp.cpp */
178extern void usageGuestProperty(PRTSTREAM pStrm);
179
180/* VBoxManageGuestCtrl.cpp */
181extern void usageGuestControl(PRTSTREAM pStrm);
182
183#ifndef VBOX_ONLY_DOCS
184/* VBoxManageGuestProp.cpp */
185extern int handleGuestProperty(HandlerArg *a);
186
187/* VBoxManageGuestCtrl.cpp */
188extern int handleGuestControl(HandlerArg *a);
189
190/* VBoxManageVMInfo.cpp */
191void showSnapshots(ComPtr<ISnapshot> &rootSnapshot,
192 ComPtr<ISnapshot> &currentSnapshot,
193 VMINFO_DETAILS details,
194 const com::Bstr &prefix = "",
195 int level = 0);
196int handleShowVMInfo(HandlerArg *a);
197HRESULT showVMInfo(ComPtr<IVirtualBox> virtualBox,
198 ComPtr<IMachine> machine,
199 VMINFO_DETAILS details = VMINFO_NONE,
200 ComPtr <IConsole> console = ComPtr<IConsole>());
201const char *machineStateToName(MachineState_T machineState, bool fShort);
202
203/* VBoxManageList.cpp */
204int handleList(HandlerArg *a);
205
206/* VBoxManageMetrics.cpp */
207int handleMetrics(HandlerArg *a);
208
209/* VBoxManageMisc.cpp */
210int handleRegisterVM(HandlerArg *a);
211int handleUnregisterVM(HandlerArg *a);
212int handleCreateVM(HandlerArg *a);
213int handleCloneVM(HandlerArg *a);
214int handleStartVM(HandlerArg *a);
215int handleDiscardState(HandlerArg *a);
216int handleAdoptState(HandlerArg *a);
217int handleGetExtraData(HandlerArg *a);
218int handleSetExtraData(HandlerArg *a);
219int handleSetProperty(HandlerArg *a);
220int handleSharedFolder(HandlerArg *a);
221int handleExtPack(HandlerArg *a);
222
223/* VBoxManageDisk.cpp */
224HRESULT findMedium(HandlerArg *a, const char *pszFilenameOrUuid,
225 DeviceType_T enmDevType, bool fSilent,
226 ComPtr<IMedium> &pMedium);
227HRESULT findOrOpenMedium(HandlerArg *a, const char *pszFilenameOrUuid,
228 DeviceType_T enmDevType, ComPtr<IMedium> &pMedium,
229 bool fForceNewUuidOnOpen, bool *pfWasUnknown);
230int handleCreateHardDisk(HandlerArg *a);
231int handleModifyHardDisk(HandlerArg *a);
232int handleCloneHardDisk(HandlerArg *a);
233RTEXITCODE handleConvertFromRaw(int argc, char *argv[]);
234int handleShowHardDiskInfo(HandlerArg *a);
235int handleCloseMedium(HandlerArg *a);
236int parseDiskType(const char *psz, MediumType_T *pDiskType);
237
238/* VBoxManageStorageController.cpp */
239int handleStorageAttach(HandlerArg *a);
240int handleStorageController(HandlerArg *a);
241
242// VBoxManageImport.cpp
243int handleImportAppliance(HandlerArg *a);
244int handleExportAppliance(HandlerArg *a);
245
246// VBoxManageSnapshot.cpp
247int handleSnapshot(HandlerArg *a);
248
249/* VBoxManageUSB.cpp */
250int handleUSBFilter(HandlerArg *a);
251
252/* VBoxManageHostonly.cpp */
253int handleHostonlyIf(HandlerArg *a);
254
255/* VBoxManageHostonly.cpp */
256int handleDHCPServer(HandlerArg *a);
257
258/* VBoxManageBandwidthControl.cpp */
259int handleBandwidthControl(HandlerArg *a);
260
261#endif /* !VBOX_ONLY_DOCS */
262
263#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