blob: 45e1763fbe3c342838c4b7ec6aa61799f4021acb [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",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -030031 .mhandler.cmd = do_commit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030032 },
33
Blue Swirl23130862009-06-06 08:22:04 +000034STEXI
35@item commit
Stefan Weil70fcbbe2010-02-05 23:52:04 +010036@findex commit
Blue Swirl23130862009-06-06 08:22:04 +000037Commit changes to the disk images (if -snapshot is used) or backing files.
Jeff Cody37222902014-01-24 09:02:37 -050038If the backing file is smaller than the snapshot, then the backing file will be
39resized to be the same size as the snapshot. If the snapshot is smaller than
40the backing file, the backing file will not be truncated. If you want the
41backing file to match the size of the smaller snapshot, you can safely truncate
42it yourself once the commit operation successfully completes.
Blue Swirl23130862009-06-06 08:22:04 +000043ETEXI
44
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030045 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030046 .name = "q|quit",
47 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030048 .params = "",
49 .help = "quit the emulator",
Luiz Capitulinob223f352009-10-07 13:41:56 -030050 .user_print = monitor_user_noop,
Luiz Capitulino7a7f3252011-09-15 14:20:28 -030051 .mhandler.cmd = hmp_quit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030052 },
53
Blue Swirl23130862009-06-06 08:22:04 +000054STEXI
55@item q or quit
Stefan Weil70fcbbe2010-02-05 23:52:04 +010056@findex quit
Blue Swirl23130862009-06-06 08:22:04 +000057Quit the emulator.
58ETEXI
59
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030060 {
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010061 .name = "block_resize",
62 .args_type = "device:B,size:o",
63 .params = "device size",
64 .help = "resize a block image",
Luiz Capitulino5e7caac2011-11-25 14:57:10 -020065 .mhandler.cmd = hmp_block_resize,
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010066 },
67
68STEXI
69@item block_resize
70@findex block_resize
71Resize a block image while a guest is running. Usually requires guest
72action to see the updated size. Resize to a lower size is supported,
73but should be used with extreme caution. Note that this command only
74resizes image files, it can not resize block devices like LVM volumes.
75ETEXI
76
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000077 {
78 .name = "block_stream",
Stefan Hajnoczic83c66c2012-04-25 16:51:03 +010079 .args_type = "device:B,speed:o?,base:s?",
80 .params = "device [speed [base]]",
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000081 .help = "copy data from a backing file into a block device",
82 .mhandler.cmd = hmp_block_stream,
83 },
84
85STEXI
86@item block_stream
87@findex block_stream
88Copy data from a backing file into a block device.
89ETEXI
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010090
91 {
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000092 .name = "block_job_set_speed",
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +010093 .args_type = "device:B,speed:o",
94 .params = "device speed",
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000095 .help = "set maximum speed for a background block operation",
96 .mhandler.cmd = hmp_block_job_set_speed,
97 },
98
99STEXI
Paolo Bonzini4451b792012-04-13 12:03:46 +0200100@item block_job_set_speed
101@findex block_job_set_speed
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +0000102Set maximum speed for a background block operation.
103ETEXI
104
105 {
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000106 .name = "block_job_cancel",
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200107 .args_type = "force:-f,device:B",
108 .params = "[-f] device",
109 .help = "stop an active background block operation (use -f"
110 "\n\t\t\t if the operation is currently paused)",
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000111 .mhandler.cmd = hmp_block_job_cancel,
112 },
113
114STEXI
115@item block_job_cancel
116@findex block_job_cancel
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200117Stop an active background block operation (streaming, mirroring).
118ETEXI
119
120 {
121 .name = "block_job_complete",
122 .args_type = "device:B",
123 .params = "device",
124 .help = "stop an active background block operation",
125 .mhandler.cmd = hmp_block_job_complete,
126 },
127
128STEXI
129@item block_job_complete
130@findex block_job_complete
131Manually trigger completion of an active background block operation.
132For mirroring, this will switch the device to the destination path.
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000133ETEXI
134
135 {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200136 .name = "block_job_pause",
137 .args_type = "device:B",
138 .params = "device",
139 .help = "pause an active background block operation",
140 .mhandler.cmd = hmp_block_job_pause,
141 },
142
143STEXI
144@item block_job_pause
145@findex block_job_pause
146Pause an active block streaming operation.
147ETEXI
148
149 {
150 .name = "block_job_resume",
151 .args_type = "device:B",
152 .params = "device",
153 .help = "resume a paused background block operation",
154 .mhandler.cmd = hmp_block_job_resume,
155 },
156
157STEXI
158@item block_job_resume
159@findex block_job_resume
160Resume a paused block streaming operation.
161ETEXI
162
163 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300164 .name = "eject",
Luiz Capitulino78d714e2009-12-14 18:53:21 -0200165 .args_type = "force:-f,device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300166 .params = "[-f] device",
167 .help = "eject a removable medium (use -f to force it)",
Luiz Capitulinoc245b6a2011-12-07 16:02:36 -0200168 .mhandler.cmd = hmp_eject,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300169 },
170
Blue Swirl23130862009-06-06 08:22:04 +0000171STEXI
172@item eject [-f] @var{device}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100173@findex eject
Blue Swirl23130862009-06-06 08:22:04 +0000174Eject a removable medium (use -f to force it).
175ETEXI
176
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300177 {
Ryan Harper9063f812010-11-12 11:07:13 -0600178 .name = "drive_del",
Hani Benhabilesf7bdc412014-04-13 16:25:05 +0100179 .args_type = "id:B",
Ryan Harper9063f812010-11-12 11:07:13 -0600180 .params = "device",
181 .help = "remove host block device",
182 .user_print = monitor_user_noop,
183 .mhandler.cmd_new = do_drive_del,
184 },
185
186STEXI
187@item drive_del @var{device}
188@findex drive_del
189Remove host block device. The result is that guest generated IO is no longer
190submitted against the host device underlying the disk. Once a drive has
191been deleted, the QEMU Block layer returns -EIO which results in IO
192errors in the guest for applications that are reading/writing to the device.
Stefan Hajnoczi293c51a2013-06-05 10:33:14 +0200193These errors are always reported to the guest, regardless of the drive's error
194actions (drive options rerror, werror).
Ryan Harper9063f812010-11-12 11:07:13 -0600195ETEXI
196
197 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300198 .name = "change",
199 .args_type = "device:B,target:F,arg:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300200 .params = "device filename [format]",
201 .help = "change a removable medium, optional format",
Luiz Capitulino333a96e2011-12-08 11:13:50 -0200202 .mhandler.cmd = hmp_change,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300203 },
204
Blue Swirl23130862009-06-06 08:22:04 +0000205STEXI
206@item change @var{device} @var{setting}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100207@findex change
Blue Swirl23130862009-06-06 08:22:04 +0000208
209Change the configuration of a device.
210
211@table @option
212@item change @var{diskdevice} @var{filename} [@var{format}]
213Change the medium for a removable disk device to point to @var{filename}. eg
214
215@example
216(qemu) change ide1-cd0 /path/to/some.iso
217@end example
218
219@var{format} is optional.
220
221@item change vnc @var{display},@var{options}
222Change the configuration of the VNC server. The valid syntax for @var{display}
223and @var{options} are described at @ref{sec_invocation}. eg
224
225@example
226(qemu) change vnc localhost:1
227@end example
228
229@item change vnc password [@var{password}]
230
231Change the password associated with the VNC server. If the new password is not
232supplied, the monitor will prompt for it to be entered. VNC passwords are only
233significant up to 8 letters. eg
234
235@example
236(qemu) change vnc password
237Password: ********
238@end example
239
240@end table
241ETEXI
242
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300243 {
244 .name = "screendump",
245 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300246 .params = "filename",
247 .help = "save screen into PPM image 'filename'",
Luiz Capitulinoad39cf62012-05-24 13:48:23 -0300248 .mhandler.cmd = hmp_screen_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300249 },
250
Blue Swirl23130862009-06-06 08:22:04 +0000251STEXI
252@item screendump @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100253@findex screendump
Blue Swirl23130862009-06-06 08:22:04 +0000254Save screen into PPM image @var{filename}.
255ETEXI
256
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300257 {
258 .name = "logfile",
259 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300260 .params = "filename",
261 .help = "output logs to 'filename'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300262 .mhandler.cmd = do_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300263 },
264
Blue Swirl23130862009-06-06 08:22:04 +0000265STEXI
266@item logfile @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100267@findex logfile
Blue Swirl23130862009-06-06 08:22:04 +0000268Output logs to @var{filename}.
269ETEXI
270
Prerna Saxena22890ab2010-06-24 17:04:53 +0530271 {
272 .name = "trace-event",
273 .args_type = "name:s,option:b",
274 .params = "name on|off",
275 .help = "changes status of a specific trace event",
LluĂ­sfc764102011-08-31 20:31:18 +0200276 .mhandler.cmd = do_trace_event_set_state,
Prerna Saxena22890ab2010-06-24 17:04:53 +0530277 },
278
279STEXI
280@item trace-event
281@findex trace-event
282changes status of a trace event
283ETEXI
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100284
Michael Rothc45a8162011-10-02 08:44:37 -0500285#if defined(CONFIG_TRACE_SIMPLE)
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100286 {
287 .name = "trace-file",
288 .args_type = "op:s?,arg:F?",
289 .params = "on|off|flush|set [arg]",
290 .help = "open, close, or flush trace file, or set a new file name",
291 .mhandler.cmd = do_trace_file,
292 },
293
294STEXI
295@item trace-file on|off|flush
296@findex trace-file
297Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
298ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +0530299#endif
300
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300301 {
302 .name = "log",
303 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300304 .params = "item1[,...]",
Peter Maydell989b6972013-02-26 17:52:40 +0000305 .help = "activate logging of the specified items",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300306 .mhandler.cmd = do_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300307 },
308
Blue Swirl23130862009-06-06 08:22:04 +0000309STEXI
310@item log @var{item1}[,...]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100311@findex log
Peter Maydell989b6972013-02-26 17:52:40 +0000312Activate logging of the specified items.
Blue Swirl23130862009-06-06 08:22:04 +0000313ETEXI
314
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300315 {
316 .name = "savevm",
317 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300318 .params = "[tag|id]",
319 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300320 .mhandler.cmd = do_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300321 },
322
Blue Swirl23130862009-06-06 08:22:04 +0000323STEXI
324@item savevm [@var{tag}|@var{id}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100325@findex savevm
Blue Swirl23130862009-06-06 08:22:04 +0000326Create a snapshot of the whole virtual machine. If @var{tag} is
327provided, it is used as human readable identifier. If there is already
328a snapshot with the same tag or ID, it is replaced. More info at
329@ref{vm_snapshots}.
330ETEXI
331
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300332 {
333 .name = "loadvm",
334 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300335 .params = "tag|id",
336 .help = "restore a VM snapshot from its tag or id",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300337 .mhandler.cmd = do_loadvm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300338 },
339
Blue Swirl23130862009-06-06 08:22:04 +0000340STEXI
341@item loadvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100342@findex loadvm
Blue Swirl23130862009-06-06 08:22:04 +0000343Set the whole virtual machine to the snapshot identified by the tag
344@var{tag} or the unique snapshot ID @var{id}.
345ETEXI
346
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300347 {
348 .name = "delvm",
349 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300350 .params = "tag|id",
351 .help = "delete a VM snapshot from its tag or id",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300352 .mhandler.cmd = do_delvm,
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",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300366 .mhandler.cmd = do_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'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300423 .mhandler.cmd = do_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'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300437 .mhandler.cmd = do_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'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300451 .mhandler.cmd = do_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 +0000524
525Print expression value. Only the @var{format} part of @var{fmt} is
526used.
527ETEXI
528
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300529 {
530 .name = "i",
531 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300532 .params = "/fmt addr",
533 .help = "I/O port read",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300534 .mhandler.cmd = do_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300535 },
536
Blue Swirl23130862009-06-06 08:22:04 +0000537STEXI
538Read I/O port.
539ETEXI
540
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300541 {
542 .name = "o",
543 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300544 .params = "/fmt addr value",
545 .help = "I/O port write",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300546 .mhandler.cmd = do_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300547 },
548
Jan Kiszkaf1147842009-07-14 10:20:11 +0200549STEXI
550Write to I/O port.
551ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000552
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300553 {
554 .name = "sendkey",
Amos Kong2ef20c12012-08-31 10:56:22 +0800555 .args_type = "keys:s,hold-time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300556 .params = "keys [hold_ms]",
557 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Amos Konge4c8f002012-08-31 10:56:26 +0800558 .mhandler.cmd = hmp_send_key,
Hani Benhabiles29136cd2014-05-07 23:41:27 +0100559 .command_completion = sendkey_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300560 },
561
Blue Swirl23130862009-06-06 08:22:04 +0000562STEXI
563@item sendkey @var{keys}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100564@findex sendkey
Blue Swirl23130862009-06-06 08:22:04 +0000565
Amos Kong886cc702012-08-31 10:56:20 +0800566Send @var{keys} to the guest. @var{keys} could be the name of the
567key or the raw value in hexadecimal format. Use @code{-} to press
568several keys simultaneously. Example:
Blue Swirl23130862009-06-06 08:22:04 +0000569@example
570sendkey ctrl-alt-f1
571@end example
572
573This command is useful to send keys that your graphical user interface
574intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
575ETEXI
576
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300577 {
578 .name = "system_reset",
579 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300580 .params = "",
581 .help = "reset the system",
Luiz Capitulino38d22652011-09-15 14:41:46 -0300582 .mhandler.cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300583 },
584
Blue Swirl23130862009-06-06 08:22:04 +0000585STEXI
586@item system_reset
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100587@findex system_reset
Blue Swirl23130862009-06-06 08:22:04 +0000588
589Reset the system.
590ETEXI
591
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300592 {
593 .name = "system_powerdown",
594 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300595 .params = "",
596 .help = "send system power down event",
Luiz Capitulino5bc465e2011-09-28 11:06:15 -0300597 .mhandler.cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300598 },
599
Blue Swirl23130862009-06-06 08:22:04 +0000600STEXI
601@item system_powerdown
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100602@findex system_powerdown
Blue Swirl23130862009-06-06 08:22:04 +0000603
604Power 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",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300612 .mhandler.cmd = do_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 +0000618
619Compute the checksum of a memory region.
620ETEXI
621
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300622 {
623 .name = "usb_add",
624 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300625 .params = "device",
626 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300627 .mhandler.cmd = do_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300628 },
629
Blue Swirl23130862009-06-06 08:22:04 +0000630STEXI
631@item usb_add @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100632@findex usb_add
Blue Swirl23130862009-06-06 08:22:04 +0000633
634Add the USB device @var{devname}. For details of available devices see
635@ref{usb_devices}
636ETEXI
637
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300638 {
639 .name = "usb_del",
640 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300641 .params = "device",
642 .help = "remove USB device 'bus.addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300643 .mhandler.cmd = do_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300644 },
645
Blue Swirl23130862009-06-06 08:22:04 +0000646STEXI
647@item usb_del @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100648@findex usb_del
Blue Swirl23130862009-06-06 08:22:04 +0000649
650Remove the USB device @var{devname} from the QEMU virtual USB
651hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
652command @code{info usb} to see the devices you can remove.
653ETEXI
654
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300655 {
656 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100657 .args_type = "device:O",
658 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300659 .help = "add device, like -device on the command line",
Markus Armbruster8bc27242010-02-10 20:52:01 +0100660 .user_print = monitor_user_noop,
661 .mhandler.cmd_new = do_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100662 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300663 },
664
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200665STEXI
666@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100667@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200668
669Add device.
670ETEXI
671
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300672 {
673 .name = "device_del",
674 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300675 .params = "device",
676 .help = "remove device",
Luiz Capitulinoa15fef22012-03-29 12:38:50 -0300677 .mhandler.cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100678 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300679 },
680
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200681STEXI
682@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100683@findex device_del
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200684
685Remove device @var{id}.
686ETEXI
687
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300688 {
689 .name = "cpu",
690 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300691 .params = "index",
692 .help = "set the default CPU",
Luiz Capitulino755f1962011-10-06 14:31:39 -0300693 .mhandler.cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300694 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200695
Blue Swirl23130862009-06-06 08:22:04 +0000696STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200697@item cpu @var{index}
698@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000699Set the default CPU.
700ETEXI
701
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300702 {
703 .name = "mouse_move",
704 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300705 .params = "dx dy [dz]",
706 .help = "send mouse move events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300707 .mhandler.cmd = do_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300708 },
709
Blue Swirl23130862009-06-06 08:22:04 +0000710STEXI
711@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100712@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000713Move the active mouse to the specified coordinates @var{dx} @var{dy}
714with optional scroll axis @var{dz}.
715ETEXI
716
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300717 {
718 .name = "mouse_button",
719 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300720 .params = "state",
721 .help = "change mouse button state (1=L, 2=M, 4=R)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300722 .mhandler.cmd = do_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300723 },
724
Blue Swirl23130862009-06-06 08:22:04 +0000725STEXI
726@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100727@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000728Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
729ETEXI
730
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300731 {
732 .name = "mouse_set",
733 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300734 .params = "index",
735 .help = "set which mouse device receives events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300736 .mhandler.cmd = do_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300737 },
738
Blue Swirl23130862009-06-06 08:22:04 +0000739STEXI
740@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100741@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000742Set which mouse device receives events at given @var{index}, index
743can be obtained with
744@example
745info mice
746@end example
747ETEXI
748
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300749 {
750 .name = "wavcapture",
751 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300752 .params = "path [frequency [bits [channels]]]",
753 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300754 .mhandler.cmd = do_wav_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300755 },
Blue Swirl23130862009-06-06 08:22:04 +0000756STEXI
757@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100758@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000759Capture audio into @var{filename}. Using sample rate @var{frequency}
760bits per sample @var{bits} and number of channels @var{channels}.
761
762Defaults:
763@itemize @minus
764@item Sample rate = 44100 Hz - CD quality
765@item Bits = 16
766@item Number of channels = 2 - Stereo
767@end itemize
768ETEXI
769
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300770 {
771 .name = "stopcapture",
772 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300773 .params = "capture index",
774 .help = "stop capture",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300775 .mhandler.cmd = do_stop_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300776 },
Blue Swirl23130862009-06-06 08:22:04 +0000777STEXI
778@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100779@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000780Stop capture with a given @var{index}, index can be obtained with
781@example
782info capture
783@end example
784ETEXI
785
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300786 {
787 .name = "memsave",
788 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300789 .params = "addr size file",
790 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulino0cfd6a92011-11-22 16:32:37 -0200791 .mhandler.cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300792 },
793
Blue Swirl23130862009-06-06 08:22:04 +0000794STEXI
795@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100796@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000797save to disk virtual memory dump starting at @var{addr} of size @var{size}.
798ETEXI
799
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300800 {
801 .name = "pmemsave",
802 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300803 .params = "addr size file",
804 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulino6d3962b2011-11-22 17:26:46 -0200805 .mhandler.cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300806 },
807
Blue Swirl23130862009-06-06 08:22:04 +0000808STEXI
809@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100810@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000811save to disk physical memory dump starting at @var{addr} of size @var{size}.
812ETEXI
813
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300814 {
815 .name = "boot_set",
816 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300817 .params = "bootdevice",
818 .help = "define new values for the boot device list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300819 .mhandler.cmd = do_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300820 },
821
Blue Swirl23130862009-06-06 08:22:04 +0000822STEXI
823@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100824@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000825
826Define new values for the boot device list. Those values will override
827the values specified on the command line through the @code{-boot} option.
828
829The values that can be specified here depend on the machine type, but are
830the same that can be specified in the @code{-boot} command line option.
831ETEXI
832
Eugene (jno) Dvurechenski7f7f9752012-12-05 15:50:07 +0100833#if defined(TARGET_I386) || defined(TARGET_S390X)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300834 {
835 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300836 .args_type = "",
837 .params = "",
838 .help = "inject an NMI on all guest's CPUs",
Luiz Capitulinoab49ab52011-11-23 12:55:53 -0200839 .mhandler.cmd = hmp_inject_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300840 },
Blue Swirl23130862009-06-06 08:22:04 +0000841#endif
842STEXI
843@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100844@findex nmi
Eugene (jno) Dvurechenski7f7f9752012-12-05 15:50:07 +0100845Inject an NMI (x86) or RESTART (s390x) on the given CPU.
Lei Li1f590cf2013-01-25 00:03:20 +0800846
847ETEXI
848
849 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100850 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800851 .args_type = "device:s,data:s",
852 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100853 .help = "Write to a ring buffer character device",
854 .mhandler.cmd = hmp_ringbuf_write,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100855 .command_completion = ringbuf_write_completion,
Lei Li1f590cf2013-01-25 00:03:20 +0800856 },
857
858STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100859@item ringbuf_write @var{device} @var{data}
860@findex ringbuf_write
861Write @var{data} to ring buffer character device @var{device}.
862@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800863
Blue Swirl23130862009-06-06 08:22:04 +0000864ETEXI
865
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300866 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100867 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800868 .args_type = "device:s,size:i",
869 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100870 .help = "Read from a ring buffer character device",
871 .mhandler.cmd = hmp_ringbuf_read,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100872 .command_completion = ringbuf_write_completion,
Lei Li49b6d722013-01-25 00:03:21 +0800873 },
874
875STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100876@item ringbuf_read @var{device}
877@findex ringbuf_read
878Read and print up to @var{size} bytes from ring buffer character
879device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100880Certain non-printable characters are printed \uXXXX, where XXXX is the
881character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100882Bug: can screw up when the buffer contains invalid UTF-8 sequences,
883NUL characters, after the ring buffer lost data, and when reading
884stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800885
886ETEXI
887
888 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300889 .name = "migrate",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200890 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
891 .params = "[-d] [-b] [-i] uri",
892 .help = "migrate to URI (using -d to not wait for completion)"
893 "\n\t\t\t -b for migration without shared storage with"
894 " full copy of disk\n\t\t\t -i for migration without "
895 "shared storage with incremental copy of disk "
896 "(base image shared between src and destination)",
Luiz Capitulinoe1c37d02011-12-05 14:48:01 -0200897 .mhandler.cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300898 },
899
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200900
Blue Swirl23130862009-06-06 08:22:04 +0000901STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200902@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100903@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000904Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200905 -b for migration with full copy of disk
906 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000907ETEXI
908
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300909 {
910 .name = "migrate_cancel",
911 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300912 .params = "",
913 .help = "cancel the current VM migration",
Luiz Capitulino6cdedb02011-11-27 22:54:09 -0200914 .mhandler.cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300915 },
916
Blue Swirl23130862009-06-06 08:22:04 +0000917STEXI
918@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100919@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000920Cancel the current VM migration.
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300921
922ETEXI
923
924 {
925 .name = "migrate_set_cache_size",
926 .args_type = "value:o",
927 .params = "value",
928 .help = "set cache size (in bytes) for XBZRLE migrations,"
929 "the cache size will be rounded down to the nearest "
930 "power of 2.\n"
931 "The cache size affects the number of cache misses."
932 "In case of a high cache miss ratio you need to increase"
933 " the cache size",
934 .mhandler.cmd = hmp_migrate_set_cache_size,
935 },
936
937STEXI
938@item migrate_set_cache_size @var{value}
939@findex migrate_set_cache_size
940Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +0000941ETEXI
942
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300943 {
944 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200945 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300946 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200947 .help = "set maximum speed (in bytes) for migrations. "
948 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Luiz Capitulino3dc85382011-11-28 11:59:37 -0200949 .mhandler.cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300950 },
951
Blue Swirl23130862009-06-06 08:22:04 +0000952STEXI
953@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100954@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +0000955Set maximum speed to @var{value} (in bytes) for migrations.
956ETEXI
957
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300958 {
959 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +0100960 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300961 .params = "value",
962 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulino4f0a9932011-11-27 23:18:01 -0200963 .mhandler.cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300964 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400965
966STEXI
967@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100968@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -0400969Set maximum tolerated downtime (in seconds) for migration.
970ETEXI
971
Jes Sorensenf8882562010-12-16 13:52:16 +0100972 {
Orit Wasserman00458432012-08-06 21:42:48 +0300973 .name = "migrate_set_capability",
974 .args_type = "capability:s,state:b",
975 .params = "capability state",
976 .help = "Enable/Disable the usage of a capability for migration",
977 .mhandler.cmd = hmp_migrate_set_capability,
978 },
979
980STEXI
981@item migrate_set_capability @var{capability} @var{state}
982@findex migrate_set_capability
983Enable/Disable the usage of a capability @var{capability} for migration.
984ETEXI
985
986 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +0100987 .name = "client_migrate_info",
988 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
989 .params = "protocol hostname port tls-port cert-subject",
990 .help = "send migration info to spice/vnc client",
991 .user_print = monitor_user_noop,
Yonit Halperinedc5cb12011-10-17 10:03:18 +0200992 .mhandler.cmd_async = client_migrate_info,
993 .flags = MONITOR_CMD_ASYNC,
Jes Sorensenf8882562010-12-16 13:52:16 +0100994 },
995
996STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +0200997@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
998@findex client_migrate_info
999Set the spice/vnc connection info for the migration target. The spice/vnc
1000server will ask the spice/vnc client to automatically reconnect using the
1001new parameters (if specified) once the vm migration finished successfully.
1002ETEXI
1003
Wen Congyang783e9b42012-05-07 12:10:47 +08001004 {
1005 .name = "dump-guest-memory",
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001006 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1007 .params = "[-p] [-z|-l|-s] filename [begin length]",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001008 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1009 "-p: do paging to get guest's memory mapping.\n\t\t\t"
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001010 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1011 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1012 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001013 "begin: the starting physical address.\n\t\t\t"
1014 "length: the memory size, in bytes.",
Wen Congyang783e9b42012-05-07 12:10:47 +08001015 .mhandler.cmd = hmp_dump_guest_memory,
1016 },
1017
1018
1019STEXI
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001020@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001021@item dump-guest-memory [-z|-l|-s] @var{filename}
Wen Congyang783e9b42012-05-07 12:10:47 +08001022@findex dump-guest-memory
1023Dump guest memory to @var{protocol}. The file can be processed with crash or
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001024gdb. Without -z|-l|-s, the dump format is ELF.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001025 -p: do paging to get guest's memory mapping.
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001026 -z: dump in kdump-compressed format, with zlib compression.
1027 -l: dump in kdump-compressed format, with lzo compression.
1028 -s: dump in kdump-compressed format, with snappy compression.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001029 filename: dump file name.
Wen Congyang783e9b42012-05-07 12:10:47 +08001030 begin: the starting physical address. It's optional, and should be
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001031 specified together with length.
Wen Congyang783e9b42012-05-07 12:10:47 +08001032 length: the memory size, in bytes. It's optional, and should be specified
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001033 together with begin.
Wen Congyang783e9b42012-05-07 12:10:47 +08001034ETEXI
Wen Congyang783e9b42012-05-07 12:10:47 +08001035
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001036 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001037 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001038 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1039 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001040 .help = "initiates a live snapshot\n\t\t\t"
1041 "of device. If a new image file is specified, the\n\t\t\t"
1042 "new image file will become the new root image.\n\t\t\t"
1043 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001044 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001045 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1046 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1047 "recreating it from scratch.",
Luiz Capitulino6106e242011-11-25 16:15:19 -02001048 .mhandler.cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001049 },
1050
1051STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001052@item snapshot_blkdev
1053@findex snapshot_blkdev
1054Snapshot device, using snapshot file as target if provided
1055ETEXI
1056
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001057 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001058 .name = "snapshot_blkdev_internal",
1059 .args_type = "device:B,name:s",
1060 .params = "device name",
1061 .help = "take an internal snapshot of device.\n\t\t\t"
1062 "The format of the image used by device must\n\t\t\t"
1063 "support it, such as qcow2.\n\t\t\t",
1064 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1065 },
1066
1067STEXI
1068@item snapshot_blkdev_internal
1069@findex snapshot_blkdev_internal
1070Take an internal snapshot on device if it support
1071ETEXI
1072
1073 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001074 .name = "snapshot_delete_blkdev_internal",
1075 .args_type = "device:B,name:s,id:s?",
1076 .params = "device name [id]",
1077 .help = "delete an internal snapshot of device.\n\t\t\t"
1078 "If id is specified, qemu will try delete\n\t\t\t"
1079 "the snapshot matching both id and name.\n\t\t\t"
1080 "The format of the image used by device must\n\t\t\t"
1081 "support it, such as qcow2.\n\t\t\t",
1082 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1083 },
1084
1085STEXI
1086@item snapshot_delete_blkdev_internal
1087@findex snapshot_delete_blkdev_internal
1088Delete an internal snapshot on device if it support
1089ETEXI
1090
1091 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001092 .name = "drive_mirror",
1093 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1094 .params = "[-n] [-f] device target [format]",
1095 .help = "initiates live storage\n\t\t\t"
1096 "migration for a device. The device's contents are\n\t\t\t"
1097 "copied to the new image file, including data that\n\t\t\t"
1098 "is written after the command is started.\n\t\t\t"
1099 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1100 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1101 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1102 "so that the result does not need a backing file.\n\t\t\t",
1103 .mhandler.cmd = hmp_drive_mirror,
1104 },
1105STEXI
1106@item drive_mirror
1107@findex drive_mirror
1108Start mirroring a block device's writes to a new destination,
1109using the specified target.
1110ETEXI
1111
1112 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001113 .name = "drive_backup",
1114 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1115 .params = "[-n] [-f] device target [format]",
1116 .help = "initiates a point-in-time\n\t\t\t"
1117 "copy for a device. The device's contents are\n\t\t\t"
1118 "copied to the new image file, excluding data that\n\t\t\t"
1119 "is written after the command is started.\n\t\t\t"
1120 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1121 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1122 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1123 "so that the result does not need a backing file.\n\t\t\t",
1124 .mhandler.cmd = hmp_drive_backup,
1125 },
1126STEXI
1127@item drive_backup
1128@findex drive_backup
1129Start a point-in-time copy of a block device to a specificed target.
1130ETEXI
1131
1132 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001133 .name = "drive_add",
1134 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001135 .params = "[[<domain>:]<bus>:]<slot>\n"
1136 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001137 "[,unit=m][,media=d][,index=i]\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001138 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001139 "[,snapshot=on|off][,cache=on|off]\n"
1140 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001141 .help = "add drive to PCI storage controller",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001142 .mhandler.cmd = drive_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001143 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001144
Blue Swirl23130862009-06-06 08:22:04 +00001145STEXI
1146@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001147@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001148Add drive to PCI storage controller.
1149ETEXI
1150
David Gibson79ca6162013-06-06 18:48:45 +10001151#if defined(CONFIG_PCI_HOTPLUG_OLD)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001152 {
1153 .name = "pci_add",
1154 .args_type = "pci_addr:s,type:s,opts:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001155 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
1156 .help = "hot-add PCI device",
Markus Armbruster6c6a58a2010-05-12 10:53:00 +02001157 .mhandler.cmd = pci_device_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001158 },
Blue Swirl23130862009-06-06 08:22:04 +00001159#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001160
Blue Swirl23130862009-06-06 08:22:04 +00001161STEXI
1162@item pci_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001163@findex pci_add
Blue Swirl23130862009-06-06 08:22:04 +00001164Hot-add PCI device.
1165ETEXI
1166
David Gibson79ca6162013-06-06 18:48:45 +10001167#if defined(CONFIG_PCI_HOTPLUG_OLD)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001168 {
1169 .name = "pci_del",
1170 .args_type = "pci_addr:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001171 .params = "[[<domain>:]<bus>:]<slot>",
1172 .help = "hot remove PCI device",
Markus Armbrusterb752daf2010-05-12 10:53:01 +02001173 .mhandler.cmd = do_pci_device_hot_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001174 },
Blue Swirl23130862009-06-06 08:22:04 +00001175#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001176
Blue Swirl23130862009-06-06 08:22:04 +00001177STEXI
1178@item pci_del
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001179@findex pci_del
Blue Swirl23130862009-06-06 08:22:04 +00001180Hot remove PCI device.
1181ETEXI
1182
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001183 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001184 .name = "pcie_aer_inject_error",
1185 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1186 "id:s,error_status:s,"
1187 "header0:i?,header1:i?,header2:i?,header3:i?,"
1188 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1189 .params = "[-a] [-c] id "
1190 "<error_status> [<tlp header> [<tlp header prefix>]]",
1191 .help = "inject pcie aer error\n\t\t\t"
1192 " -a for advisory non fatal error\n\t\t\t"
1193 " -c for correctable error\n\t\t\t"
1194 "<id> = qdev device id\n\t\t\t"
1195 "<error_status> = error string or 32bit\n\t\t\t"
1196 "<tlb header> = 32bit x 4\n\t\t\t"
1197 "<tlb header prefix> = 32bit x 4",
1198 .user_print = pcie_aer_inject_error_print,
Zhi Yong Wu1f3392b2011-11-30 12:39:47 +08001199 .mhandler.cmd_new = do_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001200 },
1201
1202STEXI
1203@item pcie_aer_inject_error
1204@findex pcie_aer_inject_error
1205Inject PCIe AER error
1206ETEXI
1207
1208 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001209 .name = "host_net_add",
1210 .args_type = "device:s,opts:s?",
Vincenzo Maffione58952132013-11-06 11:44:06 +01001211 .params = "tap|user|socket|vde|netmap|dump [options]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001212 .help = "add host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001213 .mhandler.cmd = net_host_device_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001214 },
1215
Blue Swirl23130862009-06-06 08:22:04 +00001216STEXI
1217@item host_net_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001218@findex host_net_add
Blue Swirl23130862009-06-06 08:22:04 +00001219Add host VLAN client.
1220ETEXI
1221
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001222 {
1223 .name = "host_net_remove",
1224 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001225 .params = "vlan_id name",
1226 .help = "remove host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001227 .mhandler.cmd = net_host_device_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001228 },
1229
Blue Swirl23130862009-06-06 08:22:04 +00001230STEXI
1231@item host_net_remove
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001232@findex host_net_remove
Blue Swirl23130862009-06-06 08:22:04 +00001233Remove host VLAN client.
1234ETEXI
1235
Markus Armbrusterae82d322010-03-25 17:22:40 +01001236 {
1237 .name = "netdev_add",
1238 .args_type = "netdev:O",
Hani Benhabilesb162b492014-05-07 23:41:31 +01001239 .params = "[user|tap|socket|vde|bridge|hubport|netmap],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001240 .help = "add host network device",
Luiz Capitulino928059a2012-04-18 17:34:15 -03001241 .mhandler.cmd = hmp_netdev_add,
Hani Benhabilesb162b492014-05-07 23:41:31 +01001242 .command_completion = netdev_add_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001243 },
1244
1245STEXI
1246@item netdev_add
1247@findex netdev_add
1248Add host network device.
1249ETEXI
1250
1251 {
1252 .name = "netdev_del",
1253 .args_type = "id:s",
1254 .params = "id",
1255 .help = "remove host network device",
Luiz Capitulino5f964152012-04-16 14:36:32 -03001256 .mhandler.cmd = hmp_netdev_del,
Hani Benhabiles11b389f2014-05-07 23:41:32 +01001257 .command_completion = netdev_del_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001258 },
1259
1260STEXI
1261@item netdev_del
1262@findex netdev_del
1263Remove host network device.
1264ETEXI
1265
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001266 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001267 .name = "object_add",
1268 .args_type = "object:O",
1269 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1270 .help = "create QOM object",
1271 .mhandler.cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001272 .command_completion = object_add_completion,
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001273 },
1274
1275STEXI
1276@item object_add
1277@findex object_add
1278Create QOM object.
1279ETEXI
1280
1281 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001282 .name = "object_del",
1283 .args_type = "id:s",
1284 .params = "id",
1285 .help = "destroy QOM object",
1286 .mhandler.cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001287 .command_completion = object_del_completion,
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001288 },
1289
1290STEXI
1291@item object_del
1292@findex object_del
1293Destroy QOM object.
1294ETEXI
1295
Blue Swirl23130862009-06-06 08:22:04 +00001296#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001297 {
1298 .name = "hostfwd_add",
1299 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001300 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1301 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001302 .mhandler.cmd = net_slirp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001303 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001304#endif
1305STEXI
1306@item hostfwd_add
1307@findex hostfwd_add
1308Redirect TCP or UDP connections from host to guest (requires -net user).
1309ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001310
Markus Armbruster21413d62010-05-04 13:20:30 +02001311#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001312 {
1313 .name = "hostfwd_remove",
1314 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001315 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1316 .help = "remove host-to-guest TCP or UDP redirection",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001317 .mhandler.cmd = net_slirp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001318 },
1319
Blue Swirl23130862009-06-06 08:22:04 +00001320#endif
1321STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001322@item hostfwd_remove
1323@findex hostfwd_remove
1324Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001325ETEXI
1326
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001327 {
1328 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001329 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001330 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001331 .help = "request VM to change its memory allocation (in MB)",
Luiz Capitulinod72f3262011-11-25 14:38:09 -02001332 .mhandler.cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001333 },
1334
Blue Swirl23130862009-06-06 08:22:04 +00001335STEXI
1336@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001337@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001338Request VM to change its memory allocation to @var{value} (in MB).
1339ETEXI
1340
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001341 {
1342 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001343 .args_type = "name:s,up:b",
1344 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001345 .help = "change the link status of a network adapter",
Luiz Capitulino4b371562011-11-23 13:11:55 -02001346 .mhandler.cmd = hmp_set_link,
Hani Benhabiles40d19392014-05-07 23:41:30 +01001347 .command_completion = set_link_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001348 },
1349
Blue Swirl23130862009-06-06 08:22:04 +00001350STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001351@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001352@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001353Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001354ETEXI
1355
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001356 {
1357 .name = "watchdog_action",
1358 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001359 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1360 .help = "change watchdog action",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001361 .mhandler.cmd = do_watchdog_action,
Hani Benhabilesd0ece342014-05-27 23:39:31 +01001362 .command_completion = watchdog_action_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001363 },
1364
Blue Swirl23130862009-06-06 08:22:04 +00001365STEXI
1366@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001367@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001368Change watchdog action.
1369ETEXI
1370
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001371 {
1372 .name = "acl_show",
1373 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001374 .params = "aclname",
1375 .help = "list rules in the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001376 .mhandler.cmd = do_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001377 },
1378
Blue Swirl23130862009-06-06 08:22:04 +00001379STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001380@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001381@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001382List all the matching rules in the access control list, and the default
1383policy. There are currently two named access control lists,
1384@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1385certificate distinguished name, and SASL username respectively.
1386ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001387
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001388 {
1389 .name = "acl_policy",
1390 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001391 .params = "aclname allow|deny",
1392 .help = "set default access control list policy",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001393 .mhandler.cmd = do_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001394 },
1395
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001396STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001397@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001398@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001399Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001400none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001401always @code{deny}.
1402ETEXI
1403
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001404 {
1405 .name = "acl_add",
1406 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001407 .params = "aclname match allow|deny [index]",
1408 .help = "add a match rule to the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001409 .mhandler.cmd = do_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001410 },
1411
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001412STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001413@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1414@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001415Add a match rule to the access control list, allowing or denying access.
1416The match will normally be an exact username or x509 distinguished name,
1417but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1418allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001419normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001420earlier in the list if the optional @var{index} parameter is supplied.
1421ETEXI
1422
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001423 {
1424 .name = "acl_remove",
1425 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001426 .params = "aclname match",
1427 .help = "remove a match rule from the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001428 .mhandler.cmd = do_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001429 },
1430
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001431STEXI
1432@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001433@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001434Remove the specified match rule from the access control list.
1435ETEXI
1436
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001437 {
1438 .name = "acl_reset",
1439 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001440 .params = "aclname",
1441 .help = "reset the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001442 .mhandler.cmd = do_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001443 },
1444
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001445STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001446@item acl_reset @var{aclname}
1447@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001448Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001449policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001450ETEXI
1451
Paolo Bonzini40577252012-08-23 11:53:04 +02001452 {
1453 .name = "nbd_server_start",
1454 .args_type = "all:-a,writable:-w,uri:s",
1455 .params = "nbd_server_start [-a] [-w] host:port",
1456 .help = "serve block devices on the given host and port",
1457 .mhandler.cmd = hmp_nbd_server_start,
1458 },
1459STEXI
1460@item nbd_server_start @var{host}:@var{port}
1461@findex nbd_server_start
1462Start an NBD server on the given host and/or port. If the @option{-a}
1463option is included, all of the virtual machine's block devices that
1464have an inserted media on them are automatically exported; in this case,
1465the @option{-w} option makes the devices writable too.
1466ETEXI
1467
1468 {
1469 .name = "nbd_server_add",
1470 .args_type = "writable:-w,device:B",
1471 .params = "nbd_server_add [-w] device",
1472 .help = "export a block device via NBD",
1473 .mhandler.cmd = hmp_nbd_server_add,
1474 },
1475STEXI
1476@item nbd_server_add @var{device}
1477@findex nbd_server_add
1478Export a block device through QEMU's NBD server, which must be started
1479beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1480exported device writable too.
1481ETEXI
1482
1483 {
1484 .name = "nbd_server_stop",
1485 .args_type = "",
1486 .params = "nbd_server_stop",
1487 .help = "stop serving block devices using the NBD protocol",
1488 .mhandler.cmd = hmp_nbd_server_stop,
1489 },
1490STEXI
1491@item nbd_server_stop
1492@findex nbd_server_stop
1493Stop the QEMU embedded NBD server.
1494ETEXI
1495
1496
Huang Ying79c4f6b2009-06-23 10:05:14 +08001497#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001498
1499 {
1500 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001501 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1502 .params = "[-b] cpu bank status mcgstatus addr misc",
1503 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001504 .mhandler.cmd = do_inject_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001505 },
1506
Huang Ying79c4f6b2009-06-23 10:05:14 +08001507#endif
1508STEXI
1509@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001510@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001511Inject an MCE on the given CPU (x86 only).
1512ETEXI
1513
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001514 {
1515 .name = "getfd",
1516 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001517 .params = "getfd name",
1518 .help = "receive a file descriptor via SCM rights and assign it a name",
Corey Bryant208c9d12012-06-22 14:36:09 -04001519 .mhandler.cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001520 },
1521
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001522STEXI
1523@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001524@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001525If a file descriptor is passed alongside this command using the SCM_RIGHTS
1526mechanism on unix sockets, it is stored using the name @var{fdname} for
1527later use by other monitor commands.
1528ETEXI
1529
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001530 {
1531 .name = "closefd",
1532 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001533 .params = "closefd name",
1534 .help = "close a file descriptor previously passed via SCM rights",
Corey Bryant208c9d12012-06-22 14:36:09 -04001535 .mhandler.cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001536 },
1537
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001538STEXI
1539@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001540@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001541Close the file descriptor previously assigned to @var{fdname} using the
1542@code{getfd} command. This is only needed if the file descriptor was never
1543used by another monitor command.
1544ETEXI
1545
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001546 {
1547 .name = "block_passwd",
1548 .args_type = "device:B,password:s",
1549 .params = "block_passwd device password",
1550 .help = "set the password of encrypted block devices",
Luiz Capitulinoa4dea8a2011-11-23 13:28:21 -02001551 .mhandler.cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001552 },
1553
1554STEXI
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001555@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1556@findex block_set_io_throttle
1557Change 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}
1558ETEXI
1559
1560 {
1561 .name = "block_set_io_throttle",
1562 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1563 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1564 .help = "change I/O throttle limits for a block drive",
Luiz Capitulino80047da2011-12-14 16:49:14 -02001565 .mhandler.cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001566 },
1567
1568STEXI
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001569@item block_passwd @var{device} @var{password}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001570@findex block_passwd
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001571Set the encrypted device @var{device} password to @var{password}
1572ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001573
Jan Kiszka33572ec2010-05-31 14:43:30 -03001574 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001575 .name = "set_password",
1576 .args_type = "protocol:s,password:s,connected:s?",
1577 .params = "protocol password action-if-connected",
1578 .help = "set spice/vnc password",
Luiz Capitulinofbf796f2011-12-07 11:17:51 -02001579 .mhandler.cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001580 },
1581
1582STEXI
1583@item set_password [ vnc | spice ] password [ action-if-connected ]
1584@findex set_password
1585
1586Change spice/vnc password. Use zero to make the password stay valid
1587forever. @var{action-if-connected} specifies what should happen in
1588case a connection is established: @var{fail} makes the password change
1589fail. @var{disconnect} changes the password and disconnects the
1590client. @var{keep} changes the password and keeps the connection up.
1591@var{keep} is the default.
1592ETEXI
1593
1594 {
1595 .name = "expire_password",
1596 .args_type = "protocol:s,time:s",
1597 .params = "protocol time",
1598 .help = "set spice/vnc password expire-time",
Luiz Capitulino9ad53722011-12-07 11:47:57 -02001599 .mhandler.cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001600 },
1601
1602STEXI
1603@item expire_password [ vnc | spice ] expire-time
1604@findex expire_password
1605
1606Specify when a password for spice/vnc becomes
1607invalid. @var{expire-time} accepts:
1608
1609@table @var
1610@item now
1611Invalidate password instantly.
1612
1613@item never
1614Password stays valid forever.
1615
1616@item +nsec
1617Password stays valid for @var{nsec} seconds starting now.
1618
1619@item nsec
1620Password is invalidated at the given time. @var{nsec} are the seconds
1621passed since 1970, i.e. unix epoch.
1622
1623@end table
1624ETEXI
1625
Gerd Hoffmann46920822013-02-28 08:46:10 +01001626 {
1627 .name = "chardev-add",
1628 .args_type = "args:s",
1629 .params = "args",
1630 .help = "add chardev",
1631 .mhandler.cmd = hmp_chardev_add,
Hani Benhabiles13e315d2014-05-07 23:41:29 +01001632 .command_completion = chardev_add_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001633 },
1634
1635STEXI
1636@item chardev_add args
1637@findex chardev_add
1638
1639chardev_add accepts the same parameters as the -chardev command line switch.
1640
1641ETEXI
1642
1643 {
1644 .name = "chardev-remove",
1645 .args_type = "id:s",
1646 .params = "id",
1647 .help = "remove chardev",
1648 .mhandler.cmd = hmp_chardev_remove,
Hani Benhabiles6297d9a2014-05-07 23:41:28 +01001649 .command_completion = chardev_remove_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001650 },
1651
1652STEXI
1653@item chardev_remove id
1654@findex chardev_remove
1655
1656Removes the chardev @var{id}.
1657
1658ETEXI
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001659
1660 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001661 .name = "qemu-io",
1662 .args_type = "device:B,command:s",
1663 .params = "[device] \"[command]\"",
1664 .help = "run a qemu-io command on a block device",
1665 .mhandler.cmd = hmp_qemu_io,
1666 },
1667
1668STEXI
1669@item qemu-io @var{device} @var{command}
1670@findex qemu-io
1671
1672Executes a qemu-io command on the given block device.
1673
1674ETEXI
1675
1676 {
Jason J. Herneabf23322013-12-11 13:24:14 -05001677 .name = "cpu-add",
1678 .args_type = "id:i",
1679 .params = "id",
1680 .help = "add cpu",
1681 .mhandler.cmd = hmp_cpu_add,
1682 },
1683
1684STEXI
1685@item cpu-add @var{id}
1686Add CPU with id @var{id}
1687ETEXI
1688
1689 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001690 .name = "info",
1691 .args_type = "item:s?",
1692 .params = "[subcommand]",
1693 .help = "show various information about the system state",
Wenchao Xia84c44612013-01-14 14:06:29 +08001694 .mhandler.cmd = do_info_help,
1695 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001696 },
1697
1698STEXI
1699@item info @var{subcommand}
1700@findex info
1701Show various information about the system state.
1702
1703@table @option
1704@item info version
1705show the version of QEMU
Jan Kiszka33572ec2010-05-31 14:43:30 -03001706@item info network
1707show the various VLANs and the associated devices
1708@item info chardev
1709show the character devices
1710@item info block
1711show the block devices
1712@item info blockstats
1713show block device statistics
1714@item info registers
1715show the cpu registers
1716@item info cpus
1717show infos for each CPU
1718@item info history
1719show the command line history
1720@item info irq
1721show the interrupts statistics (if available)
1722@item info pic
1723show i8259 (PIC) state
1724@item info pci
1725show emulated PCI device info
1726@item info tlb
Max Filippov692f7372012-01-07 20:02:40 +04001727show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001728@item info mem
1729show the active virtual memory mappings (i386 only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001730@item info jit
1731show dynamic compiler info
Jan Kiszka33572ec2010-05-31 14:43:30 -03001732@item info numa
1733show NUMA information
Jan Kiszkab40292e2010-05-31 14:43:31 -03001734@item info kvm
1735show KVM information
Jan Kiszka33572ec2010-05-31 14:43:30 -03001736@item info usb
1737show USB devices plugged on the virtual USB hub
1738@item info usbhost
1739show all USB host devices
1740@item info profile
1741show profiling information
1742@item info capture
1743show information about active capturing
1744@item info snapshots
1745show list of VM snapshots
1746@item info status
1747show the current VM status (running|paused)
1748@item info pcmcia
1749show guest PCMCIA status
1750@item info mice
1751show which guest mouse is receiving events
1752@item info vnc
1753show the vnc server status
1754@item info name
1755show the current VM name
1756@item info uuid
1757show the current VM UUID
1758@item info cpustats
1759show CPU statistics
1760@item info usernet
1761show user network stack connection states
1762@item info migrate
1763show migration status
Orit Wassermanbbf6da32012-08-06 21:42:47 +03001764@item info migrate_capabilities
1765show current migration capabilities
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +03001766@item info migrate_cache_size
1767show current migration XBZRLE cache size
Jan Kiszka33572ec2010-05-31 14:43:30 -03001768@item info balloon
1769show balloon information
1770@item info qtree
1771show device tree
1772@item info qdm
1773show qdev device model list
1774@item info roms
1775show roms
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05001776@item info tpm
1777show the TPM device
Jan Kiszka33572ec2010-05-31 14:43:30 -03001778@end table
1779ETEXI
1780
LluĂ­s31965ae2011-08-31 20:31:24 +02001781STEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301782@item info trace-events
1783show available trace events and their state
1784ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301785
Blue Swirl23130862009-06-06 08:22:04 +00001786STEXI
1787@end table
1788ETEXI