VBoxManageControlVM.cpp@ 33825

Last change on this file since 33825 was 33825, checked in by vboxsync, 15 years ago
Main,NAT: Managing port-forwarding at runtime. (xTracker/#4835).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 38.3 KB

Line
1	/* $Id: VBoxManageControlVM.cpp 33825 2010-11-08 10:16:25Z vboxsync $ */
2	/** @file
3	* VBoxManage - Implementation of controlvm command.
4	*/
5
6	/*
7	* Copyright (C) 2006-2010 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
19	/*******************************************************************************
20	* Header Files *
21	*******************************************************************************/
22	#include <VBox/com/com.h>
23	#include <VBox/com/string.h>
24	#include <VBox/com/Guid.h>
25	#include <VBox/com/array.h>
26	#include <VBox/com/ErrorInfo.h>
27	#include <VBox/com/errorprint.h>
28	#include <VBox/com/EventQueue.h>
29
30	#include <VBox/com/VirtualBox.h>
31
32	#include <iprt/ctype.h>
33	#include <VBox/err.h>
34	#include <iprt/getopt.h>
35	#include <iprt/stream.h>
36	#include <iprt/string.h>
37	#include <iprt/uuid.h>
38	#include <VBox/log.h>
39
40	#include "VBoxManage.h"
41
42	#include <list>
43
44
45	/**
46	* Parses a number.
47	*
48	* @returns Valid number on success.
49	* @returns 0 if invalid number. All necessary bitching has been done.
50	* @param psz Pointer to the nic number.
51	*/
52	static unsigned parseNum(const char psz, unsigned cMaxNum, const char name)
53	{
54	uint32_t u32;
55	char *pszNext;
56	int rc = RTStrToUInt32Ex(psz, &pszNext, 10, &u32);
57	if ( RT_SUCCESS(rc)
58	&& *pszNext == '\0'
59	&& u32 >= 1
60	&& u32 <= cMaxNum)
61	return (unsigned)u32;
62	errorArgument("Invalid %s number '%s'", name, psz);
63	return 0;
64	}
65
66
67	int handleControlVM(HandlerArg *a)
68	{
69	using namespace com;
70	HRESULT rc;
71
72	if (a->argc < 2)
73	return errorSyntax(USAGE_CONTROLVM, "Not enough parameters");
74
75	/* try to find the given machine */
76	ComPtr <IMachine> machine;
77	CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]).raw(),
78	machine.asOutParam()));
79	if (FAILED(rc))
80	return 1;
81
82	/* open a session for the VM */
83	CHECK_ERROR_RET(machine, LockMachine(a->session, LockType_Shared), 1);
84
85	do
86	{
87	/* get the associated console */
88	ComPtr<IConsole> console;
89	CHECK_ERROR_BREAK(a->session, COMGETTER(Console)(console.asOutParam()));
90	/* ... and session machine */
91	ComPtr<IMachine> sessionMachine;
92	CHECK_ERROR_BREAK(a->session, COMGETTER(Machine)(sessionMachine.asOutParam()));
93
94	/* which command? */
95	if (!strcmp(a->argv[1], "pause"))
96	{
97	CHECK_ERROR_BREAK(console, Pause());
98	}
99	else if (!strcmp(a->argv[1], "resume"))
100	{
101	CHECK_ERROR_BREAK(console, Resume());
102	}
103	else if (!strcmp(a->argv[1], "reset"))
104	{
105	CHECK_ERROR_BREAK(console, Reset());
106	}
107	else if (!strcmp(a->argv[1], "unplugcpu"))
108	{
109	if (a->argc <= 1 + 1)
110	{
111	errorArgument("Missing argument to '%s'. Expected CPU number.", a->argv[1]);
112	rc = E_FAIL;
113	break;
114	}
115
116	unsigned n = parseNum(a->argv[2], 32, "CPU");
117
118	CHECK_ERROR_BREAK(sessionMachine, HotUnplugCPU(n));
119	}
120	else if (!strcmp(a->argv[1], "plugcpu"))
121	{
122	if (a->argc <= 1 + 1)
123	{
124	errorArgument("Missing argument to '%s'. Expected CPU number.", a->argv[1]);
125	rc = E_FAIL;
126	break;
127	}
128
129	unsigned n = parseNum(a->argv[2], 32, "CPU");
130
131	CHECK_ERROR_BREAK(sessionMachine, HotPlugCPU(n));
132	}
133	else if (!strcmp(a->argv[1], "cpuexecutioncap"))
134	{
135	if (a->argc <= 1 + 1)
136	{
137	errorArgument("Missing argument to '%s'. Expected execution cap number.", a->argv[1]);
138	rc = E_FAIL;
139	break;
140	}
141
142	unsigned n = parseNum(a->argv[2], 100, "ExecutionCap");
143
144	CHECK_ERROR_BREAK(machine, COMSETTER(CPUExecutionCap)(n));
145	}
146	else if (!strcmp(a->argv[1], "poweroff"))
147	{
148	ComPtr<IProgress> progress;
149	CHECK_ERROR_BREAK(console, PowerDown(progress.asOutParam()));
150
151	rc = showProgress(progress);
152	if (FAILED(rc))
153	{
154	com::ProgressErrorInfo info(progress);
155	if (info.isBasicAvailable())
156	RTMsgError("Failed to power off machine. Error message: %lS", info.getText().raw());
157	else
158	RTMsgError("Failed to power off machine. No error message available!");
159	}
160	}
161	else if (!strcmp(a->argv[1], "savestate"))
162	{
163	/* first pause so we don't trigger a live save which needs more time/resources */
164	CHECK_ERROR_BREAK(console, Pause());
165
166	ComPtr<IProgress> progress;
167	CHECK_ERROR(console, SaveState(progress.asOutParam()));
168	if (FAILED(rc))
169	{
170	console->Resume();
171	break;
172	}
173
174	rc = showProgress(progress);
175	if (FAILED(rc))
176	{
177	com::ProgressErrorInfo info(progress);
178	if (info.isBasicAvailable())
179	RTMsgError("Failed to save machine state. Error message: %lS", info.getText().raw());
180	else
181	RTMsgError("Failed to save machine state. No error message available!");
182	console->Resume();
183	}
184	}
185	else if (!strcmp(a->argv[1], "acpipowerbutton"))
186	{
187	CHECK_ERROR_BREAK(console, PowerButton());
188	}
189	else if (!strcmp(a->argv[1], "acpisleepbutton"))
190	{
191	CHECK_ERROR_BREAK(console, SleepButton());
192	}
193	else if (!strcmp(a->argv[1], "injectnmi"))
194	{
195	/* get the machine debugger. */
196	ComPtr <IMachineDebugger> debugger;
197	CHECK_ERROR_BREAK(console, COMGETTER(Debugger)(debugger.asOutParam()));
198	CHECK_ERROR_BREAK(debugger, InjectNMI());
199	}
200	else if (!strcmp(a->argv[1], "keyboardputscancode"))
201	{
202	ComPtr<IKeyboard> keyboard;
203	CHECK_ERROR_BREAK(console, COMGETTER(Keyboard)(keyboard.asOutParam()));
204
205	if (a->argc <= 1 + 1)
206	{
207	errorArgument("Missing argument to '%s'. Expected IBM PC AT set 2 keyboard scancode(s) as hex byte(s).", a->argv[1]);
208	rc = E_FAIL;
209	break;
210	}
211
212	std::list<LONG> llScancodes;
213
214	/* Process the command line. */
215	int i;
216	for (i = 1 + 1; i < a->argc; i++)
217	{
218	if ( RT_C_IS_XDIGIT (a->argv[i][0])
219	&& RT_C_IS_XDIGIT (a->argv[i][1])
220	&& a->argv[i][2] == 0)
221	{
222	uint8_t u8Scancode;
223	int irc = RTStrToUInt8Ex(a->argv[i], NULL, 16, &u8Scancode);
224	if (RT_FAILURE (irc))
225	{
226	RTMsgError("Converting '%s' returned %Rrc!", a->argv[i], rc);
227	rc = E_FAIL;
228	break;
229	}
230
231	llScancodes.push_back(u8Scancode);
232	}
233	else
234	{
235	RTMsgError("Error: '%s' is not a hex byte!", a->argv[i]);
236	rc = E_FAIL;
237	break;
238	}
239	}
240
241	if (FAILED(rc))
242	break;
243
244	/* Send scancodes to the VM. */
245	com::SafeArray<LONG> saScancodes(llScancodes);
246	ULONG codesStored = 0;
247	CHECK_ERROR_BREAK(keyboard, PutScancodes(ComSafeArrayAsInParam(saScancodes),
248	&codesStored));
249	if (codesStored < saScancodes.size())
250	{
251	RTMsgError("Only %d scancodes were stored", codesStored);
252	rc = E_FAIL;
253	break;
254	}
255	}
256	else if (!strncmp(a->argv[1], "setlinkstate", 12))
257	{
258	/* Get the number of network adapters */
259	ULONG NetworkAdapterCount = 0;
260	ComPtr <ISystemProperties> info;
261	CHECK_ERROR_BREAK(a->virtualBox, COMGETTER(SystemProperties)(info.asOutParam()));
262	CHECK_ERROR_BREAK(info, COMGETTER(NetworkAdapterCount)(&NetworkAdapterCount));
263
264	unsigned n = parseNum(&a->argv[1][12], NetworkAdapterCount, "NIC");
265	if (!n)
266	{
267	rc = E_FAIL;
268	break;
269	}
270	if (a->argc <= 1 + 1)
271	{
272	errorArgument("Missing argument to '%s'", a->argv[1]);
273	rc = E_FAIL;
274	break;
275	}
276	/* get the corresponding network adapter */
277	ComPtr<INetworkAdapter> adapter;
278	CHECK_ERROR_BREAK(sessionMachine, GetNetworkAdapter(n - 1, adapter.asOutParam()));
279	if (adapter)
280	{
281	if (!strcmp(a->argv[2], "on"))
282	{
283	CHECK_ERROR_BREAK(adapter, COMSETTER(CableConnected)(TRUE));
284	}
285	else if (!strcmp(a->argv[2], "off"))
286	{
287	CHECK_ERROR_BREAK(adapter, COMSETTER(CableConnected)(FALSE));
288	}
289	else
290	{
291	errorArgument("Invalid link state '%s'", Utf8Str(a->argv[2]).c_str());
292	rc = E_FAIL;
293	break;
294	}
295	}
296	}
297	/* here the order in which strncmp is called is important
298	* cause nictracefile can be very well compared with
299	* nictrace and nic and thus everything will always fail
300	* if the order is changed
301	*/
302	else if (!strncmp(a->argv[1], "nictracefile", 12))
303	{
304	/* Get the number of network adapters */
305	ULONG NetworkAdapterCount = 0;
306	ComPtr <ISystemProperties> info;
307	CHECK_ERROR_BREAK(a->virtualBox, COMGETTER(SystemProperties)(info.asOutParam()));
308	CHECK_ERROR_BREAK(info, COMGETTER(NetworkAdapterCount)(&NetworkAdapterCount));
309
310	unsigned n = parseNum(&a->argv[1][12], NetworkAdapterCount, "NIC");
311	if (!n)
312	{
313	rc = E_FAIL;
314	break;
315	}
316	if (a->argc <= 2)
317	{
318	errorArgument("Missing argument to '%s'", a->argv[1]);
319	rc = E_FAIL;
320	break;
321	}
322
323	/* get the corresponding network adapter */
324	ComPtr<INetworkAdapter> adapter;
325	CHECK_ERROR_BREAK(sessionMachine, GetNetworkAdapter(n - 1, adapter.asOutParam()));
326	if (adapter)
327	{
328	BOOL fEnabled;
329	adapter->COMGETTER(Enabled)(&fEnabled);
330	if (fEnabled)
331	{
332	if (a->argv[2])
333	{
334	CHECK_ERROR_RET(adapter, COMSETTER(TraceFile)(Bstr(a->argv[2]).raw()), 1);
335	}
336	else
337	{
338	errorArgument("Invalid filename or filename not specified for NIC %lu", n);
339	rc = E_FAIL;
340	break;
341	}
342	}
343	else
344	RTMsgError("The NIC %d is currently disabled and thus can't change its tracefile", n);
345	}
346	}
347	else if (!strncmp(a->argv[1], "nictrace", 8))
348	{
349	/* Get the number of network adapters */
350	ULONG NetworkAdapterCount = 0;
351	ComPtr <ISystemProperties> info;
352	CHECK_ERROR_BREAK(a->virtualBox, COMGETTER(SystemProperties)(info.asOutParam()));
353	CHECK_ERROR_BREAK(info, COMGETTER(NetworkAdapterCount)(&NetworkAdapterCount));
354
355	unsigned n = parseNum(&a->argv[1][8], NetworkAdapterCount, "NIC");
356	if (!n)
357	{
358	rc = E_FAIL;
359	break;
360	}
361	if (a->argc <= 2)
362	{
363	errorArgument("Missing argument to '%s'", a->argv[1]);
364	rc = E_FAIL;
365	break;
366	}
367
368	/* get the corresponding network adapter */
369	ComPtr<INetworkAdapter> adapter;
370	CHECK_ERROR_BREAK(sessionMachine, GetNetworkAdapter(n - 1, adapter.asOutParam()));
371	if (adapter)
372	{
373	BOOL fEnabled;
374	adapter->COMGETTER(Enabled)(&fEnabled);
375	if (fEnabled)
376	{
377	if (!strcmp(a->argv[2], "on"))
378	{
379	CHECK_ERROR_RET(adapter, COMSETTER(TraceEnabled)(TRUE), 1);
380	}
381	else if (!strcmp(a->argv[2], "off"))
382	{
383	CHECK_ERROR_RET(adapter, COMSETTER(TraceEnabled)(FALSE), 1);
384	}
385	else
386	{
387	errorArgument("Invalid nictrace%lu argument '%s'", n, Utf8Str(a->argv[2]).c_str());
388	rc = E_FAIL;
389	break;
390	}
391	}
392	else
393	RTMsgError("The NIC %d is currently disabled and thus can't change its trace flag", n);
394	}
395	}
396	else if( a->argc > 2
397	&& !strncmp(a->argv[1], "natpf", 5))
398	{
399	/* Get the number of network adapters */
400	ULONG NetworkAdapterCount = 0;
401	ComPtr <ISystemProperties> info;
402	ComPtr<INATEngine> engine;
403	CHECK_ERROR_BREAK(a->virtualBox, COMGETTER(SystemProperties)(info.asOutParam()));
404	CHECK_ERROR_BREAK(info, COMGETTER(NetworkAdapterCount)(&NetworkAdapterCount));
405	unsigned n = parseNum(&a->argv[1][5], NetworkAdapterCount, "NIC");
406	if (!n)
407	{
408	rc = E_FAIL;
409	break;
410	}
411	if (a->argc <= 2)
412	{
413	errorArgument("Missing argument to '%s'", a->argv[1]);
414	rc = E_FAIL;
415	break;
416	}
417
418	/* get the corresponding network adapter */
419	ComPtr<INetworkAdapter> adapter;
420	CHECK_ERROR_BREAK(sessionMachine, GetNetworkAdapter(n - 1, adapter.asOutParam()));
421	if (!adapter)
422	{
423	rc = E_FAIL;
424	break;
425	}
426	CHECK_ERROR(adapter, COMGETTER(NatDriver)(engine.asOutParam()));
427	if (!engine)
428	{
429	rc = E_FAIL;
430	break;
431	}
432
433	if (!strcmp(a->argv[2], "delete"))
434	{
435	if (a->argc >= 3)
436	CHECK_ERROR(engine, RemoveRedirect(Bstr(a->argv[3]).raw()));
437	}
438	else
439	{
440	#define ITERATE_TO_NEXT_TERM(ch) \
441	do { \
442	while (*ch != ',') \
443	{ \
444	if (*ch == 0) \
445	{ \
446	return errorSyntax(USAGE_CONTROLVM, \
447	"Missing or Invalid argument to '%s'", \
448	a->argv[1]); \
449	} \
450	ch++; \
451	} \
452	*ch = '\0'; \
453	ch++; \
454	} while(0)
455
456	char *strName;
457	char *strProto;
458	char *strHostIp;
459	char *strHostPort;
460	char *strGuestIp;
461	char *strGuestPort;
462	char *strRaw = RTStrDup(a->argv[2]);
463	char *ch = strRaw;
464	strName = RTStrStrip(ch);
465	ITERATE_TO_NEXT_TERM(ch);
466	strProto = RTStrStrip(ch);
467	ITERATE_TO_NEXT_TERM(ch);
468	strHostIp = RTStrStrip(ch);
469	ITERATE_TO_NEXT_TERM(ch);
470	strHostPort = RTStrStrip(ch);
471	ITERATE_TO_NEXT_TERM(ch);
472	strGuestIp = RTStrStrip(ch);
473	ITERATE_TO_NEXT_TERM(ch);
474	strGuestPort = RTStrStrip(ch);
475	NATProtocol_T proto;
476	if (RTStrICmp(strProto, "udp") == 0)
477	proto = NATProtocol_UDP;
478	else if (RTStrICmp(strProto, "tcp") == 0)
479	proto = NATProtocol_TCP;
480	CHECK_ERROR(engine, AddRedirect(Bstr(strName).raw(), proto, Bstr(strHostIp).raw(),
481	RTStrToUInt16(strHostPort), Bstr(strGuestIp).raw(), RTStrToUInt16(strGuestPort)));
482	#undef ITERATE_TO_NEXT_TERM
483	}
484	/* commit changes */
485	if (SUCCEEDED(rc))
486	CHECK_ERROR(sessionMachine, SaveSettings());
487	}
488	else if (!strncmp(a->argv[1], "nic", 3))
489	{
490	/* Get the number of network adapters */
491	ULONG NetworkAdapterCount = 0;
492	ComPtr <ISystemProperties> info;
493	CHECK_ERROR_BREAK(a->virtualBox, COMGETTER(SystemProperties)(info.asOutParam()));
494	CHECK_ERROR_BREAK(info, COMGETTER(NetworkAdapterCount)(&NetworkAdapterCount));
495
496	unsigned n = parseNum(&a->argv[1][3], NetworkAdapterCount, "NIC");
497	if (!n)
498	{
499	rc = E_FAIL;
500	break;
501	}
502	if (a->argc <= 2)
503	{
504	errorArgument("Missing argument to '%s'", a->argv[1]);
505	rc = E_FAIL;
506	break;
507	}
508
509	/* get the corresponding network adapter */
510	ComPtr<INetworkAdapter> adapter;
511	CHECK_ERROR_BREAK(sessionMachine, GetNetworkAdapter(n - 1, adapter.asOutParam()));
512	if (adapter)
513	{
514	BOOL fEnabled;
515	adapter->COMGETTER(Enabled)(&fEnabled);
516	if (fEnabled)
517	{
518	if (!strcmp(a->argv[2], "null"))
519	{
520	CHECK_ERROR_RET(adapter, COMSETTER(Enabled)(TRUE), 1);
521	CHECK_ERROR_RET(adapter, Detach(), 1);
522	}
523	else if (!strcmp(a->argv[2], "nat"))
524	{
525	CHECK_ERROR_RET(adapter, COMSETTER(Enabled)(TRUE), 1);
526	if (a->argc == 4)
527	CHECK_ERROR_RET(adapter, COMSETTER(NATNetwork)(Bstr(a->argv[3]).raw()), 1);
528	CHECK_ERROR_RET(adapter, AttachToNAT(), 1);
529	}
530	else if ( !strcmp(a->argv[2], "bridged")
531	\|\| !strcmp(a->argv[2], "hostif")) /* backward compatibility */
532	{
533	if (a->argc <= 3)
534	{
535	errorArgument("Missing argument to '%s'", a->argv[2]);
536	rc = E_FAIL;
537	break;
538	}
539	CHECK_ERROR_RET(adapter, COMSETTER(Enabled)(TRUE), 1);
540	CHECK_ERROR_RET(adapter, COMSETTER(HostInterface)(Bstr(a->argv[3]).raw()), 1);
541	CHECK_ERROR_RET(adapter, AttachToBridgedInterface(), 1);
542	}
543	else if (!strcmp(a->argv[2], "intnet"))
544	{
545	if (a->argc <= 3)
546	{
547	errorArgument("Missing argument to '%s'", a->argv[2]);
548	rc = E_FAIL;
549	break;
550	}
551	CHECK_ERROR_RET(adapter, COMSETTER(Enabled)(TRUE), 1);
552	CHECK_ERROR_RET(adapter, COMSETTER(InternalNetwork)(Bstr(a->argv[3]).raw()), 1);
553	CHECK_ERROR_RET(adapter, AttachToInternalNetwork(), 1);
554	}
555	#if defined(VBOX_WITH_NETFLT)
556	else if (!strcmp(a->argv[2], "hostonly"))
557	{
558	if (a->argc <= 3)
559	{
560	errorArgument("Missing argument to '%s'", a->argv[2]);
561	rc = E_FAIL;
562	break;
563	}
564	CHECK_ERROR_RET(adapter, COMSETTER(Enabled)(TRUE), 1);
565	CHECK_ERROR_RET(adapter, COMSETTER(HostInterface)(Bstr(a->argv[3]).raw()), 1);
566	CHECK_ERROR_RET(adapter, AttachToHostOnlyInterface(), 1);
567	}
568	#endif
569	else
570	{
571	errorArgument("Invalid type '%s' specfied for NIC %lu", Utf8Str(a->argv[2]).c_str(), n);
572	rc = E_FAIL;
573	break;
574	}
575	}
576	else
577	RTMsgError("The NIC %d is currently disabled and thus can't change its attachment type", n);
578	}
579	}
580	else if ( !strcmp(a->argv[1], "vrde")
581	\|\| !strcmp(a->argv[1], "vrdp"))
582	{
583	if (!strcmp(a->argv[1], "vrdp"))
584	RTStrmPrintf(g_pStdErr, "Warning: 'vrdp' is deprecated. Use 'vrde'.\n");
585
586	if (a->argc <= 1 + 1)
587	{
588	errorArgument("Missing argument to '%s'", a->argv[1]);
589	rc = E_FAIL;
590	break;
591	}
592	ComPtr<IVRDEServer> vrdeServer;
593	sessionMachine->COMGETTER(VRDEServer)(vrdeServer.asOutParam());
594	ASSERT(vrdeServer);
595	if (vrdeServer)
596	{
597	if (!strcmp(a->argv[2], "on"))
598	{
599	CHECK_ERROR_BREAK(vrdeServer, COMSETTER(Enabled)(TRUE));
600	}
601	else if (!strcmp(a->argv[2], "off"))
602	{
603	CHECK_ERROR_BREAK(vrdeServer, COMSETTER(Enabled)(FALSE));
604	}
605	else
606	{
607	errorArgument("Invalid remote desktop server state '%s'", Utf8Str(a->argv[2]).c_str());
608	rc = E_FAIL;
609	break;
610	}
611	}
612	}
613	else if (!strcmp(a->argv[1], "vrdpport"))
614	{
615	RTStrmPrintf(g_pStdErr, "Warning: 'vrdpport' is deprecated. Use 'setvrdeproperty'.\n");
616
617	if (a->argc <= 1 + 1)
618	{
619	errorArgument("Missing argument to '%s'", a->argv[1]);
620	rc = E_FAIL;
621	break;
622	}
623	ComPtr<IVRDEServer> vrdeServer;
624	sessionMachine->COMGETTER(VRDEServer)(vrdeServer.asOutParam());
625	ASSERT(vrdeServer);
626	if (vrdeServer)
627	{
628	Bstr ports;
629
630	if (!strcmp(a->argv[2], "default"))
631	ports = "0";
632	else
633	ports = a->argv[2];
634
635	CHECK_ERROR_BREAK(vrdeServer, SetVRDEProperty(Bstr("TCP/Ports").raw(), ports.raw()));
636	}
637	}
638	else if ( !strcmp(a->argv[1], "vrdevideochannelquality")
639	\|\| !strcmp(a->argv[1], "vrdpvideochannelquality"))
640	{
641	if (!strcmp(a->argv[1], "vrdpvideochannelquality"))
642	RTStrmPrintf(g_pStdErr, "Warning: 'vrdpvideochannelquality' is deprecated. Use 'vrdevideochannelquality'.\n");
643
644	if (a->argc <= 1 + 1)
645	{
646	errorArgument("Missing argument to '%s'", a->argv[1]);
647	rc = E_FAIL;
648	break;
649	}
650	ComPtr<IVRDEServer> vrdeServer;
651	sessionMachine->COMGETTER(VRDEServer)(vrdeServer.asOutParam());
652	ASSERT(vrdeServer);
653	if (vrdeServer)
654	{
655	unsigned n = parseNum(a->argv[2], 100, "VRDE video redirection quality in percent");
656
657	CHECK_ERROR(vrdeServer, COMSETTER(VideoChannelQuality)(n));
658	}
659	}
660	else if (!strcmp(a->argv[1], "vrdeproperty"))
661	{
662	if (a->argc <= 1 + 1)
663	{
664	errorArgument("Missing argument to '%s'", a->argv[1]);
665	rc = E_FAIL;
666	break;
667	}
668	ComPtr<IVRDEServer> vrdeServer;
669	sessionMachine->COMGETTER(VRDEServer)(vrdeServer.asOutParam());
670	ASSERT(vrdeServer);
671	if (vrdeServer)
672	{
673	/* Parse 'name=value' */
674	char *pszProperty = RTStrDup(a->argv[2]);
675	if (pszProperty)
676	{
677	char *pDelimiter = strchr(pszProperty, '=');
678	if (pDelimiter)
679	{
680	*pDelimiter = '\0';
681
682	Bstr bstrName = pszProperty;
683	Bstr bstrValue = &pDelimiter[1];
684	CHECK_ERROR(vrdeServer, SetVRDEProperty(bstrName.raw(), bstrValue.raw()));
685	}
686	else
687	{
688	errorArgument("Invalid --vrdeproperty argument '%s'", a->argv[2]);
689	rc = E_FAIL;
690	break;
691	}
692	RTStrFree(pszProperty);
693	}
694	else
695	{
696	RTStrmPrintf(g_pStdErr, "Error: Failed to allocate memory for VRDE property '%s'\n", a->argv[2]);
697	rc = E_FAIL;
698	}
699	}
700	if (FAILED(rc))
701	{
702	break;
703	}
704	}
705	else if ( !strcmp(a->argv[1], "usbattach")
706	\|\| !strcmp(a->argv[1], "usbdetach"))
707	{
708	if (a->argc < 3)
709	{
710	errorSyntax(USAGE_CONTROLVM, "Not enough parameters");
711	rc = E_FAIL;
712	break;
713	}
714
715	bool attach = !strcmp(a->argv[1], "usbattach");
716
717	Bstr usbId = a->argv[2];
718	if (Guid(usbId).isEmpty())
719	{
720	// assume address
721	if (attach)
722	{
723	ComPtr <IHost> host;
724	CHECK_ERROR_BREAK(a->virtualBox, COMGETTER(Host)(host.asOutParam()));
725	SafeIfaceArray <IHostUSBDevice> coll;
726	CHECK_ERROR_BREAK(host, COMGETTER(USBDevices)(ComSafeArrayAsOutParam(coll)));
727	ComPtr <IHostUSBDevice> dev;
728	CHECK_ERROR_BREAK(host, FindUSBDeviceByAddress(Bstr(a->argv[2]).raw(),
729	dev.asOutParam()));
730	CHECK_ERROR_BREAK(dev, COMGETTER(Id)(usbId.asOutParam()));
731	}
732	else
733	{
734	SafeIfaceArray <IUSBDevice> coll;
735	CHECK_ERROR_BREAK(console, COMGETTER(USBDevices)(ComSafeArrayAsOutParam(coll)));
736	ComPtr <IUSBDevice> dev;
737	CHECK_ERROR_BREAK(console, FindUSBDeviceByAddress(Bstr(a->argv[2]).raw(),
738	dev.asOutParam()));
739	CHECK_ERROR_BREAK(dev, COMGETTER(Id)(usbId.asOutParam()));
740	}
741	}
742
743	if (attach)
744	CHECK_ERROR_BREAK(console, AttachUSBDevice(usbId.raw()));
745	else
746	{
747	ComPtr <IUSBDevice> dev;
748	CHECK_ERROR_BREAK(console, DetachUSBDevice(usbId.raw(),
749	dev.asOutParam()));
750	}
751	}
752	else if (!strcmp(a->argv[1], "setvideomodehint"))
753	{
754	if (a->argc != 5 && a->argc != 6)
755	{
756	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
757	rc = E_FAIL;
758	break;
759	}
760	uint32_t xres = RTStrToUInt32(a->argv[2]);
761	uint32_t yres = RTStrToUInt32(a->argv[3]);
762	uint32_t bpp = RTStrToUInt32(a->argv[4]);
763	uint32_t displayIdx = 0;
764	if (a->argc == 6)
765	displayIdx = RTStrToUInt32(a->argv[5]);
766
767	ComPtr<IDisplay> display;
768	CHECK_ERROR_BREAK(console, COMGETTER(Display)(display.asOutParam()));
769	CHECK_ERROR_BREAK(display, SetVideoModeHint(xres, yres, bpp, displayIdx));
770	}
771	else if (!strcmp(a->argv[1], "setcredentials"))
772	{
773	bool fAllowLocalLogon = true;
774	if (a->argc == 7)
775	{
776	if ( strcmp(a->argv[5], "--allowlocallogon")
777	&& strcmp(a->argv[5], "-allowlocallogon"))
778	{
779	errorArgument("Invalid parameter '%s'", a->argv[5]);
780	rc = E_FAIL;
781	break;
782	}
783	if (!strcmp(a->argv[6], "no"))
784	fAllowLocalLogon = false;
785	}
786	else if (a->argc != 5)
787	{
788	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
789	rc = E_FAIL;
790	break;
791	}
792
793	ComPtr<IGuest> guest;
794	CHECK_ERROR_BREAK(console, COMGETTER(Guest)(guest.asOutParam()));
795	CHECK_ERROR_BREAK(guest, SetCredentials(Bstr(a->argv[2]).raw(),
796	Bstr(a->argv[3]).raw(),
797	Bstr(a->argv[4]).raw(),
798	fAllowLocalLogon));
799	}
800	#if 0 /* TODO: review & remove */
801	else if (!strcmp(a->argv[1], "dvdattach"))
802	{
803	Bstr uuid;
804	if (a->argc != 3)
805	{
806	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
807	rc = E_FAIL;
808	break;
809	}
810
811	ComPtr<IMedium> dvdMedium;
812
813	/* unmount? */
814	if (!strcmp(a->argv[2], "none"))
815	{
816	/* nothing to do, NULL object will cause unmount */
817	}
818	/* host drive? */
819	else if (!strncmp(a->argv[2], "host:", 5))
820	{
821	ComPtr<IHost> host;
822	CHECK_ERROR(a->virtualBox, COMGETTER(Host)(host.asOutParam()));
823
824	rc = host->FindHostDVDDrive(Bstr(a->argv[2] + 5), dvdMedium.asOutParam());
825	if (!dvdMedium)
826	{
827	errorArgument("Invalid host DVD drive name \"%s\"",
828	a->argv[2] + 5);
829	rc = E_FAIL;
830	break;
831	}
832	}
833	else
834	{
835	/* first assume it's a UUID */
836	uuid = a->argv[2];
837	rc = a->virtualBox->GetDVDImage(uuid, dvdMedium.asOutParam());
838	if (FAILED(rc) \|\| !dvdMedium)
839	{
840	/* must be a filename, check if it's in the collection */
841	rc = a->virtualBox->FindDVDImage(Bstr(a->argv[2]), dvdMedium.asOutParam());
842	/* not registered, do that on the fly */
843	if (!dvdMedium)
844	{
845	Bstr emptyUUID;
846	CHECK_ERROR(a->virtualBox, OpenDVDImage(Bstr(a->argv[2]), emptyUUID, dvdMedium.asOutParam()));
847	}
848	}
849	if (!dvdMedium)
850	{
851	rc = E_FAIL;
852	break;
853	}
854	}
855
856	/** @todo generalize this, allow arbitrary number of DVD drives
857	* and as a consequence multiple attachments and different
858	* storage controllers. */
859	if (dvdMedium)
860	dvdMedium->COMGETTER(Id)(uuid.asOutParam());
861	else
862	uuid = Guid().toString();
863	CHECK_ERROR(machine, MountMedium(Bstr("IDE Controller"), 1, 0, uuid, FALSE /* aForce */));
864	}
865	else if (!strcmp(a->argv[1], "floppyattach"))
866	{
867	Bstr uuid;
868	if (a->argc != 3)
869	{
870	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
871	rc = E_FAIL;
872	break;
873	}
874
875	ComPtr<IMedium> floppyMedium;
876
877	/* unmount? */
878	if (!strcmp(a->argv[2], "none"))
879	{
880	/* nothing to do, NULL object will cause unmount */
881	}
882	/* host drive? */
883	else if (!strncmp(a->argv[2], "host:", 5))
884	{
885	ComPtr<IHost> host;
886	CHECK_ERROR(a->virtualBox, COMGETTER(Host)(host.asOutParam()));
887	host->FindHostFloppyDrive(Bstr(a->argv[2] + 5), floppyMedium.asOutParam());
888	if (!floppyMedium)
889	{
890	errorArgument("Invalid host floppy drive name \"%s\"",
891	a->argv[2] + 5);
892	rc = E_FAIL;
893	break;
894	}
895	}
896	else
897	{
898	/* first assume it's a UUID */
899	uuid = a->argv[2];
900	rc = a->virtualBox->GetFloppyImage(uuid, floppyMedium.asOutParam());
901	if (FAILED(rc) \|\| !floppyMedium)
902	{
903	/* must be a filename, check if it's in the collection */
904	rc = a->virtualBox->FindFloppyImage(Bstr(a->argv[2]), floppyMedium.asOutParam());
905	/* not registered, do that on the fly */
906	if (!floppyMedium)
907	{
908	Bstr emptyUUID;
909	CHECK_ERROR(a->virtualBox, OpenFloppyImage(Bstr(a->argv[2]), emptyUUID, floppyMedium.asOutParam()));
910	}
911	}
912	if (!floppyMedium)
913	{
914	rc = E_FAIL;
915	break;
916	}
917	}
918	floppyMedium->COMGETTER(Id)(uuid.asOutParam());
919	CHECK_ERROR(machine, MountMedium(Bstr("Floppy Controller"), 0, 0, uuid, FALSE /* aForce */));
920	}
921	#endif /* obsolete dvdattach/floppyattach */
922	else if (!strcmp(a->argv[1], "guestmemoryballoon"))
923	{
924	if (a->argc != 3)
925	{
926	errorSyntax(USAGE_CONTROLVM, "Incorrect number of parameters");
927	rc = E_FAIL;
928	break;
929	}
930	uint32_t uVal;
931	int vrc;
932	vrc = RTStrToUInt32Ex(a->argv[2], NULL, 0, &uVal);
933	if (vrc != VINF_SUCCESS)
934	{
935	errorArgument("Error parsing guest memory balloon size '%s'", a->argv[2]);
936	rc = E_FAIL;
937	break;
938	}
939	/* guest is running; update IGuest */
940	ComPtr <IGuest> guest;
941	rc = console->COMGETTER(Guest)(guest.asOutParam());
942	if (SUCCEEDED(rc))
943	CHECK_ERROR(guest, COMSETTER(MemoryBalloonSize)(uVal));
944	}
945	else if (!strcmp(a->argv[1], "teleport"))
946	{
947	Bstr bstrHostname;
948	uint32_t uMaxDowntime = 250 /ms/;
949	uint32_t uPort = UINT32_MAX;
950	uint32_t cMsTimeout = 0;
951	Bstr bstrPassword("");
952	static const RTGETOPTDEF s_aTeleportOptions[] =
953	{
954	{ "--host", 'h', RTGETOPT_REQ_STRING }, /** @todo RTGETOPT_FLAG_MANDATORY */
955	{ "--hostname", 'h', RTGETOPT_REQ_STRING }, /** @todo remove this */
956	{ "--maxdowntime", 'd', RTGETOPT_REQ_UINT32 },
957	{ "--port", 'p', RTGETOPT_REQ_UINT32 }, /** @todo RTGETOPT_FLAG_MANDATORY */
958	{ "--password", 'P', RTGETOPT_REQ_STRING },
959	{ "--timeout", 't', RTGETOPT_REQ_UINT32 },
960	{ "--detailed-progress", 'D', RTGETOPT_REQ_NOTHING }
961	};
962	RTGETOPTSTATE GetOptState;
963	RTGetOptInit(&GetOptState, a->argc, a->argv, s_aTeleportOptions, RT_ELEMENTS(s_aTeleportOptions), 2, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
964	int ch;
965	RTGETOPTUNION Value;
966	while ( SUCCEEDED(rc)
967	&& (ch = RTGetOpt(&GetOptState, &Value)))
968	{
969	switch (ch)
970	{
971	case 'h': bstrHostname = Value.psz; break;
972	case 'd': uMaxDowntime = Value.u32; break;
973	case 'D': g_fDetailedProgress = true; break;
974	case 'p': uPort = Value.u32; break;
975	case 'P': bstrPassword = Value.psz; break;
976	case 't': cMsTimeout = Value.u32; break;
977	default:
978	errorGetOpt(USAGE_CONTROLVM, ch, &Value);
979	rc = E_FAIL;
980	break;
981	}
982	}
983	if (FAILED(rc))
984	break;
985
986	ComPtr<IProgress> progress;
987	CHECK_ERROR_BREAK(console, Teleport(bstrHostname.raw(), uPort,
988	bstrPassword.raw(),
989	uMaxDowntime,
990	progress.asOutParam()));
991
992	if (cMsTimeout)
993	{
994	rc = progress->COMSETTER(Timeout)(cMsTimeout);
995	if (FAILED(rc) && rc != VBOX_E_INVALID_OBJECT_STATE)
996	CHECK_ERROR_BREAK(progress, COMSETTER(Timeout)(cMsTimeout)); /* lazyness */
997	}
998
999	rc = showProgress(progress);
1000	if (FAILED(rc))
1001	{
1002	com::ProgressErrorInfo info(progress);
1003	if (info.isBasicAvailable())
1004	RTMsgError("Teleportation failed. Error message: %lS", info.getText().raw());
1005	else
1006	RTMsgError("Teleportation failed. No error message available!");
1007	}
1008	}
1009	else
1010	{
1011	errorSyntax(USAGE_CONTROLVM, "Invalid parameter '%s'", Utf8Str(a->argv[1]).c_str());
1012	rc = E_FAIL;
1013	}
1014	} while (0);
1015
1016	a->session->UnlockMachine();
1017
1018	return SUCCEEDED(rc) ? 0 : 1;
1019	}
1020

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

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

Download in other formats: