blob: f3de4076471b65b55430912aa575935bba63083d [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",
Max Reitzbaead0a2015-10-26 21:39:18 +0100197 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
198 .params = "device filename [format [read-only-mode]]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300199 .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
Max Reitzbaead0a2015-10-26 21:39:18 +0100209@item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
Blue Swirl23130862009-06-06 08:22:04 +0000210Change 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
Max Reitzbaead0a2015-10-26 21:39:18 +0100218@var{read-only-mode} may be used to change the read-only status of the device.
219It accepts the following values:
220
221@table @var
222@item retain
223Retains the current status; this is the default.
224
225@item read-only
226Makes the device read-only.
227
228@item read-write
229Makes the device writable.
230@end table
231
Blue Swirl23130862009-06-06 08:22:04 +0000232@item change vnc @var{display},@var{options}
233Change the configuration of the VNC server. The valid syntax for @var{display}
234and @var{options} are described at @ref{sec_invocation}. eg
235
236@example
237(qemu) change vnc localhost:1
238@end example
239
240@item change vnc password [@var{password}]
241
242Change the password associated with the VNC server. If the new password is not
243supplied, the monitor will prompt for it to be entered. VNC passwords are only
244significant up to 8 letters. eg
245
246@example
247(qemu) change vnc password
248Password: ********
249@end example
250
251@end table
252ETEXI
253
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300254 {
255 .name = "screendump",
256 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300257 .params = "filename",
258 .help = "save screen into PPM image 'filename'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100259 .mhandler.cmd = hmp_screendump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300260 },
261
Blue Swirl23130862009-06-06 08:22:04 +0000262STEXI
263@item screendump @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100264@findex screendump
Blue Swirl23130862009-06-06 08:22:04 +0000265Save screen into PPM image @var{filename}.
266ETEXI
267
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300268 {
269 .name = "logfile",
270 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300271 .params = "filename",
272 .help = "output logs to 'filename'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100273 .mhandler.cmd = hmp_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300274 },
275
Blue Swirl23130862009-06-06 08:22:04 +0000276STEXI
277@item logfile @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100278@findex logfile
Blue Swirl23130862009-06-06 08:22:04 +0000279Output logs to @var{filename}.
280ETEXI
281
Prerna Saxena22890ab2010-06-24 17:04:53 +0530282 {
283 .name = "trace-event",
284 .args_type = "name:s,option:b",
285 .params = "name on|off",
286 .help = "changes status of a specific trace event",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100287 .mhandler.cmd = hmp_trace_event,
Dr. David Alan Gilbert987bd272015-08-14 11:27:43 +0100288 .command_completion = trace_event_completion,
Prerna Saxena22890ab2010-06-24 17:04:53 +0530289 },
290
291STEXI
292@item trace-event
293@findex trace-event
294changes status of a trace event
295ETEXI
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100296
Michael Rothc45a8162011-10-02 08:44:37 -0500297#if defined(CONFIG_TRACE_SIMPLE)
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100298 {
299 .name = "trace-file",
300 .args_type = "op:s?,arg:F?",
301 .params = "on|off|flush|set [arg]",
302 .help = "open, close, or flush trace file, or set a new file name",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100303 .mhandler.cmd = hmp_trace_file,
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100304 },
305
306STEXI
307@item trace-file on|off|flush
308@findex trace-file
309Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
310ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +0530311#endif
312
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300313 {
314 .name = "log",
315 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300316 .params = "item1[,...]",
Peter Maydell989b6972013-02-26 17:52:40 +0000317 .help = "activate logging of the specified items",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100318 .mhandler.cmd = hmp_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300319 },
320
Blue Swirl23130862009-06-06 08:22:04 +0000321STEXI
322@item log @var{item1}[,...]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100323@findex log
Peter Maydell989b6972013-02-26 17:52:40 +0000324Activate logging of the specified items.
Blue Swirl23130862009-06-06 08:22:04 +0000325ETEXI
326
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300327 {
328 .name = "savevm",
329 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300330 .params = "[tag|id]",
331 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100332 .mhandler.cmd = hmp_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300333 },
334
Blue Swirl23130862009-06-06 08:22:04 +0000335STEXI
336@item savevm [@var{tag}|@var{id}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100337@findex savevm
Blue Swirl23130862009-06-06 08:22:04 +0000338Create a snapshot of the whole virtual machine. If @var{tag} is
339provided, it is used as human readable identifier. If there is already
340a snapshot with the same tag or ID, it is replaced. More info at
341@ref{vm_snapshots}.
342ETEXI
343
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300344 {
345 .name = "loadvm",
346 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300347 .params = "tag|id",
348 .help = "restore a VM snapshot from its tag or id",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100349 .mhandler.cmd = hmp_loadvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100350 .command_completion = loadvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300351 },
352
Blue Swirl23130862009-06-06 08:22:04 +0000353STEXI
354@item loadvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100355@findex loadvm
Blue Swirl23130862009-06-06 08:22:04 +0000356Set the whole virtual machine to the snapshot identified by the tag
357@var{tag} or the unique snapshot ID @var{id}.
358ETEXI
359
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300360 {
361 .name = "delvm",
362 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300363 .params = "tag|id",
364 .help = "delete a VM snapshot from its tag or id",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100365 .mhandler.cmd = hmp_delvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100366 .command_completion = delvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300367 },
368
Blue Swirl23130862009-06-06 08:22:04 +0000369STEXI
370@item delvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100371@findex delvm
Blue Swirl23130862009-06-06 08:22:04 +0000372Delete the snapshot identified by @var{tag} or @var{id}.
373ETEXI
374
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300375 {
376 .name = "singlestep",
377 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300378 .params = "[on|off]",
379 .help = "run emulation in singlestep mode or switch to normal mode",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100380 .mhandler.cmd = hmp_singlestep,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300381 },
382
Blue Swirl23130862009-06-06 08:22:04 +0000383STEXI
384@item singlestep [off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100385@findex singlestep
Blue Swirl23130862009-06-06 08:22:04 +0000386Run the emulation in single step mode.
387If called with option off, the emulation returns to normal mode.
388ETEXI
389
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300390 {
391 .name = "stop",
392 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300393 .params = "",
394 .help = "stop emulation",
Luiz Capitulino5f158f22011-09-15 14:34:39 -0300395 .mhandler.cmd = hmp_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300396 },
397
Blue Swirl23130862009-06-06 08:22:04 +0000398STEXI
399@item stop
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100400@findex stop
Blue Swirl23130862009-06-06 08:22:04 +0000401Stop emulation.
402ETEXI
403
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300404 {
405 .name = "c|cont",
406 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300407 .params = "",
408 .help = "resume emulation",
Luiz Capitulinoe42e8182011-11-22 17:58:31 -0200409 .mhandler.cmd = hmp_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300410 },
411
Blue Swirl23130862009-06-06 08:22:04 +0000412STEXI
413@item c or cont
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100414@findex cont
Blue Swirl23130862009-06-06 08:22:04 +0000415Resume emulation.
416ETEXI
417
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300418 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100419 .name = "system_wakeup",
420 .args_type = "",
421 .params = "",
422 .help = "wakeup guest from suspend",
423 .mhandler.cmd = hmp_system_wakeup,
424 },
425
426STEXI
427@item system_wakeup
428@findex system_wakeup
429Wakeup guest from suspend.
430ETEXI
431
432 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300433 .name = "gdbserver",
434 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300435 .params = "[device]",
436 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100437 .mhandler.cmd = hmp_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300438 },
439
Blue Swirl23130862009-06-06 08:22:04 +0000440STEXI
441@item gdbserver [@var{port}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100442@findex gdbserver
Blue Swirl23130862009-06-06 08:22:04 +0000443Start gdbserver session (default @var{port}=1234)
444ETEXI
445
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300446 {
447 .name = "x",
448 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300449 .params = "/fmt addr",
450 .help = "virtual memory dump starting at 'addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100451 .mhandler.cmd = hmp_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300452 },
453
Blue Swirl23130862009-06-06 08:22:04 +0000454STEXI
455@item x/fmt @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100456@findex x
Blue Swirl23130862009-06-06 08:22:04 +0000457Virtual memory dump starting at @var{addr}.
458ETEXI
459
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300460 {
461 .name = "xp",
462 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300463 .params = "/fmt addr",
464 .help = "physical memory dump starting at 'addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100465 .mhandler.cmd = hmp_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300466 },
467
Blue Swirl23130862009-06-06 08:22:04 +0000468STEXI
469@item xp /@var{fmt} @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100470@findex xp
Blue Swirl23130862009-06-06 08:22:04 +0000471Physical memory dump starting at @var{addr}.
472
473@var{fmt} is a format which tells the command how to format the
474data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
475
476@table @var
477@item count
478is the number of items to be dumped.
479
480@item format
481can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
482c (char) or i (asm instruction).
483
484@item size
485can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
486@code{h} or @code{w} can be specified with the @code{i} format to
487respectively select 16 or 32 bit code instruction size.
488
489@end table
490
491Examples:
492@itemize
493@item
494Dump 10 instructions at the current instruction pointer:
495@example
496(qemu) x/10i $eip
4970x90107063: ret
4980x90107064: sti
4990x90107065: lea 0x0(%esi,1),%esi
5000x90107069: lea 0x0(%edi,1),%edi
5010x90107070: ret
5020x90107071: jmp 0x90107080
5030x90107073: nop
5040x90107074: nop
5050x90107075: nop
5060x90107076: nop
507@end example
508
509@item
510Dump 80 16 bit values at the start of the video memory.
511@smallexample
512(qemu) xp/80hx 0xb8000
5130x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
5140x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
5150x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
5160x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
5170x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
5180x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
5190x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5200x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5210x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5220x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
523@end smallexample
524@end itemize
525ETEXI
526
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300527 {
528 .name = "p|print",
529 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300530 .params = "/fmt expr",
531 .help = "print expression value (use $reg for CPU register access)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300532 .mhandler.cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300533 },
534
Blue Swirl23130862009-06-06 08:22:04 +0000535STEXI
536@item p or print/@var{fmt} @var{expr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100537@findex print
Blue Swirl23130862009-06-06 08:22:04 +0000538Print expression value. Only the @var{format} part of @var{fmt} is
539used.
540ETEXI
541
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300542 {
543 .name = "i",
544 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300545 .params = "/fmt addr",
546 .help = "I/O port read",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100547 .mhandler.cmd = hmp_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300548 },
549
Blue Swirl23130862009-06-06 08:22:04 +0000550STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100551@item i/@var{fmt} @var{addr} [.@var{index}]
552@findex i
Blue Swirl23130862009-06-06 08:22:04 +0000553Read I/O port.
554ETEXI
555
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300556 {
557 .name = "o",
558 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300559 .params = "/fmt addr value",
560 .help = "I/O port write",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100561 .mhandler.cmd = hmp_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300562 },
563
Jan Kiszkaf1147842009-07-14 10:20:11 +0200564STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100565@item o/@var{fmt} @var{addr} @var{val}
566@findex o
Jan Kiszkaf1147842009-07-14 10:20:11 +0200567Write to I/O port.
568ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000569
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300570 {
571 .name = "sendkey",
Amos Kong2ef20c12012-08-31 10:56:22 +0800572 .args_type = "keys:s,hold-time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300573 .params = "keys [hold_ms]",
574 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100575 .mhandler.cmd = hmp_sendkey,
Hani Benhabiles29136cd2014-05-07 23:41:27 +0100576 .command_completion = sendkey_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300577 },
578
Blue Swirl23130862009-06-06 08:22:04 +0000579STEXI
580@item sendkey @var{keys}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100581@findex sendkey
Amos Kong886cc702012-08-31 10:56:20 +0800582Send @var{keys} to the guest. @var{keys} could be the name of the
583key or the raw value in hexadecimal format. Use @code{-} to press
584several keys simultaneously. Example:
Blue Swirl23130862009-06-06 08:22:04 +0000585@example
586sendkey ctrl-alt-f1
587@end example
588
589This command is useful to send keys that your graphical user interface
590intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
591ETEXI
592
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300593 {
594 .name = "system_reset",
595 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300596 .params = "",
597 .help = "reset the system",
Luiz Capitulino38d22652011-09-15 14:41:46 -0300598 .mhandler.cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300599 },
600
Blue Swirl23130862009-06-06 08:22:04 +0000601STEXI
602@item system_reset
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100603@findex system_reset
Blue Swirl23130862009-06-06 08:22:04 +0000604Reset the system.
605ETEXI
606
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300607 {
608 .name = "system_powerdown",
609 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300610 .params = "",
611 .help = "send system power down event",
Luiz Capitulino5bc465e2011-09-28 11:06:15 -0300612 .mhandler.cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300613 },
614
Blue Swirl23130862009-06-06 08:22:04 +0000615STEXI
616@item system_powerdown
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100617@findex system_powerdown
Blue Swirl23130862009-06-06 08:22:04 +0000618Power down the system (if supported).
619ETEXI
620
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300621 {
622 .name = "sum",
623 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300624 .params = "addr size",
625 .help = "compute the checksum of a memory region",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100626 .mhandler.cmd = hmp_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300627 },
628
Blue Swirl23130862009-06-06 08:22:04 +0000629STEXI
630@item sum @var{addr} @var{size}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100631@findex sum
Blue Swirl23130862009-06-06 08:22:04 +0000632Compute the checksum of a memory region.
633ETEXI
634
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300635 {
636 .name = "usb_add",
637 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300638 .params = "device",
639 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100640 .mhandler.cmd = hmp_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300641 },
642
Blue Swirl23130862009-06-06 08:22:04 +0000643STEXI
644@item usb_add @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100645@findex usb_add
Blue Swirl23130862009-06-06 08:22:04 +0000646Add the USB device @var{devname}. For details of available devices see
647@ref{usb_devices}
648ETEXI
649
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300650 {
651 .name = "usb_del",
652 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300653 .params = "device",
654 .help = "remove USB device 'bus.addr'",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100655 .mhandler.cmd = hmp_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300656 },
657
Blue Swirl23130862009-06-06 08:22:04 +0000658STEXI
659@item usb_del @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100660@findex usb_del
Blue Swirl23130862009-06-06 08:22:04 +0000661Remove the USB device @var{devname} from the QEMU virtual USB
662hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
663command @code{info usb} to see the devices you can remove.
664ETEXI
665
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300666 {
667 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100668 .args_type = "device:O",
669 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300670 .help = "add device, like -device on the command line",
Markus Armbruster318660f2015-03-05 17:24:48 +0100671 .mhandler.cmd = hmp_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100672 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300673 },
674
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200675STEXI
676@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100677@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200678Add device.
679ETEXI
680
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300681 {
682 .name = "device_del",
683 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300684 .params = "device",
685 .help = "remove device",
Luiz Capitulinoa15fef22012-03-29 12:38:50 -0300686 .mhandler.cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100687 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300688 },
689
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200690STEXI
691@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100692@findex device_del
Daniel P. Berrange6287d822015-09-11 13:33:56 +0100693Remove device @var{id}. @var{id} may be a short ID
694or a QOM object path.
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200695ETEXI
696
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300697 {
698 .name = "cpu",
699 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300700 .params = "index",
701 .help = "set the default CPU",
Luiz Capitulino755f1962011-10-06 14:31:39 -0300702 .mhandler.cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300703 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200704
Blue Swirl23130862009-06-06 08:22:04 +0000705STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200706@item cpu @var{index}
707@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000708Set the default CPU.
709ETEXI
710
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300711 {
712 .name = "mouse_move",
713 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300714 .params = "dx dy [dz]",
715 .help = "send mouse move events",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100716 .mhandler.cmd = hmp_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300717 },
718
Blue Swirl23130862009-06-06 08:22:04 +0000719STEXI
720@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100721@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000722Move the active mouse to the specified coordinates @var{dx} @var{dy}
723with optional scroll axis @var{dz}.
724ETEXI
725
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300726 {
727 .name = "mouse_button",
728 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300729 .params = "state",
730 .help = "change mouse button state (1=L, 2=M, 4=R)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100731 .mhandler.cmd = hmp_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300732 },
733
Blue Swirl23130862009-06-06 08:22:04 +0000734STEXI
735@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100736@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000737Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
738ETEXI
739
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300740 {
741 .name = "mouse_set",
742 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300743 .params = "index",
744 .help = "set which mouse device receives events",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100745 .mhandler.cmd = hmp_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300746 },
747
Blue Swirl23130862009-06-06 08:22:04 +0000748STEXI
749@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100750@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000751Set which mouse device receives events at given @var{index}, index
752can be obtained with
753@example
754info mice
755@end example
756ETEXI
757
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300758 {
759 .name = "wavcapture",
760 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300761 .params = "path [frequency [bits [channels]]]",
762 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100763 .mhandler.cmd = hmp_wavcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300764 },
Blue Swirl23130862009-06-06 08:22:04 +0000765STEXI
766@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100767@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000768Capture audio into @var{filename}. Using sample rate @var{frequency}
769bits per sample @var{bits} and number of channels @var{channels}.
770
771Defaults:
772@itemize @minus
773@item Sample rate = 44100 Hz - CD quality
774@item Bits = 16
775@item Number of channels = 2 - Stereo
776@end itemize
777ETEXI
778
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300779 {
780 .name = "stopcapture",
781 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300782 .params = "capture index",
783 .help = "stop capture",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100784 .mhandler.cmd = hmp_stopcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300785 },
Blue Swirl23130862009-06-06 08:22:04 +0000786STEXI
787@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100788@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000789Stop capture with a given @var{index}, index can be obtained with
790@example
791info capture
792@end example
793ETEXI
794
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300795 {
796 .name = "memsave",
797 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300798 .params = "addr size file",
799 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulino0cfd6a92011-11-22 16:32:37 -0200800 .mhandler.cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300801 },
802
Blue Swirl23130862009-06-06 08:22:04 +0000803STEXI
804@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100805@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000806save to disk virtual memory dump starting at @var{addr} of size @var{size}.
807ETEXI
808
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300809 {
810 .name = "pmemsave",
811 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300812 .params = "addr size file",
813 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulino6d3962b2011-11-22 17:26:46 -0200814 .mhandler.cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300815 },
816
Blue Swirl23130862009-06-06 08:22:04 +0000817STEXI
818@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100819@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000820save to disk physical memory dump starting at @var{addr} of size @var{size}.
821ETEXI
822
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300823 {
824 .name = "boot_set",
825 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300826 .params = "bootdevice",
827 .help = "define new values for the boot device list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100828 .mhandler.cmd = hmp_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300829 },
830
Blue Swirl23130862009-06-06 08:22:04 +0000831STEXI
832@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100833@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000834Define new values for the boot device list. Those values will override
835the values specified on the command line through the @code{-boot} option.
836
837The values that can be specified here depend on the machine type, but are
838the same that can be specified in the @code{-boot} command line option.
839ETEXI
840
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300841 {
842 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300843 .args_type = "",
844 .params = "",
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000845 .help = "inject an NMI",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +0100846 .mhandler.cmd = hmp_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300847 },
Blue Swirl23130862009-06-06 08:22:04 +0000848STEXI
849@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100850@findex nmi
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000851Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
Lei Li1f590cf2013-01-25 00:03:20 +0800852
853ETEXI
854
855 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100856 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800857 .args_type = "device:s,data:s",
858 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100859 .help = "Write to a ring buffer character device",
860 .mhandler.cmd = hmp_ringbuf_write,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100861 .command_completion = ringbuf_write_completion,
Lei Li1f590cf2013-01-25 00:03:20 +0800862 },
863
864STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100865@item ringbuf_write @var{device} @var{data}
866@findex ringbuf_write
867Write @var{data} to ring buffer character device @var{device}.
868@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800869
Blue Swirl23130862009-06-06 08:22:04 +0000870ETEXI
871
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300872 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100873 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800874 .args_type = "device:s,size:i",
875 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100876 .help = "Read from a ring buffer character device",
877 .mhandler.cmd = hmp_ringbuf_read,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100878 .command_completion = ringbuf_write_completion,
Lei Li49b6d722013-01-25 00:03:21 +0800879 },
880
881STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100882@item ringbuf_read @var{device}
883@findex ringbuf_read
884Read and print up to @var{size} bytes from ring buffer character
885device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100886Certain non-printable characters are printed \uXXXX, where XXXX is the
887character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100888Bug: can screw up when the buffer contains invalid UTF-8 sequences,
889NUL characters, after the ring buffer lost data, and when reading
890stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800891
892ETEXI
893
894 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300895 .name = "migrate",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200896 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
897 .params = "[-d] [-b] [-i] uri",
898 .help = "migrate to URI (using -d to not wait for completion)"
899 "\n\t\t\t -b for migration without shared storage with"
900 " full copy of disk\n\t\t\t -i for migration without "
901 "shared storage with incremental copy of disk "
902 "(base image shared between src and destination)",
Luiz Capitulinoe1c37d02011-12-05 14:48:01 -0200903 .mhandler.cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300904 },
905
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200906
Blue Swirl23130862009-06-06 08:22:04 +0000907STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200908@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100909@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000910Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200911 -b for migration with full copy of disk
912 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000913ETEXI
914
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300915 {
916 .name = "migrate_cancel",
917 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300918 .params = "",
919 .help = "cancel the current VM migration",
Luiz Capitulino6cdedb02011-11-27 22:54:09 -0200920 .mhandler.cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300921 },
922
Blue Swirl23130862009-06-06 08:22:04 +0000923STEXI
924@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100925@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000926Cancel the current VM migration.
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300927
928ETEXI
929
930 {
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000931 .name = "migrate_incoming",
932 .args_type = "uri:s",
933 .params = "uri",
934 .help = "Continue an incoming migration from an -incoming defer",
935 .mhandler.cmd = hmp_migrate_incoming,
936 },
937
938STEXI
939@item migrate_incoming @var{uri}
940@findex migrate_incoming
941Continue an incoming migration using the @var{uri} (that has the same syntax
942as the -incoming option).
943
944ETEXI
945
946 {
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300947 .name = "migrate_set_cache_size",
948 .args_type = "value:o",
949 .params = "value",
950 .help = "set cache size (in bytes) for XBZRLE migrations,"
951 "the cache size will be rounded down to the nearest "
952 "power of 2.\n"
953 "The cache size affects the number of cache misses."
954 "In case of a high cache miss ratio you need to increase"
955 " the cache size",
956 .mhandler.cmd = hmp_migrate_set_cache_size,
957 },
958
959STEXI
960@item migrate_set_cache_size @var{value}
961@findex migrate_set_cache_size
962Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +0000963ETEXI
964
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300965 {
966 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200967 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300968 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200969 .help = "set maximum speed (in bytes) for migrations. "
970 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Luiz Capitulino3dc85382011-11-28 11:59:37 -0200971 .mhandler.cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300972 },
973
Blue Swirl23130862009-06-06 08:22:04 +0000974STEXI
975@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100976@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +0000977Set maximum speed to @var{value} (in bytes) for migrations.
978ETEXI
979
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300980 {
981 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +0100982 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300983 .params = "value",
984 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulino4f0a9932011-11-27 23:18:01 -0200985 .mhandler.cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300986 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400987
988STEXI
989@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100990@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -0400991Set maximum tolerated downtime (in seconds) for migration.
992ETEXI
993
Jes Sorensenf8882562010-12-16 13:52:16 +0100994 {
Orit Wasserman00458432012-08-06 21:42:48 +0300995 .name = "migrate_set_capability",
996 .args_type = "capability:s,state:b",
997 .params = "capability state",
998 .help = "Enable/Disable the usage of a capability for migration",
999 .mhandler.cmd = hmp_migrate_set_capability,
Hani Benhabilesc68a0402014-05-27 23:39:32 +01001000 .command_completion = migrate_set_capability_completion,
Orit Wasserman00458432012-08-06 21:42:48 +03001001 },
1002
1003STEXI
1004@item migrate_set_capability @var{capability} @var{state}
1005@findex migrate_set_capability
1006Enable/Disable the usage of a capability @var{capability} for migration.
1007ETEXI
1008
1009 {
Liang Li50e9a622015-03-23 16:32:29 +08001010 .name = "migrate_set_parameter",
1011 .args_type = "parameter:s,value:i",
1012 .params = "parameter value",
1013 .help = "Set the parameter for migration",
1014 .mhandler.cmd = hmp_migrate_set_parameter,
1015 .command_completion = migrate_set_parameter_completion,
1016 },
1017
1018STEXI
1019@item migrate_set_parameter @var{parameter} @var{value}
1020@findex migrate_set_parameter
1021Set the parameter @var{parameter} for migration.
1022ETEXI
1023
1024 {
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001025 .name = "migrate_start_postcopy",
1026 .args_type = "",
1027 .params = "",
1028 .help = "Switch migration to postcopy mode",
1029 .mhandler.cmd = hmp_migrate_start_postcopy,
1030 },
1031
1032STEXI
1033@item migrate_start_postcopy
1034@findex migrate_start_postcopy
1035Switch in-progress migration to postcopy mode. Ignored after the end of
1036migration (or once already in postcopy).
1037ETEXI
1038
1039 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001040 .name = "client_migrate_info",
1041 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1042 .params = "protocol hostname port tls-port cert-subject",
Markus Armbruster13cadef2015-03-05 19:16:58 +01001043 .help = "set migration information for remote display",
Markus Armbrusterb8a185b2015-03-05 17:29:02 +01001044 .mhandler.cmd = hmp_client_migrate_info,
Jes Sorensenf8882562010-12-16 13:52:16 +01001045 },
1046
1047STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001048@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1049@findex client_migrate_info
Markus Armbruster13cadef2015-03-05 19:16:58 +01001050Set migration information for remote display. This makes the server
1051ask the client to automatically reconnect using the new parameters
1052once migration finished successfully. Only implemented for SPICE.
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001053ETEXI
1054
Wen Congyang783e9b42012-05-07 12:10:47 +08001055 {
1056 .name = "dump-guest-memory",
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001057 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1058 .params = "[-p] [-z|-l|-s] filename [begin length]",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001059 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1060 "-p: do paging to get guest's memory mapping.\n\t\t\t"
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001061 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1062 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1063 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001064 "begin: the starting physical address.\n\t\t\t"
1065 "length: the memory size, in bytes.",
Wen Congyang783e9b42012-05-07 12:10:47 +08001066 .mhandler.cmd = hmp_dump_guest_memory,
1067 },
1068
1069
1070STEXI
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001071@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001072@item dump-guest-memory [-z|-l|-s] @var{filename}
Wen Congyang783e9b42012-05-07 12:10:47 +08001073@findex dump-guest-memory
1074Dump guest memory to @var{protocol}. The file can be processed with crash or
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001075gdb. Without -z|-l|-s, the dump format is ELF.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001076 -p: do paging to get guest's memory mapping.
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001077 -z: dump in kdump-compressed format, with zlib compression.
1078 -l: dump in kdump-compressed format, with lzo compression.
1079 -s: dump in kdump-compressed format, with snappy compression.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001080 filename: dump file name.
Wen Congyang783e9b42012-05-07 12:10:47 +08001081 begin: the starting physical address. It's optional, and should be
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001082 specified together with length.
Wen Congyang783e9b42012-05-07 12:10:47 +08001083 length: the memory size, in bytes. It's optional, and should be specified
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001084 together with begin.
Wen Congyang783e9b42012-05-07 12:10:47 +08001085ETEXI
Wen Congyang783e9b42012-05-07 12:10:47 +08001086
Jason J. Hernea4538a52015-06-26 14:07:21 -04001087#if defined(TARGET_S390X)
1088 {
1089 .name = "dump-skeys",
1090 .args_type = "filename:F",
1091 .params = "",
1092 .help = "Save guest storage keys into file 'filename'.\n",
1093 .mhandler.cmd = hmp_dump_skeys,
1094 },
1095#endif
1096
1097STEXI
1098@item dump-skeys @var{filename}
1099@findex dump-skeys
1100Save guest storage keys to a file.
1101ETEXI
1102
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001103 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001104 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001105 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1106 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001107 .help = "initiates a live snapshot\n\t\t\t"
1108 "of device. If a new image file is specified, the\n\t\t\t"
1109 "new image file will become the new root image.\n\t\t\t"
1110 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001111 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001112 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1113 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1114 "recreating it from scratch.",
Luiz Capitulino6106e242011-11-25 16:15:19 -02001115 .mhandler.cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001116 },
1117
1118STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001119@item snapshot_blkdev
1120@findex snapshot_blkdev
1121Snapshot device, using snapshot file as target if provided
1122ETEXI
1123
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001124 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001125 .name = "snapshot_blkdev_internal",
1126 .args_type = "device:B,name:s",
1127 .params = "device name",
1128 .help = "take an internal snapshot of device.\n\t\t\t"
1129 "The format of the image used by device must\n\t\t\t"
1130 "support it, such as qcow2.\n\t\t\t",
1131 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1132 },
1133
1134STEXI
1135@item snapshot_blkdev_internal
1136@findex snapshot_blkdev_internal
1137Take an internal snapshot on device if it support
1138ETEXI
1139
1140 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001141 .name = "snapshot_delete_blkdev_internal",
1142 .args_type = "device:B,name:s,id:s?",
1143 .params = "device name [id]",
1144 .help = "delete an internal snapshot of device.\n\t\t\t"
1145 "If id is specified, qemu will try delete\n\t\t\t"
1146 "the snapshot matching both id and name.\n\t\t\t"
1147 "The format of the image used by device must\n\t\t\t"
1148 "support it, such as qcow2.\n\t\t\t",
1149 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1150 },
1151
1152STEXI
1153@item snapshot_delete_blkdev_internal
1154@findex snapshot_delete_blkdev_internal
1155Delete an internal snapshot on device if it support
1156ETEXI
1157
1158 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001159 .name = "drive_mirror",
1160 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1161 .params = "[-n] [-f] device target [format]",
1162 .help = "initiates live storage\n\t\t\t"
1163 "migration for a device. The device's contents are\n\t\t\t"
1164 "copied to the new image file, including data that\n\t\t\t"
1165 "is written after the command is started.\n\t\t\t"
1166 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1167 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1168 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1169 "so that the result does not need a backing file.\n\t\t\t",
1170 .mhandler.cmd = hmp_drive_mirror,
1171 },
1172STEXI
1173@item drive_mirror
1174@findex drive_mirror
1175Start mirroring a block device's writes to a new destination,
1176using the specified target.
1177ETEXI
1178
1179 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001180 .name = "drive_backup",
1181 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1182 .params = "[-n] [-f] device target [format]",
1183 .help = "initiates a point-in-time\n\t\t\t"
1184 "copy for a device. The device's contents are\n\t\t\t"
1185 "copied to the new image file, excluding data that\n\t\t\t"
1186 "is written after the command is started.\n\t\t\t"
1187 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1188 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1189 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1190 "so that the result does not need a backing file.\n\t\t\t",
1191 .mhandler.cmd = hmp_drive_backup,
1192 },
1193STEXI
1194@item drive_backup
1195@findex drive_backup
1196Start a point-in-time copy of a block device to a specificed target.
1197ETEXI
1198
1199 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001200 .name = "drive_add",
1201 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001202 .params = "[[<domain>:]<bus>:]<slot>\n"
1203 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001204 "[,unit=m][,media=d][,index=i]\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001205 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001206 "[,snapshot=on|off][,cache=on|off]\n"
1207 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001208 .help = "add drive to PCI storage controller",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001209 .mhandler.cmd = hmp_drive_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001210 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001211
Blue Swirl23130862009-06-06 08:22:04 +00001212STEXI
1213@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001214@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001215Add drive to PCI storage controller.
1216ETEXI
1217
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001218 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001219 .name = "pcie_aer_inject_error",
1220 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1221 "id:s,error_status:s,"
1222 "header0:i?,header1:i?,header2:i?,header3:i?,"
1223 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1224 .params = "[-a] [-c] id "
1225 "<error_status> [<tlp header> [<tlp header prefix>]]",
1226 .help = "inject pcie aer error\n\t\t\t"
1227 " -a for advisory non fatal error\n\t\t\t"
1228 " -c for correctable error\n\t\t\t"
1229 "<id> = qdev device id\n\t\t\t"
1230 "<error_status> = error string or 32bit\n\t\t\t"
1231 "<tlb header> = 32bit x 4\n\t\t\t"
1232 "<tlb header prefix> = 32bit x 4",
Markus Armbruster04e00c92015-03-05 17:48:49 +01001233 .mhandler.cmd = hmp_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001234 },
1235
1236STEXI
1237@item pcie_aer_inject_error
1238@findex pcie_aer_inject_error
1239Inject PCIe AER error
1240ETEXI
1241
1242 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001243 .name = "host_net_add",
1244 .args_type = "device:s,opts:s?",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001245 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001246 .help = "add host VLAN client",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001247 .mhandler.cmd = hmp_host_net_add,
Hani Benhabilese3bb5322014-05-27 23:39:34 +01001248 .command_completion = host_net_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001249 },
1250
Blue Swirl23130862009-06-06 08:22:04 +00001251STEXI
1252@item host_net_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001253@findex host_net_add
Blue Swirl23130862009-06-06 08:22:04 +00001254Add host VLAN client.
1255ETEXI
1256
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001257 {
1258 .name = "host_net_remove",
1259 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001260 .params = "vlan_id name",
1261 .help = "remove host VLAN client",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001262 .mhandler.cmd = hmp_host_net_remove,
Hani Benhabilesddd6b452014-05-27 23:39:36 +01001263 .command_completion = host_net_remove_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001264 },
1265
Blue Swirl23130862009-06-06 08:22:04 +00001266STEXI
1267@item host_net_remove
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001268@findex host_net_remove
Blue Swirl23130862009-06-06 08:22:04 +00001269Remove host VLAN client.
1270ETEXI
1271
Markus Armbrusterae82d322010-03-25 17:22:40 +01001272 {
1273 .name = "netdev_add",
1274 .args_type = "netdev:O",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001275 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001276 .help = "add host network device",
Luiz Capitulino928059a2012-04-18 17:34:15 -03001277 .mhandler.cmd = hmp_netdev_add,
Hani Benhabilesb162b492014-05-07 23:41:31 +01001278 .command_completion = netdev_add_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001279 },
1280
1281STEXI
1282@item netdev_add
1283@findex netdev_add
1284Add host network device.
1285ETEXI
1286
1287 {
1288 .name = "netdev_del",
1289 .args_type = "id:s",
1290 .params = "id",
1291 .help = "remove host network device",
Luiz Capitulino5f964152012-04-16 14:36:32 -03001292 .mhandler.cmd = hmp_netdev_del,
Hani Benhabiles11b389f2014-05-07 23:41:32 +01001293 .command_completion = netdev_del_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001294 },
1295
1296STEXI
1297@item netdev_del
1298@findex netdev_del
1299Remove host network device.
1300ETEXI
1301
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001302 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001303 .name = "object_add",
1304 .args_type = "object:O",
1305 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1306 .help = "create QOM object",
1307 .mhandler.cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001308 .command_completion = object_add_completion,
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001309 },
1310
1311STEXI
1312@item object_add
1313@findex object_add
1314Create QOM object.
1315ETEXI
1316
1317 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001318 .name = "object_del",
1319 .args_type = "id:s",
1320 .params = "id",
1321 .help = "destroy QOM object",
1322 .mhandler.cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001323 .command_completion = object_del_completion,
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001324 },
1325
1326STEXI
1327@item object_del
1328@findex object_del
1329Destroy QOM object.
1330ETEXI
1331
Blue Swirl23130862009-06-06 08:22:04 +00001332#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001333 {
1334 .name = "hostfwd_add",
1335 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001336 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1337 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001338 .mhandler.cmd = hmp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001339 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001340#endif
1341STEXI
1342@item hostfwd_add
1343@findex hostfwd_add
1344Redirect TCP or UDP connections from host to guest (requires -net user).
1345ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001346
Markus Armbruster21413d62010-05-04 13:20:30 +02001347#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001348 {
1349 .name = "hostfwd_remove",
1350 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001351 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1352 .help = "remove host-to-guest TCP or UDP redirection",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001353 .mhandler.cmd = hmp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001354 },
1355
Blue Swirl23130862009-06-06 08:22:04 +00001356#endif
1357STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001358@item hostfwd_remove
1359@findex hostfwd_remove
1360Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001361ETEXI
1362
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001363 {
1364 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001365 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001366 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001367 .help = "request VM to change its memory allocation (in MB)",
Luiz Capitulinod72f3262011-11-25 14:38:09 -02001368 .mhandler.cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001369 },
1370
Blue Swirl23130862009-06-06 08:22:04 +00001371STEXI
1372@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001373@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001374Request VM to change its memory allocation to @var{value} (in MB).
1375ETEXI
1376
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001377 {
1378 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001379 .args_type = "name:s,up:b",
1380 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001381 .help = "change the link status of a network adapter",
Luiz Capitulino4b371562011-11-23 13:11:55 -02001382 .mhandler.cmd = hmp_set_link,
Hani Benhabiles40d19392014-05-07 23:41:30 +01001383 .command_completion = set_link_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001384 },
1385
Blue Swirl23130862009-06-06 08:22:04 +00001386STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001387@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001388@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001389Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001390ETEXI
1391
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001392 {
1393 .name = "watchdog_action",
1394 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001395 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1396 .help = "change watchdog action",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001397 .mhandler.cmd = hmp_watchdog_action,
Hani Benhabilesd0ece342014-05-27 23:39:31 +01001398 .command_completion = watchdog_action_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001399 },
1400
Blue Swirl23130862009-06-06 08:22:04 +00001401STEXI
1402@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001403@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001404Change watchdog action.
1405ETEXI
1406
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001407 {
1408 .name = "acl_show",
1409 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001410 .params = "aclname",
1411 .help = "list rules in the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001412 .mhandler.cmd = hmp_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001413 },
1414
Blue Swirl23130862009-06-06 08:22:04 +00001415STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001416@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001417@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001418List all the matching rules in the access control list, and the default
1419policy. There are currently two named access control lists,
1420@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1421certificate distinguished name, and SASL username respectively.
1422ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001423
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001424 {
1425 .name = "acl_policy",
1426 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001427 .params = "aclname allow|deny",
1428 .help = "set default access control list policy",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001429 .mhandler.cmd = hmp_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001430 },
1431
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001432STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001433@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001434@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001435Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001436none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001437always @code{deny}.
1438ETEXI
1439
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001440 {
1441 .name = "acl_add",
1442 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001443 .params = "aclname match allow|deny [index]",
1444 .help = "add a match rule to the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001445 .mhandler.cmd = hmp_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001446 },
1447
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001448STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001449@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1450@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001451Add a match rule to the access control list, allowing or denying access.
1452The match will normally be an exact username or x509 distinguished name,
1453but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1454allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001455normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001456earlier in the list if the optional @var{index} parameter is supplied.
1457ETEXI
1458
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001459 {
1460 .name = "acl_remove",
1461 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001462 .params = "aclname match",
1463 .help = "remove a match rule from the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001464 .mhandler.cmd = hmp_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001465 },
1466
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001467STEXI
1468@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001469@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001470Remove the specified match rule from the access control list.
1471ETEXI
1472
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001473 {
1474 .name = "acl_reset",
1475 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001476 .params = "aclname",
1477 .help = "reset the access control list",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001478 .mhandler.cmd = hmp_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001479 },
1480
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001481STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001482@item acl_reset @var{aclname}
1483@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001484Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001485policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001486ETEXI
1487
Paolo Bonzini40577252012-08-23 11:53:04 +02001488 {
1489 .name = "nbd_server_start",
1490 .args_type = "all:-a,writable:-w,uri:s",
1491 .params = "nbd_server_start [-a] [-w] host:port",
1492 .help = "serve block devices on the given host and port",
1493 .mhandler.cmd = hmp_nbd_server_start,
1494 },
1495STEXI
1496@item nbd_server_start @var{host}:@var{port}
1497@findex nbd_server_start
1498Start an NBD server on the given host and/or port. If the @option{-a}
1499option is included, all of the virtual machine's block devices that
1500have an inserted media on them are automatically exported; in this case,
1501the @option{-w} option makes the devices writable too.
1502ETEXI
1503
1504 {
1505 .name = "nbd_server_add",
1506 .args_type = "writable:-w,device:B",
1507 .params = "nbd_server_add [-w] device",
1508 .help = "export a block device via NBD",
1509 .mhandler.cmd = hmp_nbd_server_add,
1510 },
1511STEXI
1512@item nbd_server_add @var{device}
1513@findex nbd_server_add
1514Export a block device through QEMU's NBD server, which must be started
1515beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1516exported device writable too.
1517ETEXI
1518
1519 {
1520 .name = "nbd_server_stop",
1521 .args_type = "",
1522 .params = "nbd_server_stop",
1523 .help = "stop serving block devices using the NBD protocol",
1524 .mhandler.cmd = hmp_nbd_server_stop,
1525 },
1526STEXI
1527@item nbd_server_stop
1528@findex nbd_server_stop
1529Stop the QEMU embedded NBD server.
1530ETEXI
1531
1532
Huang Ying79c4f6b2009-06-23 10:05:14 +08001533#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001534
1535 {
1536 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001537 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1538 .params = "[-b] cpu bank status mcgstatus addr misc",
1539 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001540 .mhandler.cmd = hmp_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001541 },
1542
Huang Ying79c4f6b2009-06-23 10:05:14 +08001543#endif
1544STEXI
1545@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001546@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001547Inject an MCE on the given CPU (x86 only).
1548ETEXI
1549
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001550 {
1551 .name = "getfd",
1552 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001553 .params = "getfd name",
1554 .help = "receive a file descriptor via SCM rights and assign it a name",
Corey Bryant208c9d12012-06-22 14:36:09 -04001555 .mhandler.cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001556 },
1557
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001558STEXI
1559@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001560@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001561If a file descriptor is passed alongside this command using the SCM_RIGHTS
1562mechanism on unix sockets, it is stored using the name @var{fdname} for
1563later use by other monitor commands.
1564ETEXI
1565
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001566 {
1567 .name = "closefd",
1568 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001569 .params = "closefd name",
1570 .help = "close a file descriptor previously passed via SCM rights",
Corey Bryant208c9d12012-06-22 14:36:09 -04001571 .mhandler.cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001572 },
1573
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001574STEXI
1575@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001576@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001577Close the file descriptor previously assigned to @var{fdname} using the
1578@code{getfd} command. This is only needed if the file descriptor was never
1579used by another monitor command.
1580ETEXI
1581
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001582 {
1583 .name = "block_passwd",
1584 .args_type = "device:B,password:s",
1585 .params = "block_passwd device password",
1586 .help = "set the password of encrypted block devices",
Luiz Capitulinoa4dea8a2011-11-23 13:28:21 -02001587 .mhandler.cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001588 },
1589
1590STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001591@item block_passwd @var{device} @var{password}
1592@findex block_passwd
1593Set the encrypted device @var{device} password to @var{password}
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001594ETEXI
1595
1596 {
1597 .name = "block_set_io_throttle",
1598 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1599 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1600 .help = "change I/O throttle limits for a block drive",
Luiz Capitulino80047da2011-12-14 16:49:14 -02001601 .mhandler.cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001602 },
1603
1604STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001605@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1606@findex block_set_io_throttle
1607Change 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 -02001608ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001609
Jan Kiszka33572ec2010-05-31 14:43:30 -03001610 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001611 .name = "set_password",
1612 .args_type = "protocol:s,password:s,connected:s?",
1613 .params = "protocol password action-if-connected",
1614 .help = "set spice/vnc password",
Luiz Capitulinofbf796f2011-12-07 11:17:51 -02001615 .mhandler.cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001616 },
1617
1618STEXI
1619@item set_password [ vnc | spice ] password [ action-if-connected ]
1620@findex set_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001621Change spice/vnc password. Use zero to make the password stay valid
1622forever. @var{action-if-connected} specifies what should happen in
1623case a connection is established: @var{fail} makes the password change
1624fail. @var{disconnect} changes the password and disconnects the
1625client. @var{keep} changes the password and keeps the connection up.
1626@var{keep} is the default.
1627ETEXI
1628
1629 {
1630 .name = "expire_password",
1631 .args_type = "protocol:s,time:s",
1632 .params = "protocol time",
1633 .help = "set spice/vnc password expire-time",
Luiz Capitulino9ad53722011-12-07 11:47:57 -02001634 .mhandler.cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001635 },
1636
1637STEXI
1638@item expire_password [ vnc | spice ] expire-time
1639@findex expire_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001640Specify when a password for spice/vnc becomes
1641invalid. @var{expire-time} accepts:
1642
1643@table @var
1644@item now
1645Invalidate password instantly.
1646
1647@item never
1648Password stays valid forever.
1649
1650@item +nsec
1651Password stays valid for @var{nsec} seconds starting now.
1652
1653@item nsec
1654Password is invalidated at the given time. @var{nsec} are the seconds
1655passed since 1970, i.e. unix epoch.
1656
1657@end table
1658ETEXI
1659
Gerd Hoffmann46920822013-02-28 08:46:10 +01001660 {
1661 .name = "chardev-add",
1662 .args_type = "args:s",
1663 .params = "args",
1664 .help = "add chardev",
1665 .mhandler.cmd = hmp_chardev_add,
Hani Benhabiles13e315d2014-05-07 23:41:29 +01001666 .command_completion = chardev_add_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001667 },
1668
1669STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001670@item chardev-add args
1671@findex chardev-add
Gerd Hoffmann46920822013-02-28 08:46:10 +01001672chardev_add accepts the same parameters as the -chardev command line switch.
1673
1674ETEXI
1675
1676 {
1677 .name = "chardev-remove",
1678 .args_type = "id:s",
1679 .params = "id",
1680 .help = "remove chardev",
1681 .mhandler.cmd = hmp_chardev_remove,
Hani Benhabiles6297d9a2014-05-07 23:41:28 +01001682 .command_completion = chardev_remove_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001683 },
1684
1685STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001686@item chardev-remove id
1687@findex chardev-remove
Gerd Hoffmann46920822013-02-28 08:46:10 +01001688Removes the chardev @var{id}.
1689
1690ETEXI
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001691
1692 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001693 .name = "qemu-io",
1694 .args_type = "device:B,command:s",
1695 .params = "[device] \"[command]\"",
1696 .help = "run a qemu-io command on a block device",
1697 .mhandler.cmd = hmp_qemu_io,
1698 },
1699
1700STEXI
1701@item qemu-io @var{device} @var{command}
1702@findex qemu-io
Kevin Wolf587da2c2013-06-05 14:19:41 +02001703Executes a qemu-io command on the given block device.
1704
1705ETEXI
1706
1707 {
Jason J. Herneabf23322013-12-11 13:24:14 -05001708 .name = "cpu-add",
1709 .args_type = "id:i",
1710 .params = "id",
1711 .help = "add cpu",
1712 .mhandler.cmd = hmp_cpu_add,
1713 },
1714
1715STEXI
1716@item cpu-add @var{id}
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001717@findex cpu-add
Jason J. Herneabf23322013-12-11 13:24:14 -05001718Add CPU with id @var{id}
1719ETEXI
1720
1721 {
Andreas Färber89d7fa92014-05-07 18:08:29 +02001722 .name = "qom-list",
1723 .args_type = "path:s?",
1724 .params = "path",
1725 .help = "list QOM properties",
1726 .mhandler.cmd = hmp_qom_list,
1727 },
1728
1729STEXI
1730@item qom-list [@var{path}]
1731Print QOM properties of object at location @var{path}
1732ETEXI
1733
1734 {
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001735 .name = "qom-set",
1736 .args_type = "path:s,property:s,value:s",
1737 .params = "path property value",
1738 .help = "set QOM property",
1739 .mhandler.cmd = hmp_qom_set,
1740 },
1741
1742STEXI
1743@item qom-set @var{path} @var{property} @var{value}
1744Set QOM property @var{property} of object at location @var{path} to value @var{value}
1745ETEXI
1746
1747 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001748 .name = "info",
1749 .args_type = "item:s?",
1750 .params = "[subcommand]",
1751 .help = "show various information about the system state",
Markus Armbruster3e5a50d2015-02-06 13:55:43 +01001752 .mhandler.cmd = hmp_info_help,
Wenchao Xia84c44612013-01-14 14:06:29 +08001753 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001754 },
1755
1756STEXI
Pavel Butsykin70703342015-09-10 18:39:00 +03001757@end table
1758ETEXI