blob: 0cf592bcf8f0213f5c9a21d1d2d6a4d622ff5c1d [file] [log] [blame]
Blue Swirl23130862009-06-06 08:22:04 +00001HXCOMM Use DEFHEADING() to define headings in both help text and texi
2HXCOMM Text between STEXI and ETEXI are copied to texi version and
3HXCOMM discarded from C version
4HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5HXCOMM monitor commands
6HXCOMM HXCOMM can be used for comments, discarded from both texi and C
7
8STEXI
9@table @option
10ETEXI
11
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030012 {
13 .name = "help|?",
Wenchao Xia129be002013-08-27 20:38:26 +080014 .args_type = "name:S?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030015 .params = "[cmd]",
16 .help = "show the help",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -030017 .mhandler.cmd = do_help_cmd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030018 },
19
Blue Swirl23130862009-06-06 08:22:04 +000020STEXI
21@item help or ? [@var{cmd}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +010022@findex help
Blue Swirl23130862009-06-06 08:22:04 +000023Show the help for all commands or just for command @var{cmd}.
24ETEXI
25
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030026 {
27 .name = "commit",
28 .args_type = "device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030029 .params = "device|all",
30 .help = "commit changes to the disk images (if -snapshot is used) or backing files",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +010031 .mhandler.cmd = hmp_commit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030032 },
33
Blue Swirl23130862009-06-06 08:22:04 +000034STEXI
35@item commit
Stefan Weil70fcbbe2010-02-05 23:52:04 +010036@findex commit
Blue Swirl23130862009-06-06 08:22:04 +000037Commit changes to the disk images (if -snapshot is used) or backing files.
Jeff Cody37222902014-01-24 09:02:37 -050038If the backing file is smaller than the snapshot, then the backing file will be
39resized to be the same size as the snapshot. If the snapshot is smaller than
40the backing file, the backing file will not be truncated. If you want the
41backing file to match the size of the smaller snapshot, you can safely truncate
42it yourself once the commit operation successfully completes.
Blue Swirl23130862009-06-06 08:22:04 +000043ETEXI
44
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030045 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030046 .name = "q|quit",
47 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030048 .params = "",
49 .help = "quit the emulator",
Luiz Capitulino7a7f3252011-09-15 14:20:28 -030050 .mhandler.cmd = hmp_quit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030051 },
52
Blue Swirl23130862009-06-06 08:22:04 +000053STEXI
54@item q or quit
Stefan Weil70fcbbe2010-02-05 23:52:04 +010055@findex quit
Blue Swirl23130862009-06-06 08:22:04 +000056Quit the emulator.
57ETEXI
58
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030059 {
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010060 .name = "block_resize",
61 .args_type = "device:B,size:o",
62 .params = "device size",
63 .help = "resize a block image",
Luiz Capitulino5e7caac2011-11-25 14:57:10 -020064 .mhandler.cmd = hmp_block_resize,
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010065 },
66
67STEXI
68@item block_resize
69@findex block_resize
70Resize a block image while a guest is running. Usually requires guest
71action to see the updated size. Resize to a lower size is supported,
72but should be used with extreme caution. Note that this command only
73resizes image files, it can not resize block devices like LVM volumes.
74ETEXI
75
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000076 {
77 .name = "block_stream",
Stefan Hajnoczic83c66c2012-04-25 16:51:03 +010078 .args_type = "device:B,speed:o?,base:s?",
79 .params = "device [speed [base]]",
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000080 .help = "copy data from a backing file into a block device",
81 .mhandler.cmd = hmp_block_stream,
82 },
83
84STEXI
85@item block_stream
86@findex block_stream
87Copy data from a backing file into a block device.
88ETEXI
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010089
90 {
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000091 .name = "block_job_set_speed",
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +010092 .args_type = "device:B,speed:o",
93 .params = "device speed",
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000094 .help = "set maximum speed for a background block operation",
95 .mhandler.cmd = hmp_block_job_set_speed,
96 },
97
98STEXI
Paolo Bonzini4451b792012-04-13 12:03:46 +020099@item block_job_set_speed
100@findex block_job_set_speed
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +0000101Set maximum speed for a background block operation.
102ETEXI
103
104 {
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000105 .name = "block_job_cancel",
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200106 .args_type = "force:-f,device:B",
107 .params = "[-f] device",
108 .help = "stop an active background block operation (use -f"
109 "\n\t\t\t if the operation is currently paused)",
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000110 .mhandler.cmd = hmp_block_job_cancel,
111 },
112
113STEXI
114@item block_job_cancel
115@findex block_job_cancel
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200116Stop an active background block operation (streaming, mirroring).
117ETEXI
118
119 {
120 .name = "block_job_complete",
121 .args_type = "device:B",
122 .params = "device",
123 .help = "stop an active background block operation",
124 .mhandler.cmd = hmp_block_job_complete,
125 },
126
127STEXI
128@item block_job_complete
129@findex block_job_complete
130Manually trigger completion of an active background block operation.
131For mirroring, this will switch the device to the destination path.
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000132ETEXI
133
134 {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200135 .name = "block_job_pause",
136 .args_type = "device:B",
137 .params = "device",
138 .help = "pause an active background block operation",
139 .mhandler.cmd = hmp_block_job_pause,
140 },
141
142STEXI
143@item block_job_pause
144@findex block_job_pause
145Pause an active block streaming operation.
146ETEXI
147
148 {
149 .name = "block_job_resume",
150 .args_type = "device:B",
151 .params = "device",
152 .help = "resume a paused background block operation",
153 .mhandler.cmd = hmp_block_job_resume,
154 },
155
156STEXI
157@item block_job_resume
158@findex block_job_resume
159Resume a paused block streaming operation.
160ETEXI
161
162 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300163 .name = "eject",
Luiz Capitulino78d714e2009-12-14 18:53:21 -0200164 .args_type = "force:-f,device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300165 .params = "[-f] device",
166 .help = "eject a removable medium (use -f to force it)",
Luiz Capitulinoc245b6a2011-12-07 16:02:36 -0200167 .mhandler.cmd = hmp_eject,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300168 },
169
Blue Swirl23130862009-06-06 08:22:04 +0000170STEXI
171@item eject [-f] @var{device}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100172@findex eject
Blue Swirl23130862009-06-06 08:22:04 +0000173Eject a removable medium (use -f to force it).
174ETEXI
175
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300176 {
Ryan Harper9063f812010-11-12 11:07:13 -0600177 .name = "drive_del",
Hani Benhabilesf7bdc412014-04-13 16:25:05 +0100178 .args_type = "id:B",
Ryan Harper9063f812010-11-12 11:07:13 -0600179 .params = "device",
180 .help = "remove host block device",
181 .user_print = monitor_user_noop,
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100182 .mhandler.cmd_new = hmp_drive_del,
Ryan Harper9063f812010-11-12 11:07:13 -0600183 },
184
185STEXI
186@item drive_del @var{device}
187@findex drive_del
188Remove host block device. The result is that guest generated IO is no longer
189submitted against the host device underlying the disk. Once a drive has
190been deleted, the QEMU Block layer returns -EIO which results in IO
191errors in the guest for applications that are reading/writing to the device.
Stefan Hajnoczi293c51a2013-06-05 10:33:14 +0200192These errors are always reported to the guest, regardless of the drive's error
193actions (drive options rerror, werror).
Ryan Harper9063f812010-11-12 11:07:13 -0600194ETEXI
195
196 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300197 .name = "change",
198 .args_type = "device:B,target:F,arg:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300199 .params = "device filename [format]",
200 .help = "change a removable medium, optional format",
Luiz Capitulino333a96e2011-12-08 11:13:50 -0200201 .mhandler.cmd = hmp_change,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300202 },
203
Blue Swirl23130862009-06-06 08:22:04 +0000204STEXI
205@item change @var{device} @var{setting}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100206@findex change
Blue Swirl23130862009-06-06 08:22:04 +0000207Change the configuration of a device.
208
209@table @option
210@item change @var{diskdevice} @var{filename} [@var{format}]
211Change the medium for a removable disk device to point to @var{filename}. eg
212
213@example
214(qemu) change ide1-cd0 /path/to/some.iso
215@end example
216
217@var{format} is optional.
218
219@item change vnc @var{display},@var{options}
220Change the configuration of the VNC server. The valid syntax for @var{display}
221and @var{options} are described at @ref{sec_invocation}. eg
222
223@example
224(qemu) change vnc localhost:1
225@end example
226
227@item change vnc password [@var{password}]
228
229Change the password associated with the VNC server. If the new password is not
230supplied, the monitor will prompt for it to be entered. VNC passwords are only
231significant up to 8 letters. eg
232
233@example
234(qemu) change vnc password
235Password: ********
236@end example
237
238@end table
239ETEXI
240
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300241 {
242 .name = "screendump",
243 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300244 .params = "filename",
245 .help = "save screen into PPM image 'filename'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100246 .mhandler.cmd = hmp_screendump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300247 },
248
Blue Swirl23130862009-06-06 08:22:04 +0000249STEXI
250@item screendump @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100251@findex screendump
Blue Swirl23130862009-06-06 08:22:04 +0000252Save screen into PPM image @var{filename}.
253ETEXI
254
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300255 {
256 .name = "logfile",
257 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300258 .params = "filename",
259 .help = "output logs to 'filename'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100260 .mhandler.cmd = hmp_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300261 },
262
Blue Swirl23130862009-06-06 08:22:04 +0000263STEXI
264@item logfile @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100265@findex logfile
Blue Swirl23130862009-06-06 08:22:04 +0000266Output logs to @var{filename}.
267ETEXI
268
Prerna Saxena22890ab2010-06-24 17:04:53 +0530269 {
270 .name = "trace-event",
271 .args_type = "name:s,option:b",
272 .params = "name on|off",
273 .help = "changes status of a specific trace event",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100274 .mhandler.cmd = hmp_trace_event,
Prerna Saxena22890ab2010-06-24 17:04:53 +0530275 },
276
277STEXI
278@item trace-event
279@findex trace-event
280changes status of a trace event
281ETEXI
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100282
Michael Rothc45a8162011-10-02 08:44:37 -0500283#if defined(CONFIG_TRACE_SIMPLE)
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100284 {
285 .name = "trace-file",
286 .args_type = "op:s?,arg:F?",
287 .params = "on|off|flush|set [arg]",
288 .help = "open, close, or flush trace file, or set a new file name",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100289 .mhandler.cmd = hmp_trace_file,
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100290 },
291
292STEXI
293@item trace-file on|off|flush
294@findex trace-file
295Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
296ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +0530297#endif
298
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300299 {
300 .name = "log",
301 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300302 .params = "item1[,...]",
Peter Maydell989b6972013-02-26 17:52:40 +0000303 .help = "activate logging of the specified items",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100304 .mhandler.cmd = hmp_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300305 },
306
Blue Swirl23130862009-06-06 08:22:04 +0000307STEXI
308@item log @var{item1}[,...]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100309@findex log
Peter Maydell989b6972013-02-26 17:52:40 +0000310Activate logging of the specified items.
Blue Swirl23130862009-06-06 08:22:04 +0000311ETEXI
312
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300313 {
314 .name = "savevm",
315 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300316 .params = "[tag|id]",
317 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100318 .mhandler.cmd = hmp_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300319 },
320
Blue Swirl23130862009-06-06 08:22:04 +0000321STEXI
322@item savevm [@var{tag}|@var{id}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100323@findex savevm
Blue Swirl23130862009-06-06 08:22:04 +0000324Create a snapshot of the whole virtual machine. If @var{tag} is
325provided, it is used as human readable identifier. If there is already
326a snapshot with the same tag or ID, it is replaced. More info at
327@ref{vm_snapshots}.
328ETEXI
329
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300330 {
331 .name = "loadvm",
332 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300333 .params = "tag|id",
334 .help = "restore a VM snapshot from its tag or id",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100335 .mhandler.cmd = hmp_loadvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100336 .command_completion = loadvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300337 },
338
Blue Swirl23130862009-06-06 08:22:04 +0000339STEXI
340@item loadvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100341@findex loadvm
Blue Swirl23130862009-06-06 08:22:04 +0000342Set the whole virtual machine to the snapshot identified by the tag
343@var{tag} or the unique snapshot ID @var{id}.
344ETEXI
345
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300346 {
347 .name = "delvm",
348 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300349 .params = "tag|id",
350 .help = "delete a VM snapshot from its tag or id",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100351 .mhandler.cmd = hmp_delvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100352 .command_completion = delvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300353 },
354
Blue Swirl23130862009-06-06 08:22:04 +0000355STEXI
356@item delvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100357@findex delvm
Blue Swirl23130862009-06-06 08:22:04 +0000358Delete the snapshot identified by @var{tag} or @var{id}.
359ETEXI
360
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300361 {
362 .name = "singlestep",
363 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300364 .params = "[on|off]",
365 .help = "run emulation in singlestep mode or switch to normal mode",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100366 .mhandler.cmd = hmp_singlestep,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300367 },
368
Blue Swirl23130862009-06-06 08:22:04 +0000369STEXI
370@item singlestep [off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100371@findex singlestep
Blue Swirl23130862009-06-06 08:22:04 +0000372Run the emulation in single step mode.
373If called with option off, the emulation returns to normal mode.
374ETEXI
375
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300376 {
377 .name = "stop",
378 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300379 .params = "",
380 .help = "stop emulation",
Luiz Capitulino5f158f22011-09-15 14:34:39 -0300381 .mhandler.cmd = hmp_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300382 },
383
Blue Swirl23130862009-06-06 08:22:04 +0000384STEXI
385@item stop
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100386@findex stop
Blue Swirl23130862009-06-06 08:22:04 +0000387Stop emulation.
388ETEXI
389
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300390 {
391 .name = "c|cont",
392 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300393 .params = "",
394 .help = "resume emulation",
Luiz Capitulinoe42e8182011-11-22 17:58:31 -0200395 .mhandler.cmd = hmp_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300396 },
397
Blue Swirl23130862009-06-06 08:22:04 +0000398STEXI
399@item c or cont
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100400@findex cont
Blue Swirl23130862009-06-06 08:22:04 +0000401Resume emulation.
402ETEXI
403
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300404 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100405 .name = "system_wakeup",
406 .args_type = "",
407 .params = "",
408 .help = "wakeup guest from suspend",
409 .mhandler.cmd = hmp_system_wakeup,
410 },
411
412STEXI
413@item system_wakeup
414@findex system_wakeup
415Wakeup guest from suspend.
416ETEXI
417
418 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300419 .name = "gdbserver",
420 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300421 .params = "[device]",
422 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100423 .mhandler.cmd = hmp_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300424 },
425
Blue Swirl23130862009-06-06 08:22:04 +0000426STEXI
427@item gdbserver [@var{port}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100428@findex gdbserver
Blue Swirl23130862009-06-06 08:22:04 +0000429Start gdbserver session (default @var{port}=1234)
430ETEXI
431
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300432 {
433 .name = "x",
434 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300435 .params = "/fmt addr",
436 .help = "virtual memory dump starting at 'addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100437 .mhandler.cmd = hmp_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300438 },
439
Blue Swirl23130862009-06-06 08:22:04 +0000440STEXI
441@item x/fmt @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100442@findex x
Blue Swirl23130862009-06-06 08:22:04 +0000443Virtual memory dump starting at @var{addr}.
444ETEXI
445
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300446 {
447 .name = "xp",
448 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300449 .params = "/fmt addr",
450 .help = "physical memory dump starting at 'addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100451 .mhandler.cmd = hmp_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300452 },
453
Blue Swirl23130862009-06-06 08:22:04 +0000454STEXI
455@item xp /@var{fmt} @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100456@findex xp
Blue Swirl23130862009-06-06 08:22:04 +0000457Physical memory dump starting at @var{addr}.
458
459@var{fmt} is a format which tells the command how to format the
460data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
461
462@table @var
463@item count
464is the number of items to be dumped.
465
466@item format
467can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
468c (char) or i (asm instruction).
469
470@item size
471can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
472@code{h} or @code{w} can be specified with the @code{i} format to
473respectively select 16 or 32 bit code instruction size.
474
475@end table
476
477Examples:
478@itemize
479@item
480Dump 10 instructions at the current instruction pointer:
481@example
482(qemu) x/10i $eip
4830x90107063: ret
4840x90107064: sti
4850x90107065: lea 0x0(%esi,1),%esi
4860x90107069: lea 0x0(%edi,1),%edi
4870x90107070: ret
4880x90107071: jmp 0x90107080
4890x90107073: nop
4900x90107074: nop
4910x90107075: nop
4920x90107076: nop
493@end example
494
495@item
496Dump 80 16 bit values at the start of the video memory.
497@smallexample
498(qemu) xp/80hx 0xb8000
4990x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
5000x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
5010x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
5020x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
5030x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
5040x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
5050x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5060x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5070x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5080x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
509@end smallexample
510@end itemize
511ETEXI
512
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300513 {
514 .name = "p|print",
515 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300516 .params = "/fmt expr",
517 .help = "print expression value (use $reg for CPU register access)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300518 .mhandler.cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300519 },
520
Blue Swirl23130862009-06-06 08:22:04 +0000521STEXI
522@item p or print/@var{fmt} @var{expr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100523@findex print
Blue Swirl23130862009-06-06 08:22:04 +0000524Print expression value. Only the @var{format} part of @var{fmt} is
525used.
526ETEXI
527
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300528 {
529 .name = "i",
530 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300531 .params = "/fmt addr",
532 .help = "I/O port read",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100533 .mhandler.cmd = hmp_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300534 },
535
Blue Swirl23130862009-06-06 08:22:04 +0000536STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100537@item i/@var{fmt} @var{addr} [.@var{index}]
538@findex i
Blue Swirl23130862009-06-06 08:22:04 +0000539Read I/O port.
540ETEXI
541
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300542 {
543 .name = "o",
544 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300545 .params = "/fmt addr value",
546 .help = "I/O port write",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100547 .mhandler.cmd = hmp_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300548 },
549
Jan Kiszkaf1147842009-07-14 10:20:11 +0200550STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100551@item o/@var{fmt} @var{addr} @var{val}
552@findex o
Jan Kiszkaf1147842009-07-14 10:20:11 +0200553Write to I/O port.
554ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000555
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300556 {
557 .name = "sendkey",
Amos Kong2ef20c12012-08-31 10:56:22 +0800558 .args_type = "keys:s,hold-time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300559 .params = "keys [hold_ms]",
560 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100561 .mhandler.cmd = hmp_sendkey,
Hani Benhabiles29136cd2014-05-07 23:41:27 +0100562 .command_completion = sendkey_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300563 },
564
Blue Swirl23130862009-06-06 08:22:04 +0000565STEXI
566@item sendkey @var{keys}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100567@findex sendkey
Amos Kong886cc702012-08-31 10:56:20 +0800568Send @var{keys} to the guest. @var{keys} could be the name of the
569key or the raw value in hexadecimal format. Use @code{-} to press
570several keys simultaneously. Example:
Blue Swirl23130862009-06-06 08:22:04 +0000571@example
572sendkey ctrl-alt-f1
573@end example
574
575This command is useful to send keys that your graphical user interface
576intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
577ETEXI
578
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300579 {
580 .name = "system_reset",
581 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300582 .params = "",
583 .help = "reset the system",
Luiz Capitulino38d22652011-09-15 14:41:46 -0300584 .mhandler.cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300585 },
586
Blue Swirl23130862009-06-06 08:22:04 +0000587STEXI
588@item system_reset
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100589@findex system_reset
Blue Swirl23130862009-06-06 08:22:04 +0000590Reset the system.
591ETEXI
592
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300593 {
594 .name = "system_powerdown",
595 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300596 .params = "",
597 .help = "send system power down event",
Luiz Capitulino5bc465e2011-09-28 11:06:15 -0300598 .mhandler.cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300599 },
600
Blue Swirl23130862009-06-06 08:22:04 +0000601STEXI
602@item system_powerdown
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100603@findex system_powerdown
Blue Swirl23130862009-06-06 08:22:04 +0000604Power down the system (if supported).
605ETEXI
606
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300607 {
608 .name = "sum",
609 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300610 .params = "addr size",
611 .help = "compute the checksum of a memory region",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100612 .mhandler.cmd = hmp_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300613 },
614
Blue Swirl23130862009-06-06 08:22:04 +0000615STEXI
616@item sum @var{addr} @var{size}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100617@findex sum
Blue Swirl23130862009-06-06 08:22:04 +0000618Compute the checksum of a memory region.
619ETEXI
620
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300621 {
622 .name = "usb_add",
623 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300624 .params = "device",
625 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100626 .mhandler.cmd = hmp_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300627 },
628
Blue Swirl23130862009-06-06 08:22:04 +0000629STEXI
630@item usb_add @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100631@findex usb_add
Blue Swirl23130862009-06-06 08:22:04 +0000632Add the USB device @var{devname}. For details of available devices see
633@ref{usb_devices}
634ETEXI
635
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300636 {
637 .name = "usb_del",
638 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300639 .params = "device",
640 .help = "remove USB device 'bus.addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100641 .mhandler.cmd = hmp_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300642 },
643
Blue Swirl23130862009-06-06 08:22:04 +0000644STEXI
645@item usb_del @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100646@findex usb_del
Blue Swirl23130862009-06-06 08:22:04 +0000647Remove the USB device @var{devname} from the QEMU virtual USB
648hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
649command @code{info usb} to see the devices you can remove.
650ETEXI
651
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300652 {
653 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100654 .args_type = "device:O",
655 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300656 .help = "add device, like -device on the command line",
Markus Armbruster8bc27242010-02-10 20:52:01 +0100657 .user_print = monitor_user_noop,
658 .mhandler.cmd_new = do_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100659 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300660 },
661
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200662STEXI
663@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100664@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200665Add device.
666ETEXI
667
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300668 {
669 .name = "device_del",
670 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300671 .params = "device",
672 .help = "remove device",
Luiz Capitulinoa15fef22012-03-29 12:38:50 -0300673 .mhandler.cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100674 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300675 },
676
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200677STEXI
678@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100679@findex device_del
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200680Remove device @var{id}.
681ETEXI
682
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300683 {
684 .name = "cpu",
685 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300686 .params = "index",
687 .help = "set the default CPU",
Luiz Capitulino755f1962011-10-06 14:31:39 -0300688 .mhandler.cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300689 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200690
Blue Swirl23130862009-06-06 08:22:04 +0000691STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200692@item cpu @var{index}
693@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000694Set the default CPU.
695ETEXI
696
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300697 {
698 .name = "mouse_move",
699 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300700 .params = "dx dy [dz]",
701 .help = "send mouse move events",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100702 .mhandler.cmd = hmp_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300703 },
704
Blue Swirl23130862009-06-06 08:22:04 +0000705STEXI
706@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100707@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000708Move the active mouse to the specified coordinates @var{dx} @var{dy}
709with optional scroll axis @var{dz}.
710ETEXI
711
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300712 {
713 .name = "mouse_button",
714 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300715 .params = "state",
716 .help = "change mouse button state (1=L, 2=M, 4=R)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100717 .mhandler.cmd = hmp_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300718 },
719
Blue Swirl23130862009-06-06 08:22:04 +0000720STEXI
721@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100722@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000723Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
724ETEXI
725
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300726 {
727 .name = "mouse_set",
728 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300729 .params = "index",
730 .help = "set which mouse device receives events",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100731 .mhandler.cmd = hmp_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300732 },
733
Blue Swirl23130862009-06-06 08:22:04 +0000734STEXI
735@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100736@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000737Set which mouse device receives events at given @var{index}, index
738can be obtained with
739@example
740info mice
741@end example
742ETEXI
743
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300744 {
745 .name = "wavcapture",
746 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300747 .params = "path [frequency [bits [channels]]]",
748 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100749 .mhandler.cmd = hmp_wavcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300750 },
Blue Swirl23130862009-06-06 08:22:04 +0000751STEXI
752@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100753@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000754Capture audio into @var{filename}. Using sample rate @var{frequency}
755bits per sample @var{bits} and number of channels @var{channels}.
756
757Defaults:
758@itemize @minus
759@item Sample rate = 44100 Hz - CD quality
760@item Bits = 16
761@item Number of channels = 2 - Stereo
762@end itemize
763ETEXI
764
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300765 {
766 .name = "stopcapture",
767 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300768 .params = "capture index",
769 .help = "stop capture",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100770 .mhandler.cmd = hmp_stopcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300771 },
Blue Swirl23130862009-06-06 08:22:04 +0000772STEXI
773@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100774@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000775Stop capture with a given @var{index}, index can be obtained with
776@example
777info capture
778@end example
779ETEXI
780
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300781 {
782 .name = "memsave",
783 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300784 .params = "addr size file",
785 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulino0cfd6a92011-11-22 16:32:37 -0200786 .mhandler.cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300787 },
788
Blue Swirl23130862009-06-06 08:22:04 +0000789STEXI
790@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100791@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000792save to disk virtual memory dump starting at @var{addr} of size @var{size}.
793ETEXI
794
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300795 {
796 .name = "pmemsave",
797 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300798 .params = "addr size file",
799 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulino6d3962b2011-11-22 17:26:46 -0200800 .mhandler.cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300801 },
802
Blue Swirl23130862009-06-06 08:22:04 +0000803STEXI
804@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100805@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000806save to disk physical memory dump starting at @var{addr} of size @var{size}.
807ETEXI
808
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300809 {
810 .name = "boot_set",
811 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300812 .params = "bootdevice",
813 .help = "define new values for the boot device list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100814 .mhandler.cmd = hmp_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300815 },
816
Blue Swirl23130862009-06-06 08:22:04 +0000817STEXI
818@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100819@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000820Define new values for the boot device list. Those values will override
821the values specified on the command line through the @code{-boot} option.
822
823The values that can be specified here depend on the machine type, but are
824the same that can be specified in the @code{-boot} command line option.
825ETEXI
826
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300827 {
828 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300829 .args_type = "",
830 .params = "",
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000831 .help = "inject an NMI",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100832 .mhandler.cmd = hmp_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300833 },
Blue Swirl23130862009-06-06 08:22:04 +0000834STEXI
835@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100836@findex nmi
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000837Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
Lei Li1f590cf2013-01-25 00:03:20 +0800838
839ETEXI
840
841 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100842 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800843 .args_type = "device:s,data:s",
844 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100845 .help = "Write to a ring buffer character device",
846 .mhandler.cmd = hmp_ringbuf_write,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100847 .command_completion = ringbuf_write_completion,
Lei Li1f590cf2013-01-25 00:03:20 +0800848 },
849
850STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100851@item ringbuf_write @var{device} @var{data}
852@findex ringbuf_write
853Write @var{data} to ring buffer character device @var{device}.
854@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800855
Blue Swirl23130862009-06-06 08:22:04 +0000856ETEXI
857
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300858 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100859 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800860 .args_type = "device:s,size:i",
861 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100862 .help = "Read from a ring buffer character device",
863 .mhandler.cmd = hmp_ringbuf_read,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100864 .command_completion = ringbuf_write_completion,
Lei Li49b6d722013-01-25 00:03:21 +0800865 },
866
867STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100868@item ringbuf_read @var{device}
869@findex ringbuf_read
870Read and print up to @var{size} bytes from ring buffer character
871device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100872Certain non-printable characters are printed \uXXXX, where XXXX is the
873character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100874Bug: can screw up when the buffer contains invalid UTF-8 sequences,
875NUL characters, after the ring buffer lost data, and when reading
876stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800877
878ETEXI
879
880 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300881 .name = "migrate",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200882 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
883 .params = "[-d] [-b] [-i] uri",
884 .help = "migrate to URI (using -d to not wait for completion)"
885 "\n\t\t\t -b for migration without shared storage with"
886 " full copy of disk\n\t\t\t -i for migration without "
887 "shared storage with incremental copy of disk "
888 "(base image shared between src and destination)",
Luiz Capitulinoe1c37d02011-12-05 14:48:01 -0200889 .mhandler.cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300890 },
891
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200892
Blue Swirl23130862009-06-06 08:22:04 +0000893STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200894@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100895@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000896Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200897 -b for migration with full copy of disk
898 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000899ETEXI
900
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300901 {
902 .name = "migrate_cancel",
903 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300904 .params = "",
905 .help = "cancel the current VM migration",
Luiz Capitulino6cdedb02011-11-27 22:54:09 -0200906 .mhandler.cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300907 },
908
Blue Swirl23130862009-06-06 08:22:04 +0000909STEXI
910@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100911@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000912Cancel the current VM migration.
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300913
914ETEXI
915
916 {
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000917 .name = "migrate_incoming",
918 .args_type = "uri:s",
919 .params = "uri",
920 .help = "Continue an incoming migration from an -incoming defer",
921 .mhandler.cmd = hmp_migrate_incoming,
922 },
923
924STEXI
925@item migrate_incoming @var{uri}
926@findex migrate_incoming
927Continue an incoming migration using the @var{uri} (that has the same syntax
928as the -incoming option).
929
930ETEXI
931
932 {
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300933 .name = "migrate_set_cache_size",
934 .args_type = "value:o",
935 .params = "value",
936 .help = "set cache size (in bytes) for XBZRLE migrations,"
937 "the cache size will be rounded down to the nearest "
938 "power of 2.\n"
939 "The cache size affects the number of cache misses."
940 "In case of a high cache miss ratio you need to increase"
941 " the cache size",
942 .mhandler.cmd = hmp_migrate_set_cache_size,
943 },
944
945STEXI
946@item migrate_set_cache_size @var{value}
947@findex migrate_set_cache_size
948Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +0000949ETEXI
950
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300951 {
952 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200953 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300954 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200955 .help = "set maximum speed (in bytes) for migrations. "
956 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Luiz Capitulino3dc85382011-11-28 11:59:37 -0200957 .mhandler.cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300958 },
959
Blue Swirl23130862009-06-06 08:22:04 +0000960STEXI
961@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100962@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +0000963Set maximum speed to @var{value} (in bytes) for migrations.
964ETEXI
965
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300966 {
967 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +0100968 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300969 .params = "value",
970 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulino4f0a9932011-11-27 23:18:01 -0200971 .mhandler.cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300972 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400973
974STEXI
975@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100976@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -0400977Set maximum tolerated downtime (in seconds) for migration.
978ETEXI
979
Jes Sorensenf8882562010-12-16 13:52:16 +0100980 {
Orit Wasserman00458432012-08-06 21:42:48 +0300981 .name = "migrate_set_capability",
982 .args_type = "capability:s,state:b",
983 .params = "capability state",
984 .help = "Enable/Disable the usage of a capability for migration",
985 .mhandler.cmd = hmp_migrate_set_capability,
Hani Benhabilesc68a0402014-05-27 23:39:32 +0100986 .command_completion = migrate_set_capability_completion,
Orit Wasserman00458432012-08-06 21:42:48 +0300987 },
988
989STEXI
990@item migrate_set_capability @var{capability} @var{state}
991@findex migrate_set_capability
992Enable/Disable the usage of a capability @var{capability} for migration.
993ETEXI
994
995 {
Liang Li50e9a622015-03-23 16:32:29 +0800996 .name = "migrate_set_parameter",
997 .args_type = "parameter:s,value:i",
998 .params = "parameter value",
999 .help = "Set the parameter for migration",
1000 .mhandler.cmd = hmp_migrate_set_parameter,
1001 .command_completion = migrate_set_parameter_completion,
1002 },
1003
1004STEXI
1005@item migrate_set_parameter @var{parameter} @var{value}
1006@findex migrate_set_parameter
1007Set the parameter @var{parameter} for migration.
1008ETEXI
1009
1010 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001011 .name = "client_migrate_info",
1012 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1013 .params = "protocol hostname port tls-port cert-subject",
Markus Armbruster13cadef2015-03-05 19:16:58 +01001014 .help = "set migration information for remote display",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001015 .user_print = monitor_user_noop,
Markus Armbruster3b5704b2015-03-05 09:30:16 +01001016 .mhandler.cmd_new = client_migrate_info,
Jes Sorensenf8882562010-12-16 13:52:16 +01001017 },
1018
1019STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001020@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1021@findex client_migrate_info
Markus Armbruster13cadef2015-03-05 19:16:58 +01001022Set migration information for remote display. This makes the server
1023ask the client to automatically reconnect using the new parameters
1024once migration finished successfully. Only implemented for SPICE.
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001025ETEXI
1026
Wen Congyang783e9b42012-05-07 12:10:47 +08001027 {
1028 .name = "dump-guest-memory",
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001029 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1030 .params = "[-p] [-z|-l|-s] filename [begin length]",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001031 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1032 "-p: do paging to get guest's memory mapping.\n\t\t\t"
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001033 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1034 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1035 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001036 "begin: the starting physical address.\n\t\t\t"
1037 "length: the memory size, in bytes.",
Wen Congyang783e9b42012-05-07 12:10:47 +08001038 .mhandler.cmd = hmp_dump_guest_memory,
1039 },
1040
1041
1042STEXI
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001043@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001044@item dump-guest-memory [-z|-l|-s] @var{filename}
Wen Congyang783e9b42012-05-07 12:10:47 +08001045@findex dump-guest-memory
1046Dump guest memory to @var{protocol}. The file can be processed with crash or
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001047gdb. Without -z|-l|-s, the dump format is ELF.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001048 -p: do paging to get guest's memory mapping.
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001049 -z: dump in kdump-compressed format, with zlib compression.
1050 -l: dump in kdump-compressed format, with lzo compression.
1051 -s: dump in kdump-compressed format, with snappy compression.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001052 filename: dump file name.
Wen Congyang783e9b42012-05-07 12:10:47 +08001053 begin: the starting physical address. It's optional, and should be
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001054 specified together with length.
Wen Congyang783e9b42012-05-07 12:10:47 +08001055 length: the memory size, in bytes. It's optional, and should be specified
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001056 together with begin.
Wen Congyang783e9b42012-05-07 12:10:47 +08001057ETEXI
Wen Congyang783e9b42012-05-07 12:10:47 +08001058
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001059 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001060 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001061 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1062 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001063 .help = "initiates a live snapshot\n\t\t\t"
1064 "of device. If a new image file is specified, the\n\t\t\t"
1065 "new image file will become the new root image.\n\t\t\t"
1066 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001067 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001068 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1069 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1070 "recreating it from scratch.",
Luiz Capitulino6106e242011-11-25 16:15:19 -02001071 .mhandler.cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001072 },
1073
1074STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001075@item snapshot_blkdev
1076@findex snapshot_blkdev
1077Snapshot device, using snapshot file as target if provided
1078ETEXI
1079
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001080 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001081 .name = "snapshot_blkdev_internal",
1082 .args_type = "device:B,name:s",
1083 .params = "device name",
1084 .help = "take an internal snapshot of device.\n\t\t\t"
1085 "The format of the image used by device must\n\t\t\t"
1086 "support it, such as qcow2.\n\t\t\t",
1087 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1088 },
1089
1090STEXI
1091@item snapshot_blkdev_internal
1092@findex snapshot_blkdev_internal
1093Take an internal snapshot on device if it support
1094ETEXI
1095
1096 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001097 .name = "snapshot_delete_blkdev_internal",
1098 .args_type = "device:B,name:s,id:s?",
1099 .params = "device name [id]",
1100 .help = "delete an internal snapshot of device.\n\t\t\t"
1101 "If id is specified, qemu will try delete\n\t\t\t"
1102 "the snapshot matching both id and name.\n\t\t\t"
1103 "The format of the image used by device must\n\t\t\t"
1104 "support it, such as qcow2.\n\t\t\t",
1105 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1106 },
1107
1108STEXI
1109@item snapshot_delete_blkdev_internal
1110@findex snapshot_delete_blkdev_internal
1111Delete an internal snapshot on device if it support
1112ETEXI
1113
1114 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001115 .name = "drive_mirror",
1116 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1117 .params = "[-n] [-f] device target [format]",
1118 .help = "initiates live storage\n\t\t\t"
1119 "migration for a device. The device's contents are\n\t\t\t"
1120 "copied to the new image file, including data that\n\t\t\t"
1121 "is written after the command is started.\n\t\t\t"
1122 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1123 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1124 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1125 "so that the result does not need a backing file.\n\t\t\t",
1126 .mhandler.cmd = hmp_drive_mirror,
1127 },
1128STEXI
1129@item drive_mirror
1130@findex drive_mirror
1131Start mirroring a block device's writes to a new destination,
1132using the specified target.
1133ETEXI
1134
1135 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001136 .name = "drive_backup",
1137 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1138 .params = "[-n] [-f] device target [format]",
1139 .help = "initiates a point-in-time\n\t\t\t"
1140 "copy for a device. The device's contents are\n\t\t\t"
1141 "copied to the new image file, excluding data that\n\t\t\t"
1142 "is written after the command is started.\n\t\t\t"
1143 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1144 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1145 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1146 "so that the result does not need a backing file.\n\t\t\t",
1147 .mhandler.cmd = hmp_drive_backup,
1148 },
1149STEXI
1150@item drive_backup
1151@findex drive_backup
1152Start a point-in-time copy of a block device to a specificed target.
1153ETEXI
1154
1155 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001156 .name = "drive_add",
1157 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001158 .params = "[[<domain>:]<bus>:]<slot>\n"
1159 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001160 "[,unit=m][,media=d][,index=i]\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001161 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001162 "[,snapshot=on|off][,cache=on|off]\n"
1163 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001164 .help = "add drive to PCI storage controller",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001165 .mhandler.cmd = hmp_drive_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001166 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001167
Blue Swirl23130862009-06-06 08:22:04 +00001168STEXI
1169@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001170@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001171Add drive to PCI storage controller.
1172ETEXI
1173
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001174 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001175 .name = "pcie_aer_inject_error",
1176 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1177 "id:s,error_status:s,"
1178 "header0:i?,header1:i?,header2:i?,header3:i?,"
1179 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1180 .params = "[-a] [-c] id "
1181 "<error_status> [<tlp header> [<tlp header prefix>]]",
1182 .help = "inject pcie aer error\n\t\t\t"
1183 " -a for advisory non fatal error\n\t\t\t"
1184 " -c for correctable error\n\t\t\t"
1185 "<id> = qdev device id\n\t\t\t"
1186 "<error_status> = error string or 32bit\n\t\t\t"
1187 "<tlb header> = 32bit x 4\n\t\t\t"
1188 "<tlb header prefix> = 32bit x 4",
1189 .user_print = pcie_aer_inject_error_print,
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001190 .mhandler.cmd_new = hmp_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001191 },
1192
1193STEXI
1194@item pcie_aer_inject_error
1195@findex pcie_aer_inject_error
1196Inject PCIe AER error
1197ETEXI
1198
1199 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001200 .name = "host_net_add",
1201 .args_type = "device:s,opts:s?",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001202 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001203 .help = "add host VLAN client",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001204 .mhandler.cmd = hmp_host_net_add,
Hani Benhabilese3bb5322014-05-27 23:39:34 +01001205 .command_completion = host_net_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001206 },
1207
Blue Swirl23130862009-06-06 08:22:04 +00001208STEXI
1209@item host_net_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001210@findex host_net_add
Blue Swirl23130862009-06-06 08:22:04 +00001211Add host VLAN client.
1212ETEXI
1213
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001214 {
1215 .name = "host_net_remove",
1216 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001217 .params = "vlan_id name",
1218 .help = "remove host VLAN client",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001219 .mhandler.cmd = hmp_host_net_remove,
Hani Benhabilesddd6b452014-05-27 23:39:36 +01001220 .command_completion = host_net_remove_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001221 },
1222
Blue Swirl23130862009-06-06 08:22:04 +00001223STEXI
1224@item host_net_remove
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001225@findex host_net_remove
Blue Swirl23130862009-06-06 08:22:04 +00001226Remove host VLAN client.
1227ETEXI
1228
Markus Armbrusterae82d322010-03-25 17:22:40 +01001229 {
1230 .name = "netdev_add",
1231 .args_type = "netdev:O",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001232 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001233 .help = "add host network device",
Luiz Capitulino928059a2012-04-18 17:34:15 -03001234 .mhandler.cmd = hmp_netdev_add,
Hani Benhabilesb162b492014-05-07 23:41:31 +01001235 .command_completion = netdev_add_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001236 },
1237
1238STEXI
1239@item netdev_add
1240@findex netdev_add
1241Add host network device.
1242ETEXI
1243
1244 {
1245 .name = "netdev_del",
1246 .args_type = "id:s",
1247 .params = "id",
1248 .help = "remove host network device",
Luiz Capitulino5f964152012-04-16 14:36:32 -03001249 .mhandler.cmd = hmp_netdev_del,
Hani Benhabiles11b389f2014-05-07 23:41:32 +01001250 .command_completion = netdev_del_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001251 },
1252
1253STEXI
1254@item netdev_del
1255@findex netdev_del
1256Remove host network device.
1257ETEXI
1258
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001259 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001260 .name = "object_add",
1261 .args_type = "object:O",
1262 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1263 .help = "create QOM object",
1264 .mhandler.cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001265 .command_completion = object_add_completion,
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001266 },
1267
1268STEXI
1269@item object_add
1270@findex object_add
1271Create QOM object.
1272ETEXI
1273
1274 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001275 .name = "object_del",
1276 .args_type = "id:s",
1277 .params = "id",
1278 .help = "destroy QOM object",
1279 .mhandler.cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001280 .command_completion = object_del_completion,
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001281 },
1282
1283STEXI
1284@item object_del
1285@findex object_del
1286Destroy QOM object.
1287ETEXI
1288
Blue Swirl23130862009-06-06 08:22:04 +00001289#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001290 {
1291 .name = "hostfwd_add",
1292 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001293 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1294 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001295 .mhandler.cmd = hmp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001296 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001297#endif
1298STEXI
1299@item hostfwd_add
1300@findex hostfwd_add
1301Redirect TCP or UDP connections from host to guest (requires -net user).
1302ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001303
Markus Armbruster21413d62010-05-04 13:20:30 +02001304#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001305 {
1306 .name = "hostfwd_remove",
1307 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001308 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1309 .help = "remove host-to-guest TCP or UDP redirection",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001310 .mhandler.cmd = hmp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001311 },
1312
Blue Swirl23130862009-06-06 08:22:04 +00001313#endif
1314STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001315@item hostfwd_remove
1316@findex hostfwd_remove
1317Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001318ETEXI
1319
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001320 {
1321 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001322 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001323 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001324 .help = "request VM to change its memory allocation (in MB)",
Luiz Capitulinod72f3262011-11-25 14:38:09 -02001325 .mhandler.cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001326 },
1327
Blue Swirl23130862009-06-06 08:22:04 +00001328STEXI
1329@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001330@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001331Request VM to change its memory allocation to @var{value} (in MB).
1332ETEXI
1333
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001334 {
1335 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001336 .args_type = "name:s,up:b",
1337 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001338 .help = "change the link status of a network adapter",
Luiz Capitulino4b371562011-11-23 13:11:55 -02001339 .mhandler.cmd = hmp_set_link,
Hani Benhabiles40d19392014-05-07 23:41:30 +01001340 .command_completion = set_link_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001341 },
1342
Blue Swirl23130862009-06-06 08:22:04 +00001343STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001344@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001345@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001346Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001347ETEXI
1348
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001349 {
1350 .name = "watchdog_action",
1351 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001352 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1353 .help = "change watchdog action",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001354 .mhandler.cmd = hmp_watchdog_action,
Hani Benhabilesd0ece342014-05-27 23:39:31 +01001355 .command_completion = watchdog_action_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001356 },
1357
Blue Swirl23130862009-06-06 08:22:04 +00001358STEXI
1359@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001360@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001361Change watchdog action.
1362ETEXI
1363
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001364 {
1365 .name = "acl_show",
1366 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001367 .params = "aclname",
1368 .help = "list rules in the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001369 .mhandler.cmd = hmp_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001370 },
1371
Blue Swirl23130862009-06-06 08:22:04 +00001372STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001373@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001374@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001375List all the matching rules in the access control list, and the default
1376policy. There are currently two named access control lists,
1377@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1378certificate distinguished name, and SASL username respectively.
1379ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001380
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001381 {
1382 .name = "acl_policy",
1383 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001384 .params = "aclname allow|deny",
1385 .help = "set default access control list policy",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001386 .mhandler.cmd = hmp_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001387 },
1388
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001389STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001390@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001391@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001392Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001393none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001394always @code{deny}.
1395ETEXI
1396
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001397 {
1398 .name = "acl_add",
1399 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001400 .params = "aclname match allow|deny [index]",
1401 .help = "add a match rule to the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001402 .mhandler.cmd = hmp_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001403 },
1404
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001405STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001406@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1407@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001408Add a match rule to the access control list, allowing or denying access.
1409The match will normally be an exact username or x509 distinguished name,
1410but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1411allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001412normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001413earlier in the list if the optional @var{index} parameter is supplied.
1414ETEXI
1415
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001416 {
1417 .name = "acl_remove",
1418 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001419 .params = "aclname match",
1420 .help = "remove a match rule from the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001421 .mhandler.cmd = hmp_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001422 },
1423
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001424STEXI
1425@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001426@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001427Remove the specified match rule from the access control list.
1428ETEXI
1429
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001430 {
1431 .name = "acl_reset",
1432 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001433 .params = "aclname",
1434 .help = "reset the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001435 .mhandler.cmd = hmp_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001436 },
1437
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001438STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001439@item acl_reset @var{aclname}
1440@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001441Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001442policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001443ETEXI
1444
Paolo Bonzini40577252012-08-23 11:53:04 +02001445 {
1446 .name = "nbd_server_start",
1447 .args_type = "all:-a,writable:-w,uri:s",
1448 .params = "nbd_server_start [-a] [-w] host:port",
1449 .help = "serve block devices on the given host and port",
1450 .mhandler.cmd = hmp_nbd_server_start,
1451 },
1452STEXI
1453@item nbd_server_start @var{host}:@var{port}
1454@findex nbd_server_start
1455Start an NBD server on the given host and/or port. If the @option{-a}
1456option is included, all of the virtual machine's block devices that
1457have an inserted media on them are automatically exported; in this case,
1458the @option{-w} option makes the devices writable too.
1459ETEXI
1460
1461 {
1462 .name = "nbd_server_add",
1463 .args_type = "writable:-w,device:B",
1464 .params = "nbd_server_add [-w] device",
1465 .help = "export a block device via NBD",
1466 .mhandler.cmd = hmp_nbd_server_add,
1467 },
1468STEXI
1469@item nbd_server_add @var{device}
1470@findex nbd_server_add
1471Export a block device through QEMU's NBD server, which must be started
1472beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1473exported device writable too.
1474ETEXI
1475
1476 {
1477 .name = "nbd_server_stop",
1478 .args_type = "",
1479 .params = "nbd_server_stop",
1480 .help = "stop serving block devices using the NBD protocol",
1481 .mhandler.cmd = hmp_nbd_server_stop,
1482 },
1483STEXI
1484@item nbd_server_stop
1485@findex nbd_server_stop
1486Stop the QEMU embedded NBD server.
1487ETEXI
1488
1489
Huang Ying79c4f6b2009-06-23 10:05:14 +08001490#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001491
1492 {
1493 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001494 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1495 .params = "[-b] cpu bank status mcgstatus addr misc",
1496 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001497 .mhandler.cmd = hmp_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001498 },
1499
Huang Ying79c4f6b2009-06-23 10:05:14 +08001500#endif
1501STEXI
1502@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001503@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001504Inject an MCE on the given CPU (x86 only).
1505ETEXI
1506
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001507 {
1508 .name = "getfd",
1509 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001510 .params = "getfd name",
1511 .help = "receive a file descriptor via SCM rights and assign it a name",
Corey Bryant208c9d12012-06-22 14:36:09 -04001512 .mhandler.cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001513 },
1514
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001515STEXI
1516@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001517@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001518If a file descriptor is passed alongside this command using the SCM_RIGHTS
1519mechanism on unix sockets, it is stored using the name @var{fdname} for
1520later use by other monitor commands.
1521ETEXI
1522
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001523 {
1524 .name = "closefd",
1525 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001526 .params = "closefd name",
1527 .help = "close a file descriptor previously passed via SCM rights",
Corey Bryant208c9d12012-06-22 14:36:09 -04001528 .mhandler.cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001529 },
1530
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001531STEXI
1532@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001533@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001534Close the file descriptor previously assigned to @var{fdname} using the
1535@code{getfd} command. This is only needed if the file descriptor was never
1536used by another monitor command.
1537ETEXI
1538
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001539 {
1540 .name = "block_passwd",
1541 .args_type = "device:B,password:s",
1542 .params = "block_passwd device password",
1543 .help = "set the password of encrypted block devices",
Luiz Capitulinoa4dea8a2011-11-23 13:28:21 -02001544 .mhandler.cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001545 },
1546
1547STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001548@item block_passwd @var{device} @var{password}
1549@findex block_passwd
1550Set the encrypted device @var{device} password to @var{password}
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001551ETEXI
1552
1553 {
1554 .name = "block_set_io_throttle",
1555 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1556 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1557 .help = "change I/O throttle limits for a block drive",
Luiz Capitulino80047da2011-12-14 16:49:14 -02001558 .mhandler.cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001559 },
1560
1561STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001562@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1563@findex block_set_io_throttle
1564Change 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}
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001565ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001566
Jan Kiszka33572ec2010-05-31 14:43:30 -03001567 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001568 .name = "set_password",
1569 .args_type = "protocol:s,password:s,connected:s?",
1570 .params = "protocol password action-if-connected",
1571 .help = "set spice/vnc password",
Luiz Capitulinofbf796f2011-12-07 11:17:51 -02001572 .mhandler.cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001573 },
1574
1575STEXI
1576@item set_password [ vnc | spice ] password [ action-if-connected ]
1577@findex set_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001578Change spice/vnc password. Use zero to make the password stay valid
1579forever. @var{action-if-connected} specifies what should happen in
1580case a connection is established: @var{fail} makes the password change
1581fail. @var{disconnect} changes the password and disconnects the
1582client. @var{keep} changes the password and keeps the connection up.
1583@var{keep} is the default.
1584ETEXI
1585
1586 {
1587 .name = "expire_password",
1588 .args_type = "protocol:s,time:s",
1589 .params = "protocol time",
1590 .help = "set spice/vnc password expire-time",
Luiz Capitulino9ad53722011-12-07 11:47:57 -02001591 .mhandler.cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001592 },
1593
1594STEXI
1595@item expire_password [ vnc | spice ] expire-time
1596@findex expire_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001597Specify when a password for spice/vnc becomes
1598invalid. @var{expire-time} accepts:
1599
1600@table @var
1601@item now
1602Invalidate password instantly.
1603
1604@item never
1605Password stays valid forever.
1606
1607@item +nsec
1608Password stays valid for @var{nsec} seconds starting now.
1609
1610@item nsec
1611Password is invalidated at the given time. @var{nsec} are the seconds
1612passed since 1970, i.e. unix epoch.
1613
1614@end table
1615ETEXI
1616
Gerd Hoffmann46920822013-02-28 08:46:10 +01001617 {
1618 .name = "chardev-add",
1619 .args_type = "args:s",
1620 .params = "args",
1621 .help = "add chardev",
1622 .mhandler.cmd = hmp_chardev_add,
Hani Benhabiles13e315d2014-05-07 23:41:29 +01001623 .command_completion = chardev_add_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001624 },
1625
1626STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001627@item chardev-add args
1628@findex chardev-add
Gerd Hoffmann46920822013-02-28 08:46:10 +01001629chardev_add accepts the same parameters as the -chardev command line switch.
1630
1631ETEXI
1632
1633 {
1634 .name = "chardev-remove",
1635 .args_type = "id:s",
1636 .params = "id",
1637 .help = "remove chardev",
1638 .mhandler.cmd = hmp_chardev_remove,
Hani Benhabiles6297d9a2014-05-07 23:41:28 +01001639 .command_completion = chardev_remove_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001640 },
1641
1642STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001643@item chardev-remove id
1644@findex chardev-remove
Gerd Hoffmann46920822013-02-28 08:46:10 +01001645Removes the chardev @var{id}.
1646
1647ETEXI
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001648
1649 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001650 .name = "qemu-io",
1651 .args_type = "device:B,command:s",
1652 .params = "[device] \"[command]\"",
1653 .help = "run a qemu-io command on a block device",
1654 .mhandler.cmd = hmp_qemu_io,
1655 },
1656
1657STEXI
1658@item qemu-io @var{device} @var{command}
1659@findex qemu-io
Kevin Wolf587da2c2013-06-05 14:19:41 +02001660Executes a qemu-io command on the given block device.
1661
1662ETEXI
1663
1664 {
Jason J. Herneabf23322013-12-11 13:24:14 -05001665 .name = "cpu-add",
1666 .args_type = "id:i",
1667 .params = "id",
1668 .help = "add cpu",
1669 .mhandler.cmd = hmp_cpu_add,
1670 },
1671
1672STEXI
1673@item cpu-add @var{id}
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001674@findex cpu-add
Jason J. Herneabf23322013-12-11 13:24:14 -05001675Add CPU with id @var{id}
1676ETEXI
1677
1678 {
Andreas Färber89d7fa92014-05-07 18:08:29 +02001679 .name = "qom-list",
1680 .args_type = "path:s?",
1681 .params = "path",
1682 .help = "list QOM properties",
1683 .mhandler.cmd = hmp_qom_list,
1684 },
1685
1686STEXI
1687@item qom-list [@var{path}]
1688Print QOM properties of object at location @var{path}
1689ETEXI
1690
1691 {
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001692 .name = "qom-set",
1693 .args_type = "path:s,property:s,value:s",
1694 .params = "path property value",
1695 .help = "set QOM property",
1696 .mhandler.cmd = hmp_qom_set,
1697 },
1698
1699STEXI
1700@item qom-set @var{path} @var{property} @var{value}
1701Set QOM property @var{property} of object at location @var{path} to value @var{value}
1702ETEXI
1703
1704 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001705 .name = "info",
1706 .args_type = "item:s?",
1707 .params = "[subcommand]",
1708 .help = "show various information about the system state",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001709 .mhandler.cmd = hmp_info_help,
Wenchao Xia84c44612013-01-14 14:06:29 +08001710 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001711 },
1712
1713STEXI
1714@item info @var{subcommand}
1715@findex info
1716Show various information about the system state.
1717
1718@table @option
1719@item info version
1720show the version of QEMU
Jan Kiszka33572ec2010-05-31 14:43:30 -03001721@item info network
1722show the various VLANs and the associated devices
1723@item info chardev
1724show the character devices
1725@item info block
1726show the block devices
1727@item info blockstats
1728show block device statistics
1729@item info registers
1730show the cpu registers
1731@item info cpus
1732show infos for each CPU
1733@item info history
1734show the command line history
1735@item info irq
1736show the interrupts statistics (if available)
1737@item info pic
1738show i8259 (PIC) state
1739@item info pci
1740show emulated PCI device info
1741@item info tlb
Max Filippov692f7372012-01-07 20:02:40 +04001742show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001743@item info mem
1744show the active virtual memory mappings (i386 only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001745@item info jit
1746show dynamic compiler info
Jan Kiszka33572ec2010-05-31 14:43:30 -03001747@item info numa
1748show NUMA information
Jan Kiszkab40292e2010-05-31 14:43:31 -03001749@item info kvm
1750show KVM information
Jan Kiszka33572ec2010-05-31 14:43:30 -03001751@item info usb
1752show USB devices plugged on the virtual USB hub
1753@item info usbhost
1754show all USB host devices
1755@item info profile
1756show profiling information
1757@item info capture
1758show information about active capturing
1759@item info snapshots
1760show list of VM snapshots
1761@item info status
1762show the current VM status (running|paused)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001763@item info mice
1764show which guest mouse is receiving events
1765@item info vnc
1766show the vnc server status
1767@item info name
1768show the current VM name
1769@item info uuid
1770show the current VM UUID
1771@item info cpustats
1772show CPU statistics
1773@item info usernet
1774show user network stack connection states
1775@item info migrate
1776show migration status
Orit Wassermanbbf6da32012-08-06 21:42:47 +03001777@item info migrate_capabilities
1778show current migration capabilities
Liang Li50e9a622015-03-23 16:32:29 +08001779@item info migrate_parameters
1780show current migration parameters
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +03001781@item info migrate_cache_size
1782show current migration XBZRLE cache size
Jan Kiszka33572ec2010-05-31 14:43:30 -03001783@item info balloon
1784show balloon information
1785@item info qtree
1786show device tree
1787@item info qdm
1788show qdev device model list
Andreas Färbera01ff752014-05-07 17:03:18 +02001789@item info qom-tree
1790show object composition tree
Jan Kiszka33572ec2010-05-31 14:43:30 -03001791@item info roms
1792show roms
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05001793@item info tpm
1794show the TPM device
Zhu Guihuaa6318922014-09-23 13:35:19 +08001795@item info memory-devices
1796show the memory devices
Jan Kiszka33572ec2010-05-31 14:43:30 -03001797@end table
1798ETEXI
1799
Lluís31965ae2011-08-31 20:31:24 +02001800STEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301801@item info trace-events
1802show available trace events and their state
1803ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301804
Blue Swirl23130862009-06-06 08:22:04 +00001805STEXI
1806@end table
1807ETEXI