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