blob: 803ff916c2dbdb427fc7fd18a1a40ad10802ab37 [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 Armbruster318660f2015-03-05 17:24:48 +0100656 .mhandler.cmd = hmp_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100657 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300658 },
659
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200660STEXI
661@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100662@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200663Add device.
664ETEXI
665
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300666 {
667 .name = "device_del",
668 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300669 .params = "device",
670 .help = "remove device",
Luiz Capitulinoa15fef22012-03-29 12:38:50 -0300671 .mhandler.cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100672 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300673 },
674
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200675STEXI
676@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100677@findex device_del
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200678Remove device @var{id}.
679ETEXI
680
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300681 {
682 .name = "cpu",
683 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300684 .params = "index",
685 .help = "set the default CPU",
Luiz Capitulino755f1962011-10-06 14:31:39 -0300686 .mhandler.cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300687 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200688
Blue Swirl23130862009-06-06 08:22:04 +0000689STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200690@item cpu @var{index}
691@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000692Set the default CPU.
693ETEXI
694
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300695 {
696 .name = "mouse_move",
697 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300698 .params = "dx dy [dz]",
699 .help = "send mouse move events",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100700 .mhandler.cmd = hmp_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300701 },
702
Blue Swirl23130862009-06-06 08:22:04 +0000703STEXI
704@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100705@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000706Move the active mouse to the specified coordinates @var{dx} @var{dy}
707with optional scroll axis @var{dz}.
708ETEXI
709
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300710 {
711 .name = "mouse_button",
712 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300713 .params = "state",
714 .help = "change mouse button state (1=L, 2=M, 4=R)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100715 .mhandler.cmd = hmp_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300716 },
717
Blue Swirl23130862009-06-06 08:22:04 +0000718STEXI
719@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100720@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000721Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
722ETEXI
723
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300724 {
725 .name = "mouse_set",
726 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300727 .params = "index",
728 .help = "set which mouse device receives events",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100729 .mhandler.cmd = hmp_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300730 },
731
Blue Swirl23130862009-06-06 08:22:04 +0000732STEXI
733@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100734@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000735Set which mouse device receives events at given @var{index}, index
736can be obtained with
737@example
738info mice
739@end example
740ETEXI
741
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300742 {
743 .name = "wavcapture",
744 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300745 .params = "path [frequency [bits [channels]]]",
746 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100747 .mhandler.cmd = hmp_wavcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300748 },
Blue Swirl23130862009-06-06 08:22:04 +0000749STEXI
750@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100751@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000752Capture audio into @var{filename}. Using sample rate @var{frequency}
753bits per sample @var{bits} and number of channels @var{channels}.
754
755Defaults:
756@itemize @minus
757@item Sample rate = 44100 Hz - CD quality
758@item Bits = 16
759@item Number of channels = 2 - Stereo
760@end itemize
761ETEXI
762
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300763 {
764 .name = "stopcapture",
765 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300766 .params = "capture index",
767 .help = "stop capture",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100768 .mhandler.cmd = hmp_stopcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300769 },
Blue Swirl23130862009-06-06 08:22:04 +0000770STEXI
771@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100772@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000773Stop capture with a given @var{index}, index can be obtained with
774@example
775info capture
776@end example
777ETEXI
778
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300779 {
780 .name = "memsave",
781 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300782 .params = "addr size file",
783 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulino0cfd6a92011-11-22 16:32:37 -0200784 .mhandler.cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300785 },
786
Blue Swirl23130862009-06-06 08:22:04 +0000787STEXI
788@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100789@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000790save to disk virtual memory dump starting at @var{addr} of size @var{size}.
791ETEXI
792
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300793 {
794 .name = "pmemsave",
795 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300796 .params = "addr size file",
797 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulino6d3962b2011-11-22 17:26:46 -0200798 .mhandler.cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300799 },
800
Blue Swirl23130862009-06-06 08:22:04 +0000801STEXI
802@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100803@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000804save to disk physical memory dump starting at @var{addr} of size @var{size}.
805ETEXI
806
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300807 {
808 .name = "boot_set",
809 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300810 .params = "bootdevice",
811 .help = "define new values for the boot device list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100812 .mhandler.cmd = hmp_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300813 },
814
Blue Swirl23130862009-06-06 08:22:04 +0000815STEXI
816@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100817@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000818Define new values for the boot device list. Those values will override
819the values specified on the command line through the @code{-boot} option.
820
821The values that can be specified here depend on the machine type, but are
822the same that can be specified in the @code{-boot} command line option.
823ETEXI
824
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300825 {
826 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300827 .args_type = "",
828 .params = "",
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000829 .help = "inject an NMI",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100830 .mhandler.cmd = hmp_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300831 },
Blue Swirl23130862009-06-06 08:22:04 +0000832STEXI
833@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100834@findex nmi
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000835Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
Lei Li1f590cf2013-01-25 00:03:20 +0800836
837ETEXI
838
839 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100840 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800841 .args_type = "device:s,data:s",
842 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100843 .help = "Write to a ring buffer character device",
844 .mhandler.cmd = hmp_ringbuf_write,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100845 .command_completion = ringbuf_write_completion,
Lei Li1f590cf2013-01-25 00:03:20 +0800846 },
847
848STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100849@item ringbuf_write @var{device} @var{data}
850@findex ringbuf_write
851Write @var{data} to ring buffer character device @var{device}.
852@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800853
Blue Swirl23130862009-06-06 08:22:04 +0000854ETEXI
855
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300856 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100857 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800858 .args_type = "device:s,size:i",
859 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100860 .help = "Read from a ring buffer character device",
861 .mhandler.cmd = hmp_ringbuf_read,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100862 .command_completion = ringbuf_write_completion,
Lei Li49b6d722013-01-25 00:03:21 +0800863 },
864
865STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100866@item ringbuf_read @var{device}
867@findex ringbuf_read
868Read and print up to @var{size} bytes from ring buffer character
869device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100870Certain non-printable characters are printed \uXXXX, where XXXX is the
871character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100872Bug: can screw up when the buffer contains invalid UTF-8 sequences,
873NUL characters, after the ring buffer lost data, and when reading
874stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800875
876ETEXI
877
878 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300879 .name = "migrate",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200880 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
881 .params = "[-d] [-b] [-i] uri",
882 .help = "migrate to URI (using -d to not wait for completion)"
883 "\n\t\t\t -b for migration without shared storage with"
884 " full copy of disk\n\t\t\t -i for migration without "
885 "shared storage with incremental copy of disk "
886 "(base image shared between src and destination)",
Luiz Capitulinoe1c37d02011-12-05 14:48:01 -0200887 .mhandler.cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300888 },
889
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200890
Blue Swirl23130862009-06-06 08:22:04 +0000891STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200892@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100893@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000894Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200895 -b for migration with full copy of disk
896 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000897ETEXI
898
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300899 {
900 .name = "migrate_cancel",
901 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300902 .params = "",
903 .help = "cancel the current VM migration",
Luiz Capitulino6cdedb02011-11-27 22:54:09 -0200904 .mhandler.cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300905 },
906
Blue Swirl23130862009-06-06 08:22:04 +0000907STEXI
908@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100909@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000910Cancel the current VM migration.
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300911
912ETEXI
913
914 {
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000915 .name = "migrate_incoming",
916 .args_type = "uri:s",
917 .params = "uri",
918 .help = "Continue an incoming migration from an -incoming defer",
919 .mhandler.cmd = hmp_migrate_incoming,
920 },
921
922STEXI
923@item migrate_incoming @var{uri}
924@findex migrate_incoming
925Continue an incoming migration using the @var{uri} (that has the same syntax
926as the -incoming option).
927
928ETEXI
929
930 {
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300931 .name = "migrate_set_cache_size",
932 .args_type = "value:o",
933 .params = "value",
934 .help = "set cache size (in bytes) for XBZRLE migrations,"
935 "the cache size will be rounded down to the nearest "
936 "power of 2.\n"
937 "The cache size affects the number of cache misses."
938 "In case of a high cache miss ratio you need to increase"
939 " the cache size",
940 .mhandler.cmd = hmp_migrate_set_cache_size,
941 },
942
943STEXI
944@item migrate_set_cache_size @var{value}
945@findex migrate_set_cache_size
946Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +0000947ETEXI
948
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300949 {
950 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200951 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300952 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200953 .help = "set maximum speed (in bytes) for migrations. "
954 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Luiz Capitulino3dc85382011-11-28 11:59:37 -0200955 .mhandler.cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300956 },
957
Blue Swirl23130862009-06-06 08:22:04 +0000958STEXI
959@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100960@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +0000961Set maximum speed to @var{value} (in bytes) for migrations.
962ETEXI
963
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300964 {
965 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +0100966 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300967 .params = "value",
968 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulino4f0a9932011-11-27 23:18:01 -0200969 .mhandler.cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300970 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400971
972STEXI
973@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100974@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -0400975Set maximum tolerated downtime (in seconds) for migration.
976ETEXI
977
Jes Sorensenf8882562010-12-16 13:52:16 +0100978 {
Orit Wasserman00458432012-08-06 21:42:48 +0300979 .name = "migrate_set_capability",
980 .args_type = "capability:s,state:b",
981 .params = "capability state",
982 .help = "Enable/Disable the usage of a capability for migration",
983 .mhandler.cmd = hmp_migrate_set_capability,
Hani Benhabilesc68a0402014-05-27 23:39:32 +0100984 .command_completion = migrate_set_capability_completion,
Orit Wasserman00458432012-08-06 21:42:48 +0300985 },
986
987STEXI
988@item migrate_set_capability @var{capability} @var{state}
989@findex migrate_set_capability
990Enable/Disable the usage of a capability @var{capability} for migration.
991ETEXI
992
993 {
Liang Li50e9a622015-03-23 16:32:29 +0800994 .name = "migrate_set_parameter",
995 .args_type = "parameter:s,value:i",
996 .params = "parameter value",
997 .help = "Set the parameter for migration",
998 .mhandler.cmd = hmp_migrate_set_parameter,
999 .command_completion = migrate_set_parameter_completion,
1000 },
1001
1002STEXI
1003@item migrate_set_parameter @var{parameter} @var{value}
1004@findex migrate_set_parameter
1005Set the parameter @var{parameter} for migration.
1006ETEXI
1007
1008 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001009 .name = "client_migrate_info",
1010 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1011 .params = "protocol hostname port tls-port cert-subject",
Markus Armbruster13cadef2015-03-05 19:16:58 +01001012 .help = "set migration information for remote display",
Markus Armbrusterb8a185b2015-03-05 17:29:02 +01001013 .mhandler.cmd = hmp_client_migrate_info,
Jes Sorensenf8882562010-12-16 13:52:16 +01001014 },
1015
1016STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001017@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1018@findex client_migrate_info
Markus Armbruster13cadef2015-03-05 19:16:58 +01001019Set migration information for remote display. This makes the server
1020ask the client to automatically reconnect using the new parameters
1021once migration finished successfully. Only implemented for SPICE.
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001022ETEXI
1023
Wen Congyang783e9b42012-05-07 12:10:47 +08001024 {
1025 .name = "dump-guest-memory",
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001026 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1027 .params = "[-p] [-z|-l|-s] filename [begin length]",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001028 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1029 "-p: do paging to get guest's memory mapping.\n\t\t\t"
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001030 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1031 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1032 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001033 "begin: the starting physical address.\n\t\t\t"
1034 "length: the memory size, in bytes.",
Wen Congyang783e9b42012-05-07 12:10:47 +08001035 .mhandler.cmd = hmp_dump_guest_memory,
1036 },
1037
1038
1039STEXI
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001040@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001041@item dump-guest-memory [-z|-l|-s] @var{filename}
Wen Congyang783e9b42012-05-07 12:10:47 +08001042@findex dump-guest-memory
1043Dump guest memory to @var{protocol}. The file can be processed with crash or
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001044gdb. Without -z|-l|-s, the dump format is ELF.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001045 -p: do paging to get guest's memory mapping.
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001046 -z: dump in kdump-compressed format, with zlib compression.
1047 -l: dump in kdump-compressed format, with lzo compression.
1048 -s: dump in kdump-compressed format, with snappy compression.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001049 filename: dump file name.
Wen Congyang783e9b42012-05-07 12:10:47 +08001050 begin: the starting physical address. It's optional, and should be
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001051 specified together with length.
Wen Congyang783e9b42012-05-07 12:10:47 +08001052 length: the memory size, in bytes. It's optional, and should be specified
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001053 together with begin.
Wen Congyang783e9b42012-05-07 12:10:47 +08001054ETEXI
Wen Congyang783e9b42012-05-07 12:10:47 +08001055
Jason J. Hernea4538a52015-06-26 14:07:21 -04001056#if defined(TARGET_S390X)
1057 {
1058 .name = "dump-skeys",
1059 .args_type = "filename:F",
1060 .params = "",
1061 .help = "Save guest storage keys into file 'filename'.\n",
1062 .mhandler.cmd = hmp_dump_skeys,
1063 },
1064#endif
1065
1066STEXI
1067@item dump-skeys @var{filename}
1068@findex dump-skeys
1069Save guest storage keys to a file.
1070ETEXI
1071
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001072 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001073 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001074 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1075 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001076 .help = "initiates a live snapshot\n\t\t\t"
1077 "of device. If a new image file is specified, the\n\t\t\t"
1078 "new image file will become the new root image.\n\t\t\t"
1079 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001080 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001081 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1082 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1083 "recreating it from scratch.",
Luiz Capitulino6106e242011-11-25 16:15:19 -02001084 .mhandler.cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001085 },
1086
1087STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001088@item snapshot_blkdev
1089@findex snapshot_blkdev
1090Snapshot device, using snapshot file as target if provided
1091ETEXI
1092
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001093 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001094 .name = "snapshot_blkdev_internal",
1095 .args_type = "device:B,name:s",
1096 .params = "device name",
1097 .help = "take an internal snapshot of device.\n\t\t\t"
1098 "The format of the image used by device must\n\t\t\t"
1099 "support it, such as qcow2.\n\t\t\t",
1100 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1101 },
1102
1103STEXI
1104@item snapshot_blkdev_internal
1105@findex snapshot_blkdev_internal
1106Take an internal snapshot on device if it support
1107ETEXI
1108
1109 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001110 .name = "snapshot_delete_blkdev_internal",
1111 .args_type = "device:B,name:s,id:s?",
1112 .params = "device name [id]",
1113 .help = "delete an internal snapshot of device.\n\t\t\t"
1114 "If id is specified, qemu will try delete\n\t\t\t"
1115 "the snapshot matching both id and name.\n\t\t\t"
1116 "The format of the image used by device must\n\t\t\t"
1117 "support it, such as qcow2.\n\t\t\t",
1118 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1119 },
1120
1121STEXI
1122@item snapshot_delete_blkdev_internal
1123@findex snapshot_delete_blkdev_internal
1124Delete an internal snapshot on device if it support
1125ETEXI
1126
1127 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001128 .name = "drive_mirror",
1129 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1130 .params = "[-n] [-f] device target [format]",
1131 .help = "initiates live storage\n\t\t\t"
1132 "migration for a device. The device's contents are\n\t\t\t"
1133 "copied to the new image file, including data that\n\t\t\t"
1134 "is written after the command is started.\n\t\t\t"
1135 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1136 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1137 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1138 "so that the result does not need a backing file.\n\t\t\t",
1139 .mhandler.cmd = hmp_drive_mirror,
1140 },
1141STEXI
1142@item drive_mirror
1143@findex drive_mirror
1144Start mirroring a block device's writes to a new destination,
1145using the specified target.
1146ETEXI
1147
1148 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001149 .name = "drive_backup",
1150 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1151 .params = "[-n] [-f] device target [format]",
1152 .help = "initiates a point-in-time\n\t\t\t"
1153 "copy for a device. The device's contents are\n\t\t\t"
1154 "copied to the new image file, excluding data that\n\t\t\t"
1155 "is written after the command is started.\n\t\t\t"
1156 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1157 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1158 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1159 "so that the result does not need a backing file.\n\t\t\t",
1160 .mhandler.cmd = hmp_drive_backup,
1161 },
1162STEXI
1163@item drive_backup
1164@findex drive_backup
1165Start a point-in-time copy of a block device to a specificed target.
1166ETEXI
1167
1168 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001169 .name = "drive_add",
1170 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001171 .params = "[[<domain>:]<bus>:]<slot>\n"
1172 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001173 "[,unit=m][,media=d][,index=i]\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001174 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001175 "[,snapshot=on|off][,cache=on|off]\n"
1176 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001177 .help = "add drive to PCI storage controller",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001178 .mhandler.cmd = hmp_drive_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001179 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001180
Blue Swirl23130862009-06-06 08:22:04 +00001181STEXI
1182@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001183@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001184Add drive to PCI storage controller.
1185ETEXI
1186
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001187 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001188 .name = "pcie_aer_inject_error",
1189 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1190 "id:s,error_status:s,"
1191 "header0:i?,header1:i?,header2:i?,header3:i?,"
1192 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1193 .params = "[-a] [-c] id "
1194 "<error_status> [<tlp header> [<tlp header prefix>]]",
1195 .help = "inject pcie aer error\n\t\t\t"
1196 " -a for advisory non fatal error\n\t\t\t"
1197 " -c for correctable error\n\t\t\t"
1198 "<id> = qdev device id\n\t\t\t"
1199 "<error_status> = error string or 32bit\n\t\t\t"
1200 "<tlb header> = 32bit x 4\n\t\t\t"
1201 "<tlb header prefix> = 32bit x 4",
Markus Armbruster04e00c92015-03-05 17:48:49 +01001202 .mhandler.cmd = hmp_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001203 },
1204
1205STEXI
1206@item pcie_aer_inject_error
1207@findex pcie_aer_inject_error
1208Inject PCIe AER error
1209ETEXI
1210
1211 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001212 .name = "host_net_add",
1213 .args_type = "device:s,opts:s?",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001214 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001215 .help = "add host VLAN client",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001216 .mhandler.cmd = hmp_host_net_add,
Hani Benhabilese3bb5322014-05-27 23:39:34 +01001217 .command_completion = host_net_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001218 },
1219
Blue Swirl23130862009-06-06 08:22:04 +00001220STEXI
1221@item host_net_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001222@findex host_net_add
Blue Swirl23130862009-06-06 08:22:04 +00001223Add host VLAN client.
1224ETEXI
1225
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001226 {
1227 .name = "host_net_remove",
1228 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001229 .params = "vlan_id name",
1230 .help = "remove host VLAN client",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001231 .mhandler.cmd = hmp_host_net_remove,
Hani Benhabilesddd6b452014-05-27 23:39:36 +01001232 .command_completion = host_net_remove_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001233 },
1234
Blue Swirl23130862009-06-06 08:22:04 +00001235STEXI
1236@item host_net_remove
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001237@findex host_net_remove
Blue Swirl23130862009-06-06 08:22:04 +00001238Remove host VLAN client.
1239ETEXI
1240
Markus Armbrusterae82d322010-03-25 17:22:40 +01001241 {
1242 .name = "netdev_add",
1243 .args_type = "netdev:O",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001244 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001245 .help = "add host network device",
Luiz Capitulino928059a2012-04-18 17:34:15 -03001246 .mhandler.cmd = hmp_netdev_add,
Hani Benhabilesb162b492014-05-07 23:41:31 +01001247 .command_completion = netdev_add_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001248 },
1249
1250STEXI
1251@item netdev_add
1252@findex netdev_add
1253Add host network device.
1254ETEXI
1255
1256 {
1257 .name = "netdev_del",
1258 .args_type = "id:s",
1259 .params = "id",
1260 .help = "remove host network device",
Luiz Capitulino5f964152012-04-16 14:36:32 -03001261 .mhandler.cmd = hmp_netdev_del,
Hani Benhabiles11b389f2014-05-07 23:41:32 +01001262 .command_completion = netdev_del_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001263 },
1264
1265STEXI
1266@item netdev_del
1267@findex netdev_del
1268Remove host network device.
1269ETEXI
1270
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001271 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001272 .name = "object_add",
1273 .args_type = "object:O",
1274 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1275 .help = "create QOM object",
1276 .mhandler.cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001277 .command_completion = object_add_completion,
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001278 },
1279
1280STEXI
1281@item object_add
1282@findex object_add
1283Create QOM object.
1284ETEXI
1285
1286 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001287 .name = "object_del",
1288 .args_type = "id:s",
1289 .params = "id",
1290 .help = "destroy QOM object",
1291 .mhandler.cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001292 .command_completion = object_del_completion,
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001293 },
1294
1295STEXI
1296@item object_del
1297@findex object_del
1298Destroy QOM object.
1299ETEXI
1300
Blue Swirl23130862009-06-06 08:22:04 +00001301#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001302 {
1303 .name = "hostfwd_add",
1304 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001305 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1306 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001307 .mhandler.cmd = hmp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001308 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001309#endif
1310STEXI
1311@item hostfwd_add
1312@findex hostfwd_add
1313Redirect TCP or UDP connections from host to guest (requires -net user).
1314ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001315
Markus Armbruster21413d62010-05-04 13:20:30 +02001316#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001317 {
1318 .name = "hostfwd_remove",
1319 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001320 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1321 .help = "remove host-to-guest TCP or UDP redirection",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001322 .mhandler.cmd = hmp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001323 },
1324
Blue Swirl23130862009-06-06 08:22:04 +00001325#endif
1326STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001327@item hostfwd_remove
1328@findex hostfwd_remove
1329Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001330ETEXI
1331
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001332 {
1333 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001334 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001335 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001336 .help = "request VM to change its memory allocation (in MB)",
Luiz Capitulinod72f3262011-11-25 14:38:09 -02001337 .mhandler.cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001338 },
1339
Blue Swirl23130862009-06-06 08:22:04 +00001340STEXI
1341@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001342@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001343Request VM to change its memory allocation to @var{value} (in MB).
1344ETEXI
1345
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001346 {
1347 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001348 .args_type = "name:s,up:b",
1349 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001350 .help = "change the link status of a network adapter",
Luiz Capitulino4b371562011-11-23 13:11:55 -02001351 .mhandler.cmd = hmp_set_link,
Hani Benhabiles40d19392014-05-07 23:41:30 +01001352 .command_completion = set_link_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001353 },
1354
Blue Swirl23130862009-06-06 08:22:04 +00001355STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001356@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001357@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001358Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001359ETEXI
1360
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001361 {
1362 .name = "watchdog_action",
1363 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001364 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1365 .help = "change watchdog action",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001366 .mhandler.cmd = hmp_watchdog_action,
Hani Benhabilesd0ece342014-05-27 23:39:31 +01001367 .command_completion = watchdog_action_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001368 },
1369
Blue Swirl23130862009-06-06 08:22:04 +00001370STEXI
1371@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001372@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001373Change watchdog action.
1374ETEXI
1375
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001376 {
1377 .name = "acl_show",
1378 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001379 .params = "aclname",
1380 .help = "list rules in the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001381 .mhandler.cmd = hmp_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001382 },
1383
Blue Swirl23130862009-06-06 08:22:04 +00001384STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001385@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001386@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001387List all the matching rules in the access control list, and the default
1388policy. There are currently two named access control lists,
1389@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1390certificate distinguished name, and SASL username respectively.
1391ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001392
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001393 {
1394 .name = "acl_policy",
1395 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001396 .params = "aclname allow|deny",
1397 .help = "set default access control list policy",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001398 .mhandler.cmd = hmp_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001399 },
1400
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001401STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001402@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001403@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001404Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001405none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001406always @code{deny}.
1407ETEXI
1408
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001409 {
1410 .name = "acl_add",
1411 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001412 .params = "aclname match allow|deny [index]",
1413 .help = "add a match rule to the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001414 .mhandler.cmd = hmp_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001415 },
1416
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001417STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001418@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1419@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001420Add a match rule to the access control list, allowing or denying access.
1421The match will normally be an exact username or x509 distinguished name,
1422but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1423allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001424normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001425earlier in the list if the optional @var{index} parameter is supplied.
1426ETEXI
1427
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001428 {
1429 .name = "acl_remove",
1430 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001431 .params = "aclname match",
1432 .help = "remove a match rule from the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001433 .mhandler.cmd = hmp_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001434 },
1435
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001436STEXI
1437@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001438@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001439Remove the specified match rule from the access control list.
1440ETEXI
1441
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001442 {
1443 .name = "acl_reset",
1444 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001445 .params = "aclname",
1446 .help = "reset the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001447 .mhandler.cmd = hmp_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001448 },
1449
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001450STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001451@item acl_reset @var{aclname}
1452@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001453Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001454policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001455ETEXI
1456
Paolo Bonzini40577252012-08-23 11:53:04 +02001457 {
1458 .name = "nbd_server_start",
1459 .args_type = "all:-a,writable:-w,uri:s",
1460 .params = "nbd_server_start [-a] [-w] host:port",
1461 .help = "serve block devices on the given host and port",
1462 .mhandler.cmd = hmp_nbd_server_start,
1463 },
1464STEXI
1465@item nbd_server_start @var{host}:@var{port}
1466@findex nbd_server_start
1467Start an NBD server on the given host and/or port. If the @option{-a}
1468option is included, all of the virtual machine's block devices that
1469have an inserted media on them are automatically exported; in this case,
1470the @option{-w} option makes the devices writable too.
1471ETEXI
1472
1473 {
1474 .name = "nbd_server_add",
1475 .args_type = "writable:-w,device:B",
1476 .params = "nbd_server_add [-w] device",
1477 .help = "export a block device via NBD",
1478 .mhandler.cmd = hmp_nbd_server_add,
1479 },
1480STEXI
1481@item nbd_server_add @var{device}
1482@findex nbd_server_add
1483Export a block device through QEMU's NBD server, which must be started
1484beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1485exported device writable too.
1486ETEXI
1487
1488 {
1489 .name = "nbd_server_stop",
1490 .args_type = "",
1491 .params = "nbd_server_stop",
1492 .help = "stop serving block devices using the NBD protocol",
1493 .mhandler.cmd = hmp_nbd_server_stop,
1494 },
1495STEXI
1496@item nbd_server_stop
1497@findex nbd_server_stop
1498Stop the QEMU embedded NBD server.
1499ETEXI
1500
1501
Huang Ying79c4f6b2009-06-23 10:05:14 +08001502#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001503
1504 {
1505 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001506 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1507 .params = "[-b] cpu bank status mcgstatus addr misc",
1508 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001509 .mhandler.cmd = hmp_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001510 },
1511
Huang Ying79c4f6b2009-06-23 10:05:14 +08001512#endif
1513STEXI
1514@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001515@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001516Inject an MCE on the given CPU (x86 only).
1517ETEXI
1518
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001519 {
1520 .name = "getfd",
1521 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001522 .params = "getfd name",
1523 .help = "receive a file descriptor via SCM rights and assign it a name",
Corey Bryant208c9d12012-06-22 14:36:09 -04001524 .mhandler.cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001525 },
1526
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001527STEXI
1528@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001529@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001530If a file descriptor is passed alongside this command using the SCM_RIGHTS
1531mechanism on unix sockets, it is stored using the name @var{fdname} for
1532later use by other monitor commands.
1533ETEXI
1534
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001535 {
1536 .name = "closefd",
1537 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001538 .params = "closefd name",
1539 .help = "close a file descriptor previously passed via SCM rights",
Corey Bryant208c9d12012-06-22 14:36:09 -04001540 .mhandler.cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001541 },
1542
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001543STEXI
1544@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001545@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001546Close the file descriptor previously assigned to @var{fdname} using the
1547@code{getfd} command. This is only needed if the file descriptor was never
1548used by another monitor command.
1549ETEXI
1550
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001551 {
1552 .name = "block_passwd",
1553 .args_type = "device:B,password:s",
1554 .params = "block_passwd device password",
1555 .help = "set the password of encrypted block devices",
Luiz Capitulinoa4dea8a2011-11-23 13:28:21 -02001556 .mhandler.cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001557 },
1558
1559STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001560@item block_passwd @var{device} @var{password}
1561@findex block_passwd
1562Set the encrypted device @var{device} password to @var{password}
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001563ETEXI
1564
1565 {
1566 .name = "block_set_io_throttle",
1567 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1568 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1569 .help = "change I/O throttle limits for a block drive",
Luiz Capitulino80047da2011-12-14 16:49:14 -02001570 .mhandler.cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001571 },
1572
1573STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001574@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1575@findex block_set_io_throttle
1576Change 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 -02001577ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001578
Jan Kiszka33572ec2010-05-31 14:43:30 -03001579 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001580 .name = "set_password",
1581 .args_type = "protocol:s,password:s,connected:s?",
1582 .params = "protocol password action-if-connected",
1583 .help = "set spice/vnc password",
Luiz Capitulinofbf796f2011-12-07 11:17:51 -02001584 .mhandler.cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001585 },
1586
1587STEXI
1588@item set_password [ vnc | spice ] password [ action-if-connected ]
1589@findex set_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001590Change spice/vnc password. Use zero to make the password stay valid
1591forever. @var{action-if-connected} specifies what should happen in
1592case a connection is established: @var{fail} makes the password change
1593fail. @var{disconnect} changes the password and disconnects the
1594client. @var{keep} changes the password and keeps the connection up.
1595@var{keep} is the default.
1596ETEXI
1597
1598 {
1599 .name = "expire_password",
1600 .args_type = "protocol:s,time:s",
1601 .params = "protocol time",
1602 .help = "set spice/vnc password expire-time",
Luiz Capitulino9ad53722011-12-07 11:47:57 -02001603 .mhandler.cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001604 },
1605
1606STEXI
1607@item expire_password [ vnc | spice ] expire-time
1608@findex expire_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001609Specify when a password for spice/vnc becomes
1610invalid. @var{expire-time} accepts:
1611
1612@table @var
1613@item now
1614Invalidate password instantly.
1615
1616@item never
1617Password stays valid forever.
1618
1619@item +nsec
1620Password stays valid for @var{nsec} seconds starting now.
1621
1622@item nsec
1623Password is invalidated at the given time. @var{nsec} are the seconds
1624passed since 1970, i.e. unix epoch.
1625
1626@end table
1627ETEXI
1628
Gerd Hoffmann46920822013-02-28 08:46:10 +01001629 {
1630 .name = "chardev-add",
1631 .args_type = "args:s",
1632 .params = "args",
1633 .help = "add chardev",
1634 .mhandler.cmd = hmp_chardev_add,
Hani Benhabiles13e315d2014-05-07 23:41:29 +01001635 .command_completion = chardev_add_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001636 },
1637
1638STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001639@item chardev-add args
1640@findex chardev-add
Gerd Hoffmann46920822013-02-28 08:46:10 +01001641chardev_add accepts the same parameters as the -chardev command line switch.
1642
1643ETEXI
1644
1645 {
1646 .name = "chardev-remove",
1647 .args_type = "id:s",
1648 .params = "id",
1649 .help = "remove chardev",
1650 .mhandler.cmd = hmp_chardev_remove,
Hani Benhabiles6297d9a2014-05-07 23:41:28 +01001651 .command_completion = chardev_remove_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001652 },
1653
1654STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001655@item chardev-remove id
1656@findex chardev-remove
Gerd Hoffmann46920822013-02-28 08:46:10 +01001657Removes the chardev @var{id}.
1658
1659ETEXI
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001660
1661 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001662 .name = "qemu-io",
1663 .args_type = "device:B,command:s",
1664 .params = "[device] \"[command]\"",
1665 .help = "run a qemu-io command on a block device",
1666 .mhandler.cmd = hmp_qemu_io,
1667 },
1668
1669STEXI
1670@item qemu-io @var{device} @var{command}
1671@findex qemu-io
Kevin Wolf587da2c2013-06-05 14:19:41 +02001672Executes a qemu-io command on the given block device.
1673
1674ETEXI
1675
1676 {
Jason J. Herneabf23322013-12-11 13:24:14 -05001677 .name = "cpu-add",
1678 .args_type = "id:i",
1679 .params = "id",
1680 .help = "add cpu",
1681 .mhandler.cmd = hmp_cpu_add,
1682 },
1683
1684STEXI
1685@item cpu-add @var{id}
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001686@findex cpu-add
Jason J. Herneabf23322013-12-11 13:24:14 -05001687Add CPU with id @var{id}
1688ETEXI
1689
1690 {
Andreas Färber89d7fa92014-05-07 18:08:29 +02001691 .name = "qom-list",
1692 .args_type = "path:s?",
1693 .params = "path",
1694 .help = "list QOM properties",
1695 .mhandler.cmd = hmp_qom_list,
1696 },
1697
1698STEXI
1699@item qom-list [@var{path}]
1700Print QOM properties of object at location @var{path}
1701ETEXI
1702
1703 {
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001704 .name = "qom-set",
1705 .args_type = "path:s,property:s,value:s",
1706 .params = "path property value",
1707 .help = "set QOM property",
1708 .mhandler.cmd = hmp_qom_set,
1709 },
1710
1711STEXI
1712@item qom-set @var{path} @var{property} @var{value}
1713Set QOM property @var{property} of object at location @var{path} to value @var{value}
1714ETEXI
1715
1716 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001717 .name = "info",
1718 .args_type = "item:s?",
1719 .params = "[subcommand]",
1720 .help = "show various information about the system state",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001721 .mhandler.cmd = hmp_info_help,
Wenchao Xia84c44612013-01-14 14:06:29 +08001722 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001723 },
1724
1725STEXI
1726@item info @var{subcommand}
1727@findex info
1728Show various information about the system state.
1729
1730@table @option
1731@item info version
1732show the version of QEMU
Jan Kiszka33572ec2010-05-31 14:43:30 -03001733@item info network
1734show the various VLANs and the associated devices
1735@item info chardev
1736show the character devices
1737@item info block
1738show the block devices
1739@item info blockstats
1740show block device statistics
1741@item info registers
1742show the cpu registers
1743@item info cpus
1744show infos for each CPU
1745@item info history
1746show the command line history
1747@item info irq
1748show the interrupts statistics (if available)
1749@item info pic
1750show i8259 (PIC) state
1751@item info pci
1752show emulated PCI device info
1753@item info tlb
Max Filippov692f7372012-01-07 20:02:40 +04001754show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001755@item info mem
1756show the active virtual memory mappings (i386 only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001757@item info jit
1758show dynamic compiler info
Jan Kiszka33572ec2010-05-31 14:43:30 -03001759@item info numa
1760show NUMA information
Jan Kiszkab40292e2010-05-31 14:43:31 -03001761@item info kvm
1762show KVM information
Jan Kiszka33572ec2010-05-31 14:43:30 -03001763@item info usb
1764show USB devices plugged on the virtual USB hub
1765@item info usbhost
1766show all USB host devices
1767@item info profile
1768show profiling information
1769@item info capture
1770show information about active capturing
1771@item info snapshots
1772show list of VM snapshots
1773@item info status
1774show the current VM status (running|paused)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001775@item info mice
1776show which guest mouse is receiving events
1777@item info vnc
1778show the vnc server status
1779@item info name
1780show the current VM name
1781@item info uuid
1782show the current VM UUID
1783@item info cpustats
1784show CPU statistics
1785@item info usernet
1786show user network stack connection states
1787@item info migrate
1788show migration status
Orit Wassermanbbf6da32012-08-06 21:42:47 +03001789@item info migrate_capabilities
1790show current migration capabilities
Liang Li50e9a622015-03-23 16:32:29 +08001791@item info migrate_parameters
1792show current migration parameters
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +03001793@item info migrate_cache_size
1794show current migration XBZRLE cache size
Jan Kiszka33572ec2010-05-31 14:43:30 -03001795@item info balloon
1796show balloon information
1797@item info qtree
1798show device tree
1799@item info qdm
1800show qdev device model list
Andreas Färbera01ff752014-05-07 17:03:18 +02001801@item info qom-tree
1802show object composition tree
Jan Kiszka33572ec2010-05-31 14:43:30 -03001803@item info roms
1804show roms
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05001805@item info tpm
1806show the TPM device
Zhu Guihuaa6318922014-09-23 13:35:19 +08001807@item info memory-devices
1808show the memory devices
Jan Kiszka33572ec2010-05-31 14:43:30 -03001809@end table
1810ETEXI
1811
Lluís31965ae2011-08-31 20:31:24 +02001812STEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301813@item info trace-events
1814show available trace events and their state
1815ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301816
Blue Swirl23130862009-06-06 08:22:04 +00001817STEXI
Scott Feldmanfafa4d52015-06-10 18:21:21 -07001818@item rocker @var{name}
1819@findex rocker
1820Show Rocker(s)
1821ETEXI
1822
1823STEXI
1824@item rocker_ports @var{name}
1825@findex rocker_ports
1826Show Rocker ports
1827ETEXI
1828
1829STEXI
1830@item rocker_of_dpa_flows @var{name} [@var{tbl_id}]
1831@findex rocker_of_dpa_flows
1832Show Rocker OF-DPA flow tables
1833ETEXI
1834
1835STEXI
1836@item rocker_of_dpa_groups @var{name} [@var{type}]
1837@findex rocker_of_dpa_groups
1838Show Rocker OF-DPA groups
1839ETEXI
1840
1841STEXI
Blue Swirl23130862009-06-06 08:22:04 +00001842@end table
1843ETEXI