blob: 89fc09ffea4fae8f7b50223268161c1043e1a0da [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,
Dr. David Alan Gilbert987bd272015-08-14 11:27:43 +0100274 .command_completion = trace_event_completion,
Prerna Saxena22890ab2010-06-24 17:04:53 +0530275 },
276
277STEXI
278@item trace-event
279@findex trace-event
280changes status of a trace event
281ETEXI
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100282
Michael Rothc45a8162011-10-02 08:44:37 -0500283#if defined(CONFIG_TRACE_SIMPLE)
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100284 {
285 .name = "trace-file",
286 .args_type = "op:s?,arg:F?",
287 .params = "on|off|flush|set [arg]",
288 .help = "open, close, or flush trace file, or set a new file name",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100289 .mhandler.cmd = hmp_trace_file,
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100290 },
291
292STEXI
293@item trace-file on|off|flush
294@findex trace-file
295Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
296ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +0530297#endif
298
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300299 {
300 .name = "log",
301 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300302 .params = "item1[,...]",
Peter Maydell989b6972013-02-26 17:52:40 +0000303 .help = "activate logging of the specified items",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100304 .mhandler.cmd = hmp_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300305 },
306
Blue Swirl23130862009-06-06 08:22:04 +0000307STEXI
308@item log @var{item1}[,...]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100309@findex log
Peter Maydell989b6972013-02-26 17:52:40 +0000310Activate logging of the specified items.
Blue Swirl23130862009-06-06 08:22:04 +0000311ETEXI
312
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300313 {
314 .name = "savevm",
315 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300316 .params = "[tag|id]",
317 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100318 .mhandler.cmd = hmp_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300319 },
320
Blue Swirl23130862009-06-06 08:22:04 +0000321STEXI
322@item savevm [@var{tag}|@var{id}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100323@findex savevm
Blue Swirl23130862009-06-06 08:22:04 +0000324Create a snapshot of the whole virtual machine. If @var{tag} is
325provided, it is used as human readable identifier. If there is already
326a snapshot with the same tag or ID, it is replaced. More info at
327@ref{vm_snapshots}.
328ETEXI
329
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300330 {
331 .name = "loadvm",
332 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300333 .params = "tag|id",
334 .help = "restore a VM snapshot from its tag or id",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100335 .mhandler.cmd = hmp_loadvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100336 .command_completion = loadvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300337 },
338
Blue Swirl23130862009-06-06 08:22:04 +0000339STEXI
340@item loadvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100341@findex loadvm
Blue Swirl23130862009-06-06 08:22:04 +0000342Set the whole virtual machine to the snapshot identified by the tag
343@var{tag} or the unique snapshot ID @var{id}.
344ETEXI
345
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300346 {
347 .name = "delvm",
348 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300349 .params = "tag|id",
350 .help = "delete a VM snapshot from its tag or id",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100351 .mhandler.cmd = hmp_delvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100352 .command_completion = delvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300353 },
354
Blue Swirl23130862009-06-06 08:22:04 +0000355STEXI
356@item delvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100357@findex delvm
Blue Swirl23130862009-06-06 08:22:04 +0000358Delete the snapshot identified by @var{tag} or @var{id}.
359ETEXI
360
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300361 {
362 .name = "singlestep",
363 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300364 .params = "[on|off]",
365 .help = "run emulation in singlestep mode or switch to normal mode",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100366 .mhandler.cmd = hmp_singlestep,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300367 },
368
Blue Swirl23130862009-06-06 08:22:04 +0000369STEXI
370@item singlestep [off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100371@findex singlestep
Blue Swirl23130862009-06-06 08:22:04 +0000372Run the emulation in single step mode.
373If called with option off, the emulation returns to normal mode.
374ETEXI
375
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300376 {
377 .name = "stop",
378 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300379 .params = "",
380 .help = "stop emulation",
Luiz Capitulino5f158f22011-09-15 14:34:39 -0300381 .mhandler.cmd = hmp_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300382 },
383
Blue Swirl23130862009-06-06 08:22:04 +0000384STEXI
385@item stop
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100386@findex stop
Blue Swirl23130862009-06-06 08:22:04 +0000387Stop emulation.
388ETEXI
389
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300390 {
391 .name = "c|cont",
392 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300393 .params = "",
394 .help = "resume emulation",
Luiz Capitulinoe42e8182011-11-22 17:58:31 -0200395 .mhandler.cmd = hmp_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300396 },
397
Blue Swirl23130862009-06-06 08:22:04 +0000398STEXI
399@item c or cont
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100400@findex cont
Blue Swirl23130862009-06-06 08:22:04 +0000401Resume emulation.
402ETEXI
403
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300404 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100405 .name = "system_wakeup",
406 .args_type = "",
407 .params = "",
408 .help = "wakeup guest from suspend",
409 .mhandler.cmd = hmp_system_wakeup,
410 },
411
412STEXI
413@item system_wakeup
414@findex system_wakeup
415Wakeup guest from suspend.
416ETEXI
417
418 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300419 .name = "gdbserver",
420 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300421 .params = "[device]",
422 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100423 .mhandler.cmd = hmp_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300424 },
425
Blue Swirl23130862009-06-06 08:22:04 +0000426STEXI
427@item gdbserver [@var{port}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100428@findex gdbserver
Blue Swirl23130862009-06-06 08:22:04 +0000429Start gdbserver session (default @var{port}=1234)
430ETEXI
431
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300432 {
433 .name = "x",
434 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300435 .params = "/fmt addr",
436 .help = "virtual memory dump starting at 'addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100437 .mhandler.cmd = hmp_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300438 },
439
Blue Swirl23130862009-06-06 08:22:04 +0000440STEXI
441@item x/fmt @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100442@findex x
Blue Swirl23130862009-06-06 08:22:04 +0000443Virtual memory dump starting at @var{addr}.
444ETEXI
445
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300446 {
447 .name = "xp",
448 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300449 .params = "/fmt addr",
450 .help = "physical memory dump starting at 'addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100451 .mhandler.cmd = hmp_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300452 },
453
Blue Swirl23130862009-06-06 08:22:04 +0000454STEXI
455@item xp /@var{fmt} @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100456@findex xp
Blue Swirl23130862009-06-06 08:22:04 +0000457Physical memory dump starting at @var{addr}.
458
459@var{fmt} is a format which tells the command how to format the
460data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
461
462@table @var
463@item count
464is the number of items to be dumped.
465
466@item format
467can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
468c (char) or i (asm instruction).
469
470@item size
471can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
472@code{h} or @code{w} can be specified with the @code{i} format to
473respectively select 16 or 32 bit code instruction size.
474
475@end table
476
477Examples:
478@itemize
479@item
480Dump 10 instructions at the current instruction pointer:
481@example
482(qemu) x/10i $eip
4830x90107063: ret
4840x90107064: sti
4850x90107065: lea 0x0(%esi,1),%esi
4860x90107069: lea 0x0(%edi,1),%edi
4870x90107070: ret
4880x90107071: jmp 0x90107080
4890x90107073: nop
4900x90107074: nop
4910x90107075: nop
4920x90107076: nop
493@end example
494
495@item
496Dump 80 16 bit values at the start of the video memory.
497@smallexample
498(qemu) xp/80hx 0xb8000
4990x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
5000x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
5010x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
5020x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
5030x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
5040x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
5050x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5060x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5070x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5080x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
509@end smallexample
510@end itemize
511ETEXI
512
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300513 {
514 .name = "p|print",
515 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300516 .params = "/fmt expr",
517 .help = "print expression value (use $reg for CPU register access)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300518 .mhandler.cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300519 },
520
Blue Swirl23130862009-06-06 08:22:04 +0000521STEXI
522@item p or print/@var{fmt} @var{expr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100523@findex print
Blue Swirl23130862009-06-06 08:22:04 +0000524Print expression value. Only the @var{format} part of @var{fmt} is
525used.
526ETEXI
527
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300528 {
529 .name = "i",
530 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300531 .params = "/fmt addr",
532 .help = "I/O port read",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100533 .mhandler.cmd = hmp_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300534 },
535
Blue Swirl23130862009-06-06 08:22:04 +0000536STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100537@item i/@var{fmt} @var{addr} [.@var{index}]
538@findex i
Blue Swirl23130862009-06-06 08:22:04 +0000539Read I/O port.
540ETEXI
541
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300542 {
543 .name = "o",
544 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300545 .params = "/fmt addr value",
546 .help = "I/O port write",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100547 .mhandler.cmd = hmp_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300548 },
549
Jan Kiszkaf1147842009-07-14 10:20:11 +0200550STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100551@item o/@var{fmt} @var{addr} @var{val}
552@findex o
Jan Kiszkaf1147842009-07-14 10:20:11 +0200553Write to I/O port.
554ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000555
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300556 {
557 .name = "sendkey",
Amos Kong2ef20c12012-08-31 10:56:22 +0800558 .args_type = "keys:s,hold-time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300559 .params = "keys [hold_ms]",
560 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100561 .mhandler.cmd = hmp_sendkey,
Hani Benhabiles29136cd2014-05-07 23:41:27 +0100562 .command_completion = sendkey_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300563 },
564
Blue Swirl23130862009-06-06 08:22:04 +0000565STEXI
566@item sendkey @var{keys}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100567@findex sendkey
Amos Kong886cc702012-08-31 10:56:20 +0800568Send @var{keys} to the guest. @var{keys} could be the name of the
569key or the raw value in hexadecimal format. Use @code{-} to press
570several keys simultaneously. Example:
Blue Swirl23130862009-06-06 08:22:04 +0000571@example
572sendkey ctrl-alt-f1
573@end example
574
575This command is useful to send keys that your graphical user interface
576intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
577ETEXI
578
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300579 {
580 .name = "system_reset",
581 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300582 .params = "",
583 .help = "reset the system",
Luiz Capitulino38d22652011-09-15 14:41:46 -0300584 .mhandler.cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300585 },
586
Blue Swirl23130862009-06-06 08:22:04 +0000587STEXI
588@item system_reset
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100589@findex system_reset
Blue Swirl23130862009-06-06 08:22:04 +0000590Reset the system.
591ETEXI
592
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300593 {
594 .name = "system_powerdown",
595 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300596 .params = "",
597 .help = "send system power down event",
Luiz Capitulino5bc465e2011-09-28 11:06:15 -0300598 .mhandler.cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300599 },
600
Blue Swirl23130862009-06-06 08:22:04 +0000601STEXI
602@item system_powerdown
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100603@findex system_powerdown
Blue Swirl23130862009-06-06 08:22:04 +0000604Power down the system (if supported).
605ETEXI
606
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300607 {
608 .name = "sum",
609 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300610 .params = "addr size",
611 .help = "compute the checksum of a memory region",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100612 .mhandler.cmd = hmp_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300613 },
614
Blue Swirl23130862009-06-06 08:22:04 +0000615STEXI
616@item sum @var{addr} @var{size}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100617@findex sum
Blue Swirl23130862009-06-06 08:22:04 +0000618Compute the checksum of a memory region.
619ETEXI
620
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300621 {
622 .name = "usb_add",
623 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300624 .params = "device",
625 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100626 .mhandler.cmd = hmp_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300627 },
628
Blue Swirl23130862009-06-06 08:22:04 +0000629STEXI
630@item usb_add @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100631@findex usb_add
Blue Swirl23130862009-06-06 08:22:04 +0000632Add the USB device @var{devname}. For details of available devices see
633@ref{usb_devices}
634ETEXI
635
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300636 {
637 .name = "usb_del",
638 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300639 .params = "device",
640 .help = "remove USB device 'bus.addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100641 .mhandler.cmd = hmp_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300642 },
643
Blue Swirl23130862009-06-06 08:22:04 +0000644STEXI
645@item usb_del @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100646@findex usb_del
Blue Swirl23130862009-06-06 08:22:04 +0000647Remove the USB device @var{devname} from the QEMU virtual USB
648hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
649command @code{info usb} to see the devices you can remove.
650ETEXI
651
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300652 {
653 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100654 .args_type = "device:O",
655 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300656 .help = "add device, like -device on the command line",
Markus Armbruster318660f2015-03-05 17:24:48 +0100657 .mhandler.cmd = hmp_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100658 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300659 },
660
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200661STEXI
662@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100663@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200664Add device.
665ETEXI
666
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300667 {
668 .name = "device_del",
669 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300670 .params = "device",
671 .help = "remove device",
Luiz Capitulinoa15fef22012-03-29 12:38:50 -0300672 .mhandler.cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100673 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300674 },
675
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200676STEXI
677@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100678@findex device_del
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200679Remove device @var{id}.
680ETEXI
681
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300682 {
683 .name = "cpu",
684 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300685 .params = "index",
686 .help = "set the default CPU",
Luiz Capitulino755f1962011-10-06 14:31:39 -0300687 .mhandler.cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300688 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200689
Blue Swirl23130862009-06-06 08:22:04 +0000690STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200691@item cpu @var{index}
692@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000693Set the default CPU.
694ETEXI
695
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300696 {
697 .name = "mouse_move",
698 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300699 .params = "dx dy [dz]",
700 .help = "send mouse move events",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100701 .mhandler.cmd = hmp_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300702 },
703
Blue Swirl23130862009-06-06 08:22:04 +0000704STEXI
705@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100706@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000707Move the active mouse to the specified coordinates @var{dx} @var{dy}
708with optional scroll axis @var{dz}.
709ETEXI
710
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300711 {
712 .name = "mouse_button",
713 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300714 .params = "state",
715 .help = "change mouse button state (1=L, 2=M, 4=R)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100716 .mhandler.cmd = hmp_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300717 },
718
Blue Swirl23130862009-06-06 08:22:04 +0000719STEXI
720@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100721@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000722Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
723ETEXI
724
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300725 {
726 .name = "mouse_set",
727 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300728 .params = "index",
729 .help = "set which mouse device receives events",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100730 .mhandler.cmd = hmp_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300731 },
732
Blue Swirl23130862009-06-06 08:22:04 +0000733STEXI
734@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100735@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000736Set which mouse device receives events at given @var{index}, index
737can be obtained with
738@example
739info mice
740@end example
741ETEXI
742
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300743 {
744 .name = "wavcapture",
745 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300746 .params = "path [frequency [bits [channels]]]",
747 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100748 .mhandler.cmd = hmp_wavcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300749 },
Blue Swirl23130862009-06-06 08:22:04 +0000750STEXI
751@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100752@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000753Capture audio into @var{filename}. Using sample rate @var{frequency}
754bits per sample @var{bits} and number of channels @var{channels}.
755
756Defaults:
757@itemize @minus
758@item Sample rate = 44100 Hz - CD quality
759@item Bits = 16
760@item Number of channels = 2 - Stereo
761@end itemize
762ETEXI
763
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300764 {
765 .name = "stopcapture",
766 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300767 .params = "capture index",
768 .help = "stop capture",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100769 .mhandler.cmd = hmp_stopcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300770 },
Blue Swirl23130862009-06-06 08:22:04 +0000771STEXI
772@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100773@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000774Stop capture with a given @var{index}, index can be obtained with
775@example
776info capture
777@end example
778ETEXI
779
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300780 {
781 .name = "memsave",
782 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300783 .params = "addr size file",
784 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulino0cfd6a92011-11-22 16:32:37 -0200785 .mhandler.cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300786 },
787
Blue Swirl23130862009-06-06 08:22:04 +0000788STEXI
789@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100790@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000791save to disk virtual memory dump starting at @var{addr} of size @var{size}.
792ETEXI
793
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300794 {
795 .name = "pmemsave",
796 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300797 .params = "addr size file",
798 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulino6d3962b2011-11-22 17:26:46 -0200799 .mhandler.cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300800 },
801
Blue Swirl23130862009-06-06 08:22:04 +0000802STEXI
803@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100804@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000805save to disk physical memory dump starting at @var{addr} of size @var{size}.
806ETEXI
807
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300808 {
809 .name = "boot_set",
810 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300811 .params = "bootdevice",
812 .help = "define new values for the boot device list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100813 .mhandler.cmd = hmp_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300814 },
815
Blue Swirl23130862009-06-06 08:22:04 +0000816STEXI
817@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100818@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000819Define new values for the boot device list. Those values will override
820the values specified on the command line through the @code{-boot} option.
821
822The values that can be specified here depend on the machine type, but are
823the same that can be specified in the @code{-boot} command line option.
824ETEXI
825
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300826 {
827 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300828 .args_type = "",
829 .params = "",
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000830 .help = "inject an NMI",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100831 .mhandler.cmd = hmp_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300832 },
Blue Swirl23130862009-06-06 08:22:04 +0000833STEXI
834@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100835@findex nmi
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000836Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
Lei Li1f590cf2013-01-25 00:03:20 +0800837
838ETEXI
839
840 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100841 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800842 .args_type = "device:s,data:s",
843 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100844 .help = "Write to a ring buffer character device",
845 .mhandler.cmd = hmp_ringbuf_write,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100846 .command_completion = ringbuf_write_completion,
Lei Li1f590cf2013-01-25 00:03:20 +0800847 },
848
849STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100850@item ringbuf_write @var{device} @var{data}
851@findex ringbuf_write
852Write @var{data} to ring buffer character device @var{device}.
853@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800854
Blue Swirl23130862009-06-06 08:22:04 +0000855ETEXI
856
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300857 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100858 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800859 .args_type = "device:s,size:i",
860 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100861 .help = "Read from a ring buffer character device",
862 .mhandler.cmd = hmp_ringbuf_read,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100863 .command_completion = ringbuf_write_completion,
Lei Li49b6d722013-01-25 00:03:21 +0800864 },
865
866STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100867@item ringbuf_read @var{device}
868@findex ringbuf_read
869Read and print up to @var{size} bytes from ring buffer character
870device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100871Certain non-printable characters are printed \uXXXX, where XXXX is the
872character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100873Bug: can screw up when the buffer contains invalid UTF-8 sequences,
874NUL characters, after the ring buffer lost data, and when reading
875stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800876
877ETEXI
878
879 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300880 .name = "migrate",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200881 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
882 .params = "[-d] [-b] [-i] uri",
883 .help = "migrate to URI (using -d to not wait for completion)"
884 "\n\t\t\t -b for migration without shared storage with"
885 " full copy of disk\n\t\t\t -i for migration without "
886 "shared storage with incremental copy of disk "
887 "(base image shared between src and destination)",
Luiz Capitulinoe1c37d02011-12-05 14:48:01 -0200888 .mhandler.cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300889 },
890
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200891
Blue Swirl23130862009-06-06 08:22:04 +0000892STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200893@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100894@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000895Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200896 -b for migration with full copy of disk
897 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000898ETEXI
899
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300900 {
901 .name = "migrate_cancel",
902 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300903 .params = "",
904 .help = "cancel the current VM migration",
Luiz Capitulino6cdedb02011-11-27 22:54:09 -0200905 .mhandler.cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300906 },
907
Blue Swirl23130862009-06-06 08:22:04 +0000908STEXI
909@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100910@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000911Cancel the current VM migration.
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300912
913ETEXI
914
915 {
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000916 .name = "migrate_incoming",
917 .args_type = "uri:s",
918 .params = "uri",
919 .help = "Continue an incoming migration from an -incoming defer",
920 .mhandler.cmd = hmp_migrate_incoming,
921 },
922
923STEXI
924@item migrate_incoming @var{uri}
925@findex migrate_incoming
926Continue an incoming migration using the @var{uri} (that has the same syntax
927as the -incoming option).
928
929ETEXI
930
931 {
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300932 .name = "migrate_set_cache_size",
933 .args_type = "value:o",
934 .params = "value",
935 .help = "set cache size (in bytes) for XBZRLE migrations,"
936 "the cache size will be rounded down to the nearest "
937 "power of 2.\n"
938 "The cache size affects the number of cache misses."
939 "In case of a high cache miss ratio you need to increase"
940 " the cache size",
941 .mhandler.cmd = hmp_migrate_set_cache_size,
942 },
943
944STEXI
945@item migrate_set_cache_size @var{value}
946@findex migrate_set_cache_size
947Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +0000948ETEXI
949
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300950 {
951 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200952 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300953 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200954 .help = "set maximum speed (in bytes) for migrations. "
955 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Luiz Capitulino3dc85382011-11-28 11:59:37 -0200956 .mhandler.cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300957 },
958
Blue Swirl23130862009-06-06 08:22:04 +0000959STEXI
960@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100961@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +0000962Set maximum speed to @var{value} (in bytes) for migrations.
963ETEXI
964
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300965 {
966 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +0100967 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300968 .params = "value",
969 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulino4f0a9932011-11-27 23:18:01 -0200970 .mhandler.cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300971 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400972
973STEXI
974@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100975@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -0400976Set maximum tolerated downtime (in seconds) for migration.
977ETEXI
978
Jes Sorensenf8882562010-12-16 13:52:16 +0100979 {
Orit Wasserman00458432012-08-06 21:42:48 +0300980 .name = "migrate_set_capability",
981 .args_type = "capability:s,state:b",
982 .params = "capability state",
983 .help = "Enable/Disable the usage of a capability for migration",
984 .mhandler.cmd = hmp_migrate_set_capability,
Hani Benhabilesc68a0402014-05-27 23:39:32 +0100985 .command_completion = migrate_set_capability_completion,
Orit Wasserman00458432012-08-06 21:42:48 +0300986 },
987
988STEXI
989@item migrate_set_capability @var{capability} @var{state}
990@findex migrate_set_capability
991Enable/Disable the usage of a capability @var{capability} for migration.
992ETEXI
993
994 {
Liang Li50e9a622015-03-23 16:32:29 +0800995 .name = "migrate_set_parameter",
996 .args_type = "parameter:s,value:i",
997 .params = "parameter value",
998 .help = "Set the parameter for migration",
999 .mhandler.cmd = hmp_migrate_set_parameter,
1000 .command_completion = migrate_set_parameter_completion,
1001 },
1002
1003STEXI
1004@item migrate_set_parameter @var{parameter} @var{value}
1005@findex migrate_set_parameter
1006Set the parameter @var{parameter} for migration.
1007ETEXI
1008
1009 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001010 .name = "client_migrate_info",
1011 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1012 .params = "protocol hostname port tls-port cert-subject",
Markus Armbruster13cadef2015-03-05 19:16:58 +01001013 .help = "set migration information for remote display",
Markus Armbrusterb8a185b2015-03-05 17:29:02 +01001014 .mhandler.cmd = hmp_client_migrate_info,
Jes Sorensenf8882562010-12-16 13:52:16 +01001015 },
1016
1017STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001018@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1019@findex client_migrate_info
Markus Armbruster13cadef2015-03-05 19:16:58 +01001020Set migration information for remote display. This makes the server
1021ask the client to automatically reconnect using the new parameters
1022once migration finished successfully. Only implemented for SPICE.
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001023ETEXI
1024
Wen Congyang783e9b42012-05-07 12:10:47 +08001025 {
1026 .name = "dump-guest-memory",
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001027 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1028 .params = "[-p] [-z|-l|-s] filename [begin length]",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001029 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1030 "-p: do paging to get guest's memory mapping.\n\t\t\t"
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001031 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1032 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1033 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001034 "begin: the starting physical address.\n\t\t\t"
1035 "length: the memory size, in bytes.",
Wen Congyang783e9b42012-05-07 12:10:47 +08001036 .mhandler.cmd = hmp_dump_guest_memory,
1037 },
1038
1039
1040STEXI
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001041@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001042@item dump-guest-memory [-z|-l|-s] @var{filename}
Wen Congyang783e9b42012-05-07 12:10:47 +08001043@findex dump-guest-memory
1044Dump guest memory to @var{protocol}. The file can be processed with crash or
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001045gdb. Without -z|-l|-s, the dump format is ELF.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001046 -p: do paging to get guest's memory mapping.
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001047 -z: dump in kdump-compressed format, with zlib compression.
1048 -l: dump in kdump-compressed format, with lzo compression.
1049 -s: dump in kdump-compressed format, with snappy compression.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001050 filename: dump file name.
Wen Congyang783e9b42012-05-07 12:10:47 +08001051 begin: the starting physical address. It's optional, and should be
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001052 specified together with length.
Wen Congyang783e9b42012-05-07 12:10:47 +08001053 length: the memory size, in bytes. It's optional, and should be specified
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001054 together with begin.
Wen Congyang783e9b42012-05-07 12:10:47 +08001055ETEXI
Wen Congyang783e9b42012-05-07 12:10:47 +08001056
Jason J. Hernea4538a52015-06-26 14:07:21 -04001057#if defined(TARGET_S390X)
1058 {
1059 .name = "dump-skeys",
1060 .args_type = "filename:F",
1061 .params = "",
1062 .help = "Save guest storage keys into file 'filename'.\n",
1063 .mhandler.cmd = hmp_dump_skeys,
1064 },
1065#endif
1066
1067STEXI
1068@item dump-skeys @var{filename}
1069@findex dump-skeys
1070Save guest storage keys to a file.
1071ETEXI
1072
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001073 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001074 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001075 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1076 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001077 .help = "initiates a live snapshot\n\t\t\t"
1078 "of device. If a new image file is specified, the\n\t\t\t"
1079 "new image file will become the new root image.\n\t\t\t"
1080 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001081 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001082 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1083 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1084 "recreating it from scratch.",
Luiz Capitulino6106e242011-11-25 16:15:19 -02001085 .mhandler.cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001086 },
1087
1088STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001089@item snapshot_blkdev
1090@findex snapshot_blkdev
1091Snapshot device, using snapshot file as target if provided
1092ETEXI
1093
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001094 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001095 .name = "snapshot_blkdev_internal",
1096 .args_type = "device:B,name:s",
1097 .params = "device name",
1098 .help = "take an internal snapshot of device.\n\t\t\t"
1099 "The format of the image used by device must\n\t\t\t"
1100 "support it, such as qcow2.\n\t\t\t",
1101 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1102 },
1103
1104STEXI
1105@item snapshot_blkdev_internal
1106@findex snapshot_blkdev_internal
1107Take an internal snapshot on device if it support
1108ETEXI
1109
1110 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001111 .name = "snapshot_delete_blkdev_internal",
1112 .args_type = "device:B,name:s,id:s?",
1113 .params = "device name [id]",
1114 .help = "delete an internal snapshot of device.\n\t\t\t"
1115 "If id is specified, qemu will try delete\n\t\t\t"
1116 "the snapshot matching both id and name.\n\t\t\t"
1117 "The format of the image used by device must\n\t\t\t"
1118 "support it, such as qcow2.\n\t\t\t",
1119 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1120 },
1121
1122STEXI
1123@item snapshot_delete_blkdev_internal
1124@findex snapshot_delete_blkdev_internal
1125Delete an internal snapshot on device if it support
1126ETEXI
1127
1128 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001129 .name = "drive_mirror",
1130 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1131 .params = "[-n] [-f] device target [format]",
1132 .help = "initiates live storage\n\t\t\t"
1133 "migration for a device. The device's contents are\n\t\t\t"
1134 "copied to the new image file, including data that\n\t\t\t"
1135 "is written after the command is started.\n\t\t\t"
1136 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1137 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1138 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1139 "so that the result does not need a backing file.\n\t\t\t",
1140 .mhandler.cmd = hmp_drive_mirror,
1141 },
1142STEXI
1143@item drive_mirror
1144@findex drive_mirror
1145Start mirroring a block device's writes to a new destination,
1146using the specified target.
1147ETEXI
1148
1149 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001150 .name = "drive_backup",
1151 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1152 .params = "[-n] [-f] device target [format]",
1153 .help = "initiates a point-in-time\n\t\t\t"
1154 "copy for a device. The device's contents are\n\t\t\t"
1155 "copied to the new image file, excluding data that\n\t\t\t"
1156 "is written after the command is started.\n\t\t\t"
1157 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1158 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1159 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1160 "so that the result does not need a backing file.\n\t\t\t",
1161 .mhandler.cmd = hmp_drive_backup,
1162 },
1163STEXI
1164@item drive_backup
1165@findex drive_backup
1166Start a point-in-time copy of a block device to a specificed target.
1167ETEXI
1168
1169 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001170 .name = "drive_add",
1171 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001172 .params = "[[<domain>:]<bus>:]<slot>\n"
1173 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001174 "[,unit=m][,media=d][,index=i]\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001175 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001176 "[,snapshot=on|off][,cache=on|off]\n"
1177 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001178 .help = "add drive to PCI storage controller",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001179 .mhandler.cmd = hmp_drive_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001180 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001181
Blue Swirl23130862009-06-06 08:22:04 +00001182STEXI
1183@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001184@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001185Add drive to PCI storage controller.
1186ETEXI
1187
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001188 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001189 .name = "pcie_aer_inject_error",
1190 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1191 "id:s,error_status:s,"
1192 "header0:i?,header1:i?,header2:i?,header3:i?,"
1193 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1194 .params = "[-a] [-c] id "
1195 "<error_status> [<tlp header> [<tlp header prefix>]]",
1196 .help = "inject pcie aer error\n\t\t\t"
1197 " -a for advisory non fatal error\n\t\t\t"
1198 " -c for correctable error\n\t\t\t"
1199 "<id> = qdev device id\n\t\t\t"
1200 "<error_status> = error string or 32bit\n\t\t\t"
1201 "<tlb header> = 32bit x 4\n\t\t\t"
1202 "<tlb header prefix> = 32bit x 4",
Markus Armbruster04e00c92015-03-05 17:48:49 +01001203 .mhandler.cmd = hmp_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001204 },
1205
1206STEXI
1207@item pcie_aer_inject_error
1208@findex pcie_aer_inject_error
1209Inject PCIe AER error
1210ETEXI
1211
1212 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001213 .name = "host_net_add",
1214 .args_type = "device:s,opts:s?",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001215 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001216 .help = "add host VLAN client",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001217 .mhandler.cmd = hmp_host_net_add,
Hani Benhabilese3bb5322014-05-27 23:39:34 +01001218 .command_completion = host_net_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001219 },
1220
Blue Swirl23130862009-06-06 08:22:04 +00001221STEXI
1222@item host_net_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001223@findex host_net_add
Blue Swirl23130862009-06-06 08:22:04 +00001224Add host VLAN client.
1225ETEXI
1226
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001227 {
1228 .name = "host_net_remove",
1229 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001230 .params = "vlan_id name",
1231 .help = "remove host VLAN client",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001232 .mhandler.cmd = hmp_host_net_remove,
Hani Benhabilesddd6b452014-05-27 23:39:36 +01001233 .command_completion = host_net_remove_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001234 },
1235
Blue Swirl23130862009-06-06 08:22:04 +00001236STEXI
1237@item host_net_remove
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001238@findex host_net_remove
Blue Swirl23130862009-06-06 08:22:04 +00001239Remove host VLAN client.
1240ETEXI
1241
Markus Armbrusterae82d322010-03-25 17:22:40 +01001242 {
1243 .name = "netdev_add",
1244 .args_type = "netdev:O",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001245 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001246 .help = "add host network device",
Luiz Capitulino928059a2012-04-18 17:34:15 -03001247 .mhandler.cmd = hmp_netdev_add,
Hani Benhabilesb162b492014-05-07 23:41:31 +01001248 .command_completion = netdev_add_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001249 },
1250
1251STEXI
1252@item netdev_add
1253@findex netdev_add
1254Add host network device.
1255ETEXI
1256
1257 {
1258 .name = "netdev_del",
1259 .args_type = "id:s",
1260 .params = "id",
1261 .help = "remove host network device",
Luiz Capitulino5f964152012-04-16 14:36:32 -03001262 .mhandler.cmd = hmp_netdev_del,
Hani Benhabiles11b389f2014-05-07 23:41:32 +01001263 .command_completion = netdev_del_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001264 },
1265
1266STEXI
1267@item netdev_del
1268@findex netdev_del
1269Remove host network device.
1270ETEXI
1271
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001272 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001273 .name = "object_add",
1274 .args_type = "object:O",
1275 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1276 .help = "create QOM object",
1277 .mhandler.cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001278 .command_completion = object_add_completion,
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001279 },
1280
1281STEXI
1282@item object_add
1283@findex object_add
1284Create QOM object.
1285ETEXI
1286
1287 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001288 .name = "object_del",
1289 .args_type = "id:s",
1290 .params = "id",
1291 .help = "destroy QOM object",
1292 .mhandler.cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001293 .command_completion = object_del_completion,
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001294 },
1295
1296STEXI
1297@item object_del
1298@findex object_del
1299Destroy QOM object.
1300ETEXI
1301
Blue Swirl23130862009-06-06 08:22:04 +00001302#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001303 {
1304 .name = "hostfwd_add",
1305 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001306 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1307 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001308 .mhandler.cmd = hmp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001309 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001310#endif
1311STEXI
1312@item hostfwd_add
1313@findex hostfwd_add
1314Redirect TCP or UDP connections from host to guest (requires -net user).
1315ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001316
Markus Armbruster21413d62010-05-04 13:20:30 +02001317#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001318 {
1319 .name = "hostfwd_remove",
1320 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001321 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1322 .help = "remove host-to-guest TCP or UDP redirection",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001323 .mhandler.cmd = hmp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001324 },
1325
Blue Swirl23130862009-06-06 08:22:04 +00001326#endif
1327STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001328@item hostfwd_remove
1329@findex hostfwd_remove
1330Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001331ETEXI
1332
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001333 {
1334 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001335 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001336 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001337 .help = "request VM to change its memory allocation (in MB)",
Luiz Capitulinod72f3262011-11-25 14:38:09 -02001338 .mhandler.cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001339 },
1340
Blue Swirl23130862009-06-06 08:22:04 +00001341STEXI
1342@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001343@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001344Request VM to change its memory allocation to @var{value} (in MB).
1345ETEXI
1346
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001347 {
1348 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001349 .args_type = "name:s,up:b",
1350 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001351 .help = "change the link status of a network adapter",
Luiz Capitulino4b371562011-11-23 13:11:55 -02001352 .mhandler.cmd = hmp_set_link,
Hani Benhabiles40d19392014-05-07 23:41:30 +01001353 .command_completion = set_link_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001354 },
1355
Blue Swirl23130862009-06-06 08:22:04 +00001356STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001357@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001358@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001359Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001360ETEXI
1361
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001362 {
1363 .name = "watchdog_action",
1364 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001365 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1366 .help = "change watchdog action",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001367 .mhandler.cmd = hmp_watchdog_action,
Hani Benhabilesd0ece342014-05-27 23:39:31 +01001368 .command_completion = watchdog_action_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001369 },
1370
Blue Swirl23130862009-06-06 08:22:04 +00001371STEXI
1372@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001373@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001374Change watchdog action.
1375ETEXI
1376
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001377 {
1378 .name = "acl_show",
1379 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001380 .params = "aclname",
1381 .help = "list rules in the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001382 .mhandler.cmd = hmp_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001383 },
1384
Blue Swirl23130862009-06-06 08:22:04 +00001385STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001386@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001387@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001388List all the matching rules in the access control list, and the default
1389policy. There are currently two named access control lists,
1390@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1391certificate distinguished name, and SASL username respectively.
1392ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001393
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001394 {
1395 .name = "acl_policy",
1396 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001397 .params = "aclname allow|deny",
1398 .help = "set default access control list policy",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001399 .mhandler.cmd = hmp_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001400 },
1401
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001402STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001403@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001404@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001405Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001406none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001407always @code{deny}.
1408ETEXI
1409
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001410 {
1411 .name = "acl_add",
1412 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001413 .params = "aclname match allow|deny [index]",
1414 .help = "add a match rule to the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001415 .mhandler.cmd = hmp_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001416 },
1417
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001418STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001419@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1420@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001421Add a match rule to the access control list, allowing or denying access.
1422The match will normally be an exact username or x509 distinguished name,
1423but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1424allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001425normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001426earlier in the list if the optional @var{index} parameter is supplied.
1427ETEXI
1428
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001429 {
1430 .name = "acl_remove",
1431 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001432 .params = "aclname match",
1433 .help = "remove a match rule from the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001434 .mhandler.cmd = hmp_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001435 },
1436
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001437STEXI
1438@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001439@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001440Remove the specified match rule from the access control list.
1441ETEXI
1442
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001443 {
1444 .name = "acl_reset",
1445 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001446 .params = "aclname",
1447 .help = "reset the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001448 .mhandler.cmd = hmp_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001449 },
1450
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001451STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001452@item acl_reset @var{aclname}
1453@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001454Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001455policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001456ETEXI
1457
Paolo Bonzini40577252012-08-23 11:53:04 +02001458 {
1459 .name = "nbd_server_start",
1460 .args_type = "all:-a,writable:-w,uri:s",
1461 .params = "nbd_server_start [-a] [-w] host:port",
1462 .help = "serve block devices on the given host and port",
1463 .mhandler.cmd = hmp_nbd_server_start,
1464 },
1465STEXI
1466@item nbd_server_start @var{host}:@var{port}
1467@findex nbd_server_start
1468Start an NBD server on the given host and/or port. If the @option{-a}
1469option is included, all of the virtual machine's block devices that
1470have an inserted media on them are automatically exported; in this case,
1471the @option{-w} option makes the devices writable too.
1472ETEXI
1473
1474 {
1475 .name = "nbd_server_add",
1476 .args_type = "writable:-w,device:B",
1477 .params = "nbd_server_add [-w] device",
1478 .help = "export a block device via NBD",
1479 .mhandler.cmd = hmp_nbd_server_add,
1480 },
1481STEXI
1482@item nbd_server_add @var{device}
1483@findex nbd_server_add
1484Export a block device through QEMU's NBD server, which must be started
1485beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1486exported device writable too.
1487ETEXI
1488
1489 {
1490 .name = "nbd_server_stop",
1491 .args_type = "",
1492 .params = "nbd_server_stop",
1493 .help = "stop serving block devices using the NBD protocol",
1494 .mhandler.cmd = hmp_nbd_server_stop,
1495 },
1496STEXI
1497@item nbd_server_stop
1498@findex nbd_server_stop
1499Stop the QEMU embedded NBD server.
1500ETEXI
1501
1502
Huang Ying79c4f6b2009-06-23 10:05:14 +08001503#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001504
1505 {
1506 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001507 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1508 .params = "[-b] cpu bank status mcgstatus addr misc",
1509 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001510 .mhandler.cmd = hmp_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001511 },
1512
Huang Ying79c4f6b2009-06-23 10:05:14 +08001513#endif
1514STEXI
1515@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001516@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001517Inject an MCE on the given CPU (x86 only).
1518ETEXI
1519
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001520 {
1521 .name = "getfd",
1522 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001523 .params = "getfd name",
1524 .help = "receive a file descriptor via SCM rights and assign it a name",
Corey Bryant208c9d12012-06-22 14:36:09 -04001525 .mhandler.cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001526 },
1527
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001528STEXI
1529@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001530@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001531If a file descriptor is passed alongside this command using the SCM_RIGHTS
1532mechanism on unix sockets, it is stored using the name @var{fdname} for
1533later use by other monitor commands.
1534ETEXI
1535
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001536 {
1537 .name = "closefd",
1538 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001539 .params = "closefd name",
1540 .help = "close a file descriptor previously passed via SCM rights",
Corey Bryant208c9d12012-06-22 14:36:09 -04001541 .mhandler.cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001542 },
1543
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001544STEXI
1545@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001546@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001547Close the file descriptor previously assigned to @var{fdname} using the
1548@code{getfd} command. This is only needed if the file descriptor was never
1549used by another monitor command.
1550ETEXI
1551
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001552 {
1553 .name = "block_passwd",
1554 .args_type = "device:B,password:s",
1555 .params = "block_passwd device password",
1556 .help = "set the password of encrypted block devices",
Luiz Capitulinoa4dea8a2011-11-23 13:28:21 -02001557 .mhandler.cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001558 },
1559
1560STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001561@item block_passwd @var{device} @var{password}
1562@findex block_passwd
1563Set the encrypted device @var{device} password to @var{password}
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001564ETEXI
1565
1566 {
1567 .name = "block_set_io_throttle",
1568 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1569 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1570 .help = "change I/O throttle limits for a block drive",
Luiz Capitulino80047da2011-12-14 16:49:14 -02001571 .mhandler.cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001572 },
1573
1574STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001575@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1576@findex block_set_io_throttle
1577Change 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 -02001578ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001579
Jan Kiszka33572ec2010-05-31 14:43:30 -03001580 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001581 .name = "set_password",
1582 .args_type = "protocol:s,password:s,connected:s?",
1583 .params = "protocol password action-if-connected",
1584 .help = "set spice/vnc password",
Luiz Capitulinofbf796f2011-12-07 11:17:51 -02001585 .mhandler.cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001586 },
1587
1588STEXI
1589@item set_password [ vnc | spice ] password [ action-if-connected ]
1590@findex set_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001591Change spice/vnc password. Use zero to make the password stay valid
1592forever. @var{action-if-connected} specifies what should happen in
1593case a connection is established: @var{fail} makes the password change
1594fail. @var{disconnect} changes the password and disconnects the
1595client. @var{keep} changes the password and keeps the connection up.
1596@var{keep} is the default.
1597ETEXI
1598
1599 {
1600 .name = "expire_password",
1601 .args_type = "protocol:s,time:s",
1602 .params = "protocol time",
1603 .help = "set spice/vnc password expire-time",
Luiz Capitulino9ad53722011-12-07 11:47:57 -02001604 .mhandler.cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001605 },
1606
1607STEXI
1608@item expire_password [ vnc | spice ] expire-time
1609@findex expire_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001610Specify when a password for spice/vnc becomes
1611invalid. @var{expire-time} accepts:
1612
1613@table @var
1614@item now
1615Invalidate password instantly.
1616
1617@item never
1618Password stays valid forever.
1619
1620@item +nsec
1621Password stays valid for @var{nsec} seconds starting now.
1622
1623@item nsec
1624Password is invalidated at the given time. @var{nsec} are the seconds
1625passed since 1970, i.e. unix epoch.
1626
1627@end table
1628ETEXI
1629
Gerd Hoffmann46920822013-02-28 08:46:10 +01001630 {
1631 .name = "chardev-add",
1632 .args_type = "args:s",
1633 .params = "args",
1634 .help = "add chardev",
1635 .mhandler.cmd = hmp_chardev_add,
Hani Benhabiles13e315d2014-05-07 23:41:29 +01001636 .command_completion = chardev_add_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001637 },
1638
1639STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001640@item chardev-add args
1641@findex chardev-add
Gerd Hoffmann46920822013-02-28 08:46:10 +01001642chardev_add accepts the same parameters as the -chardev command line switch.
1643
1644ETEXI
1645
1646 {
1647 .name = "chardev-remove",
1648 .args_type = "id:s",
1649 .params = "id",
1650 .help = "remove chardev",
1651 .mhandler.cmd = hmp_chardev_remove,
Hani Benhabiles6297d9a2014-05-07 23:41:28 +01001652 .command_completion = chardev_remove_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001653 },
1654
1655STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001656@item chardev-remove id
1657@findex chardev-remove
Gerd Hoffmann46920822013-02-28 08:46:10 +01001658Removes the chardev @var{id}.
1659
1660ETEXI
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001661
1662 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001663 .name = "qemu-io",
1664 .args_type = "device:B,command:s",
1665 .params = "[device] \"[command]\"",
1666 .help = "run a qemu-io command on a block device",
1667 .mhandler.cmd = hmp_qemu_io,
1668 },
1669
1670STEXI
1671@item qemu-io @var{device} @var{command}
1672@findex qemu-io
Kevin Wolf587da2c2013-06-05 14:19:41 +02001673Executes a qemu-io command on the given block device.
1674
1675ETEXI
1676
1677 {
Jason J. Herneabf23322013-12-11 13:24:14 -05001678 .name = "cpu-add",
1679 .args_type = "id:i",
1680 .params = "id",
1681 .help = "add cpu",
1682 .mhandler.cmd = hmp_cpu_add,
1683 },
1684
1685STEXI
1686@item cpu-add @var{id}
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001687@findex cpu-add
Jason J. Herneabf23322013-12-11 13:24:14 -05001688Add CPU with id @var{id}
1689ETEXI
1690
1691 {
Andreas Färber89d7fa92014-05-07 18:08:29 +02001692 .name = "qom-list",
1693 .args_type = "path:s?",
1694 .params = "path",
1695 .help = "list QOM properties",
1696 .mhandler.cmd = hmp_qom_list,
1697 },
1698
1699STEXI
1700@item qom-list [@var{path}]
1701Print QOM properties of object at location @var{path}
1702ETEXI
1703
1704 {
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001705 .name = "qom-set",
1706 .args_type = "path:s,property:s,value:s",
1707 .params = "path property value",
1708 .help = "set QOM property",
1709 .mhandler.cmd = hmp_qom_set,
1710 },
1711
1712STEXI
1713@item qom-set @var{path} @var{property} @var{value}
1714Set QOM property @var{property} of object at location @var{path} to value @var{value}
1715ETEXI
1716
1717 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001718 .name = "info",
1719 .args_type = "item:s?",
1720 .params = "[subcommand]",
1721 .help = "show various information about the system state",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001722 .mhandler.cmd = hmp_info_help,
Wenchao Xia84c44612013-01-14 14:06:29 +08001723 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001724 },
1725
1726STEXI
1727@item info @var{subcommand}
1728@findex info
1729Show various information about the system state.
1730
1731@table @option
1732@item info version
1733show the version of QEMU
Jan Kiszka33572ec2010-05-31 14:43:30 -03001734@item info network
1735show the various VLANs and the associated devices
1736@item info chardev
1737show the character devices
1738@item info block
1739show the block devices
1740@item info blockstats
1741show block device statistics
1742@item info registers
1743show the cpu registers
1744@item info cpus
1745show infos for each CPU
1746@item info history
1747show the command line history
1748@item info irq
1749show the interrupts statistics (if available)
1750@item info pic
1751show i8259 (PIC) state
1752@item info pci
1753show emulated PCI device info
1754@item info tlb
Max Filippov692f7372012-01-07 20:02:40 +04001755show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001756@item info mem
1757show the active virtual memory mappings (i386 only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001758@item info jit
1759show dynamic compiler info
Jan Kiszka33572ec2010-05-31 14:43:30 -03001760@item info numa
1761show NUMA information
Jan Kiszkab40292e2010-05-31 14:43:31 -03001762@item info kvm
1763show KVM information
Jan Kiszka33572ec2010-05-31 14:43:30 -03001764@item info usb
1765show USB devices plugged on the virtual USB hub
1766@item info usbhost
1767show all USB host devices
1768@item info profile
1769show profiling information
1770@item info capture
1771show information about active capturing
1772@item info snapshots
1773show list of VM snapshots
1774@item info status
1775show the current VM status (running|paused)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001776@item info mice
1777show which guest mouse is receiving events
1778@item info vnc
1779show the vnc server status
1780@item info name
1781show the current VM name
1782@item info uuid
1783show the current VM UUID
1784@item info cpustats
1785show CPU statistics
1786@item info usernet
1787show user network stack connection states
1788@item info migrate
1789show migration status
Orit Wassermanbbf6da32012-08-06 21:42:47 +03001790@item info migrate_capabilities
1791show current migration capabilities
Liang Li50e9a622015-03-23 16:32:29 +08001792@item info migrate_parameters
1793show current migration parameters
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +03001794@item info migrate_cache_size
1795show current migration XBZRLE cache size
Jan Kiszka33572ec2010-05-31 14:43:30 -03001796@item info balloon
1797show balloon information
1798@item info qtree
1799show device tree
1800@item info qdm
1801show qdev device model list
Andreas Färbera01ff752014-05-07 17:03:18 +02001802@item info qom-tree
1803show object composition tree
Jan Kiszka33572ec2010-05-31 14:43:30 -03001804@item info roms
1805show roms
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05001806@item info tpm
1807show the TPM device
Zhu Guihuaa6318922014-09-23 13:35:19 +08001808@item info memory-devices
1809show the memory devices
Jason J. Hernea08f0082015-06-26 14:10:16 -04001810@item info skeys
1811Display the value of a storage key (s390 only)
Ting Wang62313162015-06-26 16:07:13 +08001812@item info iothreads
1813show iothreads
Jan Kiszka33572ec2010-05-31 14:43:30 -03001814ETEXI
1815
Lluís31965ae2011-08-31 20:31:24 +02001816STEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301817@item info trace-events
1818show available trace events and their state
1819ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301820
Blue Swirl23130862009-06-06 08:22:04 +00001821STEXI
Scott Feldmanfafa4d52015-06-10 18:21:21 -07001822@item rocker @var{name}
1823@findex rocker
1824Show Rocker(s)
1825ETEXI
1826
1827STEXI
1828@item rocker_ports @var{name}
1829@findex rocker_ports
1830Show Rocker ports
1831ETEXI
1832
1833STEXI
1834@item rocker_of_dpa_flows @var{name} [@var{tbl_id}]
1835@findex rocker_of_dpa_flows
1836Show Rocker OF-DPA flow tables
1837ETEXI
1838
1839STEXI
1840@item rocker_of_dpa_groups @var{name} [@var{type}]
1841@findex rocker_of_dpa_groups
1842Show Rocker OF-DPA groups
1843ETEXI
1844
1845STEXI
Blue Swirl23130862009-06-06 08:22:04 +00001846@end table
1847ETEXI
Pavel Butsykin70703342015-09-10 18:39:00 +03001848
1849STEXI
1850@end table
1851ETEXI