VirtualBox

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

Last change on this file since 77801 was 77801, checked in by vboxsync, 5 years ago

VBoxManage snapshot: Use manpage help text (option parsing needs cleaning up!).
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.1 KB
Line 
1/* $Id: VBoxManage.h 77801 2019-03-19 17:44:40Z vboxsync $ */
2/** @file
3 * VBoxManage - VirtualBox command-line interface, internal header file.
4 */
5
6/*
7 * Copyright (C) 2006-2019 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 VBOX_INCLUDED_SRC_VBoxManage_VBoxManage_h
19#define VBOX_INCLUDED_SRC_VBoxManage_VBoxManage_h
20#ifndef RT_WITHOUT_PRAGMA_ONCE
21# pragma once
22#endif
23
24#ifndef VBOX_ONLY_DOCS
25#include <VBox/com/com.h>
26#include <VBox/com/ptr.h>
27#include <VBox/com/VirtualBox.h>
28#include <VBox/com/string.h>
29#include <VBox/com/array.h>
30#endif /* !VBOX_ONLY_DOCS */
31
32#include <iprt/types.h>
33#include <iprt/message.h>
34#include <iprt/stream.h>
35#include <iprt/getopt.h>
36
37#ifndef VBOX_ONLY_DOCS
38# include "VBoxManageBuiltInHelp.h"
39#endif
40
41
42////////////////////////////////////////////////////////////////////////////////
43//
44// definitions
45//
46////////////////////////////////////////////////////////////////////////////////
47
48/** @name Syntax diagram category, i.e. the command.
49 * @{ */
50typedef enum
51{
52 USAGE_INVALID = 0,
53 USAGE_LIST,
54 USAGE_SHOWVMINFO,
55 USAGE_REGISTERVM,
56 USAGE_UNREGISTERVM,
57 USAGE_CREATEVM,
58 USAGE_MODIFYVM,
59 USAGE_CLONEVM,
60 USAGE_STARTVM,
61 USAGE_CONTROLVM,
62 USAGE_DISCARDSTATE,
63 USAGE_CLOSEMEDIUM,
64 USAGE_SHOWMEDIUMINFO,
65 USAGE_CREATEMEDIUM,
66 USAGE_MODIFYMEDIUM,
67 USAGE_CLONEMEDIUM,
68 USAGE_MOVEVM,
69 USAGE_CREATEHOSTIF,
70 USAGE_REMOVEHOSTIF,
71 USAGE_GETEXTRADATA,
72 USAGE_SETEXTRADATA,
73 USAGE_SETPROPERTY,
74 USAGE_USBFILTER,
75 USAGE_SHAREDFOLDER,
76 USAGE_I_LOADSYMS,
77 USAGE_I_LOADMAP,
78 USAGE_I_SETHDUUID,
79 USAGE_CONVERTFROMRAW,
80 USAGE_I_LISTPARTITIONS,
81 USAGE_I_CREATERAWVMDK,
82 USAGE_ADOPTSTATE,
83 USAGE_I_MODINSTALL,
84 USAGE_I_MODUNINSTALL,
85 USAGE_I_RENAMEVMDK,
86#ifdef VBOX_WITH_GUEST_PROPS
87 USAGE_GUESTPROPERTY,
88#endif /* VBOX_WITH_GUEST_PROPS defined */
89 USAGE_I_CONVERTTORAW,
90 USAGE_METRICS,
91 USAGE_I_CONVERTHD,
92 USAGE_IMPORTAPPLIANCE,
93 USAGE_EXPORTAPPLIANCE,
94 USAGE_HOSTONLYIFS,
95 USAGE_DHCPSERVER,
96 USAGE_I_DUMPHDINFO,
97 USAGE_STORAGEATTACH,
98 USAGE_STORAGECONTROLLER,
99#ifdef VBOX_WITH_GUEST_CONTROL
100 USAGE_GUESTCONTROL,
101#endif /* VBOX_WITH_GUEST_CONTROL defined */
102 USAGE_I_DEBUGLOG,
103 USAGE_I_SETHDPARENTUUID,
104 USAGE_I_PASSWORDHASH,
105 USAGE_BANDWIDTHCONTROL,
106 USAGE_I_GUESTSTATS,
107 USAGE_I_REPAIRHD,
108 USAGE_NATNETWORK,
109 USAGE_MEDIUMPROPERTY,
110 USAGE_ENCRYPTMEDIUM,
111 USAGE_MEDIUMENCCHKPWD,
112 USAGE_USBDEVSOURCE,
113 USAGE_CLOUDPROFILE,
114 /* Insert new entries before this line, but only if it is not an option
115 * to go for the new style command and help handling (see e.g. extpack,
116 * unattend or mediumio. */
117 USAGE_S_NEWCMD = 10000, /**< new style command with no old help support */
118 USAGE_S_ALL,
119 USAGE_S_DUMPOPTS
120} USAGECATEGORY;
121/** @} */
122
123
124#define HELP_SCOPE_USBFILTER_ADD RT_BIT_64(0)
125#define HELP_SCOPE_USBFILTER_MODIFY RT_BIT_64(1)
126#define HELP_SCOPE_USBFILTER_REMOVE RT_BIT_64(2)
127
128#define HELP_SCOPE_SHAREDFOLDER_ADD RT_BIT_64(0)
129#define HELP_SCOPE_SHAREDFOLDER_REMOVE RT_BIT_64(1)
130
131#ifdef VBOX_WITH_GUEST_CONTROL
132# define HELP_SCOPE_GSTCTRL_RUN RT_BIT(0)
133# define HELP_SCOPE_GSTCTRL_START RT_BIT(1)
134# define HELP_SCOPE_GSTCTRL_COPYFROM RT_BIT(2)
135# define HELP_SCOPE_GSTCTRL_COPYTO RT_BIT(3)
136# define HELP_SCOPE_GSTCTRL_MKDIR RT_BIT(4)
137# define HELP_SCOPE_GSTCTRL_RMDIR RT_BIT(5)
138# define HELP_SCOPE_GSTCTRL_RM RT_BIT(6)
139# define HELP_SCOPE_GSTCTRL_MV RT_BIT(7)
140# define HELP_SCOPE_GSTCTRL_MKTEMP RT_BIT(8)
141# define HELP_SCOPE_GSTCTRL_LIST RT_BIT(9)
142# define HELP_SCOPE_GSTCTRL_CLOSEPROCESS RT_BIT(10)
143# define HELP_SCOPE_GSTCTRL_CLOSESESSION RT_BIT(11)
144# define HELP_SCOPE_GSTCTRL_STAT RT_BIT(12)
145# define HELP_SCOPE_GSTCTRL_UPDATEGA RT_BIT(13)
146# define HELP_SCOPE_GSTCTRL_WATCH RT_BIT(14)
147#endif
148
149/** command handler argument */
150struct HandlerArg
151{
152 int argc;
153 char **argv;
154
155#ifndef VBOX_ONLY_DOCS
156 ComPtr<IVirtualBox> virtualBox;
157 ComPtr<ISession> session;
158#endif
159};
160
161/** flag whether we're in internal mode */
162extern bool g_fInternalMode;
163
164/** showVMInfo details */
165typedef enum
166{
167 VMINFO_NONE = 0,
168 VMINFO_STANDARD = 1, /**< standard details */
169 VMINFO_FULL = 2, /**< both */
170 VMINFO_MACHINEREADABLE = 3, /**< both, and make it machine readable */
171 VMINFO_COMPACT = 4
172} VMINFO_DETAILS;
173
174
175////////////////////////////////////////////////////////////////////////////////
176//
177// global variables
178//
179////////////////////////////////////////////////////////////////////////////////
180
181extern bool g_fDetailedProgress; // in VBoxManage.cpp
182
183
184////////////////////////////////////////////////////////////////////////////////
185//
186// prototypes
187//
188////////////////////////////////////////////////////////////////////////////////
189
190/* VBoxManageHelp.cpp */
191
192/* Legacy help infrastructure, to be replaced by new one using generated help. */
193void printUsage(USAGECATEGORY enmCommand, uint64_t fSubcommandScope, PRTSTREAM pStrm);
194RTEXITCODE errorSyntax(USAGECATEGORY enmCommand, const char *pszFormat, ...);
195RTEXITCODE errorSyntaxEx(USAGECATEGORY enmCommand, uint64_t fSubcommandScope, const char *pszFormat, ...);
196RTEXITCODE errorGetOpt(USAGECATEGORY enmCommand, int rc, union RTGETOPTUNION const *pValueUnion);
197RTEXITCODE errorGetOptEx(USAGECATEGORY enmCommand, uint64_t fSubcommandScope, int rc, union RTGETOPTUNION const *pValueUnion);
198RTEXITCODE errorArgument(const char *pszFormat, ...);
199
200void printUsageInternal(USAGECATEGORY enmCommand, PRTSTREAM pStrm);
201
202#ifndef VBOX_ONLY_DOCS
203void setCurrentCommand(enum HELP_CMD_VBOXMANAGE enmCommand);
204void setCurrentSubcommand(uint64_t fCurSubcommandScope);
205
206void printUsage(PRTSTREAM pStrm);
207void printHelp(PRTSTREAM pStrm);
208RTEXITCODE errorNoSubcommand(void);
209RTEXITCODE errorUnknownSubcommand(const char *pszSubCmd);
210RTEXITCODE errorTooManyParameters(char **papszArgs);
211RTEXITCODE errorGetOpt(int rcGetOpt, union RTGETOPTUNION const *pValueUnion);
212RTEXITCODE errorSyntax(const char *pszFormat, ...);
213
214HRESULT showProgress(ComPtr<IProgress> progress);
215#endif
216
217/* VBoxManage.cpp */
218void showLogo(PRTSTREAM pStrm);
219
220#ifndef VBOX_ONLY_DOCS
221RTEXITCODE readPasswordFile(const char *pszFilename, com::Utf8Str *pPasswd);
222RTEXITCODE readPasswordFromConsole(com::Utf8Str *pPassword, const char *pszPrompt, ...);
223
224RTEXITCODE handleInternalCommands(HandlerArg *a);
225#endif /* !VBOX_ONLY_DOCS */
226
227/* VBoxManageControlVM.cpp */
228RTEXITCODE handleControlVM(HandlerArg *a);
229#ifndef VBOX_ONLY_DOCS
230unsigned int getMaxNics(IVirtualBox* vbox, IMachine* mach);
231#endif
232
233/* VBoxManageModifyVM.cpp */
234#ifndef VBOX_ONLY_DOCS
235void parseGroups(const char *pcszGroups, com::SafeArray<BSTR> *pGroups);
236#endif
237RTEXITCODE handleModifyVM(HandlerArg *a);
238
239/* VBoxManageDebugVM.cpp */
240RTEXITCODE handleDebugVM(HandlerArg *a);
241
242/* VBoxManageGuestProp.cpp */
243extern void usageGuestProperty(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2);
244
245/* VBoxManageGuestCtrl.cpp */
246extern void usageGuestControl(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2, uint64_t fSubcommandScope);
247
248#ifndef VBOX_ONLY_DOCS
249/* VBoxManageGuestProp.cpp */
250RTEXITCODE handleGuestProperty(HandlerArg *a);
251
252/* VBoxManageGuestCtrl.cpp */
253RTEXITCODE handleGuestControl(HandlerArg *a);
254
255/* VBoxManageVMInfo.cpp */
256HRESULT showSnapshots(ComPtr<ISnapshot> &rootSnapshot,
257 ComPtr<ISnapshot> &currentSnapshot,
258 VMINFO_DETAILS details,
259 const com::Utf8Str &prefix = "",
260 int level = 0);
261RTEXITCODE handleShowVMInfo(HandlerArg *a);
262HRESULT showVMInfo(ComPtr<IVirtualBox> pVirtualBox,
263 ComPtr<IMachine> pMachine,
264 ComPtr<ISession> pSession,
265 VMINFO_DETAILS details = VMINFO_NONE);
266const char *machineStateToName(MachineState_T machineState, bool fShort);
267HRESULT showBandwidthGroups(ComPtr<IBandwidthControl> &bwCtrl,
268 VMINFO_DETAILS details);
269
270/* VBoxManageList.cpp */
271RTEXITCODE handleList(HandlerArg *a);
272
273/* VBoxManageMetrics.cpp */
274RTEXITCODE handleMetrics(HandlerArg *a);
275
276/* VBoxManageMisc.cpp */
277RTEXITCODE handleRegisterVM(HandlerArg *a);
278RTEXITCODE handleUnregisterVM(HandlerArg *a);
279RTEXITCODE handleCreateVM(HandlerArg *a);
280RTEXITCODE handleCloneVM(HandlerArg *a);
281RTEXITCODE handleStartVM(HandlerArg *a);
282RTEXITCODE handleDiscardState(HandlerArg *a);
283RTEXITCODE handleAdoptState(HandlerArg *a);
284RTEXITCODE handleGetExtraData(HandlerArg *a);
285RTEXITCODE handleSetExtraData(HandlerArg *a);
286RTEXITCODE handleSetProperty(HandlerArg *a);
287RTEXITCODE handleSharedFolder(HandlerArg *a);
288RTEXITCODE handleExtPack(HandlerArg *a);
289RTEXITCODE handleUnattended(HandlerArg *a);
290RTEXITCODE handleMoveVM(HandlerArg *a);
291RTEXITCODE handleCloudProfile(HandlerArg *a);
292
293/* VBoxManageDisk.cpp */
294HRESULT openMedium(HandlerArg *a, const char *pszFilenameOrUuid,
295 DeviceType_T enmDevType, AccessMode_T enmAccessMode,
296 ComPtr<IMedium> &pMedium, bool fForceNewUuidOnOpen,
297 bool fSilent);
298RTEXITCODE handleCreateMedium(HandlerArg *a);
299RTEXITCODE handleModifyMedium(HandlerArg *a);
300RTEXITCODE handleCloneMedium(HandlerArg *a);
301RTEXITCODE handleMediumProperty(HandlerArg *a);
302RTEXITCODE handleEncryptMedium(HandlerArg *a);
303RTEXITCODE handleCheckMediumPassword(HandlerArg *a);
304RTEXITCODE handleConvertFromRaw(HandlerArg *a);
305HRESULT showMediumInfo(const ComPtr<IVirtualBox> &pVirtualBox,
306 const ComPtr<IMedium> &pMedium,
307 const char *pszParentUUID,
308 bool fOptLong);
309RTEXITCODE handleShowMediumInfo(HandlerArg *a);
310RTEXITCODE handleCloseMedium(HandlerArg *a);
311RTEXITCODE handleMediumIO(HandlerArg *a);
312int parseMediumType(const char *psz, MediumType_T *penmMediumType);
313int parseBool(const char *psz, bool *pb);
314
315/* VBoxManageStorageController.cpp */
316RTEXITCODE handleStorageAttach(HandlerArg *a);
317RTEXITCODE handleStorageController(HandlerArg *a);
318
319// VBoxManageImport.cpp
320RTEXITCODE handleImportAppliance(HandlerArg *a);
321RTEXITCODE handleExportAppliance(HandlerArg *a);
322
323// VBoxManageSnapshot.cpp
324RTEXITCODE handleSnapshot(HandlerArg *a);
325
326/* VBoxManageUSB.cpp */
327RTEXITCODE handleUSBFilter(HandlerArg *a);
328RTEXITCODE handleUSBDevSource(HandlerArg *a);
329
330/* VBoxManageHostonly.cpp */
331RTEXITCODE handleHostonlyIf(HandlerArg *a);
332
333/* VBoxManageDHCPServer.cpp */
334RTEXITCODE handleDHCPServer(HandlerArg *a);
335
336/* VBoxManageNATNetwork.cpp */
337RTEXITCODE handleNATNetwork(HandlerArg *a);
338
339
340/* VBoxManageBandwidthControl.cpp */
341RTEXITCODE handleBandwidthControl(HandlerArg *a);
342
343#endif /* !VBOX_ONLY_DOCS */
344
345#endif /* !VBOX_INCLUDED_SRC_VBoxManage_VBoxManage_h */
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use