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