root / qemu-monitor.hx @ a3a55a2e
History | View | Annotate | Download (27.6 kB)
1 |
HXCOMM Use DEFHEADING() to define headings in both help text and texi |
---|---|
2 |
HXCOMM Text between STEXI and ETEXI are copied to texi version and |
3 |
HXCOMM discarded from C version |
4 |
HXCOMM DEF(command, args, callback, arg_string, help) is used to construct |
5 |
HXCOMM monitor commands |
6 |
HXCOMM HXCOMM can be used for comments, discarded from both texi and C |
7 |
|
8 |
STEXI |
9 |
@table @option |
10 |
ETEXI |
11 |
|
12 |
{ |
13 |
.name = "help|?", |
14 |
.args_type = "name:s?", |
15 |
.params = "[cmd]", |
16 |
.help = "show the help", |
17 |
.mhandler.cmd = do_help_cmd, |
18 |
}, |
19 |
|
20 |
STEXI |
21 |
@item help or ? [@var{cmd}] |
22 |
Show the help for all commands or just for command @var{cmd}. |
23 |
ETEXI |
24 |
|
25 |
{ |
26 |
.name = "commit", |
27 |
.args_type = "device:B", |
28 |
.params = "device|all", |
29 |
.help = "commit changes to the disk images (if -snapshot is used) or backing files", |
30 |
.mhandler.cmd = do_commit, |
31 |
}, |
32 |
|
33 |
STEXI |
34 |
@item commit |
35 |
Commit changes to the disk images (if -snapshot is used) or backing files. |
36 |
ETEXI |
37 |
|
38 |
{ |
39 |
.name = "info", |
40 |
.args_type = "item:s?", |
41 |
.params = "[subcommand]", |
42 |
.help = "show various information about the system state", |
43 |
.user_print = monitor_user_noop, |
44 |
.mhandler.cmd_new = do_info, |
45 |
}, |
46 |
|
47 |
STEXI |
48 |
@item info @var{subcommand} |
49 |
Show various information about the system state. |
50 |
|
51 |
@table @option |
52 |
@item info version |
53 |
show the version of QEMU |
54 |
@item info network |
55 |
show the various VLANs and the associated devices |
56 |
@item info chardev |
57 |
show the character devices |
58 |
@item info block |
59 |
show the block devices |
60 |
@item info block |
61 |
show block device statistics |
62 |
@item info registers |
63 |
show the cpu registers |
64 |
@item info cpus |
65 |
show infos for each CPU |
66 |
@item info history |
67 |
show the command line history |
68 |
@item info irq |
69 |
show the interrupts statistics (if available) |
70 |
@item info pic |
71 |
show i8259 (PIC) state |
72 |
@item info pci |
73 |
show emulated PCI device info |
74 |
@item info tlb |
75 |
show virtual to physical memory mappings (i386 only) |
76 |
@item info mem |
77 |
show the active virtual memory mappings (i386 only) |
78 |
@item info hpet |
79 |
show state of HPET (i386 only) |
80 |
@item info kvm |
81 |
show KVM information |
82 |
@item info usb |
83 |
show USB devices plugged on the virtual USB hub |
84 |
@item info usbhost |
85 |
show all USB host devices |
86 |
@item info profile |
87 |
show profiling information |
88 |
@item info capture |
89 |
show information about active capturing |
90 |
@item info snapshots |
91 |
show list of VM snapshots |
92 |
@item info status |
93 |
show the current VM status (running|paused) |
94 |
@item info pcmcia |
95 |
show guest PCMCIA status |
96 |
@item info mice |
97 |
show which guest mouse is receiving events |
98 |
@item info vnc |
99 |
show the vnc server status |
100 |
@item info name |
101 |
show the current VM name |
102 |
@item info uuid |
103 |
show the current VM UUID |
104 |
@item info cpustats |
105 |
show CPU statistics |
106 |
@item info usernet |
107 |
show user network stack connection states |
108 |
@item info migrate |
109 |
show migration status |
110 |
@item info balloon |
111 |
show balloon information |
112 |
@item info qtree |
113 |
show device tree |
114 |
@end table |
115 |
ETEXI |
116 |
|
117 |
{ |
118 |
.name = "q|quit", |
119 |
.args_type = "", |
120 |
.params = "", |
121 |
.help = "quit the emulator", |
122 |
.user_print = monitor_user_noop, |
123 |
.mhandler.cmd_new = do_quit, |
124 |
}, |
125 |
|
126 |
STEXI |
127 |
@item q or quit |
128 |
Quit the emulator. |
129 |
ETEXI |
130 |
|
131 |
{ |
132 |
.name = "eject", |
133 |
.args_type = "force:-f,filename:B", |
134 |
.params = "[-f] device", |
135 |
.help = "eject a removable medium (use -f to force it)", |
136 |
.user_print = monitor_user_noop, |
137 |
.mhandler.cmd_new = do_eject, |
138 |
}, |
139 |
|
140 |
STEXI |
141 |
@item eject [-f] @var{device} |
142 |
Eject a removable medium (use -f to force it). |
143 |
ETEXI |
144 |
|
145 |
{ |
146 |
.name = "change", |
147 |
.args_type = "device:B,target:F,arg:s?", |
148 |
.params = "device filename [format]", |
149 |
.help = "change a removable medium, optional format", |
150 |
.mhandler.cmd = do_change, |
151 |
}, |
152 |
|
153 |
STEXI |
154 |
@item change @var{device} @var{setting} |
155 |
|
156 |
Change the configuration of a device. |
157 |
|
158 |
@table @option |
159 |
@item change @var{diskdevice} @var{filename} [@var{format}] |
160 |
Change the medium for a removable disk device to point to @var{filename}. eg |
161 |
|
162 |
@example |
163 |
(qemu) change ide1-cd0 /path/to/some.iso |
164 |
@end example |
165 |
|
166 |
@var{format} is optional. |
167 |
|
168 |
@item change vnc @var{display},@var{options} |
169 |
Change the configuration of the VNC server. The valid syntax for @var{display} |
170 |
and @var{options} are described at @ref{sec_invocation}. eg |
171 |
|
172 |
@example |
173 |
(qemu) change vnc localhost:1 |
174 |
@end example |
175 |
|
176 |
@item change vnc password [@var{password}] |
177 |
|
178 |
Change the password associated with the VNC server. If the new password is not |
179 |
supplied, the monitor will prompt for it to be entered. VNC passwords are only |
180 |
significant up to 8 letters. eg |
181 |
|
182 |
@example |
183 |
(qemu) change vnc password |
184 |
Password: ******** |
185 |
@end example |
186 |
|
187 |
@end table |
188 |
ETEXI |
189 |
|
190 |
{ |
191 |
.name = "screendump", |
192 |
.args_type = "filename:F", |
193 |
.params = "filename", |
194 |
.help = "save screen into PPM image 'filename'", |
195 |
.mhandler.cmd = do_screen_dump, |
196 |
}, |
197 |
|
198 |
STEXI |
199 |
@item screendump @var{filename} |
200 |
Save screen into PPM image @var{filename}. |
201 |
ETEXI |
202 |
|
203 |
{ |
204 |
.name = "logfile", |
205 |
.args_type = "filename:F", |
206 |
.params = "filename", |
207 |
.help = "output logs to 'filename'", |
208 |
.mhandler.cmd = do_logfile, |
209 |
}, |
210 |
|
211 |
STEXI |
212 |
@item logfile @var{filename} |
213 |
Output logs to @var{filename}. |
214 |
ETEXI |
215 |
|
216 |
{ |
217 |
.name = "log", |
218 |
.args_type = "items:s", |
219 |
.params = "item1[,...]", |
220 |
.help = "activate logging of the specified items to '/tmp/qemu.log'", |
221 |
.mhandler.cmd = do_log, |
222 |
}, |
223 |
|
224 |
STEXI |
225 |
@item log @var{item1}[,...] |
226 |
Activate logging of the specified items to @file{/tmp/qemu.log}. |
227 |
ETEXI |
228 |
|
229 |
{ |
230 |
.name = "savevm", |
231 |
.args_type = "name:s?", |
232 |
.params = "[tag|id]", |
233 |
.help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created", |
234 |
.mhandler.cmd = do_savevm, |
235 |
}, |
236 |
|
237 |
STEXI |
238 |
@item savevm [@var{tag}|@var{id}] |
239 |
Create a snapshot of the whole virtual machine. If @var{tag} is |
240 |
provided, it is used as human readable identifier. If there is already |
241 |
a snapshot with the same tag or ID, it is replaced. More info at |
242 |
@ref{vm_snapshots}. |
243 |
ETEXI |
244 |
|
245 |
{ |
246 |
.name = "loadvm", |
247 |
.args_type = "name:s", |
248 |
.params = "tag|id", |
249 |
.help = "restore a VM snapshot from its tag or id", |
250 |
.mhandler.cmd = do_loadvm, |
251 |
}, |
252 |
|
253 |
STEXI |
254 |
@item loadvm @var{tag}|@var{id} |
255 |
Set the whole virtual machine to the snapshot identified by the tag |
256 |
@var{tag} or the unique snapshot ID @var{id}. |
257 |
ETEXI |
258 |
|
259 |
{ |
260 |
.name = "delvm", |
261 |
.args_type = "name:s", |
262 |
.params = "tag|id", |
263 |
.help = "delete a VM snapshot from its tag or id", |
264 |
.mhandler.cmd = do_delvm, |
265 |
}, |
266 |
|
267 |
STEXI |
268 |
@item delvm @var{tag}|@var{id} |
269 |
Delete the snapshot identified by @var{tag} or @var{id}. |
270 |
ETEXI |
271 |
|
272 |
{ |
273 |
.name = "singlestep", |
274 |
.args_type = "option:s?", |
275 |
.params = "[on|off]", |
276 |
.help = "run emulation in singlestep mode or switch to normal mode", |
277 |
.mhandler.cmd = do_singlestep, |
278 |
}, |
279 |
|
280 |
STEXI |
281 |
@item singlestep [off] |
282 |
Run the emulation in single step mode. |
283 |
If called with option off, the emulation returns to normal mode. |
284 |
ETEXI |
285 |
|
286 |
{ |
287 |
.name = "stop", |
288 |
.args_type = "", |
289 |
.params = "", |
290 |
.help = "stop emulation", |
291 |
.user_print = monitor_user_noop, |
292 |
.mhandler.cmd_new = do_stop, |
293 |
}, |
294 |
|
295 |
STEXI |
296 |
@item stop |
297 |
Stop emulation. |
298 |
ETEXI |
299 |
|
300 |
{ |
301 |
.name = "c|cont", |
302 |
.args_type = "", |
303 |
.params = "", |
304 |
.help = "resume emulation", |
305 |
.user_print = monitor_user_noop, |
306 |
.mhandler.cmd_new = do_cont, |
307 |
}, |
308 |
|
309 |
STEXI |
310 |
@item c or cont |
311 |
Resume emulation. |
312 |
ETEXI |
313 |
|
314 |
{ |
315 |
.name = "gdbserver", |
316 |
.args_type = "device:s?", |
317 |
.params = "[device]", |
318 |
.help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'", |
319 |
.mhandler.cmd = do_gdbserver, |
320 |
}, |
321 |
|
322 |
STEXI |
323 |
@item gdbserver [@var{port}] |
324 |
Start gdbserver session (default @var{port}=1234) |
325 |
ETEXI |
326 |
|
327 |
{ |
328 |
.name = "x", |
329 |
.args_type = "fmt:/,addr:l", |
330 |
.params = "/fmt addr", |
331 |
.help = "virtual memory dump starting at 'addr'", |
332 |
.mhandler.cmd = do_memory_dump, |
333 |
}, |
334 |
|
335 |
STEXI |
336 |
@item x/fmt @var{addr} |
337 |
Virtual memory dump starting at @var{addr}. |
338 |
ETEXI |
339 |
|
340 |
{ |
341 |
.name = "xp", |
342 |
.args_type = "fmt:/,addr:l", |
343 |
.params = "/fmt addr", |
344 |
.help = "physical memory dump starting at 'addr'", |
345 |
.mhandler.cmd = do_physical_memory_dump, |
346 |
}, |
347 |
|
348 |
STEXI |
349 |
@item xp /@var{fmt} @var{addr} |
350 |
Physical memory dump starting at @var{addr}. |
351 |
|
352 |
@var{fmt} is a format which tells the command how to format the |
353 |
data. Its syntax is: @option{/@{count@}@{format@}@{size@}} |
354 |
|
355 |
@table @var |
356 |
@item count |
357 |
is the number of items to be dumped. |
358 |
|
359 |
@item format |
360 |
can be x (hex), d (signed decimal), u (unsigned decimal), o (octal), |
361 |
c (char) or i (asm instruction). |
362 |
|
363 |
@item size |
364 |
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86, |
365 |
@code{h} or @code{w} can be specified with the @code{i} format to |
366 |
respectively select 16 or 32 bit code instruction size. |
367 |
|
368 |
@end table |
369 |
|
370 |
Examples: |
371 |
@itemize |
372 |
@item |
373 |
Dump 10 instructions at the current instruction pointer: |
374 |
@example |
375 |
(qemu) x/10i $eip |
376 |
0x90107063: ret |
377 |
0x90107064: sti |
378 |
0x90107065: lea 0x0(%esi,1),%esi |
379 |
0x90107069: lea 0x0(%edi,1),%edi |
380 |
0x90107070: ret |
381 |
0x90107071: jmp 0x90107080 |
382 |
0x90107073: nop |
383 |
0x90107074: nop |
384 |
0x90107075: nop |
385 |
0x90107076: nop |
386 |
@end example |
387 |
|
388 |
@item |
389 |
Dump 80 16 bit values at the start of the video memory. |
390 |
@smallexample |
391 |
(qemu) xp/80hx 0xb8000 |
392 |
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42 |
393 |
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41 |
394 |
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72 |
395 |
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73 |
396 |
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20 |
397 |
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720 |
398 |
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
399 |
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
400 |
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
401 |
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
402 |
@end smallexample |
403 |
@end itemize |
404 |
ETEXI |
405 |
|
406 |
{ |
407 |
.name = "p|print", |
408 |
.args_type = "fmt:/,val:l", |
409 |
.params = "/fmt expr", |
410 |
.help = "print expression value (use $reg for CPU register access)", |
411 |
.mhandler.cmd = do_print, |
412 |
}, |
413 |
|
414 |
STEXI |
415 |
@item p or print/@var{fmt} @var{expr} |
416 |
|
417 |
Print expression value. Only the @var{format} part of @var{fmt} is |
418 |
used. |
419 |
ETEXI |
420 |
|
421 |
{ |
422 |
.name = "i", |
423 |
.args_type = "fmt:/,addr:i,index:i.", |
424 |
.params = "/fmt addr", |
425 |
.help = "I/O port read", |
426 |
.mhandler.cmd = do_ioport_read, |
427 |
}, |
428 |
|
429 |
STEXI |
430 |
Read I/O port. |
431 |
ETEXI |
432 |
|
433 |
{ |
434 |
.name = "o", |
435 |
.args_type = "fmt:/,addr:i,val:i", |
436 |
.params = "/fmt addr value", |
437 |
.help = "I/O port write", |
438 |
.mhandler.cmd = do_ioport_write, |
439 |
}, |
440 |
|
441 |
STEXI |
442 |
Write to I/O port. |
443 |
ETEXI |
444 |
|
445 |
{ |
446 |
.name = "sendkey", |
447 |
.args_type = "string:s,hold_time:i?", |
448 |
.params = "keys [hold_ms]", |
449 |
.help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)", |
450 |
.mhandler.cmd = do_sendkey, |
451 |
}, |
452 |
|
453 |
STEXI |
454 |
@item sendkey @var{keys} |
455 |
|
456 |
Send @var{keys} to the emulator. @var{keys} could be the name of the |
457 |
key or @code{#} followed by the raw value in either decimal or hexadecimal |
458 |
format. Use @code{-} to press several keys simultaneously. Example: |
459 |
@example |
460 |
sendkey ctrl-alt-f1 |
461 |
@end example |
462 |
|
463 |
This command is useful to send keys that your graphical user interface |
464 |
intercepts at low level, such as @code{ctrl-alt-f1} in X Window. |
465 |
ETEXI |
466 |
|
467 |
{ |
468 |
.name = "system_reset", |
469 |
.args_type = "", |
470 |
.params = "", |
471 |
.help = "reset the system", |
472 |
.user_print = monitor_user_noop, |
473 |
.mhandler.cmd_new = do_system_reset, |
474 |
}, |
475 |
|
476 |
STEXI |
477 |
@item system_reset |
478 |
|
479 |
Reset the system. |
480 |
ETEXI |
481 |
|
482 |
{ |
483 |
.name = "system_powerdown", |
484 |
.args_type = "", |
485 |
.params = "", |
486 |
.help = "send system power down event", |
487 |
.user_print = monitor_user_noop, |
488 |
.mhandler.cmd_new = do_system_powerdown, |
489 |
}, |
490 |
|
491 |
STEXI |
492 |
@item system_powerdown |
493 |
|
494 |
Power down the system (if supported). |
495 |
ETEXI |
496 |
|
497 |
{ |
498 |
.name = "sum", |
499 |
.args_type = "start:i,size:i", |
500 |
.params = "addr size", |
501 |
.help = "compute the checksum of a memory region", |
502 |
.mhandler.cmd = do_sum, |
503 |
}, |
504 |
|
505 |
STEXI |
506 |
@item sum @var{addr} @var{size} |
507 |
|
508 |
Compute the checksum of a memory region. |
509 |
ETEXI |
510 |
|
511 |
{ |
512 |
.name = "usb_add", |
513 |
.args_type = "devname:s", |
514 |
.params = "device", |
515 |
.help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')", |
516 |
.mhandler.cmd = do_usb_add, |
517 |
}, |
518 |
|
519 |
STEXI |
520 |
@item usb_add @var{devname} |
521 |
|
522 |
Add the USB device @var{devname}. For details of available devices see |
523 |
@ref{usb_devices} |
524 |
ETEXI |
525 |
|
526 |
{ |
527 |
.name = "usb_del", |
528 |
.args_type = "devname:s", |
529 |
.params = "device", |
530 |
.help = "remove USB device 'bus.addr'", |
531 |
.mhandler.cmd = do_usb_del, |
532 |
}, |
533 |
|
534 |
STEXI |
535 |
@item usb_del @var{devname} |
536 |
|
537 |
Remove the USB device @var{devname} from the QEMU virtual USB |
538 |
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor |
539 |
command @code{info usb} to see the devices you can remove. |
540 |
ETEXI |
541 |
|
542 |
{ |
543 |
.name = "device_add", |
544 |
.args_type = "config:s", |
545 |
.params = "device", |
546 |
.help = "add device, like -device on the command line", |
547 |
.mhandler.cmd = do_device_add, |
548 |
}, |
549 |
|
550 |
STEXI |
551 |
@item device_add @var{config} |
552 |
|
553 |
Add device. |
554 |
ETEXI |
555 |
|
556 |
{ |
557 |
.name = "device_del", |
558 |
.args_type = "id:s", |
559 |
.params = "device", |
560 |
.help = "remove device", |
561 |
.mhandler.cmd = do_device_del, |
562 |
}, |
563 |
|
564 |
STEXI |
565 |
@item device_del @var{id} |
566 |
|
567 |
Remove device @var{id}. |
568 |
ETEXI |
569 |
|
570 |
{ |
571 |
.name = "cpu", |
572 |
.args_type = "index:i", |
573 |
.params = "index", |
574 |
.help = "set the default CPU", |
575 |
.mhandler.cmd = do_cpu_set, |
576 |
}, |
577 |
|
578 |
STEXI |
579 |
Set the default CPU. |
580 |
ETEXI |
581 |
|
582 |
{ |
583 |
.name = "mouse_move", |
584 |
.args_type = "dx_str:s,dy_str:s,dz_str:s?", |
585 |
.params = "dx dy [dz]", |
586 |
.help = "send mouse move events", |
587 |
.mhandler.cmd = do_mouse_move, |
588 |
}, |
589 |
|
590 |
STEXI |
591 |
@item mouse_move @var{dx} @var{dy} [@var{dz}] |
592 |
Move the active mouse to the specified coordinates @var{dx} @var{dy} |
593 |
with optional scroll axis @var{dz}. |
594 |
ETEXI |
595 |
|
596 |
{ |
597 |
.name = "mouse_button", |
598 |
.args_type = "button_state:i", |
599 |
.params = "state", |
600 |
.help = "change mouse button state (1=L, 2=M, 4=R)", |
601 |
.mhandler.cmd = do_mouse_button, |
602 |
}, |
603 |
|
604 |
STEXI |
605 |
@item mouse_button @var{val} |
606 |
Change the active mouse button state @var{val} (1=L, 2=M, 4=R). |
607 |
ETEXI |
608 |
|
609 |
{ |
610 |
.name = "mouse_set", |
611 |
.args_type = "index:i", |
612 |
.params = "index", |
613 |
.help = "set which mouse device receives events", |
614 |
.mhandler.cmd = do_mouse_set, |
615 |
}, |
616 |
|
617 |
STEXI |
618 |
@item mouse_set @var{index} |
619 |
Set which mouse device receives events at given @var{index}, index |
620 |
can be obtained with |
621 |
@example |
622 |
info mice |
623 |
@end example |
624 |
ETEXI |
625 |
|
626 |
#ifdef HAS_AUDIO |
627 |
{ |
628 |
.name = "wavcapture", |
629 |
.args_type = "path:F,freq:i?,bits:i?,nchannels:i?", |
630 |
.params = "path [frequency [bits [channels]]]", |
631 |
.help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)", |
632 |
.mhandler.cmd = do_wav_capture, |
633 |
}, |
634 |
#endif |
635 |
STEXI |
636 |
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]] |
637 |
Capture audio into @var{filename}. Using sample rate @var{frequency} |
638 |
bits per sample @var{bits} and number of channels @var{channels}. |
639 |
|
640 |
Defaults: |
641 |
@itemize @minus |
642 |
@item Sample rate = 44100 Hz - CD quality |
643 |
@item Bits = 16 |
644 |
@item Number of channels = 2 - Stereo |
645 |
@end itemize |
646 |
ETEXI |
647 |
|
648 |
#ifdef HAS_AUDIO |
649 |
{ |
650 |
.name = "stopcapture", |
651 |
.args_type = "n:i", |
652 |
.params = "capture index", |
653 |
.help = "stop capture", |
654 |
.mhandler.cmd = do_stop_capture, |
655 |
}, |
656 |
#endif |
657 |
STEXI |
658 |
@item stopcapture @var{index} |
659 |
Stop capture with a given @var{index}, index can be obtained with |
660 |
@example |
661 |
info capture |
662 |
@end example |
663 |
ETEXI |
664 |
|
665 |
{ |
666 |
.name = "memsave", |
667 |
.args_type = "val:l,size:i,filename:s", |
668 |
.params = "addr size file", |
669 |
.help = "save to disk virtual memory dump starting at 'addr' of size 'size'", |
670 |
.user_print = monitor_user_noop, |
671 |
.mhandler.cmd_new = do_memory_save, |
672 |
}, |
673 |
|
674 |
STEXI |
675 |
@item memsave @var{addr} @var{size} @var{file} |
676 |
save to disk virtual memory dump starting at @var{addr} of size @var{size}. |
677 |
ETEXI |
678 |
|
679 |
{ |
680 |
.name = "pmemsave", |
681 |
.args_type = "val:l,size:i,filename:s", |
682 |
.params = "addr size file", |
683 |
.help = "save to disk physical memory dump starting at 'addr' of size 'size'", |
684 |
.user_print = monitor_user_noop, |
685 |
.mhandler.cmd_new = do_physical_memory_save, |
686 |
}, |
687 |
|
688 |
STEXI |
689 |
@item pmemsave @var{addr} @var{size} @var{file} |
690 |
save to disk physical memory dump starting at @var{addr} of size @var{size}. |
691 |
ETEXI |
692 |
|
693 |
{ |
694 |
.name = "boot_set", |
695 |
.args_type = "bootdevice:s", |
696 |
.params = "bootdevice", |
697 |
.help = "define new values for the boot device list", |
698 |
.mhandler.cmd = do_boot_set, |
699 |
}, |
700 |
|
701 |
STEXI |
702 |
@item boot_set @var{bootdevicelist} |
703 |
|
704 |
Define new values for the boot device list. Those values will override |
705 |
the values specified on the command line through the @code{-boot} option. |
706 |
|
707 |
The values that can be specified here depend on the machine type, but are |
708 |
the same that can be specified in the @code{-boot} command line option. |
709 |
ETEXI |
710 |
|
711 |
#if defined(TARGET_I386) |
712 |
{ |
713 |
.name = "nmi", |
714 |
.args_type = "cpu_index:i", |
715 |
.params = "cpu", |
716 |
.help = "inject an NMI on the given CPU", |
717 |
.mhandler.cmd = do_inject_nmi, |
718 |
}, |
719 |
#endif |
720 |
STEXI |
721 |
@item nmi @var{cpu} |
722 |
Inject an NMI on the given CPU (x86 only). |
723 |
ETEXI |
724 |
|
725 |
{ |
726 |
.name = "migrate", |
727 |
.args_type = "detach:-d,blk:-b,inc:-i,uri:s", |
728 |
.params = "[-d] [-b] [-i] uri", |
729 |
.help = "migrate to URI (using -d to not wait for completion)" |
730 |
"\n\t\t\t -b for migration without shared storage with" |
731 |
" full copy of disk\n\t\t\t -i for migration without " |
732 |
"shared storage with incremental copy of disk " |
733 |
"(base image shared between src and destination)", |
734 |
.user_print = monitor_user_noop, |
735 |
.mhandler.cmd_new = do_migrate, |
736 |
}, |
737 |
|
738 |
|
739 |
STEXI |
740 |
@item migrate [-d] [-b] [-i] @var{uri} |
741 |
Migrate to @var{uri} (using -d to not wait for completion). |
742 |
-b for migration with full copy of disk |
743 |
-i for migration with incremental copy of disk (base image is shared) |
744 |
ETEXI |
745 |
|
746 |
{ |
747 |
.name = "migrate_cancel", |
748 |
.args_type = "", |
749 |
.params = "", |
750 |
.help = "cancel the current VM migration", |
751 |
.user_print = monitor_user_noop, |
752 |
.mhandler.cmd_new = do_migrate_cancel, |
753 |
}, |
754 |
|
755 |
STEXI |
756 |
@item migrate_cancel |
757 |
Cancel the current VM migration. |
758 |
ETEXI |
759 |
|
760 |
{ |
761 |
.name = "migrate_set_speed", |
762 |
.args_type = "value:s", |
763 |
.params = "value", |
764 |
.help = "set maximum speed (in bytes) for migrations", |
765 |
.user_print = monitor_user_noop, |
766 |
.mhandler.cmd_new = do_migrate_set_speed, |
767 |
}, |
768 |
|
769 |
STEXI |
770 |
@item migrate_set_speed @var{value} |
771 |
Set maximum speed to @var{value} (in bytes) for migrations. |
772 |
ETEXI |
773 |
|
774 |
{ |
775 |
.name = "migrate_set_downtime", |
776 |
.args_type = "value:s", |
777 |
.params = "value", |
778 |
.help = "set maximum tolerated downtime (in seconds) for migrations", |
779 |
.mhandler.cmd = do_migrate_set_downtime, |
780 |
}, |
781 |
|
782 |
STEXI |
783 |
@item migrate_set_downtime @var{second} |
784 |
Set maximum tolerated downtime (in seconds) for migration. |
785 |
ETEXI |
786 |
|
787 |
#if defined(TARGET_I386) |
788 |
{ |
789 |
.name = "drive_add", |
790 |
.args_type = "pci_addr:s,opts:s", |
791 |
.params = "[[<domain>:]<bus>:]<slot>\n" |
792 |
"[file=file][,if=type][,bus=n]\n" |
793 |
"[,unit=m][,media=d][index=i]\n" |
794 |
"[,cyls=c,heads=h,secs=s[,trans=t]]\n" |
795 |
"[snapshot=on|off][,cache=on|off]", |
796 |
.help = "add drive to PCI storage controller", |
797 |
.mhandler.cmd = drive_hot_add, |
798 |
}, |
799 |
#endif |
800 |
|
801 |
STEXI |
802 |
@item drive_add |
803 |
Add drive to PCI storage controller. |
804 |
ETEXI |
805 |
|
806 |
#if defined(TARGET_I386) |
807 |
{ |
808 |
.name = "pci_add", |
809 |
.args_type = "pci_addr:s,type:s,opts:s?", |
810 |
.params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...", |
811 |
.help = "hot-add PCI device", |
812 |
.mhandler.cmd = pci_device_hot_add, |
813 |
}, |
814 |
#endif |
815 |
|
816 |
STEXI |
817 |
@item pci_add |
818 |
Hot-add PCI device. |
819 |
ETEXI |
820 |
|
821 |
#if defined(TARGET_I386) |
822 |
{ |
823 |
.name = "pci_del", |
824 |
.args_type = "pci_addr:s", |
825 |
.params = "[[<domain>:]<bus>:]<slot>", |
826 |
.help = "hot remove PCI device", |
827 |
.user_print = monitor_user_noop, |
828 |
.mhandler.cmd_new = do_pci_device_hot_remove, |
829 |
}, |
830 |
#endif |
831 |
|
832 |
STEXI |
833 |
@item pci_del |
834 |
Hot remove PCI device. |
835 |
ETEXI |
836 |
|
837 |
{ |
838 |
.name = "host_net_add", |
839 |
.args_type = "device:s,opts:s?", |
840 |
.params = "tap|user|socket|vde|dump [options]", |
841 |
.help = "add host VLAN client", |
842 |
.mhandler.cmd = net_host_device_add, |
843 |
}, |
844 |
|
845 |
STEXI |
846 |
@item host_net_add |
847 |
Add host VLAN client. |
848 |
ETEXI |
849 |
|
850 |
{ |
851 |
.name = "host_net_remove", |
852 |
.args_type = "vlan_id:i,device:s", |
853 |
.params = "vlan_id name", |
854 |
.help = "remove host VLAN client", |
855 |
.mhandler.cmd = net_host_device_remove, |
856 |
}, |
857 |
|
858 |
STEXI |
859 |
@item host_net_remove |
860 |
Remove host VLAN client. |
861 |
ETEXI |
862 |
|
863 |
#ifdef CONFIG_SLIRP |
864 |
{ |
865 |
.name = "hostfwd_add", |
866 |
.args_type = "arg1:s,arg2:s?,arg3:s?", |
867 |
.params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport", |
868 |
.help = "redirect TCP or UDP connections from host to guest (requires -net user)", |
869 |
.mhandler.cmd = net_slirp_hostfwd_add, |
870 |
}, |
871 |
|
872 |
{ |
873 |
.name = "hostfwd_remove", |
874 |
.args_type = "arg1:s,arg2:s?,arg3:s?", |
875 |
.params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport", |
876 |
.help = "remove host-to-guest TCP or UDP redirection", |
877 |
.mhandler.cmd = net_slirp_hostfwd_remove, |
878 |
}, |
879 |
|
880 |
#endif |
881 |
STEXI |
882 |
@item host_net_redir |
883 |
Redirect TCP or UDP connections from host to guest (requires -net user). |
884 |
ETEXI |
885 |
|
886 |
{ |
887 |
.name = "balloon", |
888 |
.args_type = "value:i", |
889 |
.params = "target", |
890 |
.help = "request VM to change it's memory allocation (in MB)", |
891 |
.user_print = monitor_user_noop, |
892 |
.mhandler.cmd_new = do_balloon, |
893 |
}, |
894 |
|
895 |
STEXI |
896 |
@item balloon @var{value} |
897 |
Request VM to change its memory allocation to @var{value} (in MB). |
898 |
ETEXI |
899 |
|
900 |
{ |
901 |
.name = "set_link", |
902 |
.args_type = "name:s,up_or_down:s", |
903 |
.params = "name up|down", |
904 |
.help = "change the link status of a network adapter", |
905 |
.mhandler.cmd = do_set_link, |
906 |
}, |
907 |
|
908 |
STEXI |
909 |
@item set_link @var{name} [up|down] |
910 |
Set link @var{name} up or down. |
911 |
ETEXI |
912 |
|
913 |
{ |
914 |
.name = "watchdog_action", |
915 |
.args_type = "action:s", |
916 |
.params = "[reset|shutdown|poweroff|pause|debug|none]", |
917 |
.help = "change watchdog action", |
918 |
.mhandler.cmd = do_watchdog_action, |
919 |
}, |
920 |
|
921 |
STEXI |
922 |
@item watchdog_action |
923 |
Change watchdog action. |
924 |
ETEXI |
925 |
|
926 |
{ |
927 |
.name = "acl_show", |
928 |
.args_type = "aclname:s", |
929 |
.params = "aclname", |
930 |
.help = "list rules in the access control list", |
931 |
.mhandler.cmd = do_acl_show, |
932 |
}, |
933 |
|
934 |
STEXI |
935 |
@item acl_show @var{aclname} |
936 |
List all the matching rules in the access control list, and the default |
937 |
policy. There are currently two named access control lists, |
938 |
@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client |
939 |
certificate distinguished name, and SASL username respectively. |
940 |
ETEXI |
941 |
|
942 |
{ |
943 |
.name = "acl_policy", |
944 |
.args_type = "aclname:s,policy:s", |
945 |
.params = "aclname allow|deny", |
946 |
.help = "set default access control list policy", |
947 |
.mhandler.cmd = do_acl_policy, |
948 |
}, |
949 |
|
950 |
STEXI |
951 |
@item acl_policy @var{aclname} @code{allow|deny} |
952 |
Set the default access control list policy, used in the event that |
953 |
none of the explicit rules match. The default policy at startup is |
954 |
always @code{deny}. |
955 |
ETEXI |
956 |
|
957 |
{ |
958 |
.name = "acl_add", |
959 |
.args_type = "aclname:s,match:s,policy:s,index:i?", |
960 |
.params = "aclname match allow|deny [index]", |
961 |
.help = "add a match rule to the access control list", |
962 |
.mhandler.cmd = do_acl_add, |
963 |
}, |
964 |
|
965 |
STEXI |
966 |
@item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}] |
967 |
Add a match rule to the access control list, allowing or denying access. |
968 |
The match will normally be an exact username or x509 distinguished name, |
969 |
but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to |
970 |
allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will |
971 |
normally be appended to the end of the ACL, but can be inserted |
972 |
earlier in the list if the optional @var{index} parameter is supplied. |
973 |
ETEXI |
974 |
|
975 |
{ |
976 |
.name = "acl_remove", |
977 |
.args_type = "aclname:s,match:s", |
978 |
.params = "aclname match", |
979 |
.help = "remove a match rule from the access control list", |
980 |
.mhandler.cmd = do_acl_remove, |
981 |
}, |
982 |
|
983 |
STEXI |
984 |
@item acl_remove @var{aclname} @var{match} |
985 |
Remove the specified match rule from the access control list. |
986 |
ETEXI |
987 |
|
988 |
{ |
989 |
.name = "acl_reset", |
990 |
.args_type = "aclname:s", |
991 |
.params = "aclname", |
992 |
.help = "reset the access control list", |
993 |
.mhandler.cmd = do_acl_reset, |
994 |
}, |
995 |
|
996 |
STEXI |
997 |
@item acl_remove @var{aclname} @var{match} |
998 |
Remove all matches from the access control list, and set the default |
999 |
policy back to @code{deny}. |
1000 |
ETEXI |
1001 |
|
1002 |
#if defined(TARGET_I386) |
1003 |
|
1004 |
{ |
1005 |
.name = "mce", |
1006 |
.args_type = "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l", |
1007 |
.params = "cpu bank status mcgstatus addr misc", |
1008 |
.help = "inject a MCE on the given CPU", |
1009 |
.mhandler.cmd = do_inject_mce, |
1010 |
}, |
1011 |
|
1012 |
#endif |
1013 |
STEXI |
1014 |
@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc} |
1015 |
Inject an MCE on the given CPU (x86 only). |
1016 |
ETEXI |
1017 |
|
1018 |
{ |
1019 |
.name = "getfd", |
1020 |
.args_type = "fdname:s", |
1021 |
.params = "getfd name", |
1022 |
.help = "receive a file descriptor via SCM rights and assign it a name", |
1023 |
.user_print = monitor_user_noop, |
1024 |
.mhandler.cmd_new = do_getfd, |
1025 |
}, |
1026 |
|
1027 |
STEXI |
1028 |
@item getfd @var{fdname} |
1029 |
If a file descriptor is passed alongside this command using the SCM_RIGHTS |
1030 |
mechanism on unix sockets, it is stored using the name @var{fdname} for |
1031 |
later use by other monitor commands. |
1032 |
ETEXI |
1033 |
|
1034 |
{ |
1035 |
.name = "closefd", |
1036 |
.args_type = "fdname:s", |
1037 |
.params = "closefd name", |
1038 |
.help = "close a file descriptor previously passed via SCM rights", |
1039 |
.user_print = monitor_user_noop, |
1040 |
.mhandler.cmd_new = do_closefd, |
1041 |
}, |
1042 |
|
1043 |
STEXI |
1044 |
@item closefd @var{fdname} |
1045 |
Close the file descriptor previously assigned to @var{fdname} using the |
1046 |
@code{getfd} command. This is only needed if the file descriptor was never |
1047 |
used by another monitor command. |
1048 |
ETEXI |
1049 |
|
1050 |
{ |
1051 |
.name = "block_passwd", |
1052 |
.args_type = "device:B,password:s", |
1053 |
.params = "block_passwd device password", |
1054 |
.help = "set the password of encrypted block devices", |
1055 |
.user_print = monitor_user_noop, |
1056 |
.mhandler.cmd_new = do_block_set_passwd, |
1057 |
}, |
1058 |
|
1059 |
STEXI |
1060 |
@item block_passwd @var{device} @var{password} |
1061 |
Set the encrypted device @var{device} password to @var{password} |
1062 |
ETEXI |
1063 |
|
1064 |
STEXI |
1065 |
@end table |
1066 |
ETEXI |