VirtualBox

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

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

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