blob: d79cb977a90c5c397c8c8665dc7ec2bb4af96b7f [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,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300559 },
560
Blue Swirl23130862009-06-06 08:22:04 +0000561STEXI
562@item sendkey @var{keys}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100563@findex sendkey
Blue Swirl23130862009-06-06 08:22:04 +0000564
Amos Kong886cc702012-08-31 10:56:20 +0800565Send @var{keys} to the guest. @var{keys} could be the name of the
566key or the raw value in hexadecimal format. Use @code{-} to press
567several keys simultaneously. Example:
Blue Swirl23130862009-06-06 08:22:04 +0000568@example
569sendkey ctrl-alt-f1
570@end example
571
572This command is useful to send keys that your graphical user interface
573intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
574ETEXI
575
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300576 {
577 .name = "system_reset",
578 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300579 .params = "",
580 .help = "reset the system",
Luiz Capitulino38d22652011-09-15 14:41:46 -0300581 .mhandler.cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300582 },
583
Blue Swirl23130862009-06-06 08:22:04 +0000584STEXI
585@item system_reset
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100586@findex system_reset
Blue Swirl23130862009-06-06 08:22:04 +0000587
588Reset the system.
589ETEXI
590
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300591 {
592 .name = "system_powerdown",
593 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300594 .params = "",
595 .help = "send system power down event",
Luiz Capitulino5bc465e2011-09-28 11:06:15 -0300596 .mhandler.cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300597 },
598
Blue Swirl23130862009-06-06 08:22:04 +0000599STEXI
600@item system_powerdown
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100601@findex system_powerdown
Blue Swirl23130862009-06-06 08:22:04 +0000602
603Power down the system (if supported).
604ETEXI
605
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300606 {
607 .name = "sum",
608 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300609 .params = "addr size",
610 .help = "compute the checksum of a memory region",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300611 .mhandler.cmd = do_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300612 },
613
Blue Swirl23130862009-06-06 08:22:04 +0000614STEXI
615@item sum @var{addr} @var{size}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100616@findex sum
Blue Swirl23130862009-06-06 08:22:04 +0000617
618Compute the checksum of a memory region.
619ETEXI
620
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300621 {
622 .name = "usb_add",
623 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300624 .params = "device",
625 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300626 .mhandler.cmd = do_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300627 },
628
Blue Swirl23130862009-06-06 08:22:04 +0000629STEXI
630@item usb_add @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100631@findex usb_add
Blue Swirl23130862009-06-06 08:22:04 +0000632
633Add the USB device @var{devname}. For details of available devices see
634@ref{usb_devices}
635ETEXI
636
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300637 {
638 .name = "usb_del",
639 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300640 .params = "device",
641 .help = "remove USB device 'bus.addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300642 .mhandler.cmd = do_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300643 },
644
Blue Swirl23130862009-06-06 08:22:04 +0000645STEXI
646@item usb_del @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100647@findex usb_del
Blue Swirl23130862009-06-06 08:22:04 +0000648
649Remove the USB device @var{devname} from the QEMU virtual USB
650hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
651command @code{info usb} to see the devices you can remove.
652ETEXI
653
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300654 {
655 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100656 .args_type = "device:O",
657 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300658 .help = "add device, like -device on the command line",
Markus Armbruster8bc27242010-02-10 20:52:01 +0100659 .user_print = monitor_user_noop,
660 .mhandler.cmd_new = do_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100661 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300662 },
663
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200664STEXI
665@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100666@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200667
668Add device.
669ETEXI
670
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300671 {
672 .name = "device_del",
673 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300674 .params = "device",
675 .help = "remove device",
Luiz Capitulinoa15fef22012-03-29 12:38:50 -0300676 .mhandler.cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100677 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300678 },
679
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200680STEXI
681@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100682@findex device_del
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200683
684Remove device @var{id}.
685ETEXI
686
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300687 {
688 .name = "cpu",
689 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300690 .params = "index",
691 .help = "set the default CPU",
Luiz Capitulino755f1962011-10-06 14:31:39 -0300692 .mhandler.cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300693 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200694
Blue Swirl23130862009-06-06 08:22:04 +0000695STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200696@item cpu @var{index}
697@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000698Set the default CPU.
699ETEXI
700
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300701 {
702 .name = "mouse_move",
703 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300704 .params = "dx dy [dz]",
705 .help = "send mouse move events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300706 .mhandler.cmd = do_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300707 },
708
Blue Swirl23130862009-06-06 08:22:04 +0000709STEXI
710@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100711@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000712Move the active mouse to the specified coordinates @var{dx} @var{dy}
713with optional scroll axis @var{dz}.
714ETEXI
715
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300716 {
717 .name = "mouse_button",
718 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300719 .params = "state",
720 .help = "change mouse button state (1=L, 2=M, 4=R)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300721 .mhandler.cmd = do_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300722 },
723
Blue Swirl23130862009-06-06 08:22:04 +0000724STEXI
725@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100726@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000727Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
728ETEXI
729
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300730 {
731 .name = "mouse_set",
732 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300733 .params = "index",
734 .help = "set which mouse device receives events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300735 .mhandler.cmd = do_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300736 },
737
Blue Swirl23130862009-06-06 08:22:04 +0000738STEXI
739@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100740@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000741Set which mouse device receives events at given @var{index}, index
742can be obtained with
743@example
744info mice
745@end example
746ETEXI
747
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300748 {
749 .name = "wavcapture",
750 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300751 .params = "path [frequency [bits [channels]]]",
752 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300753 .mhandler.cmd = do_wav_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300754 },
Blue Swirl23130862009-06-06 08:22:04 +0000755STEXI
756@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100757@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000758Capture audio into @var{filename}. Using sample rate @var{frequency}
759bits per sample @var{bits} and number of channels @var{channels}.
760
761Defaults:
762@itemize @minus
763@item Sample rate = 44100 Hz - CD quality
764@item Bits = 16
765@item Number of channels = 2 - Stereo
766@end itemize
767ETEXI
768
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300769 {
770 .name = "stopcapture",
771 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300772 .params = "capture index",
773 .help = "stop capture",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300774 .mhandler.cmd = do_stop_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300775 },
Blue Swirl23130862009-06-06 08:22:04 +0000776STEXI
777@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100778@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000779Stop capture with a given @var{index}, index can be obtained with
780@example
781info capture
782@end example
783ETEXI
784
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300785 {
786 .name = "memsave",
787 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300788 .params = "addr size file",
789 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulino0cfd6a92011-11-22 16:32:37 -0200790 .mhandler.cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300791 },
792
Blue Swirl23130862009-06-06 08:22:04 +0000793STEXI
794@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100795@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000796save to disk virtual memory dump starting at @var{addr} of size @var{size}.
797ETEXI
798
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300799 {
800 .name = "pmemsave",
801 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300802 .params = "addr size file",
803 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulino6d3962b2011-11-22 17:26:46 -0200804 .mhandler.cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300805 },
806
Blue Swirl23130862009-06-06 08:22:04 +0000807STEXI
808@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100809@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000810save to disk physical memory dump starting at @var{addr} of size @var{size}.
811ETEXI
812
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300813 {
814 .name = "boot_set",
815 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300816 .params = "bootdevice",
817 .help = "define new values for the boot device list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300818 .mhandler.cmd = do_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300819 },
820
Blue Swirl23130862009-06-06 08:22:04 +0000821STEXI
822@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100823@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000824
825Define new values for the boot device list. Those values will override
826the values specified on the command line through the @code{-boot} option.
827
828The values that can be specified here depend on the machine type, but are
829the same that can be specified in the @code{-boot} command line option.
830ETEXI
831
Eugene (jno) Dvurechenski7f7f9752012-12-05 15:50:07 +0100832#if defined(TARGET_I386) || defined(TARGET_S390X)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300833 {
834 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300835 .args_type = "",
836 .params = "",
837 .help = "inject an NMI on all guest's CPUs",
Luiz Capitulinoab49ab52011-11-23 12:55:53 -0200838 .mhandler.cmd = hmp_inject_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300839 },
Blue Swirl23130862009-06-06 08:22:04 +0000840#endif
841STEXI
842@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100843@findex nmi
Eugene (jno) Dvurechenski7f7f9752012-12-05 15:50:07 +0100844Inject an NMI (x86) or RESTART (s390x) on the given CPU.
Lei Li1f590cf2013-01-25 00:03:20 +0800845
846ETEXI
847
848 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100849 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800850 .args_type = "device:s,data:s",
851 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100852 .help = "Write to a ring buffer character device",
853 .mhandler.cmd = hmp_ringbuf_write,
Lei Li1f590cf2013-01-25 00:03:20 +0800854 },
855
856STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100857@item ringbuf_write @var{device} @var{data}
858@findex ringbuf_write
859Write @var{data} to ring buffer character device @var{device}.
860@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800861
Blue Swirl23130862009-06-06 08:22:04 +0000862ETEXI
863
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300864 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100865 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800866 .args_type = "device:s,size:i",
867 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100868 .help = "Read from a ring buffer character device",
869 .mhandler.cmd = hmp_ringbuf_read,
Lei Li49b6d722013-01-25 00:03:21 +0800870 },
871
872STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100873@item ringbuf_read @var{device}
874@findex ringbuf_read
875Read and print up to @var{size} bytes from ring buffer character
876device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100877Certain non-printable characters are printed \uXXXX, where XXXX is the
878character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100879Bug: can screw up when the buffer contains invalid UTF-8 sequences,
880NUL characters, after the ring buffer lost data, and when reading
881stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800882
883ETEXI
884
885 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300886 .name = "migrate",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200887 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
888 .params = "[-d] [-b] [-i] uri",
889 .help = "migrate to URI (using -d to not wait for completion)"
890 "\n\t\t\t -b for migration without shared storage with"
891 " full copy of disk\n\t\t\t -i for migration without "
892 "shared storage with incremental copy of disk "
893 "(base image shared between src and destination)",
Luiz Capitulinoe1c37d02011-12-05 14:48:01 -0200894 .mhandler.cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300895 },
896
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200897
Blue Swirl23130862009-06-06 08:22:04 +0000898STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200899@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100900@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000901Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200902 -b for migration with full copy of disk
903 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000904ETEXI
905
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300906 {
907 .name = "migrate_cancel",
908 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300909 .params = "",
910 .help = "cancel the current VM migration",
Luiz Capitulino6cdedb02011-11-27 22:54:09 -0200911 .mhandler.cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300912 },
913
Blue Swirl23130862009-06-06 08:22:04 +0000914STEXI
915@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100916@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000917Cancel the current VM migration.
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300918
919ETEXI
920
921 {
922 .name = "migrate_set_cache_size",
923 .args_type = "value:o",
924 .params = "value",
925 .help = "set cache size (in bytes) for XBZRLE migrations,"
926 "the cache size will be rounded down to the nearest "
927 "power of 2.\n"
928 "The cache size affects the number of cache misses."
929 "In case of a high cache miss ratio you need to increase"
930 " the cache size",
931 .mhandler.cmd = hmp_migrate_set_cache_size,
932 },
933
934STEXI
935@item migrate_set_cache_size @var{value}
936@findex migrate_set_cache_size
937Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +0000938ETEXI
939
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300940 {
941 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200942 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300943 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200944 .help = "set maximum speed (in bytes) for migrations. "
945 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Luiz Capitulino3dc85382011-11-28 11:59:37 -0200946 .mhandler.cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300947 },
948
Blue Swirl23130862009-06-06 08:22:04 +0000949STEXI
950@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100951@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +0000952Set maximum speed to @var{value} (in bytes) for migrations.
953ETEXI
954
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300955 {
956 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +0100957 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300958 .params = "value",
959 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulino4f0a9932011-11-27 23:18:01 -0200960 .mhandler.cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300961 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400962
963STEXI
964@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100965@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -0400966Set maximum tolerated downtime (in seconds) for migration.
967ETEXI
968
Jes Sorensenf8882562010-12-16 13:52:16 +0100969 {
Orit Wasserman00458432012-08-06 21:42:48 +0300970 .name = "migrate_set_capability",
971 .args_type = "capability:s,state:b",
972 .params = "capability state",
973 .help = "Enable/Disable the usage of a capability for migration",
974 .mhandler.cmd = hmp_migrate_set_capability,
975 },
976
977STEXI
978@item migrate_set_capability @var{capability} @var{state}
979@findex migrate_set_capability
980Enable/Disable the usage of a capability @var{capability} for migration.
981ETEXI
982
983 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +0100984 .name = "client_migrate_info",
985 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
986 .params = "protocol hostname port tls-port cert-subject",
987 .help = "send migration info to spice/vnc client",
988 .user_print = monitor_user_noop,
Yonit Halperinedc5cb12011-10-17 10:03:18 +0200989 .mhandler.cmd_async = client_migrate_info,
990 .flags = MONITOR_CMD_ASYNC,
Jes Sorensenf8882562010-12-16 13:52:16 +0100991 },
992
993STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +0200994@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
995@findex client_migrate_info
996Set the spice/vnc connection info for the migration target. The spice/vnc
997server will ask the spice/vnc client to automatically reconnect using the
998new parameters (if specified) once the vm migration finished successfully.
999ETEXI
1000
Wen Congyang783e9b42012-05-07 12:10:47 +08001001 {
1002 .name = "dump-guest-memory",
Luiz Capitulino75363762012-09-21 13:53:00 -03001003 .args_type = "paging:-p,filename:F,begin:i?,length:i?",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001004 .params = "[-p] filename [begin length]",
1005 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1006 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1007 "begin: the starting physical address.\n\t\t\t"
1008 "length: the memory size, in bytes.",
Wen Congyang783e9b42012-05-07 12:10:47 +08001009 .mhandler.cmd = hmp_dump_guest_memory,
1010 },
1011
1012
1013STEXI
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001014@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
Wen Congyang783e9b42012-05-07 12:10:47 +08001015@findex dump-guest-memory
1016Dump guest memory to @var{protocol}. The file can be processed with crash or
1017gdb.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001018 -p: do paging to get guest's memory mapping.
1019 filename: dump file name.
Wen Congyang783e9b42012-05-07 12:10:47 +08001020 begin: the starting physical address. It's optional, and should be
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001021 specified together with length.
Wen Congyang783e9b42012-05-07 12:10:47 +08001022 length: the memory size, in bytes. It's optional, and should be specified
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001023 together with begin.
Wen Congyang783e9b42012-05-07 12:10:47 +08001024ETEXI
Wen Congyang783e9b42012-05-07 12:10:47 +08001025
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001026 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001027 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001028 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1029 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001030 .help = "initiates a live snapshot\n\t\t\t"
1031 "of device. If a new image file is specified, the\n\t\t\t"
1032 "new image file will become the new root image.\n\t\t\t"
1033 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001034 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001035 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1036 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1037 "recreating it from scratch.",
Luiz Capitulino6106e242011-11-25 16:15:19 -02001038 .mhandler.cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001039 },
1040
1041STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001042@item snapshot_blkdev
1043@findex snapshot_blkdev
1044Snapshot device, using snapshot file as target if provided
1045ETEXI
1046
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001047 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001048 .name = "snapshot_blkdev_internal",
1049 .args_type = "device:B,name:s",
1050 .params = "device name",
1051 .help = "take an internal snapshot of device.\n\t\t\t"
1052 "The format of the image used by device must\n\t\t\t"
1053 "support it, such as qcow2.\n\t\t\t",
1054 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1055 },
1056
1057STEXI
1058@item snapshot_blkdev_internal
1059@findex snapshot_blkdev_internal
1060Take an internal snapshot on device if it support
1061ETEXI
1062
1063 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001064 .name = "snapshot_delete_blkdev_internal",
1065 .args_type = "device:B,name:s,id:s?",
1066 .params = "device name [id]",
1067 .help = "delete an internal snapshot of device.\n\t\t\t"
1068 "If id is specified, qemu will try delete\n\t\t\t"
1069 "the snapshot matching both id and name.\n\t\t\t"
1070 "The format of the image used by device must\n\t\t\t"
1071 "support it, such as qcow2.\n\t\t\t",
1072 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1073 },
1074
1075STEXI
1076@item snapshot_delete_blkdev_internal
1077@findex snapshot_delete_blkdev_internal
1078Delete an internal snapshot on device if it support
1079ETEXI
1080
1081 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001082 .name = "drive_mirror",
1083 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1084 .params = "[-n] [-f] device target [format]",
1085 .help = "initiates live storage\n\t\t\t"
1086 "migration for a device. The device's contents are\n\t\t\t"
1087 "copied to the new image file, including data that\n\t\t\t"
1088 "is written after the command is started.\n\t\t\t"
1089 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1090 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1091 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1092 "so that the result does not need a backing file.\n\t\t\t",
1093 .mhandler.cmd = hmp_drive_mirror,
1094 },
1095STEXI
1096@item drive_mirror
1097@findex drive_mirror
1098Start mirroring a block device's writes to a new destination,
1099using the specified target.
1100ETEXI
1101
1102 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001103 .name = "drive_backup",
1104 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1105 .params = "[-n] [-f] device target [format]",
1106 .help = "initiates a point-in-time\n\t\t\t"
1107 "copy for a device. The device's contents are\n\t\t\t"
1108 "copied to the new image file, excluding data that\n\t\t\t"
1109 "is written after the command is started.\n\t\t\t"
1110 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1111 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1112 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1113 "so that the result does not need a backing file.\n\t\t\t",
1114 .mhandler.cmd = hmp_drive_backup,
1115 },
1116STEXI
1117@item drive_backup
1118@findex drive_backup
1119Start a point-in-time copy of a block device to a specificed target.
1120ETEXI
1121
1122 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001123 .name = "drive_add",
1124 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001125 .params = "[[<domain>:]<bus>:]<slot>\n"
1126 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001127 "[,unit=m][,media=d][,index=i]\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001128 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001129 "[,snapshot=on|off][,cache=on|off]\n"
1130 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001131 .help = "add drive to PCI storage controller",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001132 .mhandler.cmd = drive_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001133 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001134
Blue Swirl23130862009-06-06 08:22:04 +00001135STEXI
1136@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001137@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001138Add drive to PCI storage controller.
1139ETEXI
1140
David Gibson79ca6162013-06-06 18:48:45 +10001141#if defined(CONFIG_PCI_HOTPLUG_OLD)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001142 {
1143 .name = "pci_add",
1144 .args_type = "pci_addr:s,type:s,opts:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001145 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
1146 .help = "hot-add PCI device",
Markus Armbruster6c6a58a2010-05-12 10:53:00 +02001147 .mhandler.cmd = pci_device_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001148 },
Blue Swirl23130862009-06-06 08:22:04 +00001149#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001150
Blue Swirl23130862009-06-06 08:22:04 +00001151STEXI
1152@item pci_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001153@findex pci_add
Blue Swirl23130862009-06-06 08:22:04 +00001154Hot-add PCI device.
1155ETEXI
1156
David Gibson79ca6162013-06-06 18:48:45 +10001157#if defined(CONFIG_PCI_HOTPLUG_OLD)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001158 {
1159 .name = "pci_del",
1160 .args_type = "pci_addr:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001161 .params = "[[<domain>:]<bus>:]<slot>",
1162 .help = "hot remove PCI device",
Markus Armbrusterb752daf2010-05-12 10:53:01 +02001163 .mhandler.cmd = do_pci_device_hot_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001164 },
Blue Swirl23130862009-06-06 08:22:04 +00001165#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001166
Blue Swirl23130862009-06-06 08:22:04 +00001167STEXI
1168@item pci_del
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001169@findex pci_del
Blue Swirl23130862009-06-06 08:22:04 +00001170Hot remove PCI device.
1171ETEXI
1172
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001173 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001174 .name = "pcie_aer_inject_error",
1175 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1176 "id:s,error_status:s,"
1177 "header0:i?,header1:i?,header2:i?,header3:i?,"
1178 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1179 .params = "[-a] [-c] id "
1180 "<error_status> [<tlp header> [<tlp header prefix>]]",
1181 .help = "inject pcie aer error\n\t\t\t"
1182 " -a for advisory non fatal error\n\t\t\t"
1183 " -c for correctable error\n\t\t\t"
1184 "<id> = qdev device id\n\t\t\t"
1185 "<error_status> = error string or 32bit\n\t\t\t"
1186 "<tlb header> = 32bit x 4\n\t\t\t"
1187 "<tlb header prefix> = 32bit x 4",
1188 .user_print = pcie_aer_inject_error_print,
Zhi Yong Wu1f3392b2011-11-30 12:39:47 +08001189 .mhandler.cmd_new = do_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001190 },
1191
1192STEXI
1193@item pcie_aer_inject_error
1194@findex pcie_aer_inject_error
1195Inject PCIe AER error
1196ETEXI
1197
1198 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001199 .name = "host_net_add",
1200 .args_type = "device:s,opts:s?",
Vincenzo Maffione58952132013-11-06 11:44:06 +01001201 .params = "tap|user|socket|vde|netmap|dump [options]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001202 .help = "add host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001203 .mhandler.cmd = net_host_device_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001204 },
1205
Blue Swirl23130862009-06-06 08:22:04 +00001206STEXI
1207@item host_net_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001208@findex host_net_add
Blue Swirl23130862009-06-06 08:22:04 +00001209Add host VLAN client.
1210ETEXI
1211
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001212 {
1213 .name = "host_net_remove",
1214 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001215 .params = "vlan_id name",
1216 .help = "remove host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001217 .mhandler.cmd = net_host_device_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001218 },
1219
Blue Swirl23130862009-06-06 08:22:04 +00001220STEXI
1221@item host_net_remove
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001222@findex host_net_remove
Blue Swirl23130862009-06-06 08:22:04 +00001223Remove host VLAN client.
1224ETEXI
1225
Markus Armbrusterae82d322010-03-25 17:22:40 +01001226 {
1227 .name = "netdev_add",
1228 .args_type = "netdev:O",
Vincenzo Maffione58952132013-11-06 11:44:06 +01001229 .params = "[user|tap|socket|hubport|netmap],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001230 .help = "add host network device",
Luiz Capitulino928059a2012-04-18 17:34:15 -03001231 .mhandler.cmd = hmp_netdev_add,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001232 },
1233
1234STEXI
1235@item netdev_add
1236@findex netdev_add
1237Add host network device.
1238ETEXI
1239
1240 {
1241 .name = "netdev_del",
1242 .args_type = "id:s",
1243 .params = "id",
1244 .help = "remove host network device",
Luiz Capitulino5f964152012-04-16 14:36:32 -03001245 .mhandler.cmd = hmp_netdev_del,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001246 },
1247
1248STEXI
1249@item netdev_del
1250@findex netdev_del
1251Remove host network device.
1252ETEXI
1253
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001254 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001255 .name = "object_add",
1256 .args_type = "object:O",
1257 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1258 .help = "create QOM object",
1259 .mhandler.cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001260 .command_completion = object_add_completion,
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001261 },
1262
1263STEXI
1264@item object_add
1265@findex object_add
1266Create QOM object.
1267ETEXI
1268
1269 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001270 .name = "object_del",
1271 .args_type = "id:s",
1272 .params = "id",
1273 .help = "destroy QOM object",
1274 .mhandler.cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001275 .command_completion = object_del_completion,
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001276 },
1277
1278STEXI
1279@item object_del
1280@findex object_del
1281Destroy QOM object.
1282ETEXI
1283
Blue Swirl23130862009-06-06 08:22:04 +00001284#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001285 {
1286 .name = "hostfwd_add",
1287 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001288 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1289 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001290 .mhandler.cmd = net_slirp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001291 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001292#endif
1293STEXI
1294@item hostfwd_add
1295@findex hostfwd_add
1296Redirect TCP or UDP connections from host to guest (requires -net user).
1297ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001298
Markus Armbruster21413d62010-05-04 13:20:30 +02001299#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001300 {
1301 .name = "hostfwd_remove",
1302 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001303 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1304 .help = "remove host-to-guest TCP or UDP redirection",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001305 .mhandler.cmd = net_slirp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001306 },
1307
Blue Swirl23130862009-06-06 08:22:04 +00001308#endif
1309STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001310@item hostfwd_remove
1311@findex hostfwd_remove
1312Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001313ETEXI
1314
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001315 {
1316 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001317 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001318 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001319 .help = "request VM to change its memory allocation (in MB)",
Luiz Capitulinod72f3262011-11-25 14:38:09 -02001320 .mhandler.cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001321 },
1322
Blue Swirl23130862009-06-06 08:22:04 +00001323STEXI
1324@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001325@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001326Request VM to change its memory allocation to @var{value} (in MB).
1327ETEXI
1328
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001329 {
1330 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001331 .args_type = "name:s,up:b",
1332 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001333 .help = "change the link status of a network adapter",
Luiz Capitulino4b371562011-11-23 13:11:55 -02001334 .mhandler.cmd = hmp_set_link,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001335 },
1336
Blue Swirl23130862009-06-06 08:22:04 +00001337STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001338@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001339@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001340Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001341ETEXI
1342
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001343 {
1344 .name = "watchdog_action",
1345 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001346 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1347 .help = "change watchdog action",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001348 .mhandler.cmd = do_watchdog_action,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001349 },
1350
Blue Swirl23130862009-06-06 08:22:04 +00001351STEXI
1352@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001353@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001354Change watchdog action.
1355ETEXI
1356
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001357 {
1358 .name = "acl_show",
1359 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001360 .params = "aclname",
1361 .help = "list rules in the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001362 .mhandler.cmd = do_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001363 },
1364
Blue Swirl23130862009-06-06 08:22:04 +00001365STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001366@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001367@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001368List all the matching rules in the access control list, and the default
1369policy. There are currently two named access control lists,
1370@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1371certificate distinguished name, and SASL username respectively.
1372ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001373
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001374 {
1375 .name = "acl_policy",
1376 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001377 .params = "aclname allow|deny",
1378 .help = "set default access control list policy",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001379 .mhandler.cmd = do_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001380 },
1381
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001382STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001383@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001384@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001385Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001386none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001387always @code{deny}.
1388ETEXI
1389
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001390 {
1391 .name = "acl_add",
1392 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001393 .params = "aclname match allow|deny [index]",
1394 .help = "add a match rule to the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001395 .mhandler.cmd = do_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001396 },
1397
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001398STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001399@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1400@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001401Add a match rule to the access control list, allowing or denying access.
1402The match will normally be an exact username or x509 distinguished name,
1403but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1404allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001405normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001406earlier in the list if the optional @var{index} parameter is supplied.
1407ETEXI
1408
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001409 {
1410 .name = "acl_remove",
1411 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001412 .params = "aclname match",
1413 .help = "remove a match rule from the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001414 .mhandler.cmd = do_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001415 },
1416
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001417STEXI
1418@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001419@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001420Remove the specified match rule from the access control list.
1421ETEXI
1422
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001423 {
1424 .name = "acl_reset",
1425 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001426 .params = "aclname",
1427 .help = "reset the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001428 .mhandler.cmd = do_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001429 },
1430
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001431STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001432@item acl_reset @var{aclname}
1433@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001434Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001435policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001436ETEXI
1437
Paolo Bonzini40577252012-08-23 11:53:04 +02001438 {
1439 .name = "nbd_server_start",
1440 .args_type = "all:-a,writable:-w,uri:s",
1441 .params = "nbd_server_start [-a] [-w] host:port",
1442 .help = "serve block devices on the given host and port",
1443 .mhandler.cmd = hmp_nbd_server_start,
1444 },
1445STEXI
1446@item nbd_server_start @var{host}:@var{port}
1447@findex nbd_server_start
1448Start an NBD server on the given host and/or port. If the @option{-a}
1449option is included, all of the virtual machine's block devices that
1450have an inserted media on them are automatically exported; in this case,
1451the @option{-w} option makes the devices writable too.
1452ETEXI
1453
1454 {
1455 .name = "nbd_server_add",
1456 .args_type = "writable:-w,device:B",
1457 .params = "nbd_server_add [-w] device",
1458 .help = "export a block device via NBD",
1459 .mhandler.cmd = hmp_nbd_server_add,
1460 },
1461STEXI
1462@item nbd_server_add @var{device}
1463@findex nbd_server_add
1464Export a block device through QEMU's NBD server, which must be started
1465beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1466exported device writable too.
1467ETEXI
1468
1469 {
1470 .name = "nbd_server_stop",
1471 .args_type = "",
1472 .params = "nbd_server_stop",
1473 .help = "stop serving block devices using the NBD protocol",
1474 .mhandler.cmd = hmp_nbd_server_stop,
1475 },
1476STEXI
1477@item nbd_server_stop
1478@findex nbd_server_stop
1479Stop the QEMU embedded NBD server.
1480ETEXI
1481
1482
Huang Ying79c4f6b2009-06-23 10:05:14 +08001483#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001484
1485 {
1486 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001487 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1488 .params = "[-b] cpu bank status mcgstatus addr misc",
1489 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001490 .mhandler.cmd = do_inject_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001491 },
1492
Huang Ying79c4f6b2009-06-23 10:05:14 +08001493#endif
1494STEXI
1495@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001496@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001497Inject an MCE on the given CPU (x86 only).
1498ETEXI
1499
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001500 {
1501 .name = "getfd",
1502 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001503 .params = "getfd name",
1504 .help = "receive a file descriptor via SCM rights and assign it a name",
Corey Bryant208c9d12012-06-22 14:36:09 -04001505 .mhandler.cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001506 },
1507
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001508STEXI
1509@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001510@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001511If a file descriptor is passed alongside this command using the SCM_RIGHTS
1512mechanism on unix sockets, it is stored using the name @var{fdname} for
1513later use by other monitor commands.
1514ETEXI
1515
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001516 {
1517 .name = "closefd",
1518 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001519 .params = "closefd name",
1520 .help = "close a file descriptor previously passed via SCM rights",
Corey Bryant208c9d12012-06-22 14:36:09 -04001521 .mhandler.cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001522 },
1523
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001524STEXI
1525@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001526@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001527Close the file descriptor previously assigned to @var{fdname} using the
1528@code{getfd} command. This is only needed if the file descriptor was never
1529used by another monitor command.
1530ETEXI
1531
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001532 {
1533 .name = "block_passwd",
1534 .args_type = "device:B,password:s",
1535 .params = "block_passwd device password",
1536 .help = "set the password of encrypted block devices",
Luiz Capitulinoa4dea8a2011-11-23 13:28:21 -02001537 .mhandler.cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001538 },
1539
1540STEXI
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001541@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1542@findex block_set_io_throttle
1543Change 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}
1544ETEXI
1545
1546 {
1547 .name = "block_set_io_throttle",
1548 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1549 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1550 .help = "change I/O throttle limits for a block drive",
Luiz Capitulino80047da2011-12-14 16:49:14 -02001551 .mhandler.cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001552 },
1553
1554STEXI
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001555@item block_passwd @var{device} @var{password}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001556@findex block_passwd
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001557Set the encrypted device @var{device} password to @var{password}
1558ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001559
Jan Kiszka33572ec2010-05-31 14:43:30 -03001560 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001561 .name = "set_password",
1562 .args_type = "protocol:s,password:s,connected:s?",
1563 .params = "protocol password action-if-connected",
1564 .help = "set spice/vnc password",
Luiz Capitulinofbf796f2011-12-07 11:17:51 -02001565 .mhandler.cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001566 },
1567
1568STEXI
1569@item set_password [ vnc | spice ] password [ action-if-connected ]
1570@findex set_password
1571
1572Change spice/vnc password. Use zero to make the password stay valid
1573forever. @var{action-if-connected} specifies what should happen in
1574case a connection is established: @var{fail} makes the password change
1575fail. @var{disconnect} changes the password and disconnects the
1576client. @var{keep} changes the password and keeps the connection up.
1577@var{keep} is the default.
1578ETEXI
1579
1580 {
1581 .name = "expire_password",
1582 .args_type = "protocol:s,time:s",
1583 .params = "protocol time",
1584 .help = "set spice/vnc password expire-time",
Luiz Capitulino9ad53722011-12-07 11:47:57 -02001585 .mhandler.cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001586 },
1587
1588STEXI
1589@item expire_password [ vnc | spice ] expire-time
1590@findex expire_password
1591
1592Specify when a password for spice/vnc becomes
1593invalid. @var{expire-time} accepts:
1594
1595@table @var
1596@item now
1597Invalidate password instantly.
1598
1599@item never
1600Password stays valid forever.
1601
1602@item +nsec
1603Password stays valid for @var{nsec} seconds starting now.
1604
1605@item nsec
1606Password is invalidated at the given time. @var{nsec} are the seconds
1607passed since 1970, i.e. unix epoch.
1608
1609@end table
1610ETEXI
1611
Gerd Hoffmann46920822013-02-28 08:46:10 +01001612 {
1613 .name = "chardev-add",
1614 .args_type = "args:s",
1615 .params = "args",
1616 .help = "add chardev",
1617 .mhandler.cmd = hmp_chardev_add,
1618 },
1619
1620STEXI
1621@item chardev_add args
1622@findex chardev_add
1623
1624chardev_add accepts the same parameters as the -chardev command line switch.
1625
1626ETEXI
1627
1628 {
1629 .name = "chardev-remove",
1630 .args_type = "id:s",
1631 .params = "id",
1632 .help = "remove chardev",
1633 .mhandler.cmd = hmp_chardev_remove,
1634 },
1635
1636STEXI
1637@item chardev_remove id
1638@findex chardev_remove
1639
1640Removes the chardev @var{id}.
1641
1642ETEXI
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001643
1644 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001645 .name = "qemu-io",
1646 .args_type = "device:B,command:s",
1647 .params = "[device] \"[command]\"",
1648 .help = "run a qemu-io command on a block device",
1649 .mhandler.cmd = hmp_qemu_io,
1650 },
1651
1652STEXI
1653@item qemu-io @var{device} @var{command}
1654@findex qemu-io
1655
1656Executes a qemu-io command on the given block device.
1657
1658ETEXI
1659
1660 {
Jason J. Herneabf23322013-12-11 13:24:14 -05001661 .name = "cpu-add",
1662 .args_type = "id:i",
1663 .params = "id",
1664 .help = "add cpu",
1665 .mhandler.cmd = hmp_cpu_add,
1666 },
1667
1668STEXI
1669@item cpu-add @var{id}
1670Add CPU with id @var{id}
1671ETEXI
1672
1673 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001674 .name = "info",
1675 .args_type = "item:s?",
1676 .params = "[subcommand]",
1677 .help = "show various information about the system state",
Wenchao Xia84c44612013-01-14 14:06:29 +08001678 .mhandler.cmd = do_info_help,
1679 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001680 },
1681
1682STEXI
1683@item info @var{subcommand}
1684@findex info
1685Show various information about the system state.
1686
1687@table @option
1688@item info version
1689show the version of QEMU
Jan Kiszka33572ec2010-05-31 14:43:30 -03001690@item info network
1691show the various VLANs and the associated devices
1692@item info chardev
1693show the character devices
1694@item info block
1695show the block devices
1696@item info blockstats
1697show block device statistics
1698@item info registers
1699show the cpu registers
1700@item info cpus
1701show infos for each CPU
1702@item info history
1703show the command line history
1704@item info irq
1705show the interrupts statistics (if available)
1706@item info pic
1707show i8259 (PIC) state
1708@item info pci
1709show emulated PCI device info
1710@item info tlb
Max Filippov692f7372012-01-07 20:02:40 +04001711show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001712@item info mem
1713show the active virtual memory mappings (i386 only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001714@item info jit
1715show dynamic compiler info
Jan Kiszka33572ec2010-05-31 14:43:30 -03001716@item info numa
1717show NUMA information
Jan Kiszkab40292e2010-05-31 14:43:31 -03001718@item info kvm
1719show KVM information
Jan Kiszka33572ec2010-05-31 14:43:30 -03001720@item info usb
1721show USB devices plugged on the virtual USB hub
1722@item info usbhost
1723show all USB host devices
1724@item info profile
1725show profiling information
1726@item info capture
1727show information about active capturing
1728@item info snapshots
1729show list of VM snapshots
1730@item info status
1731show the current VM status (running|paused)
1732@item info pcmcia
1733show guest PCMCIA status
1734@item info mice
1735show which guest mouse is receiving events
1736@item info vnc
1737show the vnc server status
1738@item info name
1739show the current VM name
1740@item info uuid
1741show the current VM UUID
1742@item info cpustats
1743show CPU statistics
1744@item info usernet
1745show user network stack connection states
1746@item info migrate
1747show migration status
Orit Wassermanbbf6da32012-08-06 21:42:47 +03001748@item info migrate_capabilities
1749show current migration capabilities
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +03001750@item info migrate_cache_size
1751show current migration XBZRLE cache size
Jan Kiszka33572ec2010-05-31 14:43:30 -03001752@item info balloon
1753show balloon information
1754@item info qtree
1755show device tree
1756@item info qdm
1757show qdev device model list
1758@item info roms
1759show roms
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05001760@item info tpm
1761show the TPM device
Jan Kiszka33572ec2010-05-31 14:43:30 -03001762@end table
1763ETEXI
1764
LluĂ­s31965ae2011-08-31 20:31:24 +02001765STEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301766@item info trace-events
1767show available trace events and their state
1768ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301769
Blue Swirl23130862009-06-06 08:22:04 +00001770STEXI
1771@end table
1772ETEXI