VBoxManage.cpp@ 23702

Last change on this file since 23702 was 23667, checked in by vboxsync, 15 years ago
VBoxManage: Live migration.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 70.7 KB

Line
1	/* $Id: VBoxManage.cpp 23667 2009-10-10 01:23:58Z vboxsync $ */
2	/** @file
3	* VBoxManage - VirtualBox's command-line interface.
4	*/
5
6	/*
7	* Copyright (C) 2006-2009 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
23	/*******************************************************************************
24	* Header Files *
25	*******************************************************************************/
26	#ifndef VBOX_ONLY_DOCS
27	#include <VBox/com/com.h>
28	#include <VBox/com/string.h>
29	#include <VBox/com/Guid.h>
30	#include <VBox/com/array.h>
31	#include <VBox/com/ErrorInfo.h>
32	#include <VBox/com/errorprint.h>
33	#include <VBox/com/EventQueue.h>
34
35	#include <VBox/com/VirtualBox.h>
36
37	#include <vector>
38	#include <list>
39	#endif /* !VBOX_ONLY_DOCS */
40
41	#include <iprt/asm.h>
42	#include <iprt/buildconfig.h>
43	#include <iprt/cidr.h>
44	#include <iprt/ctype.h>
45	#include <iprt/dir.h>
46	#include <iprt/env.h>
47	#include <VBox/err.h>
48	#include <iprt/file.h>
49	#include <iprt/initterm.h>
50	#include <iprt/param.h>
51	#include <iprt/path.h>
52	#include <iprt/stream.h>
53	#include <iprt/string.h>
54	#include <iprt/stdarg.h>
55	#include <iprt/thread.h>
56	#include <iprt/uuid.h>
57	#include <iprt/getopt.h>
58	#include <iprt/ctype.h>
59	#include <VBox/version.h>
60	#include <VBox/log.h>
61
62	#include "VBoxManage.h"
63
64	#ifndef VBOX_ONLY_DOCS
65	using namespace com;
66
67	/** command handler type */
68	typedef int (PFNHANDLER)(HandlerArg a);
69
70	#endif /* !VBOX_ONLY_DOCS */
71
72	////////////////////////////////////////////////////////////////////////////////
73	//
74	// global variables
75	//
76	////////////////////////////////////////////////////////////////////////////////
77
78	/extern/ bool g_fDetailedProgress = false;
79
80	////////////////////////////////////////////////////////////////////////////////
81	//
82	// functions
83	//
84	////////////////////////////////////////////////////////////////////////////////
85
86	#ifndef VBOX_ONLY_DOCS
87	/**
88	* Print out progress on the console
89	*/
90	LONG showProgress(ComPtr<IProgress> progress)
91	{
92	BOOL fCompleted;
93	ULONG ulCurrentPercent;
94	ULONG ulLastPercent = 0;
95
96	ULONG ulCurrentOperationPercent;
97	ULONG ulLastOperationPercent = (ULONG)-1;
98
99	ULONG ulLastOperation = (ULONG)-1;
100	Bstr bstrOperationDescription;
101
102	ULONG cOperations;
103	progress->COMGETTER(OperationCount)(&cOperations);
104
105	if (!g_fDetailedProgress)
106	{
107	RTPrintf("0%%...");
108	RTStrmFlush(g_pStdOut);
109	}
110
111	while (SUCCEEDED(progress->COMGETTER(Completed(&fCompleted))))
112	{
113	ULONG ulOperation;
114	progress->COMGETTER(Operation)(&ulOperation);
115
116	progress->COMGETTER(Percent(&ulCurrentPercent));
117	progress->COMGETTER(OperationPercent(&ulCurrentOperationPercent));
118
119	if (g_fDetailedProgress)
120	{
121	if (ulLastOperation != ulOperation)
122	{
123	progress->COMGETTER(OperationDescription(bstrOperationDescription.asOutParam()));
124	ulLastPercent = (ULONG)-1; // force print
125	ulLastOperation = ulOperation;
126	}
127
128	if ( (ulCurrentPercent != ulLastPercent)
129	\|\| (ulCurrentOperationPercent != ulLastOperationPercent)
130	)
131	{
132	LONG lSecsRem;
133	progress->COMGETTER(TimeRemaining)(&lSecsRem);
134
135	RTPrintf("(%ld/%ld) %ls %ld%% => %ld%% (%d s remaining)\n", ulOperation + 1, cOperations, bstrOperationDescription.raw(), ulCurrentOperationPercent, ulCurrentPercent, lSecsRem);
136	ulLastPercent = ulCurrentPercent;
137	ulLastOperationPercent = ulCurrentOperationPercent;
138	}
139	}
140	else
141	{
142	/* did we cross a 10% mark? */
143	if (((ulCurrentPercent / 10) > (ulLastPercent / 10)))
144	{
145	/* make sure to also print out missed steps */
146	for (ULONG curVal = (ulLastPercent / 10) * 10 + 10; curVal <= (ulCurrentPercent / 10) * 10; curVal += 10)
147	{
148	if (curVal < 100)
149	{
150	RTPrintf("%ld%%...", curVal);
151	RTStrmFlush(g_pStdOut);
152	}
153	}
154	ulLastPercent = (ulCurrentPercent / 10) * 10;
155	}
156	}
157	if (fCompleted)
158	break;
159
160	/* make sure the loop is not too tight */
161	progress->WaitForCompletion(100);
162	}
163
164	/* complete the line. */
165	LONG iRc;
166	if (SUCCEEDED(progress->COMGETTER(ResultCode)(&iRc)))
167	{
168	if (SUCCEEDED(iRc))
169	RTPrintf("100%%\n");
170	else
171	RTPrintf("FAILED\n");
172	}
173	else
174	RTPrintf("\n");
175	RTStrmFlush(g_pStdOut);
176	return iRc;
177	}
178	#endif /* !VBOX_ONLY_DOCS */
179
180	void showLogo(void)
181	{
182	static bool fShown; /* show only once */
183
184	if (!fShown)
185	{
186	RTPrintf("VirtualBox Command Line Management Interface Version "
187	VBOX_VERSION_STRING "\n"
188	"(C) 2005-2009 Sun Microsystems, Inc.\n"
189	"All rights reserved.\n"
190	"\n");
191	fShown = true;
192	}
193	}
194
195	#ifndef VBOX_ONLY_DOCS
196
197	static int handleRegisterVM(HandlerArg *a)
198	{
199	HRESULT rc;
200
201	if (a->argc != 1)
202	return errorSyntax(USAGE_REGISTERVM, "Incorrect number of parameters");
203
204	ComPtr<IMachine> machine;
205	/** @todo Ugly hack to get both the API interpretation of relative paths
206	* and the client's interpretation of relative paths. Remove after the API
207	* has been redesigned. */
208	rc = a->virtualBox->OpenMachine(Bstr(a->argv[0]), machine.asOutParam());
209	if (rc == VBOX_E_FILE_ERROR)
210	{
211	char szVMFileAbs[RTPATH_MAX] = "";
212	int vrc = RTPathAbs(a->argv[0], szVMFileAbs, sizeof(szVMFileAbs));
213	if (RT_FAILURE(vrc))
214	{
215	RTPrintf("Cannot convert filename \"%s\" to absolute path\n", a->argv[0]);
216	return 1;
217	}
218	CHECK_ERROR(a->virtualBox, OpenMachine(Bstr(szVMFileAbs), machine.asOutParam()));
219	}
220	else if (FAILED(rc))
221	CHECK_ERROR(a->virtualBox, OpenMachine(Bstr(a->argv[0]), machine.asOutParam()));
222	if (SUCCEEDED(rc))
223	{
224	ASSERT(machine);
225	CHECK_ERROR(a->virtualBox, RegisterMachine(machine));
226	}
227	return SUCCEEDED(rc) ? 0 : 1;
228	}
229
230	static const RTGETOPTDEF g_aUnregisterVMOptions[] =
231	{
232	{ "--delete", 'd', RTGETOPT_REQ_NOTHING },
233	{ "-delete", 'd', RTGETOPT_REQ_NOTHING }, // deprecated
234	};
235
236	static int handleUnregisterVM(HandlerArg *a)
237	{
238	HRESULT rc;
239	const char *VMName = NULL;
240	bool fDelete = false;
241
242	int c;
243	RTGETOPTUNION ValueUnion;
244	RTGETOPTSTATE GetState;
245	// start at 0 because main() has hacked both the argc and argv given to us
246	RTGetOptInit(&GetState, a->argc, a->argv, g_aUnregisterVMOptions, RT_ELEMENTS(g_aUnregisterVMOptions), 0, 0 /* fFlags */);
247	while ((c = RTGetOpt(&GetState, &ValueUnion)))
248	{
249	switch (c)
250	{
251	case 'd': // --delete
252	fDelete = true;
253	break;
254
255	case VINF_GETOPT_NOT_OPTION:
256	if (!VMName)
257	VMName = ValueUnion.psz;
258	else
259	return errorSyntax(USAGE_UNREGISTERVM, "Invalid parameter '%s'", ValueUnion.psz);
260	break;
261
262	default:
263	if (c > 0)
264	{
265	if (RT_C_IS_PRINT(c))
266	return errorSyntax(USAGE_UNREGISTERVM, "Invalid option -%c", c);
267	else
268	return errorSyntax(USAGE_UNREGISTERVM, "Invalid option case %i", c);
269	}
270	else if (c == VERR_GETOPT_UNKNOWN_OPTION)
271	return errorSyntax(USAGE_UNREGISTERVM, "unknown option: %s\n", ValueUnion.psz);
272	else if (ValueUnion.pDef)
273	return errorSyntax(USAGE_UNREGISTERVM, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
274	else
275	return errorSyntax(USAGE_UNREGISTERVM, "error: %Rrs", c);
276	}
277	}
278
279	/* check for required options */
280	if (!VMName)
281	return errorSyntax(USAGE_UNREGISTERVM, "VM name required");
282
283	ComPtr<IMachine> machine;
284	/* assume it's a UUID */
285	rc = a->virtualBox->GetMachine(Guid(VMName).toUtf16(), machine.asOutParam());
286	if (FAILED(rc) \|\| !machine)
287	{
288	/* must be a name */
289	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(VMName), machine.asOutParam()));
290	}
291	if (machine)
292	{
293	Bstr uuid;
294	machine->COMGETTER(Id)(uuid.asOutParam());
295	machine = NULL;
296	CHECK_ERROR(a->virtualBox, UnregisterMachine(uuid, machine.asOutParam()));
297	if (SUCCEEDED(rc) && machine && fDelete)
298	CHECK_ERROR(machine, DeleteSettings());
299	}
300	return SUCCEEDED(rc) ? 0 : 1;
301	}
302
303	static int handleCreateVM(HandlerArg *a)
304	{
305	HRESULT rc;
306	Bstr baseFolder;
307	Bstr settingsFile;
308	Bstr name;
309	Bstr osTypeId;
310	RTUUID id;
311	bool fRegister = false;
312
313	RTUuidClear(&id);
314	for (int i = 0; i < a->argc; i++)
315	{
316	if ( !strcmp(a->argv[i], "--basefolder")
317	\|\| !strcmp(a->argv[i], "-basefolder"))
318	{
319	if (a->argc <= i + 1)
320	return errorArgument("Missing argument to '%s'", a->argv[i]);
321	i++;
322	baseFolder = a->argv[i];
323	}
324	else if ( !strcmp(a->argv[i], "--settingsfile")
325	\|\| !strcmp(a->argv[i], "-settingsfile"))
326	{
327	if (a->argc <= i + 1)
328	return errorArgument("Missing argument to '%s'", a->argv[i]);
329	i++;
330	settingsFile = a->argv[i];
331	}
332	else if ( !strcmp(a->argv[i], "--name")
333	\|\| !strcmp(a->argv[i], "-name"))
334	{
335	if (a->argc <= i + 1)
336	return errorArgument("Missing argument to '%s'", a->argv[i]);
337	i++;
338	name = a->argv[i];
339	}
340	else if ( !strcmp(a->argv[i], "--ostype")
341	\|\| !strcmp(a->argv[i], "-ostype"))
342	{
343	if (a->argc <= i + 1)
344	return errorArgument("Missing argument to '%s'", a->argv[i]);
345	i++;
346	osTypeId = a->argv[i];
347	}
348	else if ( !strcmp(a->argv[i], "--uuid")
349	\|\| !strcmp(a->argv[i], "-uuid"))
350	{
351	if (a->argc <= i + 1)
352	return errorArgument("Missing argument to '%s'", a->argv[i]);
353	i++;
354	if (RT_FAILURE(RTUuidFromStr(&id, a->argv[i])))
355	return errorArgument("Invalid UUID format %s\n", a->argv[i]);
356	}
357	else if ( !strcmp(a->argv[i], "--register")
358	\|\| !strcmp(a->argv[i], "-register"))
359	{
360	fRegister = true;
361	}
362	else
363	return errorSyntax(USAGE_CREATEVM, "Invalid parameter '%s'", Utf8Str(a->argv[i]).raw());
364	}
365	if (!name)
366	return errorSyntax(USAGE_CREATEVM, "Parameter --name is required");
367
368	if (!!baseFolder && !!settingsFile)
369	return errorSyntax(USAGE_CREATEVM, "Either --basefolder or --settingsfile must be specified");
370
371	do
372	{
373	ComPtr<IMachine> machine;
374
375	if (!settingsFile)
376	CHECK_ERROR_BREAK(a->virtualBox,
377	CreateMachine(name, osTypeId, baseFolder, Guid(id).toUtf16(), machine.asOutParam()));
378	else
379	CHECK_ERROR_BREAK(a->virtualBox,
380	CreateLegacyMachine(name, osTypeId, settingsFile, Guid(id).toUtf16(), machine.asOutParam()));
381
382	CHECK_ERROR_BREAK(machine, SaveSettings());
383	if (fRegister)
384	{
385	CHECK_ERROR_BREAK(a->virtualBox, RegisterMachine(machine));
386	}
387	Bstr uuid;
388	CHECK_ERROR_BREAK(machine, COMGETTER(Id)(uuid.asOutParam()));
389	CHECK_ERROR_BREAK(machine, COMGETTER(SettingsFilePath)(settingsFile.asOutParam()));
390	RTPrintf("Virtual machine '%ls' is created%s.\n"
391	"UUID: %s\n"
392	"Settings file: '%ls'\n",
393	name.raw(), fRegister ? " and registered" : "",
394	Utf8Str(uuid).raw(), settingsFile.raw());
395	}
396	while (0);
397
398	return SUCCEEDED(rc) ? 0 : 1;
399	}
400
401	/**
402	* Parses a number.
403	*
404	* @returns Valid number on success.
405	* @returns 0 if invalid number. All necesary bitching has been done.
406	* @param psz Pointer to the nic number.
407	*/
408	unsigned parseNum(const char psz, unsigned cMaxNum, const char name)
409	{
410	uint32_t u32;
411	char *pszNext;
412	int rc = RTStrToUInt32Ex(psz, &pszNext, 10, &u32);
413	if ( RT_SUCCESS(rc)
414	&& *pszNext == '\0'
415	&& u32 >= 1
416	&& u32 <= cMaxNum)
417	return (unsigned)u32;
418	errorArgument("Invalid %s number '%s'", name, psz);
419	return 0;
420	}
421
422
423	/** @todo refine this after HDD changes; MSC 8.0/64 has trouble with handleModifyVM. */
424	#if defined(_MSC_VER)
425	# pragma optimize("", on)
426	#endif
427
428	static const RTGETOPTDEF g_aStartVMOptions[] =
429	{
430	{ "--type", 't', RTGETOPT_REQ_STRING },
431	{ "-type", 't', RTGETOPT_REQ_STRING }, // deprecated
432	};
433
434	static int handleStartVM(HandlerArg *a)
435	{
436	HRESULT rc;
437	const char *VMName = NULL;
438	Bstr sessionType = "gui";
439
440	int c;
441	RTGETOPTUNION ValueUnion;
442	RTGETOPTSTATE GetState;
443	// start at 0 because main() has hacked both the argc and argv given to us
444	RTGetOptInit(&GetState, a->argc, a->argv, g_aStartVMOptions, RT_ELEMENTS(g_aStartVMOptions), 0, 0 /* fFlags */);
445	while ((c = RTGetOpt(&GetState, &ValueUnion)))
446	{
447	switch (c)
448	{
449	case 't': // --type
450	if (!RTStrICmp(ValueUnion.psz, "gui"))
451	{
452	sessionType = "gui";
453	}
454	#ifdef VBOX_WITH_VBOXSDL
455	else if (!RTStrICmp(ValueUnion.psz, "sdl"))
456	{
457	sessionType = "sdl";
458	}
459	#endif
460	#ifdef VBOX_WITH_VRDP
461	else if (!RTStrICmp(ValueUnion.psz, "vrdp"))
462	{
463	sessionType = "vrdp";
464	}
465	#endif
466	#ifdef VBOX_WITH_HEADLESS
467	else if (!RTStrICmp(ValueUnion.psz, "capture"))
468	{
469	sessionType = "capture";
470	}
471	else if (!RTStrICmp(ValueUnion.psz, "headless"))
472	{
473	sessionType = "headless";
474	}
475	#endif
476	else
477	return errorArgument("Invalid session type '%s'", ValueUnion.psz);
478	break;
479
480	case VINF_GETOPT_NOT_OPTION:
481	if (!VMName)
482	VMName = ValueUnion.psz;
483	else
484	return errorSyntax(USAGE_STARTVM, "Invalid parameter '%s'", ValueUnion.psz);
485	break;
486
487	default:
488	if (c > 0)
489	{
490	if (RT_C_IS_PRINT(c))
491	return errorSyntax(USAGE_STARTVM, "Invalid option -%c", c);
492	else
493	return errorSyntax(USAGE_STARTVM, "Invalid option case %i", c);
494	}
495	else if (c == VERR_GETOPT_UNKNOWN_OPTION)
496	return errorSyntax(USAGE_STARTVM, "unknown option: %s\n", ValueUnion.psz);
497	else if (ValueUnion.pDef)
498	return errorSyntax(USAGE_STARTVM, "%s: %Rrs", ValueUnion.pDef->pszLong, c);
499	else
500	return errorSyntax(USAGE_STARTVM, "error: %Rrs", c);
501	}
502	}
503
504	/* check for required options */
505	if (!VMName)
506	return errorSyntax(USAGE_STARTVM, "VM name required");
507
508	ComPtr<IMachine> machine;
509	/* assume it's a UUID */
510	rc = a->virtualBox->GetMachine(Guid(VMName).toUtf16(), machine.asOutParam());
511	if (FAILED(rc) \|\| !machine)
512	{
513	/* must be a name */
514	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(VMName), machine.asOutParam()));
515	}
516	if (machine)
517	{
518	Bstr uuid;
519	machine->COMGETTER(Id)(uuid.asOutParam());
520
521
522	Bstr env;
523	#if defined(RT_OS_LINUX) \|\| defined(RT_OS_SOLARIS)
524	/* make sure the VM process will start on the same display as VBoxManage */
525	Utf8Str str;
526	const char *pszDisplay = RTEnvGet("DISPLAY");
527	if (pszDisplay)
528	str = Utf8StrFmt("DISPLAY=%s\n", pszDisplay);
529	const char *pszXAuth = RTEnvGet("XAUTHORITY");
530	if (pszXAuth)
531	str.append(Utf8StrFmt("XAUTHORITY=%s\n", pszXAuth));
532	env = str;
533	#endif
534	ComPtr<IProgress> progress;
535	CHECK_ERROR_RET(a->virtualBox, OpenRemoteSession(a->session, uuid, sessionType,
536	env, progress.asOutParam()), rc);
537	RTPrintf("Waiting for the remote session to open...\n");
538	CHECK_ERROR_RET(progress, WaitForCompletion (-1), 1);
539
540	BOOL completed;
541	CHECK_ERROR_RET(progress, COMGETTER(Completed)(&completed), rc);
542	ASSERT(completed);
543
544	LONG iRc;
545	CHECK_ERROR_RET(progress, COMGETTER(ResultCode)(&iRc), rc);
546	if (FAILED(iRc))
547	{
548	ComPtr <IVirtualBoxErrorInfo> errorInfo;
549	CHECK_ERROR_RET(progress, COMGETTER(ErrorInfo)(errorInfo.asOutParam()), 1);
550	ErrorInfo info (errorInfo);
551	com::GluePrintErrorInfo(info);
552	}
553	else
554	{
555	RTPrintf("Remote session has been successfully opened.\n");
556	}
557	}
558
559	/* it's important to always close sessions */
560	a->session->Close();
561
562	return SUCCEEDED(rc) ? 0 : 1;
563	}
564
565	static int handleControlVM(HandlerArg *a)
566	{
567	HRESULT rc;
568
569	if (a->argc < 2)
570	return errorSyntax(USAGE_CONTROLVM, "Not enough parameters");
571
572	/* try to find the given machine */
573	ComPtr <IMachine> machine;
574	Bstr uuid (a->argv[0]);
575	if (!Guid(uuid).isEmpty())
576	{
577	CHECK_ERROR (a->virtualBox, GetMachine (uuid, machine.asOutParam()));
578	}
579	else
580	{
581	CHECK_ERROR (a->virtualBox, FindMachine (uuid, machine.asOutParam()));
582	if (SUCCEEDED (rc))
583	machine->COMGETTER(Id) (uuid.asOutParam());
584	}
585	if (FAILED (rc))
586	return 1;
587
588	/* open a session for the VM */
589	CHECK_ERROR_RET (a->virtualBox, OpenExistingSession (a->session, uuid), 1);
590
591	do
592	{
593	/* get the associated console */
594	ComPtr<IConsole> console;
595	CHECK_ERROR_BREAK (a->session, COMGETTER(Console)(console.asOutParam()));
596	/* ... and session machine */
597	ComPtr<IMachine> sessionMachine;
598	CHECK_ERROR_BREAK (a->session, COMGETTER(Machine)(sessionMachine.asOutParam()));
599
600	/* which command? */
601	if (!strcmp(a->argv[1], "pause"))
602	{
603	CHECK_ERROR_BREAK (console, Pause());
604	}
605	else if (!strcmp(a->argv[1], "resume"))
606	{
607	CHECK_ERROR_BREAK (console, Resume());
608	}
609	else if (!strcmp(a->argv[1], "reset"))
610	{
611	CHECK_ERROR_BREAK (console, Reset());
612	}
613	else if (!strcmp(a->argv[1], "poweroff"))
614	{
615	ComPtr<IProgress> progress;
616	CHECK_ERROR_BREAK (console, PowerDown(progress.asOutParam()));
617
618	showProgress(progress);
619
620	LONG iRc;
621	progress->COMGETTER(ResultCode)(&iRc);
622	if (FAILED(iRc))
623	{
624	com::ProgressErrorInfo info(progress);
625	if (info.isBasicAvailable())
626	{
627	RTPrintf("Error: failed to power off machine. Error message: %lS\n", info.getText().raw());
628	}
629	else
630	{
631	RTPrintf("Error: failed to power off machine. No error message available!\n");
632	}
633	}
634	}
635	else if (!strcmp(a->argv[1], "savestate"))
636	{
637	ComPtr<IProgress> progress;
638	CHECK_ERROR_BREAK (console, SaveState(progress.asOutParam()));
639
640	showProgress(progress);
641
642	LONG iRc;
643	progress->COMGETTER(ResultCode)(&iRc);
644	if (FAILED(iRc))
645	{
646	com::ProgressErrorInfo info(progress);
647	if (info.isBasicAvailable())
648	{
649	RTPrintf("Error: failed to save machine state. Error message: %lS\n", info.getText().raw());
650	}
651	else
652	{
653	RTPrintf("Error: failed to save machine state. No error message available!\n");
654	}
655	}
656	}
657	else if (!strcmp(a->argv[1], "acpipowerbutton"))
658	{
659	CHECK_ERROR_BREAK (console, PowerButton());
660	}
661	else if (!strcmp(a->argv[1], "acpisleepbutton"))
662	{
663	CHECK_ERROR_BREAK (console, SleepButton());
664	}
665	else if (!strcmp(a->argv[1], "injectnmi"))
666	{
667	/* get the machine debugger. */
668	ComPtr <IMachineDebugger> debugger;
669	CHECK_ERROR_BREAK(console, COMGETTER(Debugger)(debugger.asOutParam()));
670	CHECK_ERROR_BREAK(debugger, InjectNMI());
671	}
672	else if (!strcmp(a->argv[1], "keyboardputscancode"))
673	{
674	ComPtr<IKeyboard> keyboard;
675	CHECK_ERROR_BREAK(console, COMGETTER(Keyboard)(keyboard.asOutParam()));
676
677	if (a->argc <= 1 + 1)
678	{
679	errorArgument("Missing argument to '%s'. Expected IBM PC AT set 2 keyboard scancode(s) as hex byte(s).", a->argv[1]);
680	rc = E_FAIL;
681	break;
682	}
683
684	/* Arbitrary restrict the length of a sequence of scancodes to 1024. */
685	LONG alScancodes[1024];
686	int cScancodes = 0;
687
688	/* Process the command line. */
689	int i;
690	for (i = 1 + 1; i < a->argc && cScancodes < (int)RT_ELEMENTS(alScancodes); i++, cScancodes++)
691	{
692	if ( RT_C_IS_XDIGIT (a->argv[i][0])
693	&& RT_C_IS_XDIGIT (a->argv[i][1])
694	&& a->argv[i][2] == 0)
695	{
696	uint8_t u8Scancode;
697	int rc = RTStrToUInt8Ex(a->argv[i], NULL, 16, &u8Scancode);
698	if (RT_FAILURE (rc))
699	{
700	RTPrintf("Error: converting '%s' returned %Rrc!\n", a->argv[i], rc);
701	rc = E_FAIL;
702	break;
703	}
704
705	alScancodes[cScancodes] = u8Scancode;
706	}
707	else
708	{
709	RTPrintf("Error: '%s' is not a hex byte!\n", a->argv[i]);
710	rc = E_FAIL;
711	break;
712	}
713	}
714
715	if (FAILED(rc))
716	break;
717
718	if ( cScancodes == RT_ELEMENTS(alScancodes)
719	&& i < a->argc)
720	{
721	RTPrintf("Error: too many scancodes, maximum %d allowed!\n", RT_ELEMENTS(alScancodes));
722	rc = E_FAIL;
723	break;
724	}
725
726	/* Send scancodes to the VM.
727	* Note: 'PutScancodes' did not work here. Only the first scancode was transmitted.
728	*/
729	for (i = 0; i < cScancodes; i++)
730	{
731	CHECK_ERROR_BREAK(keyboard, PutScancode(alScancodes[i]));
732	RTPrintf("Scancode[%d]: 0x%02X\n", i, alScancodes[i]);
733	}
734	}
735	else if (!strncmp(a->argv[1], "setlinkstate", 12))
736	{
737	/* Get the number of network adapters */
738	ULONG NetworkAdapterCount = 0;
739	ComPtr <ISystemProperties> info;
740	CHECK_ERROR_BREAK (a->virtualBox, COMGETTER(SystemProperties) (info.asOutParam()));
741	CHECK_ERROR_BREAK (info, COMGETTER(NetworkAdapterCount) (&NetworkAdapterCount));
742
743	unsigned n = parseNum(&a->argv[1][12], NetworkAdapterCount, "NIC");
744	if (!n)
745	{
746	rc = E_FAIL;
747	break;
748	}
749	if (a->argc <= 1 + 1)
750	{
751	errorArgument("Missing argument to '%s'", a->argv[1]);
752	rc = E_FAIL;
753	break;
754	}
755	/* get the corresponding network adapter */
756	ComPtr<INetworkAdapter> adapter;
757	CHECK_ERROR_BREAK (sessionMachine, GetNetworkAdapter(n - 1, adapter.asOutParam()));
758	if (adapter)
759	{
760	if (!strcmp(a->argv[2], "on"))
761	{
762	CHECK_ERROR_BREAK (adapter, COMSETTER(CableConnected)(TRUE));
763	}
764	else if (!strcmp(a->argv[2], "off"))
765	{
766	CHECK_ERROR_BREAK (adapter, COMSETTER(CableConnected)(FALSE));
767	}
768	else
769	{
770	errorArgument("Invalid link state '%s'", Utf8Str(a->argv[2]).raw());
771	rc = E_FAIL;
772	break;
773	}
774	}
775	}
776	#ifdef VBOX_DYNAMIC_NET_ATTACH
777	/* here the order in which strncmp is called is important
778	* cause nictracefile can be very well compared with
779	* nictrace and nic and thus everything will always fail
780	* if the order is changed
781	*/
782	else if (!strncmp(a->argv[1], "nictracefile", 12))
783	{
784	/* Get the number of network adapters */
785	ULONG NetworkAdapterCount = 0;
786	ComPtr <ISystemProperties> info;
787	CHECK_ERROR_BREAK (a->virtualBox, COMGETTER(SystemProperties) (info.asOutParam()));
788	CHECK_ERROR_BREAK (info, COMGETTER(NetworkAdapterCount) (&NetworkAdapterCount));
789
790	unsigned n = parseNum(&a->argv[1][12], NetworkAdapterCount, "NIC");
791	if (!n)
792	{
793	rc = E_FAIL;
794	break;
795	}
796	if (a->argc <= 2)
797	{
798	errorArgument("Missing argument to '%s'", a->argv[1]);
799	rc = E_FAIL;
800	break;
801	}
802
803	/* get the corresponding network adapter */
804	ComPtr<INetworkAdapter> adapter;
805	CHECK_ERROR_BREAK (sessionMachine, GetNetworkAdapter(n - 1, adapter.asOutParam()));
806	if (adapter)
807	{
808	BOOL fEnabled;
809	adapter->COMGETTER(Enabled)(&fEnabled);
810	if (fEnabled)
811	{
812	if (a->argv[2])
813	{
814	CHECK_ERROR_RET(adapter, COMSETTER(TraceFile) (Bstr(a->argv[2])), 1);
815	}
816	else
817	{
818	errorArgument("Invalid filename or filename not specified for NIC %lu", n);
819	rc = E_FAIL;
820	break;
821	}
822	}
823	else
824	{
825	RTPrintf("The NIC %d is currently disabled and thus can't change its tracefile\n", n);
826	}
827	}
828	}
829	else if (!strncmp(a->argv[1], "nictrace", 8))
830	{
831	/* Get the number of network adapters */
832	ULONG NetworkAdapterCount = 0;
833	ComPtr <ISystemProperties> info;
834	CHECK_ERROR_BREAK (a->virtualBox, COMGETTER(SystemProperties) (info.asOutParam()));
835	CHECK_ERROR_BREAK (info, COMGETTER(NetworkAdapterCount) (&NetworkAdapterCount));
836
837	unsigned n = parseNum(&a->argv[1][8], NetworkAdapterCount, "NIC");
838	if (!n)
839	{
840	rc = E_FAIL;
841	break;
842	}
843	if (a->argc <= 2)
844	{
845	errorArgument("Missing argument to '%s'", a->argv[1]);
846	rc = E_FAIL;
847	break;
848	}
849
850	/* get the corresponding network adapter */
851	ComPtr<INetworkAdapter> adapter;
852	CHECK_ERROR_BREAK (sessionMachine, GetNetworkAdapter(n - 1, adapter.asOutParam()));
853	if (adapter)
854	{
855	BOOL fEnabled;
856	adapter->COMGETTER(Enabled)(&fEnabled);
857	if (fEnabled)
858	{
859	if (!strcmp(a->argv[2], "on"))
860	{
861	CHECK_ERROR_RET(adapter, COMSETTER(TraceEnabled)(TRUE), 1);
862	}
863	else if (!strcmp(a->argv[2], "off"))
864	{
865	CHECK_ERROR_RET(adapter, COMSETTER(TraceEnabled)(FALSE), 1);
866	}
867	else
868	{
869	errorArgument("Invalid nictrace%lu argument '%s'", n, Utf8Str(a->argv[2]).raw());
870	rc = E_FAIL;
871	break;
872	}
873	}
874	else
875	{
876	RTPrintf("The NIC %d is currently disabled and thus can't change its tracefile\n", n);
877	}
878	}
879	}
880	else if (!strncmp(a->argv[1], "nic", 3))
881	{
882	/* Get the number of network adapters */
883	ULONG NetworkAdapterCount = 0;
884	ComPtr <ISystemProperties> info;
885	CHECK_ERROR_BREAK (a->virtualBox, COMGETTER(SystemProperties) (info.asOutParam()));
886	CHECK_ERROR_BREAK (info, COMGETTER(NetworkAdapterCount) (&NetworkAdapterCount));
887
888	unsigned n = parseNum(&a->argv[1][3], NetworkAdapterCount, "NIC");
889	if (!n)
890	{
891	rc = E_FAIL;
892	break;
893	}
894	if (a->argc <= 2)
895	{
896	errorArgument("Missing argument to '%s'", a->argv[1]);
897	rc = E_FAIL;
898	break;
899	}
900
901	/* get the corresponding network adapter */
902	ComPtr<INetworkAdapter> adapter;
903	CHECK_ERROR_BREAK (sessionMachine, GetNetworkAdapter(n - 1, adapter.asOutParam()));
904	if (adapter)
905	{
906	BOOL fEnabled;
907	adapter->COMGETTER(Enabled)(&fEnabled);
908	if (fEnabled)
909	{
910	if (!strcmp(a->argv[2], "null"))
911	{
912	CHECK_ERROR_RET(adapter, COMSETTER(Enabled) (TRUE), 1);
913	CHECK_ERROR_RET(adapter, Detach(), 1);
914	}
915	else if (!strcmp(a->argv[2], "nat"))
916	{
917	CHECK_ERROR_RET(adapter, COMSETTER(Enabled) (TRUE), 1);
918	if (a->argc == 4)
919	CHECK_ERROR_RET(adapter, COMSETTER(NATNetwork)(Bstr(a->argv[3])), 1);
920	CHECK_ERROR_RET(adapter, AttachToNAT(), 1);
921	}
922	else if ( !strcmp(a->argv[2], "bridged")
923	\|\| !strcmp(a->argv[2], "hostif")) /* backward compatibility */
924	{
925	if (a->argc <= 3)
926	{
927	errorArgument("Missing argument to '%s'", a->argv[2]);
928	rc = E_FAIL;
929	break;
930	}
931	CHECK_ERROR_RET(adapter, COMSETTER(Enabled) (TRUE), 1);
932	CHECK_ERROR_RET(adapter, COMSETTER(HostInterface)(Bstr(a->argv[3])), 1);
933	CHECK_ERROR_RET(adapter, AttachToBridgedInterface(), 1);
934	}
935	else if (!strcmp(a->argv[2], "intnet"))
936	{
937	if (a->argc <= 3)
938	{
939	errorArgument("Missing argument to '%s'", a->argv[2]);
940	rc = E_FAIL;
941	break;
942	}
943	CHECK_ERROR_RET(adapter, COMSETTER(Enabled) (TRUE), 1);
944	CHECK_ERROR_RET(adapter, COMSETTER(InternalNetwork)(Bstr(a->argv[3])), 1);
945	CHECK_ERROR_RET(adapter, AttachToInternalNetwork(), 1);
946	}
947	#if defined(VBOX_WITH_NETFLT)
948	else if (!strcmp(a->argv[2], "hostonly"))
949	{
950	if (a->argc <= 3)
951	{
952	errorArgument("Missing argument to '%s'", a->argv[2]);
953	rc = E_FAIL;
954	break;
955	}
956	CHECK_ERROR_RET(adapter, COMSETTER(Enabled) (TRUE), 1);
957	CHECK_ERROR_RET(adapter, COMSETTER(HostInterface)(Bstr(a->argv[3])), 1);
958	CHECK_ERROR_RET(adapter, AttachToHostOnlyInterface(), 1);
959	}
960	#endif
961	else
962	{
963	errorArgument("Invalid type '%s' specfied for NIC %lu", Utf8Str(a->argv[2]).raw(), n);
964	rc = E_FAIL;
965	break;
966	}
967	}
968	else
969	{
970	RTPrintf("The NIC %d is currently disabled and thus can't change its attachment type\n", n);
971	}
972	}
973	}
974	#endif /* VBOX_DYNAMIC_NET_ATTACH */
975	#ifdef VBOX_WITH_VRDP
976	else if (!strcmp(a->argv[1], "vrdp"))
977	{
978	if (a->argc <= 1 + 1)
979	{
980	errorArgument("Missing argument to '%s'", a->argv[1]);
981	rc = E_FAIL;
982	break;
983	}
984	/* get the corresponding VRDP server */
985	ComPtr<IVRDPServer> vrdpServer;
986	sessionMachine->COMGETTER(VRDPServer)(vrdpServer.asOutParam());
987	ASSERT(vrdpServer);
988	if (vrdpServer)
989	{
990	if (!strcmp(a->argv[2], "on"))
991	{
992	CHECK_ERROR_BREAK (vrdpServer, COMSETTER(Enabled)(TRUE));
993	}
994	else if (!strcmp(a->argv[2], "off"))
995	{
996	CHECK_ERROR_BREAK (vrdpServer, COMSETTER(Enabled)(FALSE));
997	}
998	else
999	{
1000	errorArgument("Invalid vrdp server state '%s'", Utf8Str(a->argv[2]).raw());
1001	rc = E_FAIL;
1002	break;
1003	}
1004	}
1005	}
1006	else if (!strcmp(a->argv[1], "vrdpport"))
1007	{
1008	if (a->argc <= 1 + 1)
1009	{
1010	errorArgument("Missing argument to '%s'", a->argv[1]);
1011	rc = E_FAIL;
1012	break;
1013	}
1014	/* get the corresponding VRDP server */
1015	ComPtr<IVRDPServer> vrdpServer;
1016	sessionMachine->COMGETTER(VRDPServer)(vrdpServer.asOutParam());
1017	ASSERT(vrdpServer);
1018	if (vrdpServer)
1019	{
1020	Bstr vrdpports;
1021
1022	if (!strcmp(a->argv[2], "default"))
1023	vrdpports = "0";
1024	else
1025	vrdpports = a->argv [2];
1026
1027	CHECK_ERROR_BREAK(vrdpServer, COMSETTER(Ports)(vrdpports));
1028	}
1029	}
1030	#endif /* VBOX_WITH_VRDP */
1031	else if ( !strcmp (a->argv[1], "usbattach")
1032	\|\| !strcmp (a->argv[1], "usbdetach"))
1033	{
1034	if (a->argc < 3)
1035	{
1036	errorSyntax(USAGE_CONTROLVM, "Not enough parameters");
1037	rc = E_FAIL;
1038	break;
1039	}
1040
1041	bool attach = !strcmp(a->argv[1], "usbattach");
1042
1043	Bstr usbId = a->argv [2];
1044	if (Guid(usbId).isEmpty())
1045	{
1046	// assume address
1047	if (attach)
1048	{
1049	ComPtr <IHost> host;
1050	CHECK_ERROR_BREAK (a->virtualBox, COMGETTER(Host) (host.asOutParam()));
1051	SafeIfaceArray <IHostUSBDevice> coll;
1052	CHECK_ERROR_BREAK (host, COMGETTER(USBDevices) (ComSafeArrayAsOutParam(coll)));
1053	ComPtr <IHostUSBDevice> dev;
1054	CHECK_ERROR_BREAK (host, FindUSBDeviceByAddress (Bstr (a->argv [2]), dev.asOutParam()));
1055	CHECK_ERROR_BREAK (dev, COMGETTER(Id) (usbId.asOutParam()));
1056	}
1057	else
1058	{
1059	SafeIfaceArray <IUSBDevice> coll;
1060	CHECK_ERROR_BREAK (console, COMGETTER(USBDevices)(ComSafeArrayAsOutParam(coll)));
1061	ComPtr <IUSBDevice> dev;
1062	CHECK_ERROR_BREAK (console, FindUSBDeviceByAddress (Bstr (a->argv [2]),
1063	dev.asOutParam()));
1064	CHECK_ERROR_BREAK (dev, COMGETTER(Id) (usbId.asOutParam()));
1065	}
1066	}
1067
1068	if (attach)
1069	CHECK_ERROR_BREAK (console, AttachUSBDevice (usbId));
1070	else
1071	{
1072	ComPtr <IUSBDevice> dev;
1073	CHECK_ERROR_BREAK (console, DetachUSBDevice (usbId, dev.asOutParam()));
1074	}
1075	}
1076	else if (!strcmp(a->argv[1], "setvideomodehint"))
1077	{
1078	if (a->argc != 5 && a->argc != 6)
1079	{
1080	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
1081	rc = E_FAIL;
1082	break;
1083	}
1084	uint32_t xres = RTStrToUInt32(a->argv[2]);
1085	uint32_t yres = RTStrToUInt32(a->argv[3]);
1086	uint32_t bpp = RTStrToUInt32(a->argv[4]);
1087	uint32_t displayIdx = 0;
1088	if (a->argc == 6)
1089	displayIdx = RTStrToUInt32(a->argv[5]);
1090
1091	ComPtr<IDisplay> display;
1092	CHECK_ERROR_BREAK(console, COMGETTER(Display)(display.asOutParam()));
1093	CHECK_ERROR_BREAK(display, SetVideoModeHint(xres, yres, bpp, displayIdx));
1094	}
1095	else if (!strcmp(a->argv[1], "setcredentials"))
1096	{
1097	bool fAllowLocalLogon = true;
1098	if (a->argc == 7)
1099	{
1100	if ( strcmp(a->argv[5], "--allowlocallogon")
1101	&& strcmp(a->argv[5], "-allowlocallogon"))
1102	{
1103	errorArgument("Invalid parameter '%s'", a->argv[5]);
1104	rc = E_FAIL;
1105	break;
1106	}
1107	if (!strcmp(a->argv[6], "no"))
1108	fAllowLocalLogon = false;
1109	}
1110	else if (a->argc != 5)
1111	{
1112	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
1113	rc = E_FAIL;
1114	break;
1115	}
1116
1117	ComPtr<IGuest> guest;
1118	CHECK_ERROR_BREAK(console, COMGETTER(Guest)(guest.asOutParam()));
1119	CHECK_ERROR_BREAK(guest, SetCredentials(Bstr(a->argv[2]), Bstr(a->argv[3]), Bstr(a->argv[4]), fAllowLocalLogon));
1120	}
1121	else if (!strcmp(a->argv[1], "dvdattach"))
1122	{
1123	if (a->argc != 3)
1124	{
1125	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
1126	rc = E_FAIL;
1127	break;
1128	}
1129
1130	ComPtr<IMedium> dvdMedium;
1131
1132	/* unmount? */
1133	if (!strcmp(a->argv[2], "none"))
1134	{
1135	/* nothing to do, NULL object will cause unmount */
1136	}
1137	/* host drive? */
1138	else if (!strncmp(a->argv[2], "host:", 5))
1139	{
1140	ComPtr<IHost> host;
1141	CHECK_ERROR(a->virtualBox, COMGETTER(Host)(host.asOutParam()));
1142
1143	rc = host->FindHostDVDDrive(Bstr(a->argv[2] + 5), dvdMedium.asOutParam());
1144	if (!dvdMedium)
1145	{
1146	errorArgument("Invalid host DVD drive name \"%s\"",
1147	a->argv[2] + 5);
1148	rc = E_FAIL;
1149	break;
1150	}
1151	}
1152	else
1153	{
1154	/* first assume it's a UUID */
1155	Bstr uuid(a->argv[2]);
1156	rc = a->virtualBox->GetDVDImage(uuid, dvdMedium.asOutParam());
1157	if (FAILED(rc) \|\| !dvdMedium)
1158	{
1159	/* must be a filename, check if it's in the collection */
1160	rc = a->virtualBox->FindDVDImage(Bstr(a->argv[2]), dvdMedium.asOutParam());
1161	/* not registered, do that on the fly */
1162	if (!dvdMedium)
1163	{
1164	Bstr emptyUUID;
1165	CHECK_ERROR(a->virtualBox, OpenDVDImage(Bstr(a->argv[2]), emptyUUID, dvdMedium.asOutParam()));
1166	}
1167	}
1168	if (!dvdMedium)
1169	{
1170	rc = E_FAIL;
1171	break;
1172	}
1173	}
1174
1175	/** @todo generalize this, allow arbitrary number of DVD drives
1176	* and as a consequence multiple attachments and different
1177	* storage controllers. */
1178	if (dvdMedium)
1179	dvdMedium->COMGETTER(Id)(uuid.asOutParam());
1180	else
1181	uuid = Guid().toString();
1182	CHECK_ERROR(machine, MountMedium(Bstr("IDE Controller"), 1, 0, uuid));
1183	}
1184	else if (!strcmp(a->argv[1], "floppyattach"))
1185	{
1186	if (a->argc != 3)
1187	{
1188	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
1189	rc = E_FAIL;
1190	break;
1191	}
1192
1193	ComPtr<IMedium> floppyMedium;
1194
1195	/* unmount? */
1196	if (!strcmp(a->argv[2], "none"))
1197	{
1198	/* nothing to do, NULL object will cause unmount */
1199	}
1200	/* host drive? */
1201	else if (!strncmp(a->argv[2], "host:", 5))
1202	{
1203	ComPtr<IHost> host;
1204	CHECK_ERROR(a->virtualBox, COMGETTER(Host)(host.asOutParam()));
1205	host->FindHostFloppyDrive(Bstr(a->argv[2] + 5), floppyMedium.asOutParam());
1206	if (!floppyMedium)
1207	{
1208	errorArgument("Invalid host floppy drive name \"%s\"",
1209	a->argv[2] + 5);
1210	rc = E_FAIL;
1211	break;
1212	}
1213	}
1214	else
1215	{
1216	/* first assume it's a UUID */
1217	Bstr uuid(a->argv[2]);
1218	rc = a->virtualBox->GetFloppyImage(uuid, floppyMedium.asOutParam());
1219	if (FAILED(rc) \|\| !floppyMedium)
1220	{
1221	/* must be a filename, check if it's in the collection */
1222	rc = a->virtualBox->FindFloppyImage(Bstr(a->argv[2]), floppyMedium.asOutParam());
1223	/* not registered, do that on the fly */
1224	if (!floppyMedium)
1225	{
1226	Bstr emptyUUID;
1227	CHECK_ERROR(a->virtualBox, OpenFloppyImage(Bstr(a->argv[2]), emptyUUID, floppyMedium.asOutParam()));
1228	}
1229	}
1230	if (!floppyMedium)
1231	{
1232	rc = E_FAIL;
1233	break;
1234	}
1235	}
1236	floppyMedium->COMGETTER(Id)(uuid.asOutParam());
1237	CHECK_ERROR(machine, MountMedium(Bstr("Floppy Controller"), 0, 0, uuid));
1238	}
1239	#ifdef VBOX_WITH_MEM_BALLOONING
1240	else if ( !strcmp(a->argv[1], "--guestmemoryballoon")
1241	\|\| !strcmp(a->argv[1], "-guestmemoryballoon"))
1242	{
1243	if (a->argc != 3)
1244	{
1245	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
1246	rc = E_FAIL;
1247	break;
1248	}
1249	uint32_t uVal;
1250	int vrc;
1251	vrc = RTStrToUInt32Ex(a->argv[2], NULL, 0, &uVal);
1252	if (vrc != VINF_SUCCESS)
1253	{
1254	errorArgument("Error parsing guest memory balloon size '%s'", a->argv[2]);
1255	rc = E_FAIL;
1256	break;
1257	}
1258
1259	/* guest is running; update IGuest */
1260	ComPtr <IGuest> guest;
1261
1262	rc = console->COMGETTER(Guest)(guest.asOutParam());
1263	if (SUCCEEDED(rc))
1264	CHECK_ERROR(guest, COMSETTER(MemoryBalloonSize)(uVal));
1265	}
1266	#endif
1267	else if ( !strcmp(a->argv[1], "--gueststatisticsinterval")
1268	\|\| !strcmp(a->argv[1], "-gueststatisticsinterval"))
1269	{
1270	if (a->argc != 3)
1271	{
1272	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
1273	rc = E_FAIL;
1274	break;
1275	}
1276	uint32_t uVal;
1277	int vrc;
1278	vrc = RTStrToUInt32Ex(a->argv[2], NULL, 0, &uVal);
1279	if (vrc != VINF_SUCCESS)
1280	{
1281	errorArgument("Error parsing guest statistics interval '%s'", a->argv[2]);
1282	rc = E_FAIL;
1283	break;
1284	}
1285
1286	/* guest is running; update IGuest */
1287	ComPtr <IGuest> guest;
1288
1289	rc = console->COMGETTER(Guest)(guest.asOutParam());
1290	if (SUCCEEDED(rc))
1291	CHECK_ERROR(guest, COMSETTER(StatisticsUpdateInterval)(uVal));
1292	}
1293	else if (!strcmp(a->argv[1], "migrate"))
1294	{
1295	Bstr bstrHostname;
1296	uint32_t uPort = UINT32_MAX;
1297	Bstr bstrPassword("");
1298	static const RTGETOPTDEF s_aMigrateOptions[] =
1299	{
1300	{ "--hostname", 'h', RTGETOPT_REQ_STRING }, /** @todo RTGETOPT_FLAG_MANDATORY */
1301	{ "--port", 'p', RTGETOPT_REQ_UINT32 }, /** @todo RTGETOPT_FLAG_MANDATORY */
1302	{ "--password", 'P', RTGETOPT_REQ_STRING }
1303	};
1304	RTGETOPTSTATE GetOptState;
1305	RTGetOptInit(&GetOptState, a->argc, a->argv, s_aMigrateOptions, RT_ELEMENTS(s_aMigrateOptions), 2, 0 /fFlags/);
1306	int ch;
1307	RTGETOPTUNION Value;
1308	while ( SUCCEEDED(rc)
1309	&& (ch = RTGetOpt(&GetOptState, &Value)))
1310	{
1311	switch (ch)
1312	{
1313	case 'h': bstrHostname = Value.psz; break;
1314	case 'p': uPort = Value.u32; break;
1315	case 'P': bstrPassword = Value.psz; break;
1316	default:
1317	errorGetOpt(USAGE_SNAPSHOT, ch, &Value);
1318	rc = E_FAIL;
1319	break;
1320	}
1321	}
1322	if (FAILED(rc))
1323	break;
1324
1325	ComPtr<IProgress> progress;
1326	CHECK_ERROR_BREAK(console, Migrate(bstrHostname, uPort, bstrPassword, progress.asOutParam()));
1327	showProgress(progress);
1328
1329	LONG iRc;
1330	CHECK_ERROR_BREAK(progress, COMGETTER(ResultCode)(&iRc));
1331	if (FAILED(iRc))
1332	{
1333	com::ProgressErrorInfo info(progress);
1334	if (info.isBasicAvailable())
1335	RTPrintf("Error: live migration failed. Error message: %lS\n", info.getText().raw());
1336	else
1337	RTPrintf("Error: live migration failed. No error message available!\n");
1338	}
1339	}
1340	else
1341	{
1342	errorSyntax(USAGE_CONTROLVM, "Invalid parameter '%s'", Utf8Str(a->argv[1]).raw());
1343	rc = E_FAIL;
1344	}
1345	}
1346	while (0);
1347
1348	a->session->Close();
1349
1350	return SUCCEEDED (rc) ? 0 : 1;
1351	}
1352
1353	static int handleDiscardState(HandlerArg *a)
1354	{
1355	HRESULT rc;
1356
1357	if (a->argc != 1)
1358	return errorSyntax(USAGE_DISCARDSTATE, "Incorrect number of parameters");
1359
1360	ComPtr<IMachine> machine;
1361	/* assume it's a UUID */
1362	rc = a->virtualBox->GetMachine(Bstr(a->argv[0]), machine.asOutParam());
1363	if (FAILED(rc) \|\| !machine)
1364	{
1365	/* must be a name */
1366	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
1367	}
1368	if (machine)
1369	{
1370	do
1371	{
1372	/* we have to open a session for this task */
1373	Bstr guid;
1374	machine->COMGETTER(Id)(guid.asOutParam());
1375	CHECK_ERROR_BREAK(a->virtualBox, OpenSession(a->session, guid));
1376	do
1377	{
1378	ComPtr<IConsole> console;
1379	CHECK_ERROR_BREAK(a->session, COMGETTER(Console)(console.asOutParam()));
1380	CHECK_ERROR_BREAK(console, ForgetSavedState(true));
1381	}
1382	while (0);
1383	CHECK_ERROR_BREAK(a->session, Close());
1384	}
1385	while (0);
1386	}
1387
1388	return SUCCEEDED(rc) ? 0 : 1;
1389	}
1390
1391	static int handleAdoptdState(HandlerArg *a)
1392	{
1393	HRESULT rc;
1394
1395	if (a->argc != 2)
1396	return errorSyntax(USAGE_ADOPTSTATE, "Incorrect number of parameters");
1397
1398	ComPtr<IMachine> machine;
1399	/* assume it's a UUID */
1400	rc = a->virtualBox->GetMachine(Bstr(a->argv[0]), machine.asOutParam());
1401	if (FAILED(rc) \|\| !machine)
1402	{
1403	/* must be a name */
1404	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
1405	}
1406	if (machine)
1407	{
1408	do
1409	{
1410	/* we have to open a session for this task */
1411	Bstr guid;
1412	machine->COMGETTER(Id)(guid.asOutParam());
1413	CHECK_ERROR_BREAK(a->virtualBox, OpenSession(a->session, guid));
1414	do
1415	{
1416	ComPtr<IConsole> console;
1417	CHECK_ERROR_BREAK(a->session, COMGETTER(Console)(console.asOutParam()));
1418	CHECK_ERROR_BREAK(console, AdoptSavedState (Bstr (a->argv[1])));
1419	}
1420	while (0);
1421	CHECK_ERROR_BREAK(a->session, Close());
1422	}
1423	while (0);
1424	}
1425
1426	return SUCCEEDED(rc) ? 0 : 1;
1427	}
1428
1429	static int handleGetExtraData(HandlerArg *a)
1430	{
1431	HRESULT rc = S_OK;
1432
1433	if (a->argc != 2)
1434	return errorSyntax(USAGE_GETEXTRADATA, "Incorrect number of parameters");
1435
1436	/* global data? */
1437	if (!strcmp(a->argv[0], "global"))
1438	{
1439	/* enumeration? */
1440	if (!strcmp(a->argv[1], "enumerate"))
1441	{
1442	SafeArray<BSTR> aKeys;
1443	CHECK_ERROR(a->virtualBox, GetExtraDataKeys(ComSafeArrayAsOutParam(aKeys)));
1444
1445	for (size_t i = 0;
1446	i < aKeys.size();
1447	++i)
1448	{
1449	Bstr bstrKey(aKeys[i]);
1450	Bstr bstrValue;
1451	CHECK_ERROR(a->virtualBox, GetExtraData(bstrKey, bstrValue.asOutParam()));
1452
1453	RTPrintf("Key: %lS, Value: %lS\n", bstrKey.raw(), bstrValue.raw());
1454	}
1455	}
1456	else
1457	{
1458	Bstr value;
1459	CHECK_ERROR(a->virtualBox, GetExtraData(Bstr(a->argv[1]), value.asOutParam()));
1460	if (!value.isEmpty())
1461	RTPrintf("Value: %lS\n", value.raw());
1462	else
1463	RTPrintf("No value set!\n");
1464	}
1465	}
1466	else
1467	{
1468	ComPtr<IMachine> machine;
1469	/* assume it's a UUID */
1470	rc = a->virtualBox->GetMachine(Bstr(a->argv[0]), machine.asOutParam());
1471	if (FAILED(rc) \|\| !machine)
1472	{
1473	/* must be a name */
1474	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
1475	}
1476	if (machine)
1477	{
1478	/* enumeration? */
1479	if (!strcmp(a->argv[1], "enumerate"))
1480	{
1481	SafeArray<BSTR> aKeys;
1482	CHECK_ERROR(machine, GetExtraDataKeys(ComSafeArrayAsOutParam(aKeys)));
1483
1484	for (size_t i = 0;
1485	i < aKeys.size();
1486	++i)
1487	{
1488	Bstr bstrKey(aKeys[i]);
1489	Bstr bstrValue;
1490	CHECK_ERROR(machine, GetExtraData(bstrKey, bstrValue.asOutParam()));
1491
1492	RTPrintf("Key: %lS, Value: %lS\n", bstrKey.raw(), bstrValue.raw());
1493	}
1494	}
1495	else
1496	{
1497	Bstr value;
1498	CHECK_ERROR(machine, GetExtraData(Bstr(a->argv[1]), value.asOutParam()));
1499	if (!value.isEmpty())
1500	RTPrintf("Value: %lS\n", value.raw());
1501	else
1502	RTPrintf("No value set!\n");
1503	}
1504	}
1505	}
1506	return SUCCEEDED(rc) ? 0 : 1;
1507	}
1508
1509	static int handleSetExtraData(HandlerArg *a)
1510	{
1511	HRESULT rc = S_OK;
1512
1513	if (a->argc < 2)
1514	return errorSyntax(USAGE_SETEXTRADATA, "Not enough parameters");
1515
1516	/* global data? */
1517	if (!strcmp(a->argv[0], "global"))
1518	{
1519	if (a->argc < 3)
1520	CHECK_ERROR(a->virtualBox, SetExtraData(Bstr(a->argv[1]), NULL));
1521	else if (a->argc == 3)
1522	CHECK_ERROR(a->virtualBox, SetExtraData(Bstr(a->argv[1]), Bstr(a->argv[2])));
1523	else
1524	return errorSyntax(USAGE_SETEXTRADATA, "Too many parameters");
1525	}
1526	else
1527	{
1528	ComPtr<IMachine> machine;
1529	/* assume it's a UUID */
1530	rc = a->virtualBox->GetMachine(Bstr(a->argv[0]), machine.asOutParam());
1531	if (FAILED(rc) \|\| !machine)
1532	{
1533	/* must be a name */
1534	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
1535	}
1536	if (machine)
1537	{
1538	if (a->argc < 3)
1539	CHECK_ERROR(machine, SetExtraData(Bstr(a->argv[1]), NULL));
1540	else if (a->argc == 3)
1541	CHECK_ERROR(machine, SetExtraData(Bstr(a->argv[1]), Bstr(a->argv[2])));
1542	else
1543	return errorSyntax(USAGE_SETEXTRADATA, "Too many parameters");
1544	}
1545	}
1546	return SUCCEEDED(rc) ? 0 : 1;
1547	}
1548
1549	static int handleSetProperty(HandlerArg *a)
1550	{
1551	HRESULT rc;
1552
1553	/* there must be two arguments: property name and value */
1554	if (a->argc != 2)
1555	return errorSyntax(USAGE_SETPROPERTY, "Incorrect number of parameters");
1556
1557	ComPtr<ISystemProperties> systemProperties;
1558	a->virtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam());
1559
1560	if (!strcmp(a->argv[0], "hdfolder"))
1561	{
1562	/* reset to default? */
1563	if (!strcmp(a->argv[1], "default"))
1564	CHECK_ERROR(systemProperties, COMSETTER(DefaultHardDiskFolder)(NULL));
1565	else
1566	CHECK_ERROR(systemProperties, COMSETTER(DefaultHardDiskFolder)(Bstr(a->argv[1])));
1567	}
1568	else if (!strcmp(a->argv[0], "machinefolder"))
1569	{
1570	/* reset to default? */
1571	if (!strcmp(a->argv[1], "default"))
1572	CHECK_ERROR(systemProperties, COMSETTER(DefaultMachineFolder)(NULL));
1573	else
1574	CHECK_ERROR(systemProperties, COMSETTER(DefaultMachineFolder)(Bstr(a->argv[1])));
1575	}
1576	else if (!strcmp(a->argv[0], "vrdpauthlibrary"))
1577	{
1578	/* reset to default? */
1579	if (!strcmp(a->argv[1], "default"))
1580	CHECK_ERROR(systemProperties, COMSETTER(RemoteDisplayAuthLibrary)(NULL));
1581	else
1582	CHECK_ERROR(systemProperties, COMSETTER(RemoteDisplayAuthLibrary)(Bstr(a->argv[1])));
1583	}
1584	else if (!strcmp(a->argv[0], "websrvauthlibrary"))
1585	{
1586	/* reset to default? */
1587	if (!strcmp(a->argv[1], "default"))
1588	CHECK_ERROR(systemProperties, COMSETTER(WebServiceAuthLibrary)(NULL));
1589	else
1590	CHECK_ERROR(systemProperties, COMSETTER(WebServiceAuthLibrary)(Bstr(a->argv[1])));
1591	}
1592	else if (!strcmp(a->argv[0], "loghistorycount"))
1593	{
1594	uint32_t uVal;
1595	int vrc;
1596	vrc = RTStrToUInt32Ex(a->argv[1], NULL, 0, &uVal);
1597	if (vrc != VINF_SUCCESS)
1598	return errorArgument("Error parsing Log history count '%s'", a->argv[1]);
1599	CHECK_ERROR(systemProperties, COMSETTER(LogHistoryCount)(uVal));
1600	}
1601	else
1602	return errorSyntax(USAGE_SETPROPERTY, "Invalid parameter '%s'", a->argv[0]);
1603
1604	return SUCCEEDED(rc) ? 0 : 1;
1605	}
1606
1607	static int handleSharedFolder (HandlerArg *a)
1608	{
1609	HRESULT rc;
1610
1611	/* we need at least a command and target */
1612	if (a->argc < 2)
1613	return errorSyntax(USAGE_SHAREDFOLDER, "Not enough parameters");
1614
1615	ComPtr<IMachine> machine;
1616	/* assume it's a UUID */
1617	rc = a->virtualBox->GetMachine(Bstr(a->argv[1]), machine.asOutParam());
1618	if (FAILED(rc) \|\| !machine)
1619	{
1620	/* must be a name */
1621	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[1]), machine.asOutParam()));
1622	}
1623	if (!machine)
1624	return 1;
1625	Bstr uuid;
1626	machine->COMGETTER(Id)(uuid.asOutParam());
1627
1628	if (!strcmp(a->argv[0], "add"))
1629	{
1630	/* we need at least four more parameters */
1631	if (a->argc < 5)
1632	return errorSyntax(USAGE_SHAREDFOLDER_ADD, "Not enough parameters");
1633
1634	char *name = NULL;
1635	char *hostpath = NULL;
1636	bool fTransient = false;
1637	bool fWritable = true;
1638
1639	for (int i = 2; i < a->argc; i++)
1640	{
1641	if ( !strcmp(a->argv[i], "--name")
1642	\|\| !strcmp(a->argv[i], "-name"))
1643	{
1644	if (a->argc <= i + 1 \|\| !*a->argv[i+1])
1645	return errorArgument("Missing argument to '%s'", a->argv[i]);
1646	i++;
1647	name = a->argv[i];
1648	}
1649	else if ( !strcmp(a->argv[i], "--hostpath")
1650	\|\| !strcmp(a->argv[i], "-hostpath"))
1651	{
1652	if (a->argc <= i + 1 \|\| !*a->argv[i+1])
1653	return errorArgument("Missing argument to '%s'", a->argv[i]);
1654	i++;
1655	hostpath = a->argv[i];
1656	}
1657	else if ( !strcmp(a->argv[i], "--readonly")
1658	\|\| !strcmp(a->argv[i], "-readonly"))
1659	{
1660	fWritable = false;
1661	}
1662	else if ( !strcmp(a->argv[i], "--transient")
1663	\|\| !strcmp(a->argv[i], "-transient"))
1664	{
1665	fTransient = true;
1666	}
1667	else
1668	return errorSyntax(USAGE_SHAREDFOLDER_ADD, "Invalid parameter '%s'", Utf8Str(a->argv[i]).raw());
1669	}
1670
1671	if (NULL != strstr(name, " "))
1672	return errorSyntax(USAGE_SHAREDFOLDER_ADD, "No spaces allowed in parameter '-name'!");
1673
1674	/* required arguments */
1675	if (!name \|\| !hostpath)
1676	{
1677	return errorSyntax(USAGE_SHAREDFOLDER_ADD, "Parameters --name and --hostpath are required");
1678	}
1679
1680	if (fTransient)
1681	{
1682	ComPtr <IConsole> console;
1683
1684	/* open an existing session for the VM */
1685	CHECK_ERROR_RET(a->virtualBox, OpenExistingSession (a->session, uuid), 1);
1686	/* get the session machine */
1687	CHECK_ERROR_RET(a->session, COMGETTER(Machine)(machine.asOutParam()), 1);
1688	/* get the session console */
1689	CHECK_ERROR_RET(a->session, COMGETTER(Console)(console.asOutParam()), 1);
1690
1691	CHECK_ERROR(console, CreateSharedFolder(Bstr(name), Bstr(hostpath), fWritable));
1692
1693	if (console)
1694	a->session->Close();
1695	}
1696	else
1697	{
1698	/* open a session for the VM */
1699	CHECK_ERROR_RET (a->virtualBox, OpenSession(a->session, uuid), 1);
1700
1701	/* get the mutable session machine */
1702	a->session->COMGETTER(Machine)(machine.asOutParam());
1703
1704	CHECK_ERROR(machine, CreateSharedFolder(Bstr(name), Bstr(hostpath), fWritable));
1705
1706	if (SUCCEEDED(rc))
1707	CHECK_ERROR(machine, SaveSettings());
1708
1709	a->session->Close();
1710	}
1711	}
1712	else if (!strcmp(a->argv[0], "remove"))
1713	{
1714	/* we need at least two more parameters */
1715	if (a->argc < 3)
1716	return errorSyntax(USAGE_SHAREDFOLDER_REMOVE, "Not enough parameters");
1717
1718	char *name = NULL;
1719	bool fTransient = false;
1720
1721	for (int i = 2; i < a->argc; i++)
1722	{
1723	if ( !strcmp(a->argv[i], "--name")
1724	\|\| !strcmp(a->argv[i], "-name"))
1725	{
1726	if (a->argc <= i + 1 \|\| !*a->argv[i+1])
1727	return errorArgument("Missing argument to '%s'", a->argv[i]);
1728	i++;
1729	name = a->argv[i];
1730	}
1731	else if ( !strcmp(a->argv[i], "--transient")
1732	\|\| !strcmp(a->argv[i], "-transient"))
1733	{
1734	fTransient = true;
1735	}
1736	else
1737	return errorSyntax(USAGE_SHAREDFOLDER_REMOVE, "Invalid parameter '%s'", Utf8Str(a->argv[i]).raw());
1738	}
1739
1740	/* required arguments */
1741	if (!name)
1742	return errorSyntax(USAGE_SHAREDFOLDER_REMOVE, "Parameter --name is required");
1743
1744	if (fTransient)
1745	{
1746	ComPtr <IConsole> console;
1747
1748	/* open an existing session for the VM */
1749	CHECK_ERROR_RET(a->virtualBox, OpenExistingSession (a->session, uuid), 1);
1750	/* get the session machine */
1751	CHECK_ERROR_RET(a->session, COMGETTER(Machine)(machine.asOutParam()), 1);
1752	/* get the session console */
1753	CHECK_ERROR_RET(a->session, COMGETTER(Console)(console.asOutParam()), 1);
1754
1755	CHECK_ERROR(console, RemoveSharedFolder(Bstr(name)));
1756
1757	if (console)
1758	a->session->Close();
1759	}
1760	else
1761	{
1762	/* open a session for the VM */
1763	CHECK_ERROR_RET (a->virtualBox, OpenSession(a->session, uuid), 1);
1764
1765	/* get the mutable session machine */
1766	a->session->COMGETTER(Machine)(machine.asOutParam());
1767
1768	CHECK_ERROR(machine, RemoveSharedFolder(Bstr(name)));
1769
1770	/* commit and close the session */
1771	CHECK_ERROR(machine, SaveSettings());
1772	a->session->Close();
1773	}
1774	}
1775	else
1776	return errorSyntax(USAGE_SETPROPERTY, "Invalid parameter '%s'", Utf8Str(a->argv[0]).raw());
1777
1778	return 0;
1779	}
1780
1781	static int handleVMStatistics(HandlerArg *a)
1782	{
1783	HRESULT rc;
1784
1785	/* at least one option: the UUID or name of the VM */
1786	if (a->argc < 1)
1787	return errorSyntax(USAGE_VM_STATISTICS, "Incorrect number of parameters");
1788
1789	/* try to find the given machine */
1790	ComPtr <IMachine> machine;
1791	Bstr uuid (a->argv[0]);
1792	if (!Guid (a->argv[0]).isEmpty())
1793	CHECK_ERROR(a->virtualBox, GetMachine(uuid, machine.asOutParam()));
1794	else
1795	{
1796	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]), machine.asOutParam()));
1797	if (SUCCEEDED (rc))
1798	machine->COMGETTER(Id)(uuid.asOutParam());
1799	}
1800	if (FAILED(rc))
1801	return 1;
1802
1803	/* parse arguments. */
1804	bool fReset = false;
1805	bool fWithDescriptions = false;
1806	const char pszPattern = NULL; / all */
1807	for (int i = 1; i < a->argc; i++)
1808	{
1809	if ( !strcmp(a->argv[i], "--pattern")
1810	\|\| !strcmp(a->argv[i], "-pattern"))
1811	{
1812	if (pszPattern)
1813	return errorSyntax(USAGE_VM_STATISTICS, "Multiple --patterns options is not permitted");
1814	if (i + 1 >= a->argc)
1815	return errorArgument("Missing argument to '%s'", a->argv[i]);
1816	pszPattern = a->argv[++i];
1817	}
1818	else if ( !strcmp(a->argv[i], "--descriptions")
1819	\|\| !strcmp(a->argv[i], "-descriptions"))
1820	fWithDescriptions = true;
1821	/* add: --file <filename> and --formatted */
1822	else if ( !strcmp(a->argv[i], "--reset")
1823	\|\| !strcmp(a->argv[i], "-reset"))
1824	fReset = true;
1825	else
1826	return errorSyntax(USAGE_VM_STATISTICS, "Unknown option '%s'", a->argv[i]);
1827	}
1828	if (fReset && fWithDescriptions)
1829	return errorSyntax(USAGE_VM_STATISTICS, "The --reset and --descriptions options does not mix");
1830
1831
1832	/* open an existing session for the VM. */
1833	CHECK_ERROR(a->virtualBox, OpenExistingSession(a->session, uuid));
1834	if (SUCCEEDED(rc))
1835	{
1836	/* get the session console. */
1837	ComPtr <IConsole> console;
1838	CHECK_ERROR(a->session, COMGETTER(Console)(console.asOutParam()));
1839	if (SUCCEEDED(rc))
1840	{
1841	/* get the machine debugger. */
1842	ComPtr <IMachineDebugger> debugger;
1843	CHECK_ERROR(console, COMGETTER(Debugger)(debugger.asOutParam()));
1844	if (SUCCEEDED(rc))
1845	{
1846	if (fReset)
1847	CHECK_ERROR(debugger, ResetStats(Bstr(pszPattern)));
1848	else
1849	{
1850	Bstr stats;
1851	CHECK_ERROR(debugger, GetStats(Bstr(pszPattern), fWithDescriptions, stats.asOutParam()));
1852	if (SUCCEEDED(rc))
1853	{
1854	/* if (fFormatted)
1855	{ big mess }
1856	else
1857	*/
1858	RTPrintf("%ls\n", stats.raw());
1859	}
1860	}
1861	}
1862	a->session->Close();
1863	}
1864	}
1865
1866	return SUCCEEDED(rc) ? 0 : 1;
1867	}
1868	#endif /* !VBOX_ONLY_DOCS */
1869
1870	// main
1871	///////////////////////////////////////////////////////////////////////////////
1872
1873	int main(int argc, char *argv[])
1874	{
1875	/*
1876	* Before we do anything, init the runtime without loading
1877	* the support driver.
1878	*/
1879	RTR3Init();
1880
1881	bool fShowLogo = true;
1882	int iCmd = 1;
1883	int iCmdArg;
1884
1885	/* global options */
1886	for (int i = 1; i < argc \|\| argc <= iCmd; i++)
1887	{
1888	if ( argc <= iCmd
1889	\|\| !strcmp(argv[i], "help")
1890	\|\| !strcmp(argv[i], "-?")
1891	\|\| !strcmp(argv[i], "-h")
1892	\|\| !strcmp(argv[i], "-help")
1893	\|\| !strcmp(argv[i], "--help"))
1894	{
1895	showLogo();
1896	printUsage(USAGE_ALL);
1897	return 0;
1898	}
1899	else if ( !strcmp(argv[i], "-v")
1900	\|\| !strcmp(argv[i], "-version")
1901	\|\| !strcmp(argv[i], "-Version")
1902	\|\| !strcmp(argv[i], "--version"))
1903	{
1904	/* Print version number, and do nothing else. */
1905	RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
1906	return 0;
1907	}
1908	else if ( !strcmp(argv[i], "--dumpopts")
1909	\|\| !strcmp(argv[i], "-dumpopts"))
1910	{
1911	/* Special option to dump really all commands,
1912	* even the ones not understood on this platform. */
1913	printUsage(USAGE_DUMPOPTS);
1914	return 0;
1915	}
1916	else if ( !strcmp(argv[i], "--nologo")
1917	\|\| !strcmp(argv[i], "-nologo")
1918	\|\| !strcmp(argv[i], "-q"))
1919	{
1920	/* suppress the logo */
1921	fShowLogo = false;
1922	iCmd++;
1923	}
1924	else
1925	{
1926	break;
1927	}
1928	}
1929
1930	iCmdArg = iCmd + 1;
1931
1932	if (fShowLogo)
1933	showLogo();
1934
1935
1936	#ifdef VBOX_ONLY_DOCS
1937	int rc = 0;
1938	#else /* !VBOX_ONLY_DOCS */
1939	HRESULT rc = 0;
1940
1941	rc = com::Initialize();
1942	if (FAILED(rc))
1943	{
1944	RTPrintf("ERROR: failed to initialize COM!\n");
1945	return rc;
1946	}
1947
1948	/*
1949	* The input is in the host OS'es codepage (NT guarantees ACP).
1950	* For VBox we use UTF-8 and convert to UCS-2 when calling (XP)COM APIs.
1951	* For simplicity, just convert the argv[] array here.
1952	*/
1953	for (int i = iCmdArg; i < argc; i++)
1954	{
1955	char *converted;
1956	RTStrCurrentCPToUtf8(&converted, argv[i]);
1957	argv[i] = converted;
1958	}
1959
1960	do
1961	{
1962	// scopes all the stuff till shutdown
1963	////////////////////////////////////////////////////////////////////////////
1964
1965	/* convertfromraw: does not need a VirtualBox instantiation. */
1966	if (argc >= iCmdArg && ( !strcmp(argv[iCmd], "convertfromraw")
1967	\|\| !strcmp(argv[iCmd], "convertdd")))
1968	{
1969	rc = handleConvertFromRaw(argc - iCmdArg, argv + iCmdArg);
1970	break;
1971	}
1972
1973	ComPtr<IVirtualBox> virtualBox;
1974	ComPtr<ISession> session;
1975
1976	rc = virtualBox.createLocalObject(CLSID_VirtualBox);
1977	if (FAILED(rc))
1978	RTPrintf("ERROR: failed to create the VirtualBox object!\n");
1979	else
1980	{
1981	rc = session.createInprocObject(CLSID_Session);
1982	if (FAILED(rc))
1983	RTPrintf("ERROR: failed to create a session object!\n");
1984	}
1985
1986	if (FAILED(rc))
1987	{
1988	com::ErrorInfo info;
1989	if (!info.isFullAvailable() && !info.isBasicAvailable())
1990	{
1991	com::GluePrintRCMessage(rc);
1992	RTPrintf("Most likely, the VirtualBox COM server is not running or failed to start.\n");
1993	}
1994	else
1995	com::GluePrintErrorInfo(info);
1996	break;
1997	}
1998
1999	HandlerArg handlerArg = { 0, NULL, virtualBox, session };
2000
2001	/*
2002	* All registered command handlers
2003	*/
2004	struct
2005	{
2006	const char *command;
2007	PFNHANDLER handler;
2008	} commandHandlers[] =
2009	{
2010	{ "internalcommands", handleInternalCommands },
2011	{ "list", handleList },
2012	{ "showvminfo", handleShowVMInfo },
2013	{ "registervm", handleRegisterVM },
2014	{ "unregistervm", handleUnregisterVM },
2015	{ "createhd", handleCreateHardDisk },
2016	{ "createvdi", handleCreateHardDisk }, /* backward compatiblity */
2017	{ "modifyhd", handleModifyHardDisk },
2018	{ "modifyvdi", handleModifyHardDisk }, /* backward compatiblity */
2019	{ "clonehd", handleCloneHardDisk },
2020	{ "clonevdi", handleCloneHardDisk }, /* backward compatiblity */
2021	{ "addiscsidisk", handleAddiSCSIDisk },
2022	{ "createvm", handleCreateVM },
2023	{ "modifyvm", handleModifyVM },
2024	{ "startvm", handleStartVM },
2025	{ "controlvm", handleControlVM },
2026	{ "discardstate", handleDiscardState },
2027	{ "adoptstate", handleAdoptdState },
2028	{ "snapshot", handleSnapshot },
2029	{ "openmedium", handleOpenMedium },
2030	{ "registerimage", handleOpenMedium }, /* backward compatiblity */
2031	{ "closemedium", handleCloseMedium },
2032	{ "unregisterimage", handleCloseMedium }, /* backward compatiblity */
2033	{ "showhdinfo", handleShowHardDiskInfo },
2034	{ "showvdiinfo", handleShowHardDiskInfo }, /* backward compatiblity */
2035	{ "getextradata", handleGetExtraData },
2036	{ "setextradata", handleSetExtraData },
2037	{ "setproperty", handleSetProperty },
2038	{ "usbfilter", handleUSBFilter },
2039	{ "sharedfolder", handleSharedFolder },
2040	{ "vmstatistics", handleVMStatistics },
2041	#ifdef VBOX_WITH_GUEST_PROPS
2042	{ "guestproperty", handleGuestProperty },
2043	#endif /* VBOX_WITH_GUEST_PROPS defined */
2044	{ "metrics", handleMetrics },
2045	{ "import", handleImportAppliance },
2046	{ "export", handleExportAppliance },
2047	#if defined(VBOX_WITH_NETFLT)
2048	{ "hostonlyif", handleHostonlyIf },
2049	#endif
2050	{ "dhcpserver", handleDHCPServer},
2051	{ NULL, NULL }
2052	};
2053
2054	int commandIndex;
2055	for (commandIndex = 0; commandHandlers[commandIndex].command != NULL; commandIndex++)
2056	{
2057	if (!strcmp(commandHandlers[commandIndex].command, argv[iCmd]))
2058	{
2059	handlerArg.argc = argc - iCmdArg;
2060	handlerArg.argv = &argv[iCmdArg];
2061
2062	rc = commandHandlers[commandIndex].handler(&handlerArg);
2063	break;
2064	}
2065	}
2066	if (!commandHandlers[commandIndex].command)
2067	{
2068	rc = errorSyntax(USAGE_ALL, "Invalid command '%s'", Utf8Str(argv[iCmd]).raw());
2069	}
2070
2071	/* Although all handlers should always close the session if they open it,
2072	* we do it here just in case if some of the handlers contains a bug --
2073	* leaving the direct session not closed will turn the machine state to
2074	* Aborted which may have unwanted side effects like killing the saved
2075	* state file (if the machine was in the Saved state before). */
2076	session->Close();
2077
2078	EventQueue::getMainEventQueue()->processEventQueue(0);
2079	// end "all-stuff" scope
2080	////////////////////////////////////////////////////////////////////////////
2081	}
2082	while (0);
2083
2084	com::Shutdown();
2085	#endif /* !VBOX_ONLY_DOCS */
2086
2087	/*
2088	* Free converted argument vector
2089	*/
2090	for (int i = iCmdArg; i < argc; i++)
2091	RTStrFree(argv[i]);
2092
2093	return rc != 0;
2094	}

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Frontends/VBoxManage/VBoxManage.cpp@ 23702

Download in other formats: