VirtualBox

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

Last change on this file since 25275 was 24907, checked in by vboxsync, 14 years ago

VBoxManage: A little clean up in progress.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.8 KB
Line 
1/* $Id: VBoxManage.h 24907 2009-11-24 14:22:47Z vboxsync $ */
2/** @file
3 * VBoxManage - VirtualBox command-line interface, internal header file.
4 */
5
6/*
7 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
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 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18 * Clara, CA 95054 USA or visit http://www.sun.com if you need
19 * additional information or have any questions.
20 */
21
22#ifndef ___H_VBOXMANAGE
23#define ___H_VBOXMANAGE
24
25#ifndef VBOX_ONLY_DOCS
26#include <VBox/com/com.h>
27#include <VBox/com/ptr.h>
28#include <VBox/com/VirtualBox.h>
29#include <VBox/com/string.h>
30#endif /* !VBOX_ONLY_DOCS */
31
32#include <iprt/types.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_STARTVM RT_BIT_64(6)
50#define USAGE_CONTROLVM RT_BIT_64(7)
51#define USAGE_DISCARDSTATE RT_BIT_64(8)
52#define USAGE_SNAPSHOT RT_BIT_64(9)
53#define USAGE_OPENMEDIUM RT_BIT_64(10)
54#define USAGE_CLOSEMEDIUM RT_BIT_64(11)
55#define USAGE_SHOWHDINFO RT_BIT_64(12)
56#define USAGE_CREATEHD RT_BIT_64(13)
57#define USAGE_MODIFYHD RT_BIT_64(14)
58#define USAGE_CLONEHD RT_BIT_64(15)
59#define USAGE_ADDISCSIDISK RT_BIT_64(16)
60#define USAGE_CREATEHOSTIF RT_BIT_64(17)
61#define USAGE_REMOVEHOSTIF RT_BIT_64(18)
62#define USAGE_GETEXTRADATA RT_BIT_64(19)
63#define USAGE_SETEXTRADATA RT_BIT_64(20)
64#define USAGE_SETPROPERTY RT_BIT_64(21)
65#define USAGE_USBFILTER (RT_BIT_64(22) | RT_BIT_64(23) | RT_BIT_64(24))
66#define USAGE_USBFILTER_ADD RT_BIT_64(22)
67#define USAGE_USBFILTER_MODIFY RT_BIT_64(23)
68#define USAGE_USBFILTER_REMOVE RT_BIT_64(24)
69#define USAGE_SHAREDFOLDER (RT_BIT_64(25) | RT_BIT_64(26))
70#define USAGE_SHAREDFOLDER_ADD RT_BIT_64(25)
71#define USAGE_SHAREDFOLDER_REMOVE RT_BIT_64(26)
72#define USAGE_LOADSYMS RT_BIT_64(29)
73#define USAGE_UNLOADSYMS RT_BIT_64(30)
74#define USAGE_SETHDUUID RT_BIT_64(31)
75#define USAGE_CONVERTFROMRAW RT_BIT_64(32)
76#define USAGE_LISTPARTITIONS RT_BIT_64(33)
77#define USAGE_CREATERAWVMDK RT_BIT_64(34)
78#define USAGE_VM_STATISTICS RT_BIT_64(35)
79#define USAGE_ADOPTSTATE RT_BIT_64(36)
80#define USAGE_MODINSTALL RT_BIT_64(37)
81#define USAGE_MODUNINSTALL RT_BIT_64(38)
82#define USAGE_RENAMEVMDK RT_BIT_64(39)
83#ifdef VBOX_WITH_GUEST_PROPS
84#define USAGE_GUESTPROPERTY RT_BIT_64(40)
85#endif /* VBOX_WITH_GUEST_PROPS defined */
86#define USAGE_CONVERTTORAW RT_BIT_64(41)
87#define USAGE_METRICS RT_BIT_64(42)
88#define USAGE_CONVERTHD RT_BIT_64(43)
89#define USAGE_IMPORTAPPLIANCE RT_BIT_64(44)
90#define USAGE_EXPORTAPPLIANCE RT_BIT_64(45)
91#define USAGE_HOSTONLYIFS RT_BIT_64(46)
92#define USAGE_DHCPSERVER RT_BIT_64(47)
93#define USAGE_DUMPHDINFO RT_BIT_64(48)
94#define USAGE_STORAGEATTACH RT_BIT_64(49)
95#define USAGE_STORAGECONTROLLER RT_BIT_64(50)
96#define USAGE_ALL (~(uint64_t)0)
97/** @} */
98
99typedef uint64_t USAGECATEGORY;
100
101/** command handler argument */
102struct HandlerArg
103{
104 int argc;
105 char **argv;
106
107#ifndef VBOX_ONLY_DOCS
108 ComPtr<IVirtualBox> virtualBox;
109 ComPtr<ISession> session;
110#endif
111};
112
113/** flag whether we're in internal mode */
114extern bool g_fInternalMode;
115
116/** showVMInfo details */
117typedef enum
118{
119 VMINFO_NONE = 0,
120 VMINFO_STANDARD = 1, /**< standard details */
121 VMINFO_STATISTICS = 2, /**< guest statistics */
122 VMINFO_FULL = 3, /**< both */
123 VMINFO_MACHINEREADABLE = 4, /**< both, and make it machine readable */
124 VMINFO_COMPACT = 5
125} VMINFO_DETAILS;
126
127////////////////////////////////////////////////////////////////////////////////
128//
129// global variables
130//
131////////////////////////////////////////////////////////////////////////////////
132
133extern bool g_fDetailedProgress; // in VBoxManage.cpp
134
135////////////////////////////////////////////////////////////////////////////////
136//
137// prototypes
138//
139////////////////////////////////////////////////////////////////////////////////
140
141/* VBoxManageHelp.cpp */
142void printUsage(USAGECATEGORY u64Cmd);
143int errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...);
144int errorGetOpt(USAGECATEGORY u64Cmd, int rc, union RTGETOPTUNION const *pValueUnion);
145int errorArgument(const char *pszFormat, ...);
146
147void printUsageInternal(USAGECATEGORY u64Cmd);
148
149#ifndef VBOX_ONLY_DOCS
150HRESULT showProgress(ComPtr<IProgress> progress);
151#endif
152
153/* VBoxManage.cpp */
154void showLogo(void);
155
156#ifndef VBOX_ONLY_DOCS
157int handleInternalCommands(HandlerArg *a);
158#endif /* !VBOX_ONLY_DOCS */
159
160/* VBoxManageControlVM.cpp */
161int handleControlVM(HandlerArg *a);
162
163/* VBoxManageModifyVM.cpp */
164int handleModifyVM(HandlerArg *a);
165
166/* VBoxManageGuestProp.cpp */
167extern void usageGuestProperty(void);
168#ifndef VBOX_ONLY_DOCS
169extern int handleGuestProperty(HandlerArg *a);
170
171/* VBoxManageVMInfo.cpp */
172void showSnapshots(ComPtr<ISnapshot> &rootSnapshot,
173 ComPtr<ISnapshot> &currentSnapshot,
174 VMINFO_DETAILS details,
175 const com::Bstr &prefix = "",
176 int level = 0);
177int handleShowVMInfo(HandlerArg *a);
178HRESULT showVMInfo(ComPtr<IVirtualBox> virtualBox,
179 ComPtr<IMachine> machine,
180 VMINFO_DETAILS details = VMINFO_NONE,
181 ComPtr <IConsole> console = ComPtr<IConsole>());
182
183/* VBoxManageList.cpp */
184int handleList(HandlerArg *a);
185
186/* VBoxManageMetrics.cpp */
187int handleMetrics(HandlerArg *a);
188
189/* VBoxManageMisc.cpp */
190int handleRegisterVM(HandlerArg *a);
191int handleUnregisterVM(HandlerArg *a);
192int handleCreateVM(HandlerArg *a);
193int handleStartVM(HandlerArg *a);
194int handleDiscardState(HandlerArg *a);
195int handleAdoptdState(HandlerArg *a);
196int handleGetExtraData(HandlerArg *a);
197int handleSetExtraData(HandlerArg *a);
198int handleSetProperty(HandlerArg *a);
199int handleSharedFolder(HandlerArg *a);
200int handleVMStatistics(HandlerArg *a);
201
202/* VBoxManageDisk.cpp */
203int handleCreateHardDisk(HandlerArg *a);
204int handleModifyHardDisk(HandlerArg *a);
205int handleCloneHardDisk(HandlerArg *a);
206int handleConvertFromRaw(int argc, char *argv[]);
207int handleAddiSCSIDisk(HandlerArg *a);
208int handleShowHardDiskInfo(HandlerArg *a);
209int handleOpenMedium(HandlerArg *a);
210int handleCloseMedium(HandlerArg *a);
211
212/* VBoxManageStorageController.cpp */
213int handleStorageAttach(HandlerArg *a);
214int handleStorageController(HandlerArg *a);
215
216// VBoxManageImport.cpp
217int handleImportAppliance(HandlerArg *a);
218int handleExportAppliance(HandlerArg *a);
219
220// VBoxManageSnapshot.cpp
221int handleSnapshot(HandlerArg *a);
222
223/* VBoxManageUSB.cpp */
224int handleUSBFilter(HandlerArg *a);
225
226/* VBoxManageHostonly.cpp */
227int handleHostonlyIf(HandlerArg *a);
228
229/* VBoxManageHostonly.cpp */
230int handleDHCPServer(HandlerArg *a);
231
232#endif /* !VBOX_ONLY_DOCS */
233
234#endif /* !___H_VBOXMANAGE */
235
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use