]>
Commit | Line | Data |
---|---|---|
2313086a BS |
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 | ||
d7f9b689 LC |
12 | { |
13 | .name = "help|?", | |
14 | .args_type = "name:s?", | |
d7f9b689 LC |
15 | .params = "[cmd]", |
16 | .help = "show the help", | |
af4ce882 | 17 | .mhandler.cmd = do_help_cmd, |
d7f9b689 LC |
18 | }, |
19 | ||
2313086a BS |
20 | STEXI |
21 | @item help or ? [@var{cmd}] | |
70fcbbe7 | 22 | @findex help |
2313086a BS |
23 | Show the help for all commands or just for command @var{cmd}. |
24 | ETEXI | |
25 | ||
d7f9b689 LC |
26 | { |
27 | .name = "commit", | |
28 | .args_type = "device:B", | |
d7f9b689 LC |
29 | .params = "device|all", |
30 | .help = "commit changes to the disk images (if -snapshot is used) or backing files", | |
af4ce882 | 31 | .mhandler.cmd = do_commit, |
d7f9b689 LC |
32 | }, |
33 | ||
2313086a BS |
34 | STEXI |
35 | @item commit | |
70fcbbe7 | 36 | @findex commit |
2313086a | 37 | Commit changes to the disk images (if -snapshot is used) or backing files. |
2313086a BS |
38 | ETEXI |
39 | ||
d7f9b689 LC |
40 | { |
41 | .name = "q|quit", | |
42 | .args_type = "", | |
d7f9b689 LC |
43 | .params = "", |
44 | .help = "quit the emulator", | |
b223f35f | 45 | .user_print = monitor_user_noop, |
7a7f325e | 46 | .mhandler.cmd = hmp_quit, |
d7f9b689 LC |
47 | }, |
48 | ||
2313086a BS |
49 | STEXI |
50 | @item q or quit | |
70fcbbe7 | 51 | @findex quit |
2313086a BS |
52 | Quit the emulator. |
53 | ETEXI | |
54 | ||
6d4a2b3a CH |
55 | { |
56 | .name = "block_resize", | |
57 | .args_type = "device:B,size:o", | |
58 | .params = "device size", | |
59 | .help = "resize a block image", | |
5e7caacb | 60 | .mhandler.cmd = hmp_block_resize, |
6d4a2b3a CH |
61 | }, |
62 | ||
63 | STEXI | |
64 | @item block_resize | |
65 | @findex block_resize | |
66 | Resize a block image while a guest is running. Usually requires guest | |
67 | action to see the updated size. Resize to a lower size is supported, | |
68 | but should be used with extreme caution. Note that this command only | |
69 | resizes image files, it can not resize block devices like LVM volumes. | |
70 | ETEXI | |
71 | ||
12bd451f SH |
72 | { |
73 | .name = "block_stream", | |
74 | .args_type = "device:B,base:s?", | |
75 | .params = "device [base]", | |
76 | .help = "copy data from a backing file into a block device", | |
77 | .mhandler.cmd = hmp_block_stream, | |
78 | }, | |
79 | ||
80 | STEXI | |
81 | @item block_stream | |
82 | @findex block_stream | |
83 | Copy data from a backing file into a block device. | |
2d47c6e9 SH |
84 | ETEXI |
85 | ||
86 | { | |
87 | .name = "block_job_set_speed", | |
88 | .args_type = "device:B,value:o", | |
89 | .params = "device value", | |
90 | .help = "set maximum speed for a background block operation", | |
91 | .mhandler.cmd = hmp_block_job_set_speed, | |
92 | }, | |
93 | ||
94 | STEXI | |
95 | @item block_job_set_stream | |
96 | @findex block_job_set_stream | |
97 | Set maximum speed for a background block operation. | |
12bd451f | 98 | ETEXI |
6d4a2b3a | 99 | |
d7f9b689 LC |
100 | { |
101 | .name = "eject", | |
78d714e0 | 102 | .args_type = "force:-f,device:B", |
d7f9b689 LC |
103 | .params = "[-f] device", |
104 | .help = "eject a removable medium (use -f to force it)", | |
c245b6a3 | 105 | .mhandler.cmd = hmp_eject, |
d7f9b689 LC |
106 | }, |
107 | ||
2313086a BS |
108 | STEXI |
109 | @item eject [-f] @var{device} | |
70fcbbe7 | 110 | @findex eject |
2313086a | 111 | Eject a removable medium (use -f to force it). |
9063f814 RH |
112 | ETEXI |
113 | ||
114 | { | |
115 | .name = "drive_del", | |
116 | .args_type = "id:s", | |
117 | .params = "device", | |
118 | .help = "remove host block device", | |
119 | .user_print = monitor_user_noop, | |
120 | .mhandler.cmd_new = do_drive_del, | |
121 | }, | |
122 | ||
123 | STEXI | |
124 | @item drive_del @var{device} | |
125 | @findex drive_del | |
126 | Remove host block device. The result is that guest generated IO is no longer | |
127 | submitted against the host device underlying the disk. Once a drive has | |
128 | been deleted, the QEMU Block layer returns -EIO which results in IO | |
129 | errors in the guest for applications that are reading/writing to the device. | |
2313086a BS |
130 | ETEXI |
131 | ||
d7f9b689 LC |
132 | { |
133 | .name = "change", | |
134 | .args_type = "device:B,target:F,arg:s?", | |
d7f9b689 LC |
135 | .params = "device filename [format]", |
136 | .help = "change a removable medium, optional format", | |
333a96ec | 137 | .mhandler.cmd = hmp_change, |
d7f9b689 LC |
138 | }, |
139 | ||
2313086a BS |
140 | STEXI |
141 | @item change @var{device} @var{setting} | |
70fcbbe7 | 142 | @findex change |
2313086a BS |
143 | |
144 | Change the configuration of a device. | |
145 | ||
146 | @table @option | |
147 | @item change @var{diskdevice} @var{filename} [@var{format}] | |
148 | Change the medium for a removable disk device to point to @var{filename}. eg | |
149 | ||
150 | @example | |
151 | (qemu) change ide1-cd0 /path/to/some.iso | |
152 | @end example | |
153 | ||
154 | @var{format} is optional. | |
155 | ||
156 | @item change vnc @var{display},@var{options} | |
157 | Change the configuration of the VNC server. The valid syntax for @var{display} | |
158 | and @var{options} are described at @ref{sec_invocation}. eg | |
159 | ||
160 | @example | |
161 | (qemu) change vnc localhost:1 | |
162 | @end example | |
163 | ||
164 | @item change vnc password [@var{password}] | |
165 | ||
166 | Change the password associated with the VNC server. If the new password is not | |
167 | supplied, the monitor will prompt for it to be entered. VNC passwords are only | |
168 | significant up to 8 letters. eg | |
169 | ||
170 | @example | |
171 | (qemu) change vnc password | |
172 | Password: ******** | |
173 | @end example | |
174 | ||
175 | @end table | |
176 | ETEXI | |
177 | ||
d7f9b689 LC |
178 | { |
179 | .name = "screendump", | |
180 | .args_type = "filename:F", | |
d7f9b689 LC |
181 | .params = "filename", |
182 | .help = "save screen into PPM image 'filename'", | |
f1dc58e0 LC |
183 | .user_print = monitor_user_noop, |
184 | .mhandler.cmd_new = do_screen_dump, | |
d7f9b689 LC |
185 | }, |
186 | ||
2313086a BS |
187 | STEXI |
188 | @item screendump @var{filename} | |
70fcbbe7 | 189 | @findex screendump |
2313086a BS |
190 | Save screen into PPM image @var{filename}. |
191 | ETEXI | |
192 | ||
d7f9b689 LC |
193 | { |
194 | .name = "logfile", | |
195 | .args_type = "filename:F", | |
d7f9b689 LC |
196 | .params = "filename", |
197 | .help = "output logs to 'filename'", | |
af4ce882 | 198 | .mhandler.cmd = do_logfile, |
d7f9b689 LC |
199 | }, |
200 | ||
2313086a BS |
201 | STEXI |
202 | @item logfile @var{filename} | |
70fcbbe7 | 203 | @findex logfile |
2313086a BS |
204 | Output logs to @var{filename}. |
205 | ETEXI | |
206 | ||
22890ab5 PS |
207 | { |
208 | .name = "trace-event", | |
209 | .args_type = "name:s,option:b", | |
210 | .params = "name on|off", | |
211 | .help = "changes status of a specific trace event", | |
fc764105 | 212 | .mhandler.cmd = do_trace_event_set_state, |
22890ab5 PS |
213 | }, |
214 | ||
215 | STEXI | |
216 | @item trace-event | |
217 | @findex trace-event | |
218 | changes status of a trace event | |
c5ceb523 SH |
219 | ETEXI |
220 | ||
c45a8168 | 221 | #if defined(CONFIG_TRACE_SIMPLE) |
c5ceb523 SH |
222 | { |
223 | .name = "trace-file", | |
224 | .args_type = "op:s?,arg:F?", | |
225 | .params = "on|off|flush|set [arg]", | |
226 | .help = "open, close, or flush trace file, or set a new file name", | |
227 | .mhandler.cmd = do_trace_file, | |
228 | }, | |
229 | ||
230 | STEXI | |
231 | @item trace-file on|off|flush | |
232 | @findex trace-file | |
233 | Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed. | |
22890ab5 PS |
234 | ETEXI |
235 | #endif | |
236 | ||
d7f9b689 LC |
237 | { |
238 | .name = "log", | |
239 | .args_type = "items:s", | |
d7f9b689 LC |
240 | .params = "item1[,...]", |
241 | .help = "activate logging of the specified items to '/tmp/qemu.log'", | |
af4ce882 | 242 | .mhandler.cmd = do_log, |
d7f9b689 LC |
243 | }, |
244 | ||
2313086a BS |
245 | STEXI |
246 | @item log @var{item1}[,...] | |
70fcbbe7 | 247 | @findex log |
2313086a BS |
248 | Activate logging of the specified items to @file{/tmp/qemu.log}. |
249 | ETEXI | |
250 | ||
d7f9b689 LC |
251 | { |
252 | .name = "savevm", | |
253 | .args_type = "name:s?", | |
d7f9b689 LC |
254 | .params = "[tag|id]", |
255 | .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created", | |
af4ce882 | 256 | .mhandler.cmd = do_savevm, |
d7f9b689 LC |
257 | }, |
258 | ||
2313086a BS |
259 | STEXI |
260 | @item savevm [@var{tag}|@var{id}] | |
70fcbbe7 | 261 | @findex savevm |
2313086a BS |
262 | Create a snapshot of the whole virtual machine. If @var{tag} is |
263 | provided, it is used as human readable identifier. If there is already | |
264 | a snapshot with the same tag or ID, it is replaced. More info at | |
265 | @ref{vm_snapshots}. | |
266 | ETEXI | |
267 | ||
d7f9b689 LC |
268 | { |
269 | .name = "loadvm", | |
270 | .args_type = "name:s", | |
d7f9b689 LC |
271 | .params = "tag|id", |
272 | .help = "restore a VM snapshot from its tag or id", | |
af4ce882 | 273 | .mhandler.cmd = do_loadvm, |
d7f9b689 LC |
274 | }, |
275 | ||
2313086a BS |
276 | STEXI |
277 | @item loadvm @var{tag}|@var{id} | |
70fcbbe7 | 278 | @findex loadvm |
2313086a BS |
279 | Set the whole virtual machine to the snapshot identified by the tag |
280 | @var{tag} or the unique snapshot ID @var{id}. | |
281 | ETEXI | |
282 | ||
d7f9b689 LC |
283 | { |
284 | .name = "delvm", | |
285 | .args_type = "name:s", | |
d7f9b689 LC |
286 | .params = "tag|id", |
287 | .help = "delete a VM snapshot from its tag or id", | |
af4ce882 | 288 | .mhandler.cmd = do_delvm, |
d7f9b689 LC |
289 | }, |
290 | ||
2313086a BS |
291 | STEXI |
292 | @item delvm @var{tag}|@var{id} | |
70fcbbe7 | 293 | @findex delvm |
2313086a BS |
294 | Delete the snapshot identified by @var{tag} or @var{id}. |
295 | ETEXI | |
296 | ||
d7f9b689 LC |
297 | { |
298 | .name = "singlestep", | |
299 | .args_type = "option:s?", | |
d7f9b689 LC |
300 | .params = "[on|off]", |
301 | .help = "run emulation in singlestep mode or switch to normal mode", | |
af4ce882 | 302 | .mhandler.cmd = do_singlestep, |
d7f9b689 LC |
303 | }, |
304 | ||
2313086a BS |
305 | STEXI |
306 | @item singlestep [off] | |
70fcbbe7 | 307 | @findex singlestep |
2313086a BS |
308 | Run the emulation in single step mode. |
309 | If called with option off, the emulation returns to normal mode. | |
310 | ETEXI | |
311 | ||
d7f9b689 LC |
312 | { |
313 | .name = "stop", | |
314 | .args_type = "", | |
d7f9b689 LC |
315 | .params = "", |
316 | .help = "stop emulation", | |
5f158f21 | 317 | .mhandler.cmd = hmp_stop, |
d7f9b689 LC |
318 | }, |
319 | ||
2313086a BS |
320 | STEXI |
321 | @item stop | |
70fcbbe7 | 322 | @findex stop |
2313086a BS |
323 | Stop emulation. |
324 | ETEXI | |
325 | ||
d7f9b689 LC |
326 | { |
327 | .name = "c|cont", | |
328 | .args_type = "", | |
d7f9b689 LC |
329 | .params = "", |
330 | .help = "resume emulation", | |
e42e818b | 331 | .mhandler.cmd = hmp_cont, |
d7f9b689 LC |
332 | }, |
333 | ||
2313086a BS |
334 | STEXI |
335 | @item c or cont | |
70fcbbe7 | 336 | @findex cont |
2313086a BS |
337 | Resume emulation. |
338 | ETEXI | |
339 | ||
d7f9b689 LC |
340 | { |
341 | .name = "gdbserver", | |
342 | .args_type = "device:s?", | |
d7f9b689 LC |
343 | .params = "[device]", |
344 | .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'", | |
af4ce882 | 345 | .mhandler.cmd = do_gdbserver, |
d7f9b689 LC |
346 | }, |
347 | ||
2313086a BS |
348 | STEXI |
349 | @item gdbserver [@var{port}] | |
70fcbbe7 | 350 | @findex gdbserver |
2313086a BS |
351 | Start gdbserver session (default @var{port}=1234) |
352 | ETEXI | |
353 | ||
d7f9b689 LC |
354 | { |
355 | .name = "x", | |
356 | .args_type = "fmt:/,addr:l", | |
d7f9b689 LC |
357 | .params = "/fmt addr", |
358 | .help = "virtual memory dump starting at 'addr'", | |
af4ce882 | 359 | .mhandler.cmd = do_memory_dump, |
d7f9b689 LC |
360 | }, |
361 | ||
2313086a BS |
362 | STEXI |
363 | @item x/fmt @var{addr} | |
70fcbbe7 | 364 | @findex x |
2313086a BS |
365 | Virtual memory dump starting at @var{addr}. |
366 | ETEXI | |
367 | ||
d7f9b689 LC |
368 | { |
369 | .name = "xp", | |
370 | .args_type = "fmt:/,addr:l", | |
d7f9b689 LC |
371 | .params = "/fmt addr", |
372 | .help = "physical memory dump starting at 'addr'", | |
af4ce882 | 373 | .mhandler.cmd = do_physical_memory_dump, |
d7f9b689 LC |
374 | }, |
375 | ||
2313086a BS |
376 | STEXI |
377 | @item xp /@var{fmt} @var{addr} | |
70fcbbe7 | 378 | @findex xp |
2313086a BS |
379 | Physical memory dump starting at @var{addr}. |
380 | ||
381 | @var{fmt} is a format which tells the command how to format the | |
382 | data. Its syntax is: @option{/@{count@}@{format@}@{size@}} | |
383 | ||
384 | @table @var | |
385 | @item count | |
386 | is the number of items to be dumped. | |
387 | ||
388 | @item format | |
389 | can be x (hex), d (signed decimal), u (unsigned decimal), o (octal), | |
390 | c (char) or i (asm instruction). | |
391 | ||
392 | @item size | |
393 | can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86, | |
394 | @code{h} or @code{w} can be specified with the @code{i} format to | |
395 | respectively select 16 or 32 bit code instruction size. | |
396 | ||
397 | @end table | |
398 | ||
399 | Examples: | |
400 | @itemize | |
401 | @item | |
402 | Dump 10 instructions at the current instruction pointer: | |
403 | @example | |
404 | (qemu) x/10i $eip | |
405 | 0x90107063: ret | |
406 | 0x90107064: sti | |
407 | 0x90107065: lea 0x0(%esi,1),%esi | |
408 | 0x90107069: lea 0x0(%edi,1),%edi | |
409 | 0x90107070: ret | |
410 | 0x90107071: jmp 0x90107080 | |
411 | 0x90107073: nop | |
412 | 0x90107074: nop | |
413 | 0x90107075: nop | |
414 | 0x90107076: nop | |
415 | @end example | |
416 | ||
417 | @item | |
418 | Dump 80 16 bit values at the start of the video memory. | |
419 | @smallexample | |
420 | (qemu) xp/80hx 0xb8000 | |
421 | 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42 | |
422 | 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41 | |
423 | 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72 | |
424 | 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73 | |
425 | 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20 | |
426 | 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720 | |
427 | 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 | |
428 | 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 | |
429 | 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 | |
430 | 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 | |
431 | @end smallexample | |
432 | @end itemize | |
433 | ETEXI | |
434 | ||
d7f9b689 LC |
435 | { |
436 | .name = "p|print", | |
437 | .args_type = "fmt:/,val:l", | |
d7f9b689 LC |
438 | .params = "/fmt expr", |
439 | .help = "print expression value (use $reg for CPU register access)", | |
af4ce882 | 440 | .mhandler.cmd = do_print, |
d7f9b689 LC |
441 | }, |
442 | ||
2313086a BS |
443 | STEXI |
444 | @item p or print/@var{fmt} @var{expr} | |
70fcbbe7 | 445 | @findex print |
2313086a BS |
446 | |
447 | Print expression value. Only the @var{format} part of @var{fmt} is | |
448 | used. | |
449 | ETEXI | |
450 | ||
d7f9b689 LC |
451 | { |
452 | .name = "i", | |
453 | .args_type = "fmt:/,addr:i,index:i.", | |
d7f9b689 LC |
454 | .params = "/fmt addr", |
455 | .help = "I/O port read", | |
af4ce882 | 456 | .mhandler.cmd = do_ioport_read, |
d7f9b689 LC |
457 | }, |
458 | ||
2313086a BS |
459 | STEXI |
460 | Read I/O port. | |
461 | ETEXI | |
462 | ||
d7f9b689 LC |
463 | { |
464 | .name = "o", | |
465 | .args_type = "fmt:/,addr:i,val:i", | |
d7f9b689 LC |
466 | .params = "/fmt addr value", |
467 | .help = "I/O port write", | |
af4ce882 | 468 | .mhandler.cmd = do_ioport_write, |
d7f9b689 LC |
469 | }, |
470 | ||
f114784f JK |
471 | STEXI |
472 | Write to I/O port. | |
473 | ETEXI | |
2313086a | 474 | |
d7f9b689 LC |
475 | { |
476 | .name = "sendkey", | |
477 | .args_type = "string:s,hold_time:i?", | |
d7f9b689 LC |
478 | .params = "keys [hold_ms]", |
479 | .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)", | |
af4ce882 | 480 | .mhandler.cmd = do_sendkey, |
d7f9b689 LC |
481 | }, |
482 | ||
2313086a BS |
483 | STEXI |
484 | @item sendkey @var{keys} | |
70fcbbe7 | 485 | @findex sendkey |
2313086a BS |
486 | |
487 | Send @var{keys} to the emulator. @var{keys} could be the name of the | |
488 | key or @code{#} followed by the raw value in either decimal or hexadecimal | |
489 | format. Use @code{-} to press several keys simultaneously. Example: | |
490 | @example | |
491 | sendkey ctrl-alt-f1 | |
492 | @end example | |
493 | ||
494 | This command is useful to send keys that your graphical user interface | |
495 | intercepts at low level, such as @code{ctrl-alt-f1} in X Window. | |
496 | ETEXI | |
497 | ||
d7f9b689 LC |
498 | { |
499 | .name = "system_reset", | |
500 | .args_type = "", | |
d7f9b689 LC |
501 | .params = "", |
502 | .help = "reset the system", | |
38d22653 | 503 | .mhandler.cmd = hmp_system_reset, |
d7f9b689 LC |
504 | }, |
505 | ||
2313086a BS |
506 | STEXI |
507 | @item system_reset | |
70fcbbe7 | 508 | @findex system_reset |
2313086a BS |
509 | |
510 | Reset the system. | |
511 | ETEXI | |
512 | ||
d7f9b689 LC |
513 | { |
514 | .name = "system_powerdown", | |
515 | .args_type = "", | |
d7f9b689 LC |
516 | .params = "", |
517 | .help = "send system power down event", | |
5bc465e4 | 518 | .mhandler.cmd = hmp_system_powerdown, |
d7f9b689 LC |
519 | }, |
520 | ||
2313086a BS |
521 | STEXI |
522 | @item system_powerdown | |
70fcbbe7 | 523 | @findex system_powerdown |
2313086a BS |
524 | |
525 | Power down the system (if supported). | |
526 | ETEXI | |
527 | ||
d7f9b689 LC |
528 | { |
529 | .name = "sum", | |
530 | .args_type = "start:i,size:i", | |
d7f9b689 LC |
531 | .params = "addr size", |
532 | .help = "compute the checksum of a memory region", | |
af4ce882 | 533 | .mhandler.cmd = do_sum, |
d7f9b689 LC |
534 | }, |
535 | ||
2313086a BS |
536 | STEXI |
537 | @item sum @var{addr} @var{size} | |
70fcbbe7 | 538 | @findex sum |
2313086a BS |
539 | |
540 | Compute the checksum of a memory region. | |
541 | ETEXI | |
542 | ||
d7f9b689 LC |
543 | { |
544 | .name = "usb_add", | |
545 | .args_type = "devname:s", | |
d7f9b689 LC |
546 | .params = "device", |
547 | .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')", | |
af4ce882 | 548 | .mhandler.cmd = do_usb_add, |
d7f9b689 LC |
549 | }, |
550 | ||
2313086a BS |
551 | STEXI |
552 | @item usb_add @var{devname} | |
70fcbbe7 | 553 | @findex usb_add |
2313086a BS |
554 | |
555 | Add the USB device @var{devname}. For details of available devices see | |
556 | @ref{usb_devices} | |
557 | ETEXI | |
558 | ||
d7f9b689 LC |
559 | { |
560 | .name = "usb_del", | |
561 | .args_type = "devname:s", | |
d7f9b689 LC |
562 | .params = "device", |
563 | .help = "remove USB device 'bus.addr'", | |
af4ce882 | 564 | .mhandler.cmd = do_usb_del, |
d7f9b689 LC |
565 | }, |
566 | ||
2313086a BS |
567 | STEXI |
568 | @item usb_del @var{devname} | |
70fcbbe7 | 569 | @findex usb_del |
2313086a BS |
570 | |
571 | Remove the USB device @var{devname} from the QEMU virtual USB | |
572 | hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor | |
573 | command @code{info usb} to see the devices you can remove. | |
574 | ETEXI | |
575 | ||
d7f9b689 LC |
576 | { |
577 | .name = "device_add", | |
c7e4e8ce MA |
578 | .args_type = "device:O", |
579 | .params = "driver[,prop=value][,...]", | |
d7f9b689 | 580 | .help = "add device, like -device on the command line", |
8bc27249 MA |
581 | .user_print = monitor_user_noop, |
582 | .mhandler.cmd_new = do_device_add, | |
d7f9b689 LC |
583 | }, |
584 | ||
3418bd25 GH |
585 | STEXI |
586 | @item device_add @var{config} | |
70fcbbe7 | 587 | @findex device_add |
3418bd25 GH |
588 | |
589 | Add device. | |
590 | ETEXI | |
591 | ||
d7f9b689 LC |
592 | { |
593 | .name = "device_del", | |
594 | .args_type = "id:s", | |
d7f9b689 LC |
595 | .params = "device", |
596 | .help = "remove device", | |
17a38eaa MA |
597 | .user_print = monitor_user_noop, |
598 | .mhandler.cmd_new = do_device_del, | |
d7f9b689 LC |
599 | }, |
600 | ||
3418bd25 GH |
601 | STEXI |
602 | @item device_del @var{id} | |
70fcbbe7 | 603 | @findex device_del |
3418bd25 GH |
604 | |
605 | Remove device @var{id}. | |
606 | ETEXI | |
607 | ||
d7f9b689 LC |
608 | { |
609 | .name = "cpu", | |
610 | .args_type = "index:i", | |
d7f9b689 LC |
611 | .params = "index", |
612 | .help = "set the default CPU", | |
755f1968 | 613 | .mhandler.cmd = hmp_cpu, |
d7f9b689 | 614 | }, |
3418bd25 | 615 | |
2313086a | 616 | STEXI |
c427ea9c MA |
617 | @item cpu @var{index} |
618 | @findex cpu | |
2313086a BS |
619 | Set the default CPU. |
620 | ETEXI | |
621 | ||
d7f9b689 LC |
622 | { |
623 | .name = "mouse_move", | |
624 | .args_type = "dx_str:s,dy_str:s,dz_str:s?", | |
d7f9b689 LC |
625 | .params = "dx dy [dz]", |
626 | .help = "send mouse move events", | |
af4ce882 | 627 | .mhandler.cmd = do_mouse_move, |
d7f9b689 LC |
628 | }, |
629 | ||
2313086a BS |
630 | STEXI |
631 | @item mouse_move @var{dx} @var{dy} [@var{dz}] | |
70fcbbe7 | 632 | @findex mouse_move |
2313086a BS |
633 | Move the active mouse to the specified coordinates @var{dx} @var{dy} |
634 | with optional scroll axis @var{dz}. | |
635 | ETEXI | |
636 | ||
d7f9b689 LC |
637 | { |
638 | .name = "mouse_button", | |
639 | .args_type = "button_state:i", | |
d7f9b689 LC |
640 | .params = "state", |
641 | .help = "change mouse button state (1=L, 2=M, 4=R)", | |
af4ce882 | 642 | .mhandler.cmd = do_mouse_button, |
d7f9b689 LC |
643 | }, |
644 | ||
2313086a BS |
645 | STEXI |
646 | @item mouse_button @var{val} | |
70fcbbe7 | 647 | @findex mouse_button |
2313086a BS |
648 | Change the active mouse button state @var{val} (1=L, 2=M, 4=R). |
649 | ETEXI | |
650 | ||
d7f9b689 LC |
651 | { |
652 | .name = "mouse_set", | |
653 | .args_type = "index:i", | |
d7f9b689 LC |
654 | .params = "index", |
655 | .help = "set which mouse device receives events", | |
af4ce882 | 656 | .mhandler.cmd = do_mouse_set, |
d7f9b689 LC |
657 | }, |
658 | ||
2313086a BS |
659 | STEXI |
660 | @item mouse_set @var{index} | |
70fcbbe7 | 661 | @findex mouse_set |
2313086a BS |
662 | Set which mouse device receives events at given @var{index}, index |
663 | can be obtained with | |
664 | @example | |
665 | info mice | |
666 | @end example | |
667 | ETEXI | |
668 | ||
669 | #ifdef HAS_AUDIO | |
d7f9b689 LC |
670 | { |
671 | .name = "wavcapture", | |
672 | .args_type = "path:F,freq:i?,bits:i?,nchannels:i?", | |
d7f9b689 LC |
673 | .params = "path [frequency [bits [channels]]]", |
674 | .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)", | |
af4ce882 | 675 | .mhandler.cmd = do_wav_capture, |
d7f9b689 | 676 | }, |
2313086a BS |
677 | #endif |
678 | STEXI | |
679 | @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]] | |
70fcbbe7 | 680 | @findex wavcapture |
2313086a BS |
681 | Capture audio into @var{filename}. Using sample rate @var{frequency} |
682 | bits per sample @var{bits} and number of channels @var{channels}. | |
683 | ||
684 | Defaults: | |
685 | @itemize @minus | |
686 | @item Sample rate = 44100 Hz - CD quality | |
687 | @item Bits = 16 | |
688 | @item Number of channels = 2 - Stereo | |
689 | @end itemize | |
690 | ETEXI | |
691 | ||
692 | #ifdef HAS_AUDIO | |
d7f9b689 LC |
693 | { |
694 | .name = "stopcapture", | |
695 | .args_type = "n:i", | |
d7f9b689 LC |
696 | .params = "capture index", |
697 | .help = "stop capture", | |
af4ce882 | 698 | .mhandler.cmd = do_stop_capture, |
d7f9b689 | 699 | }, |
2313086a BS |
700 | #endif |
701 | STEXI | |
702 | @item stopcapture @var{index} | |
70fcbbe7 | 703 | @findex stopcapture |
2313086a BS |
704 | Stop capture with a given @var{index}, index can be obtained with |
705 | @example | |
706 | info capture | |
707 | @end example | |
708 | ETEXI | |
709 | ||
d7f9b689 LC |
710 | { |
711 | .name = "memsave", | |
712 | .args_type = "val:l,size:i,filename:s", | |
d7f9b689 LC |
713 | .params = "addr size file", |
714 | .help = "save to disk virtual memory dump starting at 'addr' of size 'size'", | |
0cfd6a9a | 715 | .mhandler.cmd = hmp_memsave, |
d7f9b689 LC |
716 | }, |
717 | ||
2313086a BS |
718 | STEXI |
719 | @item memsave @var{addr} @var{size} @var{file} | |
70fcbbe7 | 720 | @findex memsave |
2313086a BS |
721 | save to disk virtual memory dump starting at @var{addr} of size @var{size}. |
722 | ETEXI | |
723 | ||
d7f9b689 LC |
724 | { |
725 | .name = "pmemsave", | |
726 | .args_type = "val:l,size:i,filename:s", | |
d7f9b689 LC |
727 | .params = "addr size file", |
728 | .help = "save to disk physical memory dump starting at 'addr' of size 'size'", | |
6d3962bf | 729 | .mhandler.cmd = hmp_pmemsave, |
d7f9b689 LC |
730 | }, |
731 | ||
2313086a BS |
732 | STEXI |
733 | @item pmemsave @var{addr} @var{size} @var{file} | |
70fcbbe7 | 734 | @findex pmemsave |
2313086a BS |
735 | save to disk physical memory dump starting at @var{addr} of size @var{size}. |
736 | ETEXI | |
737 | ||
d7f9b689 LC |
738 | { |
739 | .name = "boot_set", | |
740 | .args_type = "bootdevice:s", | |
d7f9b689 LC |
741 | .params = "bootdevice", |
742 | .help = "define new values for the boot device list", | |
af4ce882 | 743 | .mhandler.cmd = do_boot_set, |
d7f9b689 LC |
744 | }, |
745 | ||
2313086a BS |
746 | STEXI |
747 | @item boot_set @var{bootdevicelist} | |
70fcbbe7 | 748 | @findex boot_set |
2313086a BS |
749 | |
750 | Define new values for the boot device list. Those values will override | |
751 | the values specified on the command line through the @code{-boot} option. | |
752 | ||
753 | The values that can be specified here depend on the machine type, but are | |
754 | the same that can be specified in the @code{-boot} command line option. | |
755 | ETEXI | |
756 | ||
757 | #if defined(TARGET_I386) | |
d7f9b689 LC |
758 | { |
759 | .name = "nmi", | |
e9b4b432 LC |
760 | .args_type = "", |
761 | .params = "", | |
762 | .help = "inject an NMI on all guest's CPUs", | |
ab49ab5c | 763 | .mhandler.cmd = hmp_inject_nmi, |
d7f9b689 | 764 | }, |
2313086a BS |
765 | #endif |
766 | STEXI | |
767 | @item nmi @var{cpu} | |
70fcbbe7 | 768 | @findex nmi |
2313086a BS |
769 | Inject an NMI on the given CPU (x86 only). |
770 | ETEXI | |
771 | ||
d7f9b689 LC |
772 | { |
773 | .name = "migrate", | |
fbc3d96c | 774 | .args_type = "detach:-d,blk:-b,inc:-i,uri:s", |
775 | .params = "[-d] [-b] [-i] uri", | |
776 | .help = "migrate to URI (using -d to not wait for completion)" | |
777 | "\n\t\t\t -b for migration without shared storage with" | |
778 | " full copy of disk\n\t\t\t -i for migration without " | |
779 | "shared storage with incremental copy of disk " | |
780 | "(base image shared between src and destination)", | |
781 | .user_print = monitor_user_noop, | |
261394db | 782 | .mhandler.cmd_new = do_migrate, |
d7f9b689 LC |
783 | }, |
784 | ||
fbc3d96c | 785 | |
2313086a | 786 | STEXI |
fbc3d96c | 787 | @item migrate [-d] [-b] [-i] @var{uri} |
70fcbbe7 | 788 | @findex migrate |
2313086a | 789 | Migrate to @var{uri} (using -d to not wait for completion). |
fbc3d96c | 790 | -b for migration with full copy of disk |
791 | -i for migration with incremental copy of disk (base image is shared) | |
2313086a BS |
792 | ETEXI |
793 | ||
d7f9b689 LC |
794 | { |
795 | .name = "migrate_cancel", | |
796 | .args_type = "", | |
d7f9b689 LC |
797 | .params = "", |
798 | .help = "cancel the current VM migration", | |
6cdedb07 | 799 | .mhandler.cmd = hmp_migrate_cancel, |
d7f9b689 LC |
800 | }, |
801 | ||
2313086a BS |
802 | STEXI |
803 | @item migrate_cancel | |
70fcbbe7 | 804 | @findex migrate_cancel |
2313086a BS |
805 | Cancel the current VM migration. |
806 | ETEXI | |
807 | ||
d7f9b689 LC |
808 | { |
809 | .name = "migrate_set_speed", | |
ed3d4a80 | 810 | .args_type = "value:o", |
d7f9b689 | 811 | .params = "value", |
ed3d4a80 JS |
812 | .help = "set maximum speed (in bytes) for migrations. " |
813 | "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T", | |
3dc85383 | 814 | .mhandler.cmd = hmp_migrate_set_speed, |
d7f9b689 LC |
815 | }, |
816 | ||
2313086a BS |
817 | STEXI |
818 | @item migrate_set_speed @var{value} | |
70fcbbe7 | 819 | @findex migrate_set_speed |
2313086a | 820 | Set maximum speed to @var{value} (in bytes) for migrations. |
2ea42952 GC |
821 | ETEXI |
822 | ||
d7f9b689 LC |
823 | { |
824 | .name = "migrate_set_downtime", | |
b0fbf7d3 | 825 | .args_type = "value:T", |
d7f9b689 LC |
826 | .params = "value", |
827 | .help = "set maximum tolerated downtime (in seconds) for migrations", | |
4f0a993b | 828 | .mhandler.cmd = hmp_migrate_set_downtime, |
d7f9b689 | 829 | }, |
2ea42952 GC |
830 | |
831 | STEXI | |
832 | @item migrate_set_downtime @var{second} | |
70fcbbe7 | 833 | @findex migrate_set_downtime |
2ea42952 | 834 | Set maximum tolerated downtime (in seconds) for migration. |
f8882568 JS |
835 | ETEXI |
836 | ||
837 | { | |
2ea720db JS |
838 | .name = "client_migrate_info", |
839 | .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?", | |
840 | .params = "protocol hostname port tls-port cert-subject", | |
841 | .help = "send migration info to spice/vnc client", | |
842 | .user_print = monitor_user_noop, | |
edc5cb1a YH |
843 | .mhandler.cmd_async = client_migrate_info, |
844 | .flags = MONITOR_CMD_ASYNC, | |
f8882568 JS |
845 | }, |
846 | ||
e866e239 GH |
847 | STEXI |
848 | @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject} | |
849 | @findex client_migrate_info | |
850 | Set the spice/vnc connection info for the migration target. The spice/vnc | |
851 | server will ask the spice/vnc client to automatically reconnect using the | |
852 | new parameters (if specified) once the vm migration finished successfully. | |
853 | ETEXI | |
854 | ||
855 | { | |
2ea720db | 856 | .name = "snapshot_blkdev", |
d967b2f1 | 857 | .args_type = "device:B,snapshot-file:s?,format:s?", |
2ea720db JS |
858 | .params = "device [new-image-file] [format]", |
859 | .help = "initiates a live snapshot\n\t\t\t" | |
860 | "of device. If a new image file is specified, the\n\t\t\t" | |
861 | "new image file will become the new root image.\n\t\t\t" | |
862 | "If format is specified, the snapshot file will\n\t\t\t" | |
863 | "be created in that format. Otherwise the\n\t\t\t" | |
864 | "snapshot will be internal! (currently unsupported)", | |
6106e249 | 865 | .mhandler.cmd = hmp_snapshot_blkdev, |
e866e239 GH |
866 | }, |
867 | ||
f8882568 JS |
868 | STEXI |
869 | @item snapshot_blkdev | |
870 | @findex snapshot_blkdev | |
871 | Snapshot device, using snapshot file as target if provided | |
2313086a BS |
872 | ETEXI |
873 | ||
d7f9b689 LC |
874 | { |
875 | .name = "drive_add", | |
876 | .args_type = "pci_addr:s,opts:s", | |
d7f9b689 LC |
877 | .params = "[[<domain>:]<bus>:]<slot>\n" |
878 | "[file=file][,if=type][,bus=n]\n" | |
fb0490f6 | 879 | "[,unit=m][,media=d][,index=i]\n" |
d7f9b689 | 880 | "[,cyls=c,heads=h,secs=s[,trans=t]]\n" |
fb0490f6 SH |
881 | "[,snapshot=on|off][,cache=on|off]\n" |
882 | "[,readonly=on|off][,copy-on-read=on|off]", | |
d7f9b689 | 883 | .help = "add drive to PCI storage controller", |
af4ce882 | 884 | .mhandler.cmd = drive_hot_add, |
d7f9b689 | 885 | }, |
d7f9b689 | 886 | |
2313086a BS |
887 | STEXI |
888 | @item drive_add | |
70fcbbe7 | 889 | @findex drive_add |
2313086a BS |
890 | Add drive to PCI storage controller. |
891 | ETEXI | |
892 | ||
893 | #if defined(TARGET_I386) | |
d7f9b689 LC |
894 | { |
895 | .name = "pci_add", | |
896 | .args_type = "pci_addr:s,type:s,opts:s?", | |
d7f9b689 LC |
897 | .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...", |
898 | .help = "hot-add PCI device", | |
6c6a58ae | 899 | .mhandler.cmd = pci_device_hot_add, |
d7f9b689 | 900 | }, |
2313086a | 901 | #endif |
d7f9b689 | 902 | |
2313086a BS |
903 | STEXI |
904 | @item pci_add | |
70fcbbe7 | 905 | @findex pci_add |
2313086a BS |
906 | Hot-add PCI device. |
907 | ETEXI | |
908 | ||
909 | #if defined(TARGET_I386) | |
d7f9b689 LC |
910 | { |
911 | .name = "pci_del", | |
912 | .args_type = "pci_addr:s", | |
d7f9b689 LC |
913 | .params = "[[<domain>:]<bus>:]<slot>", |
914 | .help = "hot remove PCI device", | |
b752daf0 | 915 | .mhandler.cmd = do_pci_device_hot_remove, |
d7f9b689 | 916 | }, |
2313086a | 917 | #endif |
d7f9b689 | 918 | |
2313086a BS |
919 | STEXI |
920 | @item pci_del | |
70fcbbe7 | 921 | @findex pci_del |
2313086a | 922 | Hot remove PCI device. |
2ae63bda IY |
923 | ETEXI |
924 | ||
925 | { | |
926 | .name = "pcie_aer_inject_error", | |
927 | .args_type = "advisory_non_fatal:-a,correctable:-c," | |
928 | "id:s,error_status:s," | |
929 | "header0:i?,header1:i?,header2:i?,header3:i?," | |
930 | "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?", | |
931 | .params = "[-a] [-c] id " | |
932 | "<error_status> [<tlp header> [<tlp header prefix>]]", | |
933 | .help = "inject pcie aer error\n\t\t\t" | |
934 | " -a for advisory non fatal error\n\t\t\t" | |
935 | " -c for correctable error\n\t\t\t" | |
936 | "<id> = qdev device id\n\t\t\t" | |
937 | "<error_status> = error string or 32bit\n\t\t\t" | |
938 | "<tlb header> = 32bit x 4\n\t\t\t" | |
939 | "<tlb header prefix> = 32bit x 4", | |
940 | .user_print = pcie_aer_inject_error_print, | |
1f3392b7 | 941 | .mhandler.cmd_new = do_pcie_aer_inject_error, |
2ae63bda IY |
942 | }, |
943 | ||
944 | STEXI | |
945 | @item pcie_aer_inject_error | |
946 | @findex pcie_aer_inject_error | |
947 | Inject PCIe AER error | |
2313086a BS |
948 | ETEXI |
949 | ||
d7f9b689 LC |
950 | { |
951 | .name = "host_net_add", | |
952 | .args_type = "device:s,opts:s?", | |
d7f9b689 LC |
953 | .params = "tap|user|socket|vde|dump [options]", |
954 | .help = "add host VLAN client", | |
af4ce882 | 955 | .mhandler.cmd = net_host_device_add, |
d7f9b689 LC |
956 | }, |
957 | ||
2313086a BS |
958 | STEXI |
959 | @item host_net_add | |
70fcbbe7 | 960 | @findex host_net_add |
2313086a BS |
961 | Add host VLAN client. |
962 | ETEXI | |
963 | ||
d7f9b689 LC |
964 | { |
965 | .name = "host_net_remove", | |
966 | .args_type = "vlan_id:i,device:s", | |
d7f9b689 LC |
967 | .params = "vlan_id name", |
968 | .help = "remove host VLAN client", | |
af4ce882 | 969 | .mhandler.cmd = net_host_device_remove, |
d7f9b689 LC |
970 | }, |
971 | ||
2313086a BS |
972 | STEXI |
973 | @item host_net_remove | |
70fcbbe7 | 974 | @findex host_net_remove |
2313086a | 975 | Remove host VLAN client. |
ae82d324 MA |
976 | ETEXI |
977 | ||
978 | { | |
979 | .name = "netdev_add", | |
980 | .args_type = "netdev:O", | |
981 | .params = "[user|tap|socket],id=str[,prop=value][,...]", | |
982 | .help = "add host network device", | |
983 | .user_print = monitor_user_noop, | |
984 | .mhandler.cmd_new = do_netdev_add, | |
985 | }, | |
986 | ||
987 | STEXI | |
988 | @item netdev_add | |
989 | @findex netdev_add | |
990 | Add host network device. | |
991 | ETEXI | |
992 | ||
993 | { | |
994 | .name = "netdev_del", | |
995 | .args_type = "id:s", | |
996 | .params = "id", | |
997 | .help = "remove host network device", | |
998 | .user_print = monitor_user_noop, | |
999 | .mhandler.cmd_new = do_netdev_del, | |
1000 | }, | |
1001 | ||
1002 | STEXI | |
1003 | @item netdev_del | |
1004 | @findex netdev_del | |
1005 | Remove host network device. | |
2313086a BS |
1006 | ETEXI |
1007 | ||
1008 | #ifdef CONFIG_SLIRP | |
d7f9b689 LC |
1009 | { |
1010 | .name = "hostfwd_add", | |
1011 | .args_type = "arg1:s,arg2:s?,arg3:s?", | |
d7f9b689 LC |
1012 | .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport", |
1013 | .help = "redirect TCP or UDP connections from host to guest (requires -net user)", | |
af4ce882 | 1014 | .mhandler.cmd = net_slirp_hostfwd_add, |
d7f9b689 | 1015 | }, |
21413d68 MA |
1016 | #endif |
1017 | STEXI | |
1018 | @item hostfwd_add | |
1019 | @findex hostfwd_add | |
1020 | Redirect TCP or UDP connections from host to guest (requires -net user). | |
1021 | ETEXI | |
d7f9b689 | 1022 | |
21413d68 | 1023 | #ifdef CONFIG_SLIRP |
d7f9b689 LC |
1024 | { |
1025 | .name = "hostfwd_remove", | |
1026 | .args_type = "arg1:s,arg2:s?,arg3:s?", | |
d7f9b689 LC |
1027 | .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport", |
1028 | .help = "remove host-to-guest TCP or UDP redirection", | |
af4ce882 | 1029 | .mhandler.cmd = net_slirp_hostfwd_remove, |
d7f9b689 LC |
1030 | }, |
1031 | ||
2313086a BS |
1032 | #endif |
1033 | STEXI | |
21413d68 MA |
1034 | @item hostfwd_remove |
1035 | @findex hostfwd_remove | |
1036 | Remove host-to-guest TCP or UDP redirection. | |
2313086a BS |
1037 | ETEXI |
1038 | ||
d7f9b689 LC |
1039 | { |
1040 | .name = "balloon", | |
3b0bd6ec | 1041 | .args_type = "value:M", |
d7f9b689 | 1042 | .params = "target", |
3c05613a | 1043 | .help = "request VM to change its memory allocation (in MB)", |
d72f3264 | 1044 | .mhandler.cmd = hmp_balloon, |
d7f9b689 LC |
1045 | }, |
1046 | ||
2313086a BS |
1047 | STEXI |
1048 | @item balloon @var{value} | |
70fcbbe7 | 1049 | @findex balloon |
2313086a BS |
1050 | Request VM to change its memory allocation to @var{value} (in MB). |
1051 | ETEXI | |
1052 | ||
d7f9b689 LC |
1053 | { |
1054 | .name = "set_link", | |
c9b26a4c MA |
1055 | .args_type = "name:s,up:b", |
1056 | .params = "name on|off", | |
d7f9b689 | 1057 | .help = "change the link status of a network adapter", |
4b37156c | 1058 | .mhandler.cmd = hmp_set_link, |
d7f9b689 LC |
1059 | }, |
1060 | ||
2313086a | 1061 | STEXI |
c9b26a4c | 1062 | @item set_link @var{name} [on|off] |
70fcbbe7 | 1063 | @findex set_link |
c9b26a4c | 1064 | Switch link @var{name} on (i.e. up) or off (i.e. down). |
2313086a BS |
1065 | ETEXI |
1066 | ||
d7f9b689 LC |
1067 | { |
1068 | .name = "watchdog_action", | |
1069 | .args_type = "action:s", | |
d7f9b689 LC |
1070 | .params = "[reset|shutdown|poweroff|pause|debug|none]", |
1071 | .help = "change watchdog action", | |
af4ce882 | 1072 | .mhandler.cmd = do_watchdog_action, |
d7f9b689 LC |
1073 | }, |
1074 | ||
2313086a BS |
1075 | STEXI |
1076 | @item watchdog_action | |
70fcbbe7 | 1077 | @findex watchdog_action |
2313086a BS |
1078 | Change watchdog action. |
1079 | ETEXI | |
1080 | ||
d7f9b689 LC |
1081 | { |
1082 | .name = "acl_show", | |
1083 | .args_type = "aclname:s", | |
d7f9b689 LC |
1084 | .params = "aclname", |
1085 | .help = "list rules in the access control list", | |
af4ce882 | 1086 | .mhandler.cmd = do_acl_show, |
d7f9b689 LC |
1087 | }, |
1088 | ||
2313086a | 1089 | STEXI |
15dfcd45 | 1090 | @item acl_show @var{aclname} |
70fcbbe7 | 1091 | @findex acl_show |
15dfcd45 JK |
1092 | List all the matching rules in the access control list, and the default |
1093 | policy. There are currently two named access control lists, | |
1094 | @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client | |
1095 | certificate distinguished name, and SASL username respectively. | |
1096 | ETEXI | |
2313086a | 1097 | |
d7f9b689 LC |
1098 | { |
1099 | .name = "acl_policy", | |
1100 | .args_type = "aclname:s,policy:s", | |
d7f9b689 LC |
1101 | .params = "aclname allow|deny", |
1102 | .help = "set default access control list policy", | |
af4ce882 | 1103 | .mhandler.cmd = do_acl_policy, |
d7f9b689 LC |
1104 | }, |
1105 | ||
15dfcd45 | 1106 | STEXI |
cbbfacc6 | 1107 | @item acl_policy @var{aclname} @code{allow|deny} |
70fcbbe7 | 1108 | @findex acl_policy |
15dfcd45 | 1109 | Set the default access control list policy, used in the event that |
2313086a | 1110 | none of the explicit rules match. The default policy at startup is |
15dfcd45 JK |
1111 | always @code{deny}. |
1112 | ETEXI | |
1113 | ||
d7f9b689 LC |
1114 | { |
1115 | .name = "acl_add", | |
1116 | .args_type = "aclname:s,match:s,policy:s,index:i?", | |
d7f9b689 LC |
1117 | .params = "aclname match allow|deny [index]", |
1118 | .help = "add a match rule to the access control list", | |
af4ce882 | 1119 | .mhandler.cmd = do_acl_add, |
d7f9b689 LC |
1120 | }, |
1121 | ||
15dfcd45 | 1122 | STEXI |
0e4aec98 MA |
1123 | @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}] |
1124 | @findex acl_add | |
15dfcd45 JK |
1125 | Add a match rule to the access control list, allowing or denying access. |
1126 | The match will normally be an exact username or x509 distinguished name, | |
1127 | but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to | |
1128 | allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will | |
2313086a | 1129 | normally be appended to the end of the ACL, but can be inserted |
15dfcd45 JK |
1130 | earlier in the list if the optional @var{index} parameter is supplied. |
1131 | ETEXI | |
1132 | ||
d7f9b689 LC |
1133 | { |
1134 | .name = "acl_remove", | |
1135 | .args_type = "aclname:s,match:s", | |
d7f9b689 LC |
1136 | .params = "aclname match", |
1137 | .help = "remove a match rule from the access control list", | |
af4ce882 | 1138 | .mhandler.cmd = do_acl_remove, |
d7f9b689 LC |
1139 | }, |
1140 | ||
15dfcd45 JK |
1141 | STEXI |
1142 | @item acl_remove @var{aclname} @var{match} | |
70fcbbe7 | 1143 | @findex acl_remove |
15dfcd45 JK |
1144 | Remove the specified match rule from the access control list. |
1145 | ETEXI | |
1146 | ||
d7f9b689 LC |
1147 | { |
1148 | .name = "acl_reset", | |
1149 | .args_type = "aclname:s", | |
d7f9b689 LC |
1150 | .params = "aclname", |
1151 | .help = "reset the access control list", | |
af4ce882 | 1152 | .mhandler.cmd = do_acl_reset, |
d7f9b689 LC |
1153 | }, |
1154 | ||
15dfcd45 | 1155 | STEXI |
0e4aec98 MA |
1156 | @item acl_reset @var{aclname} |
1157 | @findex acl_reset | |
15dfcd45 | 1158 | Remove all matches from the access control list, and set the default |
2313086a | 1159 | policy back to @code{deny}. |
2313086a BS |
1160 | ETEXI |
1161 | ||
79c4f6b0 | 1162 | #if defined(TARGET_I386) |
d7f9b689 LC |
1163 | |
1164 | { | |
1165 | .name = "mce", | |
31ce5e0c JD |
1166 | .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l", |
1167 | .params = "[-b] cpu bank status mcgstatus addr misc", | |
1168 | .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]", | |
af4ce882 | 1169 | .mhandler.cmd = do_inject_mce, |
d7f9b689 LC |
1170 | }, |
1171 | ||
79c4f6b0 HY |
1172 | #endif |
1173 | STEXI | |
1174 | @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc} | |
70fcbbe7 | 1175 | @findex mce (x86) |
79c4f6b0 | 1176 | Inject an MCE on the given CPU (x86 only). |
f07918fd MM |
1177 | ETEXI |
1178 | ||
d7f9b689 LC |
1179 | { |
1180 | .name = "getfd", | |
1181 | .args_type = "fdname:s", | |
d7f9b689 LC |
1182 | .params = "getfd name", |
1183 | .help = "receive a file descriptor via SCM rights and assign it a name", | |
f0d6000a | 1184 | .user_print = monitor_user_noop, |
261394db | 1185 | .mhandler.cmd_new = do_getfd, |
d7f9b689 LC |
1186 | }, |
1187 | ||
f07918fd MM |
1188 | STEXI |
1189 | @item getfd @var{fdname} | |
70fcbbe7 | 1190 | @findex getfd |
f07918fd MM |
1191 | If a file descriptor is passed alongside this command using the SCM_RIGHTS |
1192 | mechanism on unix sockets, it is stored using the name @var{fdname} for | |
1193 | later use by other monitor commands. | |
1194 | ETEXI | |
1195 | ||
d7f9b689 LC |
1196 | { |
1197 | .name = "closefd", | |
1198 | .args_type = "fdname:s", | |
d7f9b689 LC |
1199 | .params = "closefd name", |
1200 | .help = "close a file descriptor previously passed via SCM rights", | |
18f3a515 | 1201 | .user_print = monitor_user_noop, |
261394db | 1202 | .mhandler.cmd_new = do_closefd, |
d7f9b689 LC |
1203 | }, |
1204 | ||
f07918fd MM |
1205 | STEXI |
1206 | @item closefd @var{fdname} | |
70fcbbe7 | 1207 | @findex closefd |
f07918fd MM |
1208 | Close the file descriptor previously assigned to @var{fdname} using the |
1209 | @code{getfd} command. This is only needed if the file descriptor was never | |
1210 | used by another monitor command. | |
a3a55a2e LC |
1211 | ETEXI |
1212 | ||
1213 | { | |
1214 | .name = "block_passwd", | |
1215 | .args_type = "device:B,password:s", | |
1216 | .params = "block_passwd device password", | |
1217 | .help = "set the password of encrypted block devices", | |
a4dea8a9 | 1218 | .mhandler.cmd = hmp_block_passwd, |
a3a55a2e LC |
1219 | }, |
1220 | ||
727f005e ZYW |
1221 | STEXI |
1222 | @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr} | |
1223 | @findex block_set_io_throttle | |
1224 | Change I/O throttle limits for a block drive to @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr} | |
1225 | ETEXI | |
1226 | ||
1227 | { | |
1228 | .name = "block_set_io_throttle", | |
1229 | .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l", | |
1230 | .params = "device bps bps_rd bps_wr iops iops_rd iops_wr", | |
1231 | .help = "change I/O throttle limits for a block drive", | |
80047da5 | 1232 | .mhandler.cmd = hmp_block_set_io_throttle, |
727f005e ZYW |
1233 | }, |
1234 | ||
a3a55a2e LC |
1235 | STEXI |
1236 | @item block_passwd @var{device} @var{password} | |
70fcbbe7 | 1237 | @findex block_passwd |
a3a55a2e | 1238 | Set the encrypted device @var{device} password to @var{password} |
7572150c GH |
1239 | ETEXI |
1240 | ||
1241 | { | |
1242 | .name = "set_password", | |
1243 | .args_type = "protocol:s,password:s,connected:s?", | |
1244 | .params = "protocol password action-if-connected", | |
1245 | .help = "set spice/vnc password", | |
fbf796fd | 1246 | .mhandler.cmd = hmp_set_password, |
7572150c GH |
1247 | }, |
1248 | ||
1249 | STEXI | |
1250 | @item set_password [ vnc | spice ] password [ action-if-connected ] | |
1251 | @findex set_password | |
1252 | ||
1253 | Change spice/vnc password. Use zero to make the password stay valid | |
1254 | forever. @var{action-if-connected} specifies what should happen in | |
1255 | case a connection is established: @var{fail} makes the password change | |
1256 | fail. @var{disconnect} changes the password and disconnects the | |
1257 | client. @var{keep} changes the password and keeps the connection up. | |
1258 | @var{keep} is the default. | |
1259 | ETEXI | |
1260 | ||
1261 | { | |
1262 | .name = "expire_password", | |
1263 | .args_type = "protocol:s,time:s", | |
1264 | .params = "protocol time", | |
1265 | .help = "set spice/vnc password expire-time", | |
9ad5372d | 1266 | .mhandler.cmd = hmp_expire_password, |
7572150c GH |
1267 | }, |
1268 | ||
1269 | STEXI | |
1270 | @item expire_password [ vnc | spice ] expire-time | |
1271 | @findex expire_password | |
1272 | ||
1273 | Specify when a password for spice/vnc becomes | |
1274 | invalid. @var{expire-time} accepts: | |
1275 | ||
1276 | @table @var | |
1277 | @item now | |
1278 | Invalidate password instantly. | |
1279 | ||
1280 | @item never | |
1281 | Password stays valid forever. | |
1282 | ||
1283 | @item +nsec | |
1284 | Password stays valid for @var{nsec} seconds starting now. | |
1285 | ||
1286 | @item nsec | |
1287 | Password is invalidated at the given time. @var{nsec} are the seconds | |
1288 | passed since 1970, i.e. unix epoch. | |
1289 | ||
1290 | @end table | |
4a7e1190 | 1291 | ETEXI |
b40292e7 | 1292 | |
33572ece JK |
1293 | { |
1294 | .name = "info", | |
1295 | .args_type = "item:s?", | |
1296 | .params = "[subcommand]", | |
1297 | .help = "show various information about the system state", | |
1162daa6 | 1298 | .mhandler.cmd = do_info, |
33572ece JK |
1299 | }, |
1300 | ||
1301 | STEXI | |
1302 | @item info @var{subcommand} | |
1303 | @findex info | |
1304 | Show various information about the system state. | |
1305 | ||
1306 | @table @option | |
1307 | @item info version | |
1308 | show the version of QEMU | |
33572ece JK |
1309 | @item info network |
1310 | show the various VLANs and the associated devices | |
1311 | @item info chardev | |
1312 | show the character devices | |
1313 | @item info block | |
1314 | show the block devices | |
1315 | @item info blockstats | |
1316 | show block device statistics | |
1317 | @item info registers | |
1318 | show the cpu registers | |
1319 | @item info cpus | |
1320 | show infos for each CPU | |
1321 | @item info history | |
1322 | show the command line history | |
1323 | @item info irq | |
1324 | show the interrupts statistics (if available) | |
1325 | @item info pic | |
1326 | show i8259 (PIC) state | |
1327 | @item info pci | |
1328 | show emulated PCI device info | |
1329 | @item info tlb | |
bebabbc7 | 1330 | show virtual to physical memory mappings (i386, SH4, SPARC, and PPC only) |
33572ece JK |
1331 | @item info mem |
1332 | show the active virtual memory mappings (i386 only) | |
33572ece JK |
1333 | @item info jit |
1334 | show dynamic compiler info | |
33572ece JK |
1335 | @item info numa |
1336 | show NUMA information | |
b40292e7 JK |
1337 | @item info kvm |
1338 | show KVM information | |
33572ece JK |
1339 | @item info usb |
1340 | show USB devices plugged on the virtual USB hub | |
1341 | @item info usbhost | |
1342 | show all USB host devices | |
1343 | @item info profile | |
1344 | show profiling information | |
1345 | @item info capture | |
1346 | show information about active capturing | |
1347 | @item info snapshots | |
1348 | show list of VM snapshots | |
1349 | @item info status | |
1350 | show the current VM status (running|paused) | |
1351 | @item info pcmcia | |
1352 | show guest PCMCIA status | |
1353 | @item info mice | |
1354 | show which guest mouse is receiving events | |
1355 | @item info vnc | |
1356 | show the vnc server status | |
1357 | @item info name | |
1358 | show the current VM name | |
1359 | @item info uuid | |
1360 | show the current VM UUID | |
1361 | @item info cpustats | |
1362 | show CPU statistics | |
1363 | @item info usernet | |
1364 | show user network stack connection states | |
1365 | @item info migrate | |
1366 | show migration status | |
1367 | @item info balloon | |
1368 | show balloon information | |
1369 | @item info qtree | |
1370 | show device tree | |
1371 | @item info qdm | |
1372 | show qdev device model list | |
1373 | @item info roms | |
1374 | show roms | |
1375 | @end table | |
1376 | ETEXI | |
1377 | ||
6d8a764e | 1378 | #ifdef CONFIG_TRACE_SIMPLE |
22890ab5 PS |
1379 | STEXI |
1380 | @item info trace | |
1381 | show contents of trace buffer | |
31965ae2 L |
1382 | ETEXI |
1383 | #endif | |
1384 | ||
1385 | STEXI | |
22890ab5 PS |
1386 | @item info trace-events |
1387 | show available trace events and their state | |
1388 | ETEXI | |
22890ab5 | 1389 | |
2313086a BS |
1390 | STEXI |
1391 | @end table | |
1392 | ETEXI |