VirtualBox

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

Last change on this file since 35273 was 35194, checked in by vboxsync, 13 years ago

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

© 2023 Oracle
Contact – Privacy policy – Terms of Use