blob: 527fa2dc1afe95898113f0bda4489bcef642e9c0 [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 Capitulinob223f352009-10-07 13:41:56 -030050 .user_print = monitor_user_noop,
Luiz Capitulino7a7f3252011-09-15 14:20:28 -030051 .mhandler.cmd = hmp_quit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030052 },
53
Blue Swirl23130862009-06-06 08:22:04 +000054STEXI
55@item q or quit
Stefan Weil70fcbbe2010-02-05 23:52:04 +010056@findex quit
Blue Swirl23130862009-06-06 08:22:04 +000057Quit the emulator.
58ETEXI
59
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030060 {
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010061 .name = "block_resize",
62 .args_type = "device:B,size:o",
63 .params = "device size",
64 .help = "resize a block image",
Luiz Capitulino5e7caac2011-11-25 14:57:10 -020065 .mhandler.cmd = hmp_block_resize,
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010066 },
67
68STEXI
69@item block_resize
70@findex block_resize
71Resize a block image while a guest is running. Usually requires guest
72action to see the updated size. Resize to a lower size is supported,
73but should be used with extreme caution. Note that this command only
74resizes image files, it can not resize block devices like LVM volumes.
75ETEXI
76
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000077 {
78 .name = "block_stream",
Stefan Hajnoczic83c66c2012-04-25 16:51:03 +010079 .args_type = "device:B,speed:o?,base:s?",
80 .params = "device [speed [base]]",
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000081 .help = "copy data from a backing file into a block device",
82 .mhandler.cmd = hmp_block_stream,
83 },
84
85STEXI
86@item block_stream
87@findex block_stream
88Copy data from a backing file into a block device.
89ETEXI
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010090
91 {
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000092 .name = "block_job_set_speed",
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +010093 .args_type = "device:B,speed:o",
94 .params = "device speed",
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000095 .help = "set maximum speed for a background block operation",
96 .mhandler.cmd = hmp_block_job_set_speed,
97 },
98
99STEXI
Paolo Bonzini4451b792012-04-13 12:03:46 +0200100@item block_job_set_speed
101@findex block_job_set_speed
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +0000102Set maximum speed for a background block operation.
103ETEXI
104
105 {
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000106 .name = "block_job_cancel",
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200107 .args_type = "force:-f,device:B",
108 .params = "[-f] device",
109 .help = "stop an active background block operation (use -f"
110 "\n\t\t\t if the operation is currently paused)",
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000111 .mhandler.cmd = hmp_block_job_cancel,
112 },
113
114STEXI
115@item block_job_cancel
116@findex block_job_cancel
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200117Stop an active background block operation (streaming, mirroring).
118ETEXI
119
120 {
121 .name = "block_job_complete",
122 .args_type = "device:B",
123 .params = "device",
124 .help = "stop an active background block operation",
125 .mhandler.cmd = hmp_block_job_complete,
126 },
127
128STEXI
129@item block_job_complete
130@findex block_job_complete
131Manually trigger completion of an active background block operation.
132For mirroring, this will switch the device to the destination path.
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000133ETEXI
134
135 {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200136 .name = "block_job_pause",
137 .args_type = "device:B",
138 .params = "device",
139 .help = "pause an active background block operation",
140 .mhandler.cmd = hmp_block_job_pause,
141 },
142
143STEXI
144@item block_job_pause
145@findex block_job_pause
146Pause an active block streaming operation.
147ETEXI
148
149 {
150 .name = "block_job_resume",
151 .args_type = "device:B",
152 .params = "device",
153 .help = "resume a paused background block operation",
154 .mhandler.cmd = hmp_block_job_resume,
155 },
156
157STEXI
158@item block_job_resume
159@findex block_job_resume
160Resume a paused block streaming operation.
161ETEXI
162
163 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300164 .name = "eject",
Luiz Capitulino78d714e2009-12-14 18:53:21 -0200165 .args_type = "force:-f,device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300166 .params = "[-f] device",
167 .help = "eject a removable medium (use -f to force it)",
Luiz Capitulinoc245b6a2011-12-07 16:02:36 -0200168 .mhandler.cmd = hmp_eject,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300169 },
170
Blue Swirl23130862009-06-06 08:22:04 +0000171STEXI
172@item eject [-f] @var{device}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100173@findex eject
Blue Swirl23130862009-06-06 08:22:04 +0000174Eject a removable medium (use -f to force it).
175ETEXI
176
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300177 {
Ryan Harper9063f812010-11-12 11:07:13 -0600178 .name = "drive_del",
Hani Benhabilesf7bdc412014-04-13 16:25:05 +0100179 .args_type = "id:B",
Ryan Harper9063f812010-11-12 11:07:13 -0600180 .params = "device",
181 .help = "remove host block device",
182 .user_print = monitor_user_noop,
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100183 .mhandler.cmd_new = hmp_drive_del,
Ryan Harper9063f812010-11-12 11:07:13 -0600184 },
185
186STEXI
187@item drive_del @var{device}
188@findex drive_del
189Remove host block device. The result is that guest generated IO is no longer
190submitted against the host device underlying the disk. Once a drive has
191been deleted, the QEMU Block layer returns -EIO which results in IO
192errors in the guest for applications that are reading/writing to the device.
Stefan Hajnoczi293c51a2013-06-05 10:33:14 +0200193These errors are always reported to the guest, regardless of the drive's error
194actions (drive options rerror, werror).
Ryan Harper9063f812010-11-12 11:07:13 -0600195ETEXI
196
197 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300198 .name = "change",
199 .args_type = "device:B,target:F,arg:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300200 .params = "device filename [format]",
201 .help = "change a removable medium, optional format",
Luiz Capitulino333a96e2011-12-08 11:13:50 -0200202 .mhandler.cmd = hmp_change,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300203 },
204
Blue Swirl23130862009-06-06 08:22:04 +0000205STEXI
206@item change @var{device} @var{setting}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100207@findex change
Blue Swirl23130862009-06-06 08:22:04 +0000208
209Change the configuration of a device.
210
211@table @option
212@item change @var{diskdevice} @var{filename} [@var{format}]
213Change the medium for a removable disk device to point to @var{filename}. eg
214
215@example
216(qemu) change ide1-cd0 /path/to/some.iso
217@end example
218
219@var{format} is optional.
220
221@item change vnc @var{display},@var{options}
222Change the configuration of the VNC server. The valid syntax for @var{display}
223and @var{options} are described at @ref{sec_invocation}. eg
224
225@example
226(qemu) change vnc localhost:1
227@end example
228
229@item change vnc password [@var{password}]
230
231Change the password associated with the VNC server. If the new password is not
232supplied, the monitor will prompt for it to be entered. VNC passwords are only
233significant up to 8 letters. eg
234
235@example
236(qemu) change vnc password
237Password: ********
238@end example
239
240@end table
241ETEXI
242
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300243 {
244 .name = "screendump",
245 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300246 .params = "filename",
247 .help = "save screen into PPM image 'filename'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100248 .mhandler.cmd = hmp_screendump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300249 },
250
Blue Swirl23130862009-06-06 08:22:04 +0000251STEXI
252@item screendump @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100253@findex screendump
Blue Swirl23130862009-06-06 08:22:04 +0000254Save screen into PPM image @var{filename}.
255ETEXI
256
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300257 {
258 .name = "logfile",
259 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300260 .params = "filename",
261 .help = "output logs to 'filename'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100262 .mhandler.cmd = hmp_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300263 },
264
Blue Swirl23130862009-06-06 08:22:04 +0000265STEXI
266@item logfile @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100267@findex logfile
Blue Swirl23130862009-06-06 08:22:04 +0000268Output logs to @var{filename}.
269ETEXI
270
Prerna Saxena22890ab2010-06-24 17:04:53 +0530271 {
272 .name = "trace-event",
273 .args_type = "name:s,option:b",
274 .params = "name on|off",
275 .help = "changes status of a specific trace event",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100276 .mhandler.cmd = hmp_trace_event,
Prerna Saxena22890ab2010-06-24 17:04:53 +0530277 },
278
279STEXI
280@item trace-event
281@findex trace-event
282changes status of a trace event
283ETEXI
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100284
Michael Rothc45a8162011-10-02 08:44:37 -0500285#if defined(CONFIG_TRACE_SIMPLE)
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100286 {
287 .name = "trace-file",
288 .args_type = "op:s?,arg:F?",
289 .params = "on|off|flush|set [arg]",
290 .help = "open, close, or flush trace file, or set a new file name",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100291 .mhandler.cmd = hmp_trace_file,
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100292 },
293
294STEXI
295@item trace-file on|off|flush
296@findex trace-file
297Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
298ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +0530299#endif
300
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300301 {
302 .name = "log",
303 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300304 .params = "item1[,...]",
Peter Maydell989b6972013-02-26 17:52:40 +0000305 .help = "activate logging of the specified items",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100306 .mhandler.cmd = hmp_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300307 },
308
Blue Swirl23130862009-06-06 08:22:04 +0000309STEXI
310@item log @var{item1}[,...]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100311@findex log
Peter Maydell989b6972013-02-26 17:52:40 +0000312Activate logging of the specified items.
Blue Swirl23130862009-06-06 08:22:04 +0000313ETEXI
314
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300315 {
316 .name = "savevm",
317 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300318 .params = "[tag|id]",
319 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100320 .mhandler.cmd = hmp_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300321 },
322
Blue Swirl23130862009-06-06 08:22:04 +0000323STEXI
324@item savevm [@var{tag}|@var{id}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100325@findex savevm
Blue Swirl23130862009-06-06 08:22:04 +0000326Create a snapshot of the whole virtual machine. If @var{tag} is
327provided, it is used as human readable identifier. If there is already
328a snapshot with the same tag or ID, it is replaced. More info at
329@ref{vm_snapshots}.
330ETEXI
331
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300332 {
333 .name = "loadvm",
334 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300335 .params = "tag|id",
336 .help = "restore a VM snapshot from its tag or id",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100337 .mhandler.cmd = hmp_loadvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100338 .command_completion = loadvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300339 },
340
Blue Swirl23130862009-06-06 08:22:04 +0000341STEXI
342@item loadvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100343@findex loadvm
Blue Swirl23130862009-06-06 08:22:04 +0000344Set the whole virtual machine to the snapshot identified by the tag
345@var{tag} or the unique snapshot ID @var{id}.
346ETEXI
347
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300348 {
349 .name = "delvm",
350 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300351 .params = "tag|id",
352 .help = "delete a VM snapshot from its tag or id",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100353 .mhandler.cmd = hmp_delvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100354 .command_completion = delvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300355 },
356
Blue Swirl23130862009-06-06 08:22:04 +0000357STEXI
358@item delvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100359@findex delvm
Blue Swirl23130862009-06-06 08:22:04 +0000360Delete the snapshot identified by @var{tag} or @var{id}.
361ETEXI
362
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300363 {
364 .name = "singlestep",
365 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300366 .params = "[on|off]",
367 .help = "run emulation in singlestep mode or switch to normal mode",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100368 .mhandler.cmd = hmp_singlestep,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300369 },
370
Blue Swirl23130862009-06-06 08:22:04 +0000371STEXI
372@item singlestep [off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100373@findex singlestep
Blue Swirl23130862009-06-06 08:22:04 +0000374Run the emulation in single step mode.
375If called with option off, the emulation returns to normal mode.
376ETEXI
377
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300378 {
379 .name = "stop",
380 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300381 .params = "",
382 .help = "stop emulation",
Luiz Capitulino5f158f22011-09-15 14:34:39 -0300383 .mhandler.cmd = hmp_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300384 },
385
Blue Swirl23130862009-06-06 08:22:04 +0000386STEXI
387@item stop
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100388@findex stop
Blue Swirl23130862009-06-06 08:22:04 +0000389Stop emulation.
390ETEXI
391
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300392 {
393 .name = "c|cont",
394 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300395 .params = "",
396 .help = "resume emulation",
Luiz Capitulinoe42e8182011-11-22 17:58:31 -0200397 .mhandler.cmd = hmp_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300398 },
399
Blue Swirl23130862009-06-06 08:22:04 +0000400STEXI
401@item c or cont
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100402@findex cont
Blue Swirl23130862009-06-06 08:22:04 +0000403Resume emulation.
404ETEXI
405
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300406 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100407 .name = "system_wakeup",
408 .args_type = "",
409 .params = "",
410 .help = "wakeup guest from suspend",
411 .mhandler.cmd = hmp_system_wakeup,
412 },
413
414STEXI
415@item system_wakeup
416@findex system_wakeup
417Wakeup guest from suspend.
418ETEXI
419
420 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300421 .name = "gdbserver",
422 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300423 .params = "[device]",
424 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100425 .mhandler.cmd = hmp_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300426 },
427
Blue Swirl23130862009-06-06 08:22:04 +0000428STEXI
429@item gdbserver [@var{port}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100430@findex gdbserver
Blue Swirl23130862009-06-06 08:22:04 +0000431Start gdbserver session (default @var{port}=1234)
432ETEXI
433
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300434 {
435 .name = "x",
436 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300437 .params = "/fmt addr",
438 .help = "virtual memory dump starting at 'addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100439 .mhandler.cmd = hmp_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300440 },
441
Blue Swirl23130862009-06-06 08:22:04 +0000442STEXI
443@item x/fmt @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100444@findex x
Blue Swirl23130862009-06-06 08:22:04 +0000445Virtual memory dump starting at @var{addr}.
446ETEXI
447
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300448 {
449 .name = "xp",
450 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300451 .params = "/fmt addr",
452 .help = "physical memory dump starting at 'addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100453 .mhandler.cmd = hmp_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300454 },
455
Blue Swirl23130862009-06-06 08:22:04 +0000456STEXI
457@item xp /@var{fmt} @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100458@findex xp
Blue Swirl23130862009-06-06 08:22:04 +0000459Physical memory dump starting at @var{addr}.
460
461@var{fmt} is a format which tells the command how to format the
462data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
463
464@table @var
465@item count
466is the number of items to be dumped.
467
468@item format
469can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
470c (char) or i (asm instruction).
471
472@item size
473can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
474@code{h} or @code{w} can be specified with the @code{i} format to
475respectively select 16 or 32 bit code instruction size.
476
477@end table
478
479Examples:
480@itemize
481@item
482Dump 10 instructions at the current instruction pointer:
483@example
484(qemu) x/10i $eip
4850x90107063: ret
4860x90107064: sti
4870x90107065: lea 0x0(%esi,1),%esi
4880x90107069: lea 0x0(%edi,1),%edi
4890x90107070: ret
4900x90107071: jmp 0x90107080
4910x90107073: nop
4920x90107074: nop
4930x90107075: nop
4940x90107076: nop
495@end example
496
497@item
498Dump 80 16 bit values at the start of the video memory.
499@smallexample
500(qemu) xp/80hx 0xb8000
5010x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
5020x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
5030x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
5040x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
5050x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
5060x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
5070x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5080x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5090x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5100x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
511@end smallexample
512@end itemize
513ETEXI
514
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300515 {
516 .name = "p|print",
517 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300518 .params = "/fmt expr",
519 .help = "print expression value (use $reg for CPU register access)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300520 .mhandler.cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300521 },
522
Blue Swirl23130862009-06-06 08:22:04 +0000523STEXI
524@item p or print/@var{fmt} @var{expr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100525@findex print
Blue Swirl23130862009-06-06 08:22:04 +0000526
527Print expression value. Only the @var{format} part of @var{fmt} is
528used.
529ETEXI
530
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300531 {
532 .name = "i",
533 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300534 .params = "/fmt addr",
535 .help = "I/O port read",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100536 .mhandler.cmd = hmp_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300537 },
538
Blue Swirl23130862009-06-06 08:22:04 +0000539STEXI
540Read I/O port.
541ETEXI
542
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300543 {
544 .name = "o",
545 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300546 .params = "/fmt addr value",
547 .help = "I/O port write",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100548 .mhandler.cmd = hmp_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300549 },
550
Jan Kiszkaf1147842009-07-14 10:20:11 +0200551STEXI
552Write 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
Blue Swirl23130862009-06-06 08:22:04 +0000567
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 +0000590
591Reset the system.
592ETEXI
593
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300594 {
595 .name = "system_powerdown",
596 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300597 .params = "",
598 .help = "send system power down event",
Luiz Capitulino5bc465e2011-09-28 11:06:15 -0300599 .mhandler.cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300600 },
601
Blue Swirl23130862009-06-06 08:22:04 +0000602STEXI
603@item system_powerdown
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100604@findex system_powerdown
Blue Swirl23130862009-06-06 08:22:04 +0000605
606Power down the system (if supported).
607ETEXI
608
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300609 {
610 .name = "sum",
611 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300612 .params = "addr size",
613 .help = "compute the checksum of a memory region",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100614 .mhandler.cmd = hmp_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300615 },
616
Blue Swirl23130862009-06-06 08:22:04 +0000617STEXI
618@item sum @var{addr} @var{size}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100619@findex sum
Blue Swirl23130862009-06-06 08:22:04 +0000620
621Compute the checksum of a memory region.
622ETEXI
623
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300624 {
625 .name = "usb_add",
626 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300627 .params = "device",
628 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100629 .mhandler.cmd = hmp_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300630 },
631
Blue Swirl23130862009-06-06 08:22:04 +0000632STEXI
633@item usb_add @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100634@findex usb_add
Blue Swirl23130862009-06-06 08:22:04 +0000635
636Add the USB device @var{devname}. For details of available devices see
637@ref{usb_devices}
638ETEXI
639
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300640 {
641 .name = "usb_del",
642 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300643 .params = "device",
644 .help = "remove USB device 'bus.addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100645 .mhandler.cmd = hmp_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300646 },
647
Blue Swirl23130862009-06-06 08:22:04 +0000648STEXI
649@item usb_del @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100650@findex usb_del
Blue Swirl23130862009-06-06 08:22:04 +0000651
652Remove the USB device @var{devname} from the QEMU virtual USB
653hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
654command @code{info usb} to see the devices you can remove.
655ETEXI
656
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300657 {
658 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100659 .args_type = "device:O",
660 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300661 .help = "add device, like -device on the command line",
Markus Armbruster8bc27242010-02-10 20:52:01 +0100662 .user_print = monitor_user_noop,
663 .mhandler.cmd_new = do_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100664 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300665 },
666
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200667STEXI
668@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100669@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200670
671Add device.
672ETEXI
673
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300674 {
675 .name = "device_del",
676 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300677 .params = "device",
678 .help = "remove device",
Luiz Capitulinoa15fef22012-03-29 12:38:50 -0300679 .mhandler.cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100680 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300681 },
682
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200683STEXI
684@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100685@findex device_del
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200686
687Remove device @var{id}.
688ETEXI
689
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300690 {
691 .name = "cpu",
692 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300693 .params = "index",
694 .help = "set the default CPU",
Luiz Capitulino755f1962011-10-06 14:31:39 -0300695 .mhandler.cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300696 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200697
Blue Swirl23130862009-06-06 08:22:04 +0000698STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200699@item cpu @var{index}
700@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000701Set the default CPU.
702ETEXI
703
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300704 {
705 .name = "mouse_move",
706 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300707 .params = "dx dy [dz]",
708 .help = "send mouse move events",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100709 .mhandler.cmd = hmp_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300710 },
711
Blue Swirl23130862009-06-06 08:22:04 +0000712STEXI
713@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100714@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000715Move the active mouse to the specified coordinates @var{dx} @var{dy}
716with optional scroll axis @var{dz}.
717ETEXI
718
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300719 {
720 .name = "mouse_button",
721 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300722 .params = "state",
723 .help = "change mouse button state (1=L, 2=M, 4=R)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100724 .mhandler.cmd = hmp_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300725 },
726
Blue Swirl23130862009-06-06 08:22:04 +0000727STEXI
728@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100729@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000730Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
731ETEXI
732
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300733 {
734 .name = "mouse_set",
735 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300736 .params = "index",
737 .help = "set which mouse device receives events",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100738 .mhandler.cmd = hmp_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300739 },
740
Blue Swirl23130862009-06-06 08:22:04 +0000741STEXI
742@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100743@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000744Set which mouse device receives events at given @var{index}, index
745can be obtained with
746@example
747info mice
748@end example
749ETEXI
750
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300751 {
752 .name = "wavcapture",
753 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300754 .params = "path [frequency [bits [channels]]]",
755 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100756 .mhandler.cmd = hmp_wavcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300757 },
Blue Swirl23130862009-06-06 08:22:04 +0000758STEXI
759@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100760@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000761Capture audio into @var{filename}. Using sample rate @var{frequency}
762bits per sample @var{bits} and number of channels @var{channels}.
763
764Defaults:
765@itemize @minus
766@item Sample rate = 44100 Hz - CD quality
767@item Bits = 16
768@item Number of channels = 2 - Stereo
769@end itemize
770ETEXI
771
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300772 {
773 .name = "stopcapture",
774 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300775 .params = "capture index",
776 .help = "stop capture",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100777 .mhandler.cmd = hmp_stopcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300778 },
Blue Swirl23130862009-06-06 08:22:04 +0000779STEXI
780@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100781@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000782Stop capture with a given @var{index}, index can be obtained with
783@example
784info capture
785@end example
786ETEXI
787
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300788 {
789 .name = "memsave",
790 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300791 .params = "addr size file",
792 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulino0cfd6a92011-11-22 16:32:37 -0200793 .mhandler.cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300794 },
795
Blue Swirl23130862009-06-06 08:22:04 +0000796STEXI
797@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100798@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000799save to disk virtual memory dump starting at @var{addr} of size @var{size}.
800ETEXI
801
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300802 {
803 .name = "pmemsave",
804 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300805 .params = "addr size file",
806 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulino6d3962b2011-11-22 17:26:46 -0200807 .mhandler.cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300808 },
809
Blue Swirl23130862009-06-06 08:22:04 +0000810STEXI
811@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100812@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000813save to disk physical memory dump starting at @var{addr} of size @var{size}.
814ETEXI
815
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300816 {
817 .name = "boot_set",
818 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300819 .params = "bootdevice",
820 .help = "define new values for the boot device list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100821 .mhandler.cmd = hmp_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300822 },
823
Blue Swirl23130862009-06-06 08:22:04 +0000824STEXI
825@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100826@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000827
828Define new values for the boot device list. Those values will override
829the values specified on the command line through the @code{-boot} option.
830
831The values that can be specified here depend on the machine type, but are
832the same that can be specified in the @code{-boot} command line option.
833ETEXI
834
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300835 {
836 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300837 .args_type = "",
838 .params = "",
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000839 .help = "inject an NMI",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100840 .mhandler.cmd = hmp_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300841 },
Blue Swirl23130862009-06-06 08:22:04 +0000842STEXI
843@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100844@findex nmi
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000845Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
Lei Li1f590cf2013-01-25 00:03:20 +0800846
847ETEXI
848
849 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100850 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800851 .args_type = "device:s,data:s",
852 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100853 .help = "Write to a ring buffer character device",
854 .mhandler.cmd = hmp_ringbuf_write,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100855 .command_completion = ringbuf_write_completion,
Lei Li1f590cf2013-01-25 00:03:20 +0800856 },
857
858STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100859@item ringbuf_write @var{device} @var{data}
860@findex ringbuf_write
861Write @var{data} to ring buffer character device @var{device}.
862@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800863
Blue Swirl23130862009-06-06 08:22:04 +0000864ETEXI
865
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300866 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100867 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800868 .args_type = "device:s,size:i",
869 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100870 .help = "Read from a ring buffer character device",
871 .mhandler.cmd = hmp_ringbuf_read,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100872 .command_completion = ringbuf_write_completion,
Lei Li49b6d722013-01-25 00:03:21 +0800873 },
874
875STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100876@item ringbuf_read @var{device}
877@findex ringbuf_read
878Read and print up to @var{size} bytes from ring buffer character
879device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100880Certain non-printable characters are printed \uXXXX, where XXXX is the
881character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100882Bug: can screw up when the buffer contains invalid UTF-8 sequences,
883NUL characters, after the ring buffer lost data, and when reading
884stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800885
886ETEXI
887
888 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300889 .name = "migrate",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200890 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
891 .params = "[-d] [-b] [-i] uri",
892 .help = "migrate to URI (using -d to not wait for completion)"
893 "\n\t\t\t -b for migration without shared storage with"
894 " full copy of disk\n\t\t\t -i for migration without "
895 "shared storage with incremental copy of disk "
896 "(base image shared between src and destination)",
Luiz Capitulinoe1c37d02011-12-05 14:48:01 -0200897 .mhandler.cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300898 },
899
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200900
Blue Swirl23130862009-06-06 08:22:04 +0000901STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200902@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100903@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000904Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200905 -b for migration with full copy of disk
906 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000907ETEXI
908
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300909 {
910 .name = "migrate_cancel",
911 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300912 .params = "",
913 .help = "cancel the current VM migration",
Luiz Capitulino6cdedb02011-11-27 22:54:09 -0200914 .mhandler.cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300915 },
916
Blue Swirl23130862009-06-06 08:22:04 +0000917STEXI
918@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100919@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000920Cancel the current VM migration.
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300921
922ETEXI
923
924 {
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000925 .name = "migrate_incoming",
926 .args_type = "uri:s",
927 .params = "uri",
928 .help = "Continue an incoming migration from an -incoming defer",
929 .mhandler.cmd = hmp_migrate_incoming,
930 },
931
932STEXI
933@item migrate_incoming @var{uri}
934@findex migrate_incoming
935Continue an incoming migration using the @var{uri} (that has the same syntax
936as the -incoming option).
937
938ETEXI
939
940 {
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300941 .name = "migrate_set_cache_size",
942 .args_type = "value:o",
943 .params = "value",
944 .help = "set cache size (in bytes) for XBZRLE migrations,"
945 "the cache size will be rounded down to the nearest "
946 "power of 2.\n"
947 "The cache size affects the number of cache misses."
948 "In case of a high cache miss ratio you need to increase"
949 " the cache size",
950 .mhandler.cmd = hmp_migrate_set_cache_size,
951 },
952
953STEXI
954@item migrate_set_cache_size @var{value}
955@findex migrate_set_cache_size
956Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +0000957ETEXI
958
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300959 {
960 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200961 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300962 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200963 .help = "set maximum speed (in bytes) for migrations. "
964 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Luiz Capitulino3dc85382011-11-28 11:59:37 -0200965 .mhandler.cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300966 },
967
Blue Swirl23130862009-06-06 08:22:04 +0000968STEXI
969@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100970@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +0000971Set maximum speed to @var{value} (in bytes) for migrations.
972ETEXI
973
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300974 {
975 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +0100976 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300977 .params = "value",
978 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulino4f0a9932011-11-27 23:18:01 -0200979 .mhandler.cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300980 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400981
982STEXI
983@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100984@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -0400985Set maximum tolerated downtime (in seconds) for migration.
986ETEXI
987
Jes Sorensenf8882562010-12-16 13:52:16 +0100988 {
Orit Wasserman00458432012-08-06 21:42:48 +0300989 .name = "migrate_set_capability",
990 .args_type = "capability:s,state:b",
991 .params = "capability state",
992 .help = "Enable/Disable the usage of a capability for migration",
993 .mhandler.cmd = hmp_migrate_set_capability,
Hani Benhabilesc68a0402014-05-27 23:39:32 +0100994 .command_completion = migrate_set_capability_completion,
Orit Wasserman00458432012-08-06 21:42:48 +0300995 },
996
997STEXI
998@item migrate_set_capability @var{capability} @var{state}
999@findex migrate_set_capability
1000Enable/Disable the usage of a capability @var{capability} for migration.
1001ETEXI
1002
1003 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001004 .name = "client_migrate_info",
1005 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1006 .params = "protocol hostname port tls-port cert-subject",
1007 .help = "send migration info to spice/vnc client",
1008 .user_print = monitor_user_noop,
Yonit Halperinedc5cb12011-10-17 10:03:18 +02001009 .mhandler.cmd_async = client_migrate_info,
1010 .flags = MONITOR_CMD_ASYNC,
Jes Sorensenf8882562010-12-16 13:52:16 +01001011 },
1012
1013STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001014@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1015@findex client_migrate_info
1016Set the spice/vnc connection info for the migration target. The spice/vnc
1017server will ask the spice/vnc client to automatically reconnect using the
1018new parameters (if specified) once the vm migration finished successfully.
1019ETEXI
1020
Wen Congyang783e9b42012-05-07 12:10:47 +08001021 {
1022 .name = "dump-guest-memory",
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001023 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1024 .params = "[-p] [-z|-l|-s] filename [begin length]",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001025 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1026 "-p: do paging to get guest's memory mapping.\n\t\t\t"
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001027 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1028 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1029 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001030 "begin: the starting physical address.\n\t\t\t"
1031 "length: the memory size, in bytes.",
Wen Congyang783e9b42012-05-07 12:10:47 +08001032 .mhandler.cmd = hmp_dump_guest_memory,
1033 },
1034
1035
1036STEXI
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001037@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001038@item dump-guest-memory [-z|-l|-s] @var{filename}
Wen Congyang783e9b42012-05-07 12:10:47 +08001039@findex dump-guest-memory
1040Dump guest memory to @var{protocol}. The file can be processed with crash or
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001041gdb. Without -z|-l|-s, the dump format is ELF.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001042 -p: do paging to get guest's memory mapping.
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001043 -z: dump in kdump-compressed format, with zlib compression.
1044 -l: dump in kdump-compressed format, with lzo compression.
1045 -s: dump in kdump-compressed format, with snappy compression.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001046 filename: dump file name.
Wen Congyang783e9b42012-05-07 12:10:47 +08001047 begin: the starting physical address. It's optional, and should be
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001048 specified together with length.
Wen Congyang783e9b42012-05-07 12:10:47 +08001049 length: the memory size, in bytes. It's optional, and should be specified
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001050 together with begin.
Wen Congyang783e9b42012-05-07 12:10:47 +08001051ETEXI
Wen Congyang783e9b42012-05-07 12:10:47 +08001052
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001053 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001054 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001055 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1056 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001057 .help = "initiates a live snapshot\n\t\t\t"
1058 "of device. If a new image file is specified, the\n\t\t\t"
1059 "new image file will become the new root image.\n\t\t\t"
1060 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001061 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001062 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1063 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1064 "recreating it from scratch.",
Luiz Capitulino6106e242011-11-25 16:15:19 -02001065 .mhandler.cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001066 },
1067
1068STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001069@item snapshot_blkdev
1070@findex snapshot_blkdev
1071Snapshot device, using snapshot file as target if provided
1072ETEXI
1073
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001074 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001075 .name = "snapshot_blkdev_internal",
1076 .args_type = "device:B,name:s",
1077 .params = "device name",
1078 .help = "take an internal snapshot of device.\n\t\t\t"
1079 "The format of the image used by device must\n\t\t\t"
1080 "support it, such as qcow2.\n\t\t\t",
1081 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1082 },
1083
1084STEXI
1085@item snapshot_blkdev_internal
1086@findex snapshot_blkdev_internal
1087Take an internal snapshot on device if it support
1088ETEXI
1089
1090 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001091 .name = "snapshot_delete_blkdev_internal",
1092 .args_type = "device:B,name:s,id:s?",
1093 .params = "device name [id]",
1094 .help = "delete an internal snapshot of device.\n\t\t\t"
1095 "If id is specified, qemu will try delete\n\t\t\t"
1096 "the snapshot matching both id and name.\n\t\t\t"
1097 "The format of the image used by device must\n\t\t\t"
1098 "support it, such as qcow2.\n\t\t\t",
1099 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1100 },
1101
1102STEXI
1103@item snapshot_delete_blkdev_internal
1104@findex snapshot_delete_blkdev_internal
1105Delete an internal snapshot on device if it support
1106ETEXI
1107
1108 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001109 .name = "drive_mirror",
1110 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1111 .params = "[-n] [-f] device target [format]",
1112 .help = "initiates live storage\n\t\t\t"
1113 "migration for a device. The device's contents are\n\t\t\t"
1114 "copied to the new image file, including data that\n\t\t\t"
1115 "is written after the command is started.\n\t\t\t"
1116 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1117 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1118 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1119 "so that the result does not need a backing file.\n\t\t\t",
1120 .mhandler.cmd = hmp_drive_mirror,
1121 },
1122STEXI
1123@item drive_mirror
1124@findex drive_mirror
1125Start mirroring a block device's writes to a new destination,
1126using the specified target.
1127ETEXI
1128
1129 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001130 .name = "drive_backup",
1131 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1132 .params = "[-n] [-f] device target [format]",
1133 .help = "initiates a point-in-time\n\t\t\t"
1134 "copy for a device. The device's contents are\n\t\t\t"
1135 "copied to the new image file, excluding data that\n\t\t\t"
1136 "is written after the command is started.\n\t\t\t"
1137 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1138 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1139 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1140 "so that the result does not need a backing file.\n\t\t\t",
1141 .mhandler.cmd = hmp_drive_backup,
1142 },
1143STEXI
1144@item drive_backup
1145@findex drive_backup
1146Start a point-in-time copy of a block device to a specificed target.
1147ETEXI
1148
1149 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001150 .name = "drive_add",
1151 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001152 .params = "[[<domain>:]<bus>:]<slot>\n"
1153 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001154 "[,unit=m][,media=d][,index=i]\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001155 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001156 "[,snapshot=on|off][,cache=on|off]\n"
1157 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001158 .help = "add drive to PCI storage controller",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001159 .mhandler.cmd = hmp_drive_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001160 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001161
Blue Swirl23130862009-06-06 08:22:04 +00001162STEXI
1163@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001164@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001165Add drive to PCI storage controller.
1166ETEXI
1167
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001168 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001169 .name = "pcie_aer_inject_error",
1170 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1171 "id:s,error_status:s,"
1172 "header0:i?,header1:i?,header2:i?,header3:i?,"
1173 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1174 .params = "[-a] [-c] id "
1175 "<error_status> [<tlp header> [<tlp header prefix>]]",
1176 .help = "inject pcie aer error\n\t\t\t"
1177 " -a for advisory non fatal error\n\t\t\t"
1178 " -c for correctable error\n\t\t\t"
1179 "<id> = qdev device id\n\t\t\t"
1180 "<error_status> = error string or 32bit\n\t\t\t"
1181 "<tlb header> = 32bit x 4\n\t\t\t"
1182 "<tlb header prefix> = 32bit x 4",
1183 .user_print = pcie_aer_inject_error_print,
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001184 .mhandler.cmd_new = hmp_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001185 },
1186
1187STEXI
1188@item pcie_aer_inject_error
1189@findex pcie_aer_inject_error
1190Inject PCIe AER error
1191ETEXI
1192
1193 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001194 .name = "host_net_add",
1195 .args_type = "device:s,opts:s?",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001196 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001197 .help = "add host VLAN client",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001198 .mhandler.cmd = hmp_host_net_add,
Hani Benhabilese3bb5322014-05-27 23:39:34 +01001199 .command_completion = host_net_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001200 },
1201
Blue Swirl23130862009-06-06 08:22:04 +00001202STEXI
1203@item host_net_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001204@findex host_net_add
Blue Swirl23130862009-06-06 08:22:04 +00001205Add host VLAN client.
1206ETEXI
1207
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001208 {
1209 .name = "host_net_remove",
1210 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001211 .params = "vlan_id name",
1212 .help = "remove host VLAN client",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001213 .mhandler.cmd = hmp_host_net_remove,
Hani Benhabilesddd6b452014-05-27 23:39:36 +01001214 .command_completion = host_net_remove_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001215 },
1216
Blue Swirl23130862009-06-06 08:22:04 +00001217STEXI
1218@item host_net_remove
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001219@findex host_net_remove
Blue Swirl23130862009-06-06 08:22:04 +00001220Remove host VLAN client.
1221ETEXI
1222
Markus Armbrusterae82d322010-03-25 17:22:40 +01001223 {
1224 .name = "netdev_add",
1225 .args_type = "netdev:O",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001226 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001227 .help = "add host network device",
Luiz Capitulino928059a2012-04-18 17:34:15 -03001228 .mhandler.cmd = hmp_netdev_add,
Hani Benhabilesb162b492014-05-07 23:41:31 +01001229 .command_completion = netdev_add_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001230 },
1231
1232STEXI
1233@item netdev_add
1234@findex netdev_add
1235Add host network device.
1236ETEXI
1237
1238 {
1239 .name = "netdev_del",
1240 .args_type = "id:s",
1241 .params = "id",
1242 .help = "remove host network device",
Luiz Capitulino5f964152012-04-16 14:36:32 -03001243 .mhandler.cmd = hmp_netdev_del,
Hani Benhabiles11b389f2014-05-07 23:41:32 +01001244 .command_completion = netdev_del_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001245 },
1246
1247STEXI
1248@item netdev_del
1249@findex netdev_del
1250Remove host network device.
1251ETEXI
1252
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001253 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001254 .name = "object_add",
1255 .args_type = "object:O",
1256 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1257 .help = "create QOM object",
1258 .mhandler.cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001259 .command_completion = object_add_completion,
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001260 },
1261
1262STEXI
1263@item object_add
1264@findex object_add
1265Create QOM object.
1266ETEXI
1267
1268 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001269 .name = "object_del",
1270 .args_type = "id:s",
1271 .params = "id",
1272 .help = "destroy QOM object",
1273 .mhandler.cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001274 .command_completion = object_del_completion,
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001275 },
1276
1277STEXI
1278@item object_del
1279@findex object_del
1280Destroy QOM object.
1281ETEXI
1282
Blue Swirl23130862009-06-06 08:22:04 +00001283#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001284 {
1285 .name = "hostfwd_add",
1286 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001287 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1288 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001289 .mhandler.cmd = hmp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001290 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001291#endif
1292STEXI
1293@item hostfwd_add
1294@findex hostfwd_add
1295Redirect TCP or UDP connections from host to guest (requires -net user).
1296ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001297
Markus Armbruster21413d62010-05-04 13:20:30 +02001298#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001299 {
1300 .name = "hostfwd_remove",
1301 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001302 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1303 .help = "remove host-to-guest TCP or UDP redirection",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001304 .mhandler.cmd = hmp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001305 },
1306
Blue Swirl23130862009-06-06 08:22:04 +00001307#endif
1308STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001309@item hostfwd_remove
1310@findex hostfwd_remove
1311Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001312ETEXI
1313
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001314 {
1315 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001316 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001317 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001318 .help = "request VM to change its memory allocation (in MB)",
Luiz Capitulinod72f3262011-11-25 14:38:09 -02001319 .mhandler.cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001320 },
1321
Blue Swirl23130862009-06-06 08:22:04 +00001322STEXI
1323@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001324@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001325Request VM to change its memory allocation to @var{value} (in MB).
1326ETEXI
1327
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001328 {
1329 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001330 .args_type = "name:s,up:b",
1331 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001332 .help = "change the link status of a network adapter",
Luiz Capitulino4b371562011-11-23 13:11:55 -02001333 .mhandler.cmd = hmp_set_link,
Hani Benhabiles40d19392014-05-07 23:41:30 +01001334 .command_completion = set_link_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001335 },
1336
Blue Swirl23130862009-06-06 08:22:04 +00001337STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001338@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001339@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001340Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001341ETEXI
1342
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001343 {
1344 .name = "watchdog_action",
1345 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001346 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1347 .help = "change watchdog action",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001348 .mhandler.cmd = hmp_watchdog_action,
Hani Benhabilesd0ece342014-05-27 23:39:31 +01001349 .command_completion = watchdog_action_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001350 },
1351
Blue Swirl23130862009-06-06 08:22:04 +00001352STEXI
1353@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001354@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001355Change watchdog action.
1356ETEXI
1357
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001358 {
1359 .name = "acl_show",
1360 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001361 .params = "aclname",
1362 .help = "list rules in the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001363 .mhandler.cmd = hmp_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001364 },
1365
Blue Swirl23130862009-06-06 08:22:04 +00001366STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001367@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001368@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001369List all the matching rules in the access control list, and the default
1370policy. There are currently two named access control lists,
1371@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1372certificate distinguished name, and SASL username respectively.
1373ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001374
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001375 {
1376 .name = "acl_policy",
1377 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001378 .params = "aclname allow|deny",
1379 .help = "set default access control list policy",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001380 .mhandler.cmd = hmp_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001381 },
1382
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001383STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001384@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001385@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001386Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001387none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001388always @code{deny}.
1389ETEXI
1390
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001391 {
1392 .name = "acl_add",
1393 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001394 .params = "aclname match allow|deny [index]",
1395 .help = "add a match rule to the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001396 .mhandler.cmd = hmp_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001397 },
1398
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001399STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001400@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1401@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001402Add a match rule to the access control list, allowing or denying access.
1403The match will normally be an exact username or x509 distinguished name,
1404but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1405allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001406normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001407earlier in the list if the optional @var{index} parameter is supplied.
1408ETEXI
1409
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001410 {
1411 .name = "acl_remove",
1412 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001413 .params = "aclname match",
1414 .help = "remove a match rule from the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001415 .mhandler.cmd = hmp_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001416 },
1417
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001418STEXI
1419@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001420@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001421Remove the specified match rule from the access control list.
1422ETEXI
1423
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001424 {
1425 .name = "acl_reset",
1426 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001427 .params = "aclname",
1428 .help = "reset the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001429 .mhandler.cmd = hmp_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001430 },
1431
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001432STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001433@item acl_reset @var{aclname}
1434@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001435Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001436policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001437ETEXI
1438
Paolo Bonzini40577252012-08-23 11:53:04 +02001439 {
1440 .name = "nbd_server_start",
1441 .args_type = "all:-a,writable:-w,uri:s",
1442 .params = "nbd_server_start [-a] [-w] host:port",
1443 .help = "serve block devices on the given host and port",
1444 .mhandler.cmd = hmp_nbd_server_start,
1445 },
1446STEXI
1447@item nbd_server_start @var{host}:@var{port}
1448@findex nbd_server_start
1449Start an NBD server on the given host and/or port. If the @option{-a}
1450option is included, all of the virtual machine's block devices that
1451have an inserted media on them are automatically exported; in this case,
1452the @option{-w} option makes the devices writable too.
1453ETEXI
1454
1455 {
1456 .name = "nbd_server_add",
1457 .args_type = "writable:-w,device:B",
1458 .params = "nbd_server_add [-w] device",
1459 .help = "export a block device via NBD",
1460 .mhandler.cmd = hmp_nbd_server_add,
1461 },
1462STEXI
1463@item nbd_server_add @var{device}
1464@findex nbd_server_add
1465Export a block device through QEMU's NBD server, which must be started
1466beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1467exported device writable too.
1468ETEXI
1469
1470 {
1471 .name = "nbd_server_stop",
1472 .args_type = "",
1473 .params = "nbd_server_stop",
1474 .help = "stop serving block devices using the NBD protocol",
1475 .mhandler.cmd = hmp_nbd_server_stop,
1476 },
1477STEXI
1478@item nbd_server_stop
1479@findex nbd_server_stop
1480Stop the QEMU embedded NBD server.
1481ETEXI
1482
1483
Huang Ying79c4f6b2009-06-23 10:05:14 +08001484#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001485
1486 {
1487 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001488 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1489 .params = "[-b] cpu bank status mcgstatus addr misc",
1490 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001491 .mhandler.cmd = hmp_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001492 },
1493
Huang Ying79c4f6b2009-06-23 10:05:14 +08001494#endif
1495STEXI
1496@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001497@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001498Inject an MCE on the given CPU (x86 only).
1499ETEXI
1500
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001501 {
1502 .name = "getfd",
1503 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001504 .params = "getfd name",
1505 .help = "receive a file descriptor via SCM rights and assign it a name",
Corey Bryant208c9d12012-06-22 14:36:09 -04001506 .mhandler.cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001507 },
1508
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001509STEXI
1510@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001511@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001512If a file descriptor is passed alongside this command using the SCM_RIGHTS
1513mechanism on unix sockets, it is stored using the name @var{fdname} for
1514later use by other monitor commands.
1515ETEXI
1516
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001517 {
1518 .name = "closefd",
1519 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001520 .params = "closefd name",
1521 .help = "close a file descriptor previously passed via SCM rights",
Corey Bryant208c9d12012-06-22 14:36:09 -04001522 .mhandler.cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001523 },
1524
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001525STEXI
1526@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001527@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001528Close the file descriptor previously assigned to @var{fdname} using the
1529@code{getfd} command. This is only needed if the file descriptor was never
1530used by another monitor command.
1531ETEXI
1532
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001533 {
1534 .name = "block_passwd",
1535 .args_type = "device:B,password:s",
1536 .params = "block_passwd device password",
1537 .help = "set the password of encrypted block devices",
Luiz Capitulinoa4dea8a2011-11-23 13:28:21 -02001538 .mhandler.cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001539 },
1540
1541STEXI
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001542@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1543@findex block_set_io_throttle
1544Change 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}
1545ETEXI
1546
1547 {
1548 .name = "block_set_io_throttle",
1549 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1550 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1551 .help = "change I/O throttle limits for a block drive",
Luiz Capitulino80047da2011-12-14 16:49:14 -02001552 .mhandler.cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001553 },
1554
1555STEXI
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001556@item block_passwd @var{device} @var{password}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001557@findex block_passwd
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001558Set the encrypted device @var{device} password to @var{password}
1559ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001560
Jan Kiszka33572ec2010-05-31 14:43:30 -03001561 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001562 .name = "set_password",
1563 .args_type = "protocol:s,password:s,connected:s?",
1564 .params = "protocol password action-if-connected",
1565 .help = "set spice/vnc password",
Luiz Capitulinofbf796f2011-12-07 11:17:51 -02001566 .mhandler.cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001567 },
1568
1569STEXI
1570@item set_password [ vnc | spice ] password [ action-if-connected ]
1571@findex set_password
1572
1573Change spice/vnc password. Use zero to make the password stay valid
1574forever. @var{action-if-connected} specifies what should happen in
1575case a connection is established: @var{fail} makes the password change
1576fail. @var{disconnect} changes the password and disconnects the
1577client. @var{keep} changes the password and keeps the connection up.
1578@var{keep} is the default.
1579ETEXI
1580
1581 {
1582 .name = "expire_password",
1583 .args_type = "protocol:s,time:s",
1584 .params = "protocol time",
1585 .help = "set spice/vnc password expire-time",
Luiz Capitulino9ad53722011-12-07 11:47:57 -02001586 .mhandler.cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001587 },
1588
1589STEXI
1590@item expire_password [ vnc | spice ] expire-time
1591@findex expire_password
1592
1593Specify when a password for spice/vnc becomes
1594invalid. @var{expire-time} accepts:
1595
1596@table @var
1597@item now
1598Invalidate password instantly.
1599
1600@item never
1601Password stays valid forever.
1602
1603@item +nsec
1604Password stays valid for @var{nsec} seconds starting now.
1605
1606@item nsec
1607Password is invalidated at the given time. @var{nsec} are the seconds
1608passed since 1970, i.e. unix epoch.
1609
1610@end table
1611ETEXI
1612
Gerd Hoffmann46920822013-02-28 08:46:10 +01001613 {
1614 .name = "chardev-add",
1615 .args_type = "args:s",
1616 .params = "args",
1617 .help = "add chardev",
1618 .mhandler.cmd = hmp_chardev_add,
Hani Benhabiles13e315d2014-05-07 23:41:29 +01001619 .command_completion = chardev_add_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001620 },
1621
1622STEXI
1623@item chardev_add args
1624@findex chardev_add
1625
1626chardev_add accepts the same parameters as the -chardev command line switch.
1627
1628ETEXI
1629
1630 {
1631 .name = "chardev-remove",
1632 .args_type = "id:s",
1633 .params = "id",
1634 .help = "remove chardev",
1635 .mhandler.cmd = hmp_chardev_remove,
Hani Benhabiles6297d9a2014-05-07 23:41:28 +01001636 .command_completion = chardev_remove_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001637 },
1638
1639STEXI
1640@item chardev_remove id
1641@findex chardev_remove
1642
1643Removes 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
1658
1659Executes a qemu-io command on the given block device.
1660
1661ETEXI
1662
1663 {
Jason J. Herneabf23322013-12-11 13:24:14 -05001664 .name = "cpu-add",
1665 .args_type = "id:i",
1666 .params = "id",
1667 .help = "add cpu",
1668 .mhandler.cmd = hmp_cpu_add,
1669 },
1670
1671STEXI
1672@item cpu-add @var{id}
1673Add 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 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001690 .name = "info",
1691 .args_type = "item:s?",
1692 .params = "[subcommand]",
1693 .help = "show various information about the system state",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001694 .mhandler.cmd = hmp_info_help,
Wenchao Xia84c44612013-01-14 14:06:29 +08001695 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001696 },
1697
1698STEXI
1699@item info @var{subcommand}
1700@findex info
1701Show various information about the system state.
1702
1703@table @option
1704@item info version
1705show the version of QEMU
Jan Kiszka33572ec2010-05-31 14:43:30 -03001706@item info network
1707show the various VLANs and the associated devices
1708@item info chardev
1709show the character devices
1710@item info block
1711show the block devices
1712@item info blockstats
1713show block device statistics
1714@item info registers
1715show the cpu registers
1716@item info cpus
1717show infos for each CPU
1718@item info history
1719show the command line history
1720@item info irq
1721show the interrupts statistics (if available)
1722@item info pic
1723show i8259 (PIC) state
1724@item info pci
1725show emulated PCI device info
1726@item info tlb
Max Filippov692f7372012-01-07 20:02:40 +04001727show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001728@item info mem
1729show the active virtual memory mappings (i386 only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001730@item info jit
1731show dynamic compiler info
Jan Kiszka33572ec2010-05-31 14:43:30 -03001732@item info numa
1733show NUMA information
Jan Kiszkab40292e2010-05-31 14:43:31 -03001734@item info kvm
1735show KVM information
Jan Kiszka33572ec2010-05-31 14:43:30 -03001736@item info usb
1737show USB devices plugged on the virtual USB hub
1738@item info usbhost
1739show all USB host devices
1740@item info profile
1741show profiling information
1742@item info capture
1743show information about active capturing
1744@item info snapshots
1745show list of VM snapshots
1746@item info status
1747show the current VM status (running|paused)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001748@item info mice
1749show which guest mouse is receiving events
1750@item info vnc
1751show the vnc server status
1752@item info name
1753show the current VM name
1754@item info uuid
1755show the current VM UUID
1756@item info cpustats
1757show CPU statistics
1758@item info usernet
1759show user network stack connection states
1760@item info migrate
1761show migration status
Orit Wassermanbbf6da32012-08-06 21:42:47 +03001762@item info migrate_capabilities
1763show current migration capabilities
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +03001764@item info migrate_cache_size
1765show current migration XBZRLE cache size
Jan Kiszka33572ec2010-05-31 14:43:30 -03001766@item info balloon
1767show balloon information
1768@item info qtree
1769show device tree
1770@item info qdm
1771show qdev device model list
1772@item info roms
1773show roms
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05001774@item info tpm
1775show the TPM device
Zhu Guihuaa6318922014-09-23 13:35:19 +08001776@item info memory-devices
1777show the memory devices
Jan Kiszka33572ec2010-05-31 14:43:30 -03001778@end table
1779ETEXI
1780
Lluís31965ae2011-08-31 20:31:24 +02001781STEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301782@item info trace-events
1783show available trace events and their state
1784ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301785
Blue Swirl23130862009-06-06 08:22:04 +00001786STEXI
1787@end table
1788ETEXI