blob: 52579698af6da14ca49d6232f541bac3b261db3c [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",
Markus Armbruster072ebe62015-03-05 17:00:56 +0100181 .mhandler.cmd = hmp_drive_del,
Ryan Harper9063f812010-11-12 11:07:13 -0600182 },
183
184STEXI
185@item drive_del @var{device}
186@findex drive_del
187Remove host block device. The result is that guest generated IO is no longer
188submitted against the host device underlying the disk. Once a drive has
189been deleted, the QEMU Block layer returns -EIO which results in IO
190errors in the guest for applications that are reading/writing to the device.
Stefan Hajnoczi293c51a2013-06-05 10:33:14 +0200191These errors are always reported to the guest, regardless of the drive's error
192actions (drive options rerror, werror).
Ryan Harper9063f812010-11-12 11:07:13 -0600193ETEXI
194
195 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300196 .name = "change",
197 .args_type = "device:B,target:F,arg:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300198 .params = "device filename [format]",
199 .help = "change a removable medium, optional format",
Luiz Capitulino333a96e2011-12-08 11:13:50 -0200200 .mhandler.cmd = hmp_change,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300201 },
202
Blue Swirl23130862009-06-06 08:22:04 +0000203STEXI
204@item change @var{device} @var{setting}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100205@findex change
Blue Swirl23130862009-06-06 08:22:04 +0000206Change the configuration of a device.
207
208@table @option
209@item change @var{diskdevice} @var{filename} [@var{format}]
210Change the medium for a removable disk device to point to @var{filename}. eg
211
212@example
213(qemu) change ide1-cd0 /path/to/some.iso
214@end example
215
216@var{format} is optional.
217
218@item change vnc @var{display},@var{options}
219Change the configuration of the VNC server. The valid syntax for @var{display}
220and @var{options} are described at @ref{sec_invocation}. eg
221
222@example
223(qemu) change vnc localhost:1
224@end example
225
226@item change vnc password [@var{password}]
227
228Change the password associated with the VNC server. If the new password is not
229supplied, the monitor will prompt for it to be entered. VNC passwords are only
230significant up to 8 letters. eg
231
232@example
233(qemu) change vnc password
234Password: ********
235@end example
236
237@end table
238ETEXI
239
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300240 {
241 .name = "screendump",
242 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300243 .params = "filename",
244 .help = "save screen into PPM image 'filename'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100245 .mhandler.cmd = hmp_screendump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300246 },
247
Blue Swirl23130862009-06-06 08:22:04 +0000248STEXI
249@item screendump @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100250@findex screendump
Blue Swirl23130862009-06-06 08:22:04 +0000251Save screen into PPM image @var{filename}.
252ETEXI
253
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300254 {
255 .name = "logfile",
256 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300257 .params = "filename",
258 .help = "output logs to 'filename'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100259 .mhandler.cmd = hmp_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300260 },
261
Blue Swirl23130862009-06-06 08:22:04 +0000262STEXI
263@item logfile @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100264@findex logfile
Blue Swirl23130862009-06-06 08:22:04 +0000265Output logs to @var{filename}.
266ETEXI
267
Prerna Saxena22890ab2010-06-24 17:04:53 +0530268 {
269 .name = "trace-event",
270 .args_type = "name:s,option:b",
271 .params = "name on|off",
272 .help = "changes status of a specific trace event",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100273 .mhandler.cmd = hmp_trace_event,
Prerna Saxena22890ab2010-06-24 17:04:53 +0530274 },
275
276STEXI
277@item trace-event
278@findex trace-event
279changes status of a trace event
280ETEXI
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100281
Michael Rothc45a8162011-10-02 08:44:37 -0500282#if defined(CONFIG_TRACE_SIMPLE)
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100283 {
284 .name = "trace-file",
285 .args_type = "op:s?,arg:F?",
286 .params = "on|off|flush|set [arg]",
287 .help = "open, close, or flush trace file, or set a new file name",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100288 .mhandler.cmd = hmp_trace_file,
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100289 },
290
291STEXI
292@item trace-file on|off|flush
293@findex trace-file
294Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
295ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +0530296#endif
297
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300298 {
299 .name = "log",
300 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300301 .params = "item1[,...]",
Peter Maydell989b6972013-02-26 17:52:40 +0000302 .help = "activate logging of the specified items",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100303 .mhandler.cmd = hmp_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300304 },
305
Blue Swirl23130862009-06-06 08:22:04 +0000306STEXI
307@item log @var{item1}[,...]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100308@findex log
Peter Maydell989b6972013-02-26 17:52:40 +0000309Activate logging of the specified items.
Blue Swirl23130862009-06-06 08:22:04 +0000310ETEXI
311
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300312 {
313 .name = "savevm",
314 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300315 .params = "[tag|id]",
316 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100317 .mhandler.cmd = hmp_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300318 },
319
Blue Swirl23130862009-06-06 08:22:04 +0000320STEXI
321@item savevm [@var{tag}|@var{id}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100322@findex savevm
Blue Swirl23130862009-06-06 08:22:04 +0000323Create a snapshot of the whole virtual machine. If @var{tag} is
324provided, it is used as human readable identifier. If there is already
325a snapshot with the same tag or ID, it is replaced. More info at
326@ref{vm_snapshots}.
327ETEXI
328
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300329 {
330 .name = "loadvm",
331 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300332 .params = "tag|id",
333 .help = "restore a VM snapshot from its tag or id",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100334 .mhandler.cmd = hmp_loadvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100335 .command_completion = loadvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300336 },
337
Blue Swirl23130862009-06-06 08:22:04 +0000338STEXI
339@item loadvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100340@findex loadvm
Blue Swirl23130862009-06-06 08:22:04 +0000341Set the whole virtual machine to the snapshot identified by the tag
342@var{tag} or the unique snapshot ID @var{id}.
343ETEXI
344
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300345 {
346 .name = "delvm",
347 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300348 .params = "tag|id",
349 .help = "delete a VM snapshot from its tag or id",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100350 .mhandler.cmd = hmp_delvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100351 .command_completion = delvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300352 },
353
Blue Swirl23130862009-06-06 08:22:04 +0000354STEXI
355@item delvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100356@findex delvm
Blue Swirl23130862009-06-06 08:22:04 +0000357Delete the snapshot identified by @var{tag} or @var{id}.
358ETEXI
359
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300360 {
361 .name = "singlestep",
362 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300363 .params = "[on|off]",
364 .help = "run emulation in singlestep mode or switch to normal mode",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100365 .mhandler.cmd = hmp_singlestep,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300366 },
367
Blue Swirl23130862009-06-06 08:22:04 +0000368STEXI
369@item singlestep [off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100370@findex singlestep
Blue Swirl23130862009-06-06 08:22:04 +0000371Run the emulation in single step mode.
372If called with option off, the emulation returns to normal mode.
373ETEXI
374
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300375 {
376 .name = "stop",
377 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300378 .params = "",
379 .help = "stop emulation",
Luiz Capitulino5f158f22011-09-15 14:34:39 -0300380 .mhandler.cmd = hmp_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300381 },
382
Blue Swirl23130862009-06-06 08:22:04 +0000383STEXI
384@item stop
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100385@findex stop
Blue Swirl23130862009-06-06 08:22:04 +0000386Stop emulation.
387ETEXI
388
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300389 {
390 .name = "c|cont",
391 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300392 .params = "",
393 .help = "resume emulation",
Luiz Capitulinoe42e8182011-11-22 17:58:31 -0200394 .mhandler.cmd = hmp_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300395 },
396
Blue Swirl23130862009-06-06 08:22:04 +0000397STEXI
398@item c or cont
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100399@findex cont
Blue Swirl23130862009-06-06 08:22:04 +0000400Resume emulation.
401ETEXI
402
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300403 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100404 .name = "system_wakeup",
405 .args_type = "",
406 .params = "",
407 .help = "wakeup guest from suspend",
408 .mhandler.cmd = hmp_system_wakeup,
409 },
410
411STEXI
412@item system_wakeup
413@findex system_wakeup
414Wakeup guest from suspend.
415ETEXI
416
417 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300418 .name = "gdbserver",
419 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300420 .params = "[device]",
421 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100422 .mhandler.cmd = hmp_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300423 },
424
Blue Swirl23130862009-06-06 08:22:04 +0000425STEXI
426@item gdbserver [@var{port}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100427@findex gdbserver
Blue Swirl23130862009-06-06 08:22:04 +0000428Start gdbserver session (default @var{port}=1234)
429ETEXI
430
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300431 {
432 .name = "x",
433 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300434 .params = "/fmt addr",
435 .help = "virtual memory dump starting at 'addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100436 .mhandler.cmd = hmp_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300437 },
438
Blue Swirl23130862009-06-06 08:22:04 +0000439STEXI
440@item x/fmt @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100441@findex x
Blue Swirl23130862009-06-06 08:22:04 +0000442Virtual memory dump starting at @var{addr}.
443ETEXI
444
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300445 {
446 .name = "xp",
447 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300448 .params = "/fmt addr",
449 .help = "physical memory dump starting at 'addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100450 .mhandler.cmd = hmp_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300451 },
452
Blue Swirl23130862009-06-06 08:22:04 +0000453STEXI
454@item xp /@var{fmt} @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100455@findex xp
Blue Swirl23130862009-06-06 08:22:04 +0000456Physical memory dump starting at @var{addr}.
457
458@var{fmt} is a format which tells the command how to format the
459data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
460
461@table @var
462@item count
463is the number of items to be dumped.
464
465@item format
466can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
467c (char) or i (asm instruction).
468
469@item size
470can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
471@code{h} or @code{w} can be specified with the @code{i} format to
472respectively select 16 or 32 bit code instruction size.
473
474@end table
475
476Examples:
477@itemize
478@item
479Dump 10 instructions at the current instruction pointer:
480@example
481(qemu) x/10i $eip
4820x90107063: ret
4830x90107064: sti
4840x90107065: lea 0x0(%esi,1),%esi
4850x90107069: lea 0x0(%edi,1),%edi
4860x90107070: ret
4870x90107071: jmp 0x90107080
4880x90107073: nop
4890x90107074: nop
4900x90107075: nop
4910x90107076: nop
492@end example
493
494@item
495Dump 80 16 bit values at the start of the video memory.
496@smallexample
497(qemu) xp/80hx 0xb8000
4980x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
4990x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
5000x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
5010x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
5020x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
5030x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
5040x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5050x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5060x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5070x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
508@end smallexample
509@end itemize
510ETEXI
511
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300512 {
513 .name = "p|print",
514 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300515 .params = "/fmt expr",
516 .help = "print expression value (use $reg for CPU register access)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300517 .mhandler.cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300518 },
519
Blue Swirl23130862009-06-06 08:22:04 +0000520STEXI
521@item p or print/@var{fmt} @var{expr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100522@findex print
Blue Swirl23130862009-06-06 08:22:04 +0000523Print expression value. Only the @var{format} part of @var{fmt} is
524used.
525ETEXI
526
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300527 {
528 .name = "i",
529 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300530 .params = "/fmt addr",
531 .help = "I/O port read",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100532 .mhandler.cmd = hmp_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300533 },
534
Blue Swirl23130862009-06-06 08:22:04 +0000535STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100536@item i/@var{fmt} @var{addr} [.@var{index}]
537@findex i
Blue Swirl23130862009-06-06 08:22:04 +0000538Read I/O port.
539ETEXI
540
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300541 {
542 .name = "o",
543 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300544 .params = "/fmt addr value",
545 .help = "I/O port write",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100546 .mhandler.cmd = hmp_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300547 },
548
Jan Kiszkaf1147842009-07-14 10:20:11 +0200549STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100550@item o/@var{fmt} @var{addr} @var{val}
551@findex o
Jan Kiszkaf1147842009-07-14 10:20:11 +0200552Write to I/O port.
553ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000554
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300555 {
556 .name = "sendkey",
Amos Kong2ef20c12012-08-31 10:56:22 +0800557 .args_type = "keys:s,hold-time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300558 .params = "keys [hold_ms]",
559 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100560 .mhandler.cmd = hmp_sendkey,
Hani Benhabiles29136cd2014-05-07 23:41:27 +0100561 .command_completion = sendkey_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300562 },
563
Blue Swirl23130862009-06-06 08:22:04 +0000564STEXI
565@item sendkey @var{keys}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100566@findex sendkey
Amos Kong886cc702012-08-31 10:56:20 +0800567Send @var{keys} to the guest. @var{keys} could be the name of the
568key or the raw value in hexadecimal format. Use @code{-} to press
569several keys simultaneously. Example:
Blue Swirl23130862009-06-06 08:22:04 +0000570@example
571sendkey ctrl-alt-f1
572@end example
573
574This command is useful to send keys that your graphical user interface
575intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
576ETEXI
577
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300578 {
579 .name = "system_reset",
580 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300581 .params = "",
582 .help = "reset the system",
Luiz Capitulino38d22652011-09-15 14:41:46 -0300583 .mhandler.cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300584 },
585
Blue Swirl23130862009-06-06 08:22:04 +0000586STEXI
587@item system_reset
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100588@findex system_reset
Blue Swirl23130862009-06-06 08:22:04 +0000589Reset the system.
590ETEXI
591
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300592 {
593 .name = "system_powerdown",
594 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300595 .params = "",
596 .help = "send system power down event",
Luiz Capitulino5bc465e2011-09-28 11:06:15 -0300597 .mhandler.cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300598 },
599
Blue Swirl23130862009-06-06 08:22:04 +0000600STEXI
601@item system_powerdown
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100602@findex system_powerdown
Blue Swirl23130862009-06-06 08:22:04 +0000603Power down the system (if supported).
604ETEXI
605
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300606 {
607 .name = "sum",
608 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300609 .params = "addr size",
610 .help = "compute the checksum of a memory region",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100611 .mhandler.cmd = hmp_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300612 },
613
Blue Swirl23130862009-06-06 08:22:04 +0000614STEXI
615@item sum @var{addr} @var{size}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100616@findex sum
Blue Swirl23130862009-06-06 08:22:04 +0000617Compute the checksum of a memory region.
618ETEXI
619
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300620 {
621 .name = "usb_add",
622 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300623 .params = "device",
624 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100625 .mhandler.cmd = hmp_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300626 },
627
Blue Swirl23130862009-06-06 08:22:04 +0000628STEXI
629@item usb_add @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100630@findex usb_add
Blue Swirl23130862009-06-06 08:22:04 +0000631Add the USB device @var{devname}. For details of available devices see
632@ref{usb_devices}
633ETEXI
634
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300635 {
636 .name = "usb_del",
637 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300638 .params = "device",
639 .help = "remove USB device 'bus.addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100640 .mhandler.cmd = hmp_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300641 },
642
Blue Swirl23130862009-06-06 08:22:04 +0000643STEXI
644@item usb_del @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100645@findex usb_del
Blue Swirl23130862009-06-06 08:22:04 +0000646Remove the USB device @var{devname} from the QEMU virtual USB
647hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
648command @code{info usb} to see the devices you can remove.
649ETEXI
650
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300651 {
652 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100653 .args_type = "device:O",
654 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300655 .help = "add device, like -device on the command line",
Markus Armbruster8bc27242010-02-10 20:52:01 +0100656 .user_print = monitor_user_noop,
657 .mhandler.cmd_new = do_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100658 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300659 },
660
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200661STEXI
662@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100663@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200664Add device.
665ETEXI
666
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300667 {
668 .name = "device_del",
669 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300670 .params = "device",
671 .help = "remove device",
Luiz Capitulinoa15fef22012-03-29 12:38:50 -0300672 .mhandler.cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100673 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300674 },
675
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200676STEXI
677@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100678@findex device_del
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200679Remove device @var{id}.
680ETEXI
681
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300682 {
683 .name = "cpu",
684 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300685 .params = "index",
686 .help = "set the default CPU",
Luiz Capitulino755f1962011-10-06 14:31:39 -0300687 .mhandler.cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300688 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200689
Blue Swirl23130862009-06-06 08:22:04 +0000690STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200691@item cpu @var{index}
692@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000693Set the default CPU.
694ETEXI
695
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300696 {
697 .name = "mouse_move",
698 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300699 .params = "dx dy [dz]",
700 .help = "send mouse move events",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100701 .mhandler.cmd = hmp_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300702 },
703
Blue Swirl23130862009-06-06 08:22:04 +0000704STEXI
705@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100706@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000707Move the active mouse to the specified coordinates @var{dx} @var{dy}
708with optional scroll axis @var{dz}.
709ETEXI
710
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300711 {
712 .name = "mouse_button",
713 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300714 .params = "state",
715 .help = "change mouse button state (1=L, 2=M, 4=R)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100716 .mhandler.cmd = hmp_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300717 },
718
Blue Swirl23130862009-06-06 08:22:04 +0000719STEXI
720@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100721@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000722Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
723ETEXI
724
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300725 {
726 .name = "mouse_set",
727 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300728 .params = "index",
729 .help = "set which mouse device receives events",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100730 .mhandler.cmd = hmp_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300731 },
732
Blue Swirl23130862009-06-06 08:22:04 +0000733STEXI
734@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100735@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000736Set which mouse device receives events at given @var{index}, index
737can be obtained with
738@example
739info mice
740@end example
741ETEXI
742
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300743 {
744 .name = "wavcapture",
745 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300746 .params = "path [frequency [bits [channels]]]",
747 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100748 .mhandler.cmd = hmp_wavcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300749 },
Blue Swirl23130862009-06-06 08:22:04 +0000750STEXI
751@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100752@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000753Capture audio into @var{filename}. Using sample rate @var{frequency}
754bits per sample @var{bits} and number of channels @var{channels}.
755
756Defaults:
757@itemize @minus
758@item Sample rate = 44100 Hz - CD quality
759@item Bits = 16
760@item Number of channels = 2 - Stereo
761@end itemize
762ETEXI
763
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300764 {
765 .name = "stopcapture",
766 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300767 .params = "capture index",
768 .help = "stop capture",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100769 .mhandler.cmd = hmp_stopcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300770 },
Blue Swirl23130862009-06-06 08:22:04 +0000771STEXI
772@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100773@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000774Stop capture with a given @var{index}, index can be obtained with
775@example
776info capture
777@end example
778ETEXI
779
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300780 {
781 .name = "memsave",
782 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300783 .params = "addr size file",
784 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulino0cfd6a92011-11-22 16:32:37 -0200785 .mhandler.cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300786 },
787
Blue Swirl23130862009-06-06 08:22:04 +0000788STEXI
789@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100790@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000791save to disk virtual memory dump starting at @var{addr} of size @var{size}.
792ETEXI
793
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300794 {
795 .name = "pmemsave",
796 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300797 .params = "addr size file",
798 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulino6d3962b2011-11-22 17:26:46 -0200799 .mhandler.cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300800 },
801
Blue Swirl23130862009-06-06 08:22:04 +0000802STEXI
803@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100804@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000805save to disk physical memory dump starting at @var{addr} of size @var{size}.
806ETEXI
807
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300808 {
809 .name = "boot_set",
810 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300811 .params = "bootdevice",
812 .help = "define new values for the boot device list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100813 .mhandler.cmd = hmp_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300814 },
815
Blue Swirl23130862009-06-06 08:22:04 +0000816STEXI
817@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100818@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000819Define new values for the boot device list. Those values will override
820the values specified on the command line through the @code{-boot} option.
821
822The values that can be specified here depend on the machine type, but are
823the same that can be specified in the @code{-boot} command line option.
824ETEXI
825
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300826 {
827 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300828 .args_type = "",
829 .params = "",
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000830 .help = "inject an NMI",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100831 .mhandler.cmd = hmp_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300832 },
Blue Swirl23130862009-06-06 08:22:04 +0000833STEXI
834@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100835@findex nmi
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000836Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
Lei Li1f590cf2013-01-25 00:03:20 +0800837
838ETEXI
839
840 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100841 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800842 .args_type = "device:s,data:s",
843 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100844 .help = "Write to a ring buffer character device",
845 .mhandler.cmd = hmp_ringbuf_write,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100846 .command_completion = ringbuf_write_completion,
Lei Li1f590cf2013-01-25 00:03:20 +0800847 },
848
849STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100850@item ringbuf_write @var{device} @var{data}
851@findex ringbuf_write
852Write @var{data} to ring buffer character device @var{device}.
853@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800854
Blue Swirl23130862009-06-06 08:22:04 +0000855ETEXI
856
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300857 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100858 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800859 .args_type = "device:s,size:i",
860 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100861 .help = "Read from a ring buffer character device",
862 .mhandler.cmd = hmp_ringbuf_read,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100863 .command_completion = ringbuf_write_completion,
Lei Li49b6d722013-01-25 00:03:21 +0800864 },
865
866STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100867@item ringbuf_read @var{device}
868@findex ringbuf_read
869Read and print up to @var{size} bytes from ring buffer character
870device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100871Certain non-printable characters are printed \uXXXX, where XXXX is the
872character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100873Bug: can screw up when the buffer contains invalid UTF-8 sequences,
874NUL characters, after the ring buffer lost data, and when reading
875stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800876
877ETEXI
878
879 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300880 .name = "migrate",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200881 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
882 .params = "[-d] [-b] [-i] uri",
883 .help = "migrate to URI (using -d to not wait for completion)"
884 "\n\t\t\t -b for migration without shared storage with"
885 " full copy of disk\n\t\t\t -i for migration without "
886 "shared storage with incremental copy of disk "
887 "(base image shared between src and destination)",
Luiz Capitulinoe1c37d02011-12-05 14:48:01 -0200888 .mhandler.cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300889 },
890
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200891
Blue Swirl23130862009-06-06 08:22:04 +0000892STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200893@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100894@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000895Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200896 -b for migration with full copy of disk
897 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000898ETEXI
899
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300900 {
901 .name = "migrate_cancel",
902 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300903 .params = "",
904 .help = "cancel the current VM migration",
Luiz Capitulino6cdedb02011-11-27 22:54:09 -0200905 .mhandler.cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300906 },
907
Blue Swirl23130862009-06-06 08:22:04 +0000908STEXI
909@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100910@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000911Cancel the current VM migration.
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300912
913ETEXI
914
915 {
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000916 .name = "migrate_incoming",
917 .args_type = "uri:s",
918 .params = "uri",
919 .help = "Continue an incoming migration from an -incoming defer",
920 .mhandler.cmd = hmp_migrate_incoming,
921 },
922
923STEXI
924@item migrate_incoming @var{uri}
925@findex migrate_incoming
926Continue an incoming migration using the @var{uri} (that has the same syntax
927as the -incoming option).
928
929ETEXI
930
931 {
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300932 .name = "migrate_set_cache_size",
933 .args_type = "value:o",
934 .params = "value",
935 .help = "set cache size (in bytes) for XBZRLE migrations,"
936 "the cache size will be rounded down to the nearest "
937 "power of 2.\n"
938 "The cache size affects the number of cache misses."
939 "In case of a high cache miss ratio you need to increase"
940 " the cache size",
941 .mhandler.cmd = hmp_migrate_set_cache_size,
942 },
943
944STEXI
945@item migrate_set_cache_size @var{value}
946@findex migrate_set_cache_size
947Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +0000948ETEXI
949
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300950 {
951 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200952 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300953 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200954 .help = "set maximum speed (in bytes) for migrations. "
955 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Luiz Capitulino3dc85382011-11-28 11:59:37 -0200956 .mhandler.cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300957 },
958
Blue Swirl23130862009-06-06 08:22:04 +0000959STEXI
960@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100961@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +0000962Set maximum speed to @var{value} (in bytes) for migrations.
963ETEXI
964
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300965 {
966 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +0100967 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300968 .params = "value",
969 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulino4f0a9932011-11-27 23:18:01 -0200970 .mhandler.cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300971 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400972
973STEXI
974@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100975@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -0400976Set maximum tolerated downtime (in seconds) for migration.
977ETEXI
978
Jes Sorensenf8882562010-12-16 13:52:16 +0100979 {
Orit Wasserman00458432012-08-06 21:42:48 +0300980 .name = "migrate_set_capability",
981 .args_type = "capability:s,state:b",
982 .params = "capability state",
983 .help = "Enable/Disable the usage of a capability for migration",
984 .mhandler.cmd = hmp_migrate_set_capability,
Hani Benhabilesc68a0402014-05-27 23:39:32 +0100985 .command_completion = migrate_set_capability_completion,
Orit Wasserman00458432012-08-06 21:42:48 +0300986 },
987
988STEXI
989@item migrate_set_capability @var{capability} @var{state}
990@findex migrate_set_capability
991Enable/Disable the usage of a capability @var{capability} for migration.
992ETEXI
993
994 {
Liang Li50e9a622015-03-23 16:32:29 +0800995 .name = "migrate_set_parameter",
996 .args_type = "parameter:s,value:i",
997 .params = "parameter value",
998 .help = "Set the parameter for migration",
999 .mhandler.cmd = hmp_migrate_set_parameter,
1000 .command_completion = migrate_set_parameter_completion,
1001 },
1002
1003STEXI
1004@item migrate_set_parameter @var{parameter} @var{value}
1005@findex migrate_set_parameter
1006Set the parameter @var{parameter} for migration.
1007ETEXI
1008
1009 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001010 .name = "client_migrate_info",
1011 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1012 .params = "protocol hostname port tls-port cert-subject",
Markus Armbruster13cadef2015-03-05 19:16:58 +01001013 .help = "set migration information for remote display",
Markus Armbrusterb8a185b2015-03-05 17:29:02 +01001014 .mhandler.cmd = hmp_client_migrate_info,
Jes Sorensenf8882562010-12-16 13:52:16 +01001015 },
1016
1017STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001018@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1019@findex client_migrate_info
Markus Armbruster13cadef2015-03-05 19:16:58 +01001020Set migration information for remote display. This makes the server
1021ask the client to automatically reconnect using the new parameters
1022once migration finished successfully. Only implemented for SPICE.
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001023ETEXI
1024
Wen Congyang783e9b42012-05-07 12:10:47 +08001025 {
1026 .name = "dump-guest-memory",
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001027 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1028 .params = "[-p] [-z|-l|-s] filename [begin length]",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001029 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1030 "-p: do paging to get guest's memory mapping.\n\t\t\t"
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001031 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1032 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1033 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001034 "begin: the starting physical address.\n\t\t\t"
1035 "length: the memory size, in bytes.",
Wen Congyang783e9b42012-05-07 12:10:47 +08001036 .mhandler.cmd = hmp_dump_guest_memory,
1037 },
1038
1039
1040STEXI
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001041@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001042@item dump-guest-memory [-z|-l|-s] @var{filename}
Wen Congyang783e9b42012-05-07 12:10:47 +08001043@findex dump-guest-memory
1044Dump guest memory to @var{protocol}. The file can be processed with crash or
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001045gdb. Without -z|-l|-s, the dump format is ELF.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001046 -p: do paging to get guest's memory mapping.
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001047 -z: dump in kdump-compressed format, with zlib compression.
1048 -l: dump in kdump-compressed format, with lzo compression.
1049 -s: dump in kdump-compressed format, with snappy compression.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001050 filename: dump file name.
Wen Congyang783e9b42012-05-07 12:10:47 +08001051 begin: the starting physical address. It's optional, and should be
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001052 specified together with length.
Wen Congyang783e9b42012-05-07 12:10:47 +08001053 length: the memory size, in bytes. It's optional, and should be specified
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001054 together with begin.
Wen Congyang783e9b42012-05-07 12:10:47 +08001055ETEXI
Wen Congyang783e9b42012-05-07 12:10:47 +08001056
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001057 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001058 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001059 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1060 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001061 .help = "initiates a live snapshot\n\t\t\t"
1062 "of device. If a new image file is specified, the\n\t\t\t"
1063 "new image file will become the new root image.\n\t\t\t"
1064 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001065 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001066 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1067 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1068 "recreating it from scratch.",
Luiz Capitulino6106e242011-11-25 16:15:19 -02001069 .mhandler.cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001070 },
1071
1072STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001073@item snapshot_blkdev
1074@findex snapshot_blkdev
1075Snapshot device, using snapshot file as target if provided
1076ETEXI
1077
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001078 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001079 .name = "snapshot_blkdev_internal",
1080 .args_type = "device:B,name:s",
1081 .params = "device name",
1082 .help = "take an internal snapshot of device.\n\t\t\t"
1083 "The format of the image used by device must\n\t\t\t"
1084 "support it, such as qcow2.\n\t\t\t",
1085 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1086 },
1087
1088STEXI
1089@item snapshot_blkdev_internal
1090@findex snapshot_blkdev_internal
1091Take an internal snapshot on device if it support
1092ETEXI
1093
1094 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001095 .name = "snapshot_delete_blkdev_internal",
1096 .args_type = "device:B,name:s,id:s?",
1097 .params = "device name [id]",
1098 .help = "delete an internal snapshot of device.\n\t\t\t"
1099 "If id is specified, qemu will try delete\n\t\t\t"
1100 "the snapshot matching both id and name.\n\t\t\t"
1101 "The format of the image used by device must\n\t\t\t"
1102 "support it, such as qcow2.\n\t\t\t",
1103 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1104 },
1105
1106STEXI
1107@item snapshot_delete_blkdev_internal
1108@findex snapshot_delete_blkdev_internal
1109Delete an internal snapshot on device if it support
1110ETEXI
1111
1112 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001113 .name = "drive_mirror",
1114 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1115 .params = "[-n] [-f] device target [format]",
1116 .help = "initiates live storage\n\t\t\t"
1117 "migration for a device. The device's contents are\n\t\t\t"
1118 "copied to the new image file, including data that\n\t\t\t"
1119 "is written after the command is started.\n\t\t\t"
1120 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1121 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1122 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1123 "so that the result does not need a backing file.\n\t\t\t",
1124 .mhandler.cmd = hmp_drive_mirror,
1125 },
1126STEXI
1127@item drive_mirror
1128@findex drive_mirror
1129Start mirroring a block device's writes to a new destination,
1130using the specified target.
1131ETEXI
1132
1133 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001134 .name = "drive_backup",
1135 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1136 .params = "[-n] [-f] device target [format]",
1137 .help = "initiates a point-in-time\n\t\t\t"
1138 "copy for a device. The device's contents are\n\t\t\t"
1139 "copied to the new image file, excluding data that\n\t\t\t"
1140 "is written after the command is started.\n\t\t\t"
1141 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1142 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1143 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1144 "so that the result does not need a backing file.\n\t\t\t",
1145 .mhandler.cmd = hmp_drive_backup,
1146 },
1147STEXI
1148@item drive_backup
1149@findex drive_backup
1150Start a point-in-time copy of a block device to a specificed target.
1151ETEXI
1152
1153 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001154 .name = "drive_add",
1155 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001156 .params = "[[<domain>:]<bus>:]<slot>\n"
1157 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001158 "[,unit=m][,media=d][,index=i]\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001159 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001160 "[,snapshot=on|off][,cache=on|off]\n"
1161 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001162 .help = "add drive to PCI storage controller",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001163 .mhandler.cmd = hmp_drive_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001164 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001165
Blue Swirl23130862009-06-06 08:22:04 +00001166STEXI
1167@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001168@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001169Add drive to PCI storage controller.
1170ETEXI
1171
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001172 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001173 .name = "pcie_aer_inject_error",
1174 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1175 "id:s,error_status:s,"
1176 "header0:i?,header1:i?,header2:i?,header3:i?,"
1177 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1178 .params = "[-a] [-c] id "
1179 "<error_status> [<tlp header> [<tlp header prefix>]]",
1180 .help = "inject pcie aer error\n\t\t\t"
1181 " -a for advisory non fatal error\n\t\t\t"
1182 " -c for correctable error\n\t\t\t"
1183 "<id> = qdev device id\n\t\t\t"
1184 "<error_status> = error string or 32bit\n\t\t\t"
1185 "<tlb header> = 32bit x 4\n\t\t\t"
1186 "<tlb header prefix> = 32bit x 4",
1187 .user_print = pcie_aer_inject_error_print,
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001188 .mhandler.cmd_new = hmp_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001189 },
1190
1191STEXI
1192@item pcie_aer_inject_error
1193@findex pcie_aer_inject_error
1194Inject PCIe AER error
1195ETEXI
1196
1197 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001198 .name = "host_net_add",
1199 .args_type = "device:s,opts:s?",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001200 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001201 .help = "add host VLAN client",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001202 .mhandler.cmd = hmp_host_net_add,
Hani Benhabilese3bb5322014-05-27 23:39:34 +01001203 .command_completion = host_net_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001204 },
1205
Blue Swirl23130862009-06-06 08:22:04 +00001206STEXI
1207@item host_net_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001208@findex host_net_add
Blue Swirl23130862009-06-06 08:22:04 +00001209Add host VLAN client.
1210ETEXI
1211
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001212 {
1213 .name = "host_net_remove",
1214 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001215 .params = "vlan_id name",
1216 .help = "remove host VLAN client",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001217 .mhandler.cmd = hmp_host_net_remove,
Hani Benhabilesddd6b452014-05-27 23:39:36 +01001218 .command_completion = host_net_remove_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001219 },
1220
Blue Swirl23130862009-06-06 08:22:04 +00001221STEXI
1222@item host_net_remove
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001223@findex host_net_remove
Blue Swirl23130862009-06-06 08:22:04 +00001224Remove host VLAN client.
1225ETEXI
1226
Markus Armbrusterae82d322010-03-25 17:22:40 +01001227 {
1228 .name = "netdev_add",
1229 .args_type = "netdev:O",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001230 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001231 .help = "add host network device",
Luiz Capitulino928059a2012-04-18 17:34:15 -03001232 .mhandler.cmd = hmp_netdev_add,
Hani Benhabilesb162b492014-05-07 23:41:31 +01001233 .command_completion = netdev_add_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001234 },
1235
1236STEXI
1237@item netdev_add
1238@findex netdev_add
1239Add host network device.
1240ETEXI
1241
1242 {
1243 .name = "netdev_del",
1244 .args_type = "id:s",
1245 .params = "id",
1246 .help = "remove host network device",
Luiz Capitulino5f964152012-04-16 14:36:32 -03001247 .mhandler.cmd = hmp_netdev_del,
Hani Benhabiles11b389f2014-05-07 23:41:32 +01001248 .command_completion = netdev_del_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001249 },
1250
1251STEXI
1252@item netdev_del
1253@findex netdev_del
1254Remove host network device.
1255ETEXI
1256
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001257 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001258 .name = "object_add",
1259 .args_type = "object:O",
1260 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1261 .help = "create QOM object",
1262 .mhandler.cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001263 .command_completion = object_add_completion,
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001264 },
1265
1266STEXI
1267@item object_add
1268@findex object_add
1269Create QOM object.
1270ETEXI
1271
1272 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001273 .name = "object_del",
1274 .args_type = "id:s",
1275 .params = "id",
1276 .help = "destroy QOM object",
1277 .mhandler.cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001278 .command_completion = object_del_completion,
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001279 },
1280
1281STEXI
1282@item object_del
1283@findex object_del
1284Destroy QOM object.
1285ETEXI
1286
Blue Swirl23130862009-06-06 08:22:04 +00001287#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001288 {
1289 .name = "hostfwd_add",
1290 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001291 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1292 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001293 .mhandler.cmd = hmp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001294 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001295#endif
1296STEXI
1297@item hostfwd_add
1298@findex hostfwd_add
1299Redirect TCP or UDP connections from host to guest (requires -net user).
1300ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001301
Markus Armbruster21413d62010-05-04 13:20:30 +02001302#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001303 {
1304 .name = "hostfwd_remove",
1305 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001306 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1307 .help = "remove host-to-guest TCP or UDP redirection",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001308 .mhandler.cmd = hmp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001309 },
1310
Blue Swirl23130862009-06-06 08:22:04 +00001311#endif
1312STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001313@item hostfwd_remove
1314@findex hostfwd_remove
1315Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001316ETEXI
1317
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001318 {
1319 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001320 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001321 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001322 .help = "request VM to change its memory allocation (in MB)",
Luiz Capitulinod72f3262011-11-25 14:38:09 -02001323 .mhandler.cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001324 },
1325
Blue Swirl23130862009-06-06 08:22:04 +00001326STEXI
1327@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001328@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001329Request VM to change its memory allocation to @var{value} (in MB).
1330ETEXI
1331
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001332 {
1333 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001334 .args_type = "name:s,up:b",
1335 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001336 .help = "change the link status of a network adapter",
Luiz Capitulino4b371562011-11-23 13:11:55 -02001337 .mhandler.cmd = hmp_set_link,
Hani Benhabiles40d19392014-05-07 23:41:30 +01001338 .command_completion = set_link_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001339 },
1340
Blue Swirl23130862009-06-06 08:22:04 +00001341STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001342@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001343@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001344Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001345ETEXI
1346
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001347 {
1348 .name = "watchdog_action",
1349 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001350 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1351 .help = "change watchdog action",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001352 .mhandler.cmd = hmp_watchdog_action,
Hani Benhabilesd0ece342014-05-27 23:39:31 +01001353 .command_completion = watchdog_action_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001354 },
1355
Blue Swirl23130862009-06-06 08:22:04 +00001356STEXI
1357@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001358@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001359Change watchdog action.
1360ETEXI
1361
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001362 {
1363 .name = "acl_show",
1364 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001365 .params = "aclname",
1366 .help = "list rules in the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001367 .mhandler.cmd = hmp_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001368 },
1369
Blue Swirl23130862009-06-06 08:22:04 +00001370STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001371@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001372@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001373List all the matching rules in the access control list, and the default
1374policy. There are currently two named access control lists,
1375@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1376certificate distinguished name, and SASL username respectively.
1377ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001378
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001379 {
1380 .name = "acl_policy",
1381 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001382 .params = "aclname allow|deny",
1383 .help = "set default access control list policy",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001384 .mhandler.cmd = hmp_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001385 },
1386
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001387STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001388@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001389@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001390Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001391none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001392always @code{deny}.
1393ETEXI
1394
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001395 {
1396 .name = "acl_add",
1397 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001398 .params = "aclname match allow|deny [index]",
1399 .help = "add a match rule to the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001400 .mhandler.cmd = hmp_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001401 },
1402
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001403STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001404@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1405@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001406Add a match rule to the access control list, allowing or denying access.
1407The match will normally be an exact username or x509 distinguished name,
1408but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1409allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001410normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001411earlier in the list if the optional @var{index} parameter is supplied.
1412ETEXI
1413
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001414 {
1415 .name = "acl_remove",
1416 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001417 .params = "aclname match",
1418 .help = "remove a match rule from the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001419 .mhandler.cmd = hmp_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001420 },
1421
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001422STEXI
1423@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001424@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001425Remove the specified match rule from the access control list.
1426ETEXI
1427
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001428 {
1429 .name = "acl_reset",
1430 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001431 .params = "aclname",
1432 .help = "reset the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001433 .mhandler.cmd = hmp_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001434 },
1435
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001436STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001437@item acl_reset @var{aclname}
1438@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001439Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001440policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001441ETEXI
1442
Paolo Bonzini40577252012-08-23 11:53:04 +02001443 {
1444 .name = "nbd_server_start",
1445 .args_type = "all:-a,writable:-w,uri:s",
1446 .params = "nbd_server_start [-a] [-w] host:port",
1447 .help = "serve block devices on the given host and port",
1448 .mhandler.cmd = hmp_nbd_server_start,
1449 },
1450STEXI
1451@item nbd_server_start @var{host}:@var{port}
1452@findex nbd_server_start
1453Start an NBD server on the given host and/or port. If the @option{-a}
1454option is included, all of the virtual machine's block devices that
1455have an inserted media on them are automatically exported; in this case,
1456the @option{-w} option makes the devices writable too.
1457ETEXI
1458
1459 {
1460 .name = "nbd_server_add",
1461 .args_type = "writable:-w,device:B",
1462 .params = "nbd_server_add [-w] device",
1463 .help = "export a block device via NBD",
1464 .mhandler.cmd = hmp_nbd_server_add,
1465 },
1466STEXI
1467@item nbd_server_add @var{device}
1468@findex nbd_server_add
1469Export a block device through QEMU's NBD server, which must be started
1470beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1471exported device writable too.
1472ETEXI
1473
1474 {
1475 .name = "nbd_server_stop",
1476 .args_type = "",
1477 .params = "nbd_server_stop",
1478 .help = "stop serving block devices using the NBD protocol",
1479 .mhandler.cmd = hmp_nbd_server_stop,
1480 },
1481STEXI
1482@item nbd_server_stop
1483@findex nbd_server_stop
1484Stop the QEMU embedded NBD server.
1485ETEXI
1486
1487
Huang Ying79c4f6b2009-06-23 10:05:14 +08001488#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001489
1490 {
1491 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001492 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1493 .params = "[-b] cpu bank status mcgstatus addr misc",
1494 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001495 .mhandler.cmd = hmp_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001496 },
1497
Huang Ying79c4f6b2009-06-23 10:05:14 +08001498#endif
1499STEXI
1500@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001501@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001502Inject an MCE on the given CPU (x86 only).
1503ETEXI
1504
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001505 {
1506 .name = "getfd",
1507 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001508 .params = "getfd name",
1509 .help = "receive a file descriptor via SCM rights and assign it a name",
Corey Bryant208c9d12012-06-22 14:36:09 -04001510 .mhandler.cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001511 },
1512
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001513STEXI
1514@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001515@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001516If a file descriptor is passed alongside this command using the SCM_RIGHTS
1517mechanism on unix sockets, it is stored using the name @var{fdname} for
1518later use by other monitor commands.
1519ETEXI
1520
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001521 {
1522 .name = "closefd",
1523 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001524 .params = "closefd name",
1525 .help = "close a file descriptor previously passed via SCM rights",
Corey Bryant208c9d12012-06-22 14:36:09 -04001526 .mhandler.cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001527 },
1528
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001529STEXI
1530@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001531@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001532Close the file descriptor previously assigned to @var{fdname} using the
1533@code{getfd} command. This is only needed if the file descriptor was never
1534used by another monitor command.
1535ETEXI
1536
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001537 {
1538 .name = "block_passwd",
1539 .args_type = "device:B,password:s",
1540 .params = "block_passwd device password",
1541 .help = "set the password of encrypted block devices",
Luiz Capitulinoa4dea8a2011-11-23 13:28:21 -02001542 .mhandler.cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001543 },
1544
1545STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001546@item block_passwd @var{device} @var{password}
1547@findex block_passwd
1548Set the encrypted device @var{device} password to @var{password}
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001549ETEXI
1550
1551 {
1552 .name = "block_set_io_throttle",
1553 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1554 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1555 .help = "change I/O throttle limits for a block drive",
Luiz Capitulino80047da2011-12-14 16:49:14 -02001556 .mhandler.cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001557 },
1558
1559STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001560@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1561@findex block_set_io_throttle
1562Change 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 -02001563ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001564
Jan Kiszka33572ec2010-05-31 14:43:30 -03001565 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001566 .name = "set_password",
1567 .args_type = "protocol:s,password:s,connected:s?",
1568 .params = "protocol password action-if-connected",
1569 .help = "set spice/vnc password",
Luiz Capitulinofbf796f2011-12-07 11:17:51 -02001570 .mhandler.cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001571 },
1572
1573STEXI
1574@item set_password [ vnc | spice ] password [ action-if-connected ]
1575@findex set_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001576Change spice/vnc password. Use zero to make the password stay valid
1577forever. @var{action-if-connected} specifies what should happen in
1578case a connection is established: @var{fail} makes the password change
1579fail. @var{disconnect} changes the password and disconnects the
1580client. @var{keep} changes the password and keeps the connection up.
1581@var{keep} is the default.
1582ETEXI
1583
1584 {
1585 .name = "expire_password",
1586 .args_type = "protocol:s,time:s",
1587 .params = "protocol time",
1588 .help = "set spice/vnc password expire-time",
Luiz Capitulino9ad53722011-12-07 11:47:57 -02001589 .mhandler.cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001590 },
1591
1592STEXI
1593@item expire_password [ vnc | spice ] expire-time
1594@findex expire_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001595Specify when a password for spice/vnc becomes
1596invalid. @var{expire-time} accepts:
1597
1598@table @var
1599@item now
1600Invalidate password instantly.
1601
1602@item never
1603Password stays valid forever.
1604
1605@item +nsec
1606Password stays valid for @var{nsec} seconds starting now.
1607
1608@item nsec
1609Password is invalidated at the given time. @var{nsec} are the seconds
1610passed since 1970, i.e. unix epoch.
1611
1612@end table
1613ETEXI
1614
Gerd Hoffmann46920822013-02-28 08:46:10 +01001615 {
1616 .name = "chardev-add",
1617 .args_type = "args:s",
1618 .params = "args",
1619 .help = "add chardev",
1620 .mhandler.cmd = hmp_chardev_add,
Hani Benhabiles13e315d2014-05-07 23:41:29 +01001621 .command_completion = chardev_add_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001622 },
1623
1624STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001625@item chardev-add args
1626@findex chardev-add
Gerd Hoffmann46920822013-02-28 08:46:10 +01001627chardev_add accepts the same parameters as the -chardev command line switch.
1628
1629ETEXI
1630
1631 {
1632 .name = "chardev-remove",
1633 .args_type = "id:s",
1634 .params = "id",
1635 .help = "remove chardev",
1636 .mhandler.cmd = hmp_chardev_remove,
Hani Benhabiles6297d9a2014-05-07 23:41:28 +01001637 .command_completion = chardev_remove_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001638 },
1639
1640STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001641@item chardev-remove id
1642@findex chardev-remove
Gerd Hoffmann46920822013-02-28 08:46:10 +01001643Removes the chardev @var{id}.
1644
1645ETEXI
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001646
1647 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001648 .name = "qemu-io",
1649 .args_type = "device:B,command:s",
1650 .params = "[device] \"[command]\"",
1651 .help = "run a qemu-io command on a block device",
1652 .mhandler.cmd = hmp_qemu_io,
1653 },
1654
1655STEXI
1656@item qemu-io @var{device} @var{command}
1657@findex qemu-io
Kevin Wolf587da2c2013-06-05 14:19:41 +02001658Executes a qemu-io command on the given block device.
1659
1660ETEXI
1661
1662 {
Jason J. Herneabf23322013-12-11 13:24:14 -05001663 .name = "cpu-add",
1664 .args_type = "id:i",
1665 .params = "id",
1666 .help = "add cpu",
1667 .mhandler.cmd = hmp_cpu_add,
1668 },
1669
1670STEXI
1671@item cpu-add @var{id}
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001672@findex cpu-add
Jason J. Herneabf23322013-12-11 13:24:14 -05001673Add CPU with id @var{id}
1674ETEXI
1675
1676 {
Andreas Färber89d7fa92014-05-07 18:08:29 +02001677 .name = "qom-list",
1678 .args_type = "path:s?",
1679 .params = "path",
1680 .help = "list QOM properties",
1681 .mhandler.cmd = hmp_qom_list,
1682 },
1683
1684STEXI
1685@item qom-list [@var{path}]
1686Print QOM properties of object at location @var{path}
1687ETEXI
1688
1689 {
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001690 .name = "qom-set",
1691 .args_type = "path:s,property:s,value:s",
1692 .params = "path property value",
1693 .help = "set QOM property",
1694 .mhandler.cmd = hmp_qom_set,
1695 },
1696
1697STEXI
1698@item qom-set @var{path} @var{property} @var{value}
1699Set QOM property @var{property} of object at location @var{path} to value @var{value}
1700ETEXI
1701
1702 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001703 .name = "info",
1704 .args_type = "item:s?",
1705 .params = "[subcommand]",
1706 .help = "show various information about the system state",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001707 .mhandler.cmd = hmp_info_help,
Wenchao Xia84c44612013-01-14 14:06:29 +08001708 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001709 },
1710
1711STEXI
1712@item info @var{subcommand}
1713@findex info
1714Show various information about the system state.
1715
1716@table @option
1717@item info version
1718show the version of QEMU
Jan Kiszka33572ec2010-05-31 14:43:30 -03001719@item info network
1720show the various VLANs and the associated devices
1721@item info chardev
1722show the character devices
1723@item info block
1724show the block devices
1725@item info blockstats
1726show block device statistics
1727@item info registers
1728show the cpu registers
1729@item info cpus
1730show infos for each CPU
1731@item info history
1732show the command line history
1733@item info irq
1734show the interrupts statistics (if available)
1735@item info pic
1736show i8259 (PIC) state
1737@item info pci
1738show emulated PCI device info
1739@item info tlb
Max Filippov692f7372012-01-07 20:02:40 +04001740show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001741@item info mem
1742show the active virtual memory mappings (i386 only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001743@item info jit
1744show dynamic compiler info
Jan Kiszka33572ec2010-05-31 14:43:30 -03001745@item info numa
1746show NUMA information
Jan Kiszkab40292e2010-05-31 14:43:31 -03001747@item info kvm
1748show KVM information
Jan Kiszka33572ec2010-05-31 14:43:30 -03001749@item info usb
1750show USB devices plugged on the virtual USB hub
1751@item info usbhost
1752show all USB host devices
1753@item info profile
1754show profiling information
1755@item info capture
1756show information about active capturing
1757@item info snapshots
1758show list of VM snapshots
1759@item info status
1760show the current VM status (running|paused)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001761@item info mice
1762show which guest mouse is receiving events
1763@item info vnc
1764show the vnc server status
1765@item info name
1766show the current VM name
1767@item info uuid
1768show the current VM UUID
1769@item info cpustats
1770show CPU statistics
1771@item info usernet
1772show user network stack connection states
1773@item info migrate
1774show migration status
Orit Wassermanbbf6da32012-08-06 21:42:47 +03001775@item info migrate_capabilities
1776show current migration capabilities
Liang Li50e9a622015-03-23 16:32:29 +08001777@item info migrate_parameters
1778show current migration parameters
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +03001779@item info migrate_cache_size
1780show current migration XBZRLE cache size
Jan Kiszka33572ec2010-05-31 14:43:30 -03001781@item info balloon
1782show balloon information
1783@item info qtree
1784show device tree
1785@item info qdm
1786show qdev device model list
Andreas Färbera01ff752014-05-07 17:03:18 +02001787@item info qom-tree
1788show object composition tree
Jan Kiszka33572ec2010-05-31 14:43:30 -03001789@item info roms
1790show roms
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05001791@item info tpm
1792show the TPM device
Zhu Guihuaa6318922014-09-23 13:35:19 +08001793@item info memory-devices
1794show the memory devices
Jan Kiszka33572ec2010-05-31 14:43:30 -03001795@end table
1796ETEXI
1797
Lluís31965ae2011-08-31 20:31:24 +02001798STEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301799@item info trace-events
1800show available trace events and their state
1801ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301802
Blue Swirl23130862009-06-06 08:22:04 +00001803STEXI
1804@end table
1805ETEXI