blob: 396691a5d61e32753aff6f5cfd13f349cd0667fc [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|?",
14 .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.
38ETEXI
39
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030040 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030041 .name = "q|quit",
42 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030043 .params = "",
44 .help = "quit the emulator",
Luiz Capitulinob223f352009-10-07 13:41:56 -030045 .user_print = monitor_user_noop,
Luiz Capitulino7a7f3252011-09-15 14:20:28 -030046 .mhandler.cmd = hmp_quit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030047 },
48
Blue Swirl23130862009-06-06 08:22:04 +000049STEXI
50@item q or quit
Stefan Weil70fcbbe2010-02-05 23:52:04 +010051@findex quit
Blue Swirl23130862009-06-06 08:22:04 +000052Quit the emulator.
53ETEXI
54
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030055 {
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010056 .name = "block_resize",
57 .args_type = "device:B,size:o",
58 .params = "device size",
59 .help = "resize a block image",
Luiz Capitulino5e7caac2011-11-25 14:57:10 -020060 .mhandler.cmd = hmp_block_resize,
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010061 },
62
63STEXI
64@item block_resize
65@findex block_resize
66Resize a block image while a guest is running. Usually requires guest
67action to see the updated size. Resize to a lower size is supported,
68but should be used with extreme caution. Note that this command only
69resizes image files, it can not resize block devices like LVM volumes.
70ETEXI
71
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000072 {
73 .name = "block_stream",
Stefan Hajnoczic83c66c2012-04-25 16:51:03 +010074 .args_type = "device:B,speed:o?,base:s?",
75 .params = "device [speed [base]]",
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000076 .help = "copy data from a backing file into a block device",
77 .mhandler.cmd = hmp_block_stream,
78 },
79
80STEXI
81@item block_stream
82@findex block_stream
83Copy data from a backing file into a block device.
84ETEXI
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010085
86 {
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000087 .name = "block_job_set_speed",
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +010088 .args_type = "device:B,speed:o",
89 .params = "device speed",
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000090 .help = "set maximum speed for a background block operation",
91 .mhandler.cmd = hmp_block_job_set_speed,
92 },
93
94STEXI
Paolo Bonzini4451b792012-04-13 12:03:46 +020095@item block_job_set_speed
96@findex block_job_set_speed
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000097Set maximum speed for a background block operation.
98ETEXI
99
100 {
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000101 .name = "block_job_cancel",
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200102 .args_type = "force:-f,device:B",
103 .params = "[-f] device",
104 .help = "stop an active background block operation (use -f"
105 "\n\t\t\t if the operation is currently paused)",
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000106 .mhandler.cmd = hmp_block_job_cancel,
107 },
108
109STEXI
110@item block_job_cancel
111@findex block_job_cancel
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200112Stop an active background block operation (streaming, mirroring).
113ETEXI
114
115 {
116 .name = "block_job_complete",
117 .args_type = "device:B",
118 .params = "device",
119 .help = "stop an active background block operation",
120 .mhandler.cmd = hmp_block_job_complete,
121 },
122
123STEXI
124@item block_job_complete
125@findex block_job_complete
126Manually trigger completion of an active background block operation.
127For mirroring, this will switch the device to the destination path.
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000128ETEXI
129
130 {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200131 .name = "block_job_pause",
132 .args_type = "device:B",
133 .params = "device",
134 .help = "pause an active background block operation",
135 .mhandler.cmd = hmp_block_job_pause,
136 },
137
138STEXI
139@item block_job_pause
140@findex block_job_pause
141Pause an active block streaming operation.
142ETEXI
143
144 {
145 .name = "block_job_resume",
146 .args_type = "device:B",
147 .params = "device",
148 .help = "resume a paused background block operation",
149 .mhandler.cmd = hmp_block_job_resume,
150 },
151
152STEXI
153@item block_job_resume
154@findex block_job_resume
155Resume a paused block streaming operation.
156ETEXI
157
158 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300159 .name = "eject",
Luiz Capitulino78d714e2009-12-14 18:53:21 -0200160 .args_type = "force:-f,device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300161 .params = "[-f] device",
162 .help = "eject a removable medium (use -f to force it)",
Luiz Capitulinoc245b6a2011-12-07 16:02:36 -0200163 .mhandler.cmd = hmp_eject,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300164 },
165
Blue Swirl23130862009-06-06 08:22:04 +0000166STEXI
167@item eject [-f] @var{device}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100168@findex eject
Blue Swirl23130862009-06-06 08:22:04 +0000169Eject a removable medium (use -f to force it).
170ETEXI
171
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300172 {
Ryan Harper9063f812010-11-12 11:07:13 -0600173 .name = "drive_del",
174 .args_type = "id:s",
175 .params = "device",
176 .help = "remove host block device",
177 .user_print = monitor_user_noop,
178 .mhandler.cmd_new = do_drive_del,
179 },
180
181STEXI
182@item drive_del @var{device}
183@findex drive_del
184Remove host block device. The result is that guest generated IO is no longer
185submitted against the host device underlying the disk. Once a drive has
186been deleted, the QEMU Block layer returns -EIO which results in IO
187errors in the guest for applications that are reading/writing to the device.
Stefan Hajnoczi293c51a2013-06-05 10:33:14 +0200188These errors are always reported to the guest, regardless of the drive's error
189actions (drive options rerror, werror).
Ryan Harper9063f812010-11-12 11:07:13 -0600190ETEXI
191
192 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300193 .name = "change",
194 .args_type = "device:B,target:F,arg:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300195 .params = "device filename [format]",
196 .help = "change a removable medium, optional format",
Luiz Capitulino333a96e2011-12-08 11:13:50 -0200197 .mhandler.cmd = hmp_change,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300198 },
199
Blue Swirl23130862009-06-06 08:22:04 +0000200STEXI
201@item change @var{device} @var{setting}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100202@findex change
Blue Swirl23130862009-06-06 08:22:04 +0000203
204Change the configuration of a device.
205
206@table @option
207@item change @var{diskdevice} @var{filename} [@var{format}]
208Change the medium for a removable disk device to point to @var{filename}. eg
209
210@example
211(qemu) change ide1-cd0 /path/to/some.iso
212@end example
213
214@var{format} is optional.
215
216@item change vnc @var{display},@var{options}
217Change the configuration of the VNC server. The valid syntax for @var{display}
218and @var{options} are described at @ref{sec_invocation}. eg
219
220@example
221(qemu) change vnc localhost:1
222@end example
223
224@item change vnc password [@var{password}]
225
226Change the password associated with the VNC server. If the new password is not
227supplied, the monitor will prompt for it to be entered. VNC passwords are only
228significant up to 8 letters. eg
229
230@example
231(qemu) change vnc password
232Password: ********
233@end example
234
235@end table
236ETEXI
237
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300238 {
239 .name = "screendump",
240 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300241 .params = "filename",
242 .help = "save screen into PPM image 'filename'",
Luiz Capitulinoad39cf62012-05-24 13:48:23 -0300243 .mhandler.cmd = hmp_screen_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300244 },
245
Blue Swirl23130862009-06-06 08:22:04 +0000246STEXI
247@item screendump @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100248@findex screendump
Blue Swirl23130862009-06-06 08:22:04 +0000249Save screen into PPM image @var{filename}.
250ETEXI
251
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300252 {
253 .name = "logfile",
254 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300255 .params = "filename",
256 .help = "output logs to 'filename'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300257 .mhandler.cmd = do_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300258 },
259
Blue Swirl23130862009-06-06 08:22:04 +0000260STEXI
261@item logfile @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100262@findex logfile
Blue Swirl23130862009-06-06 08:22:04 +0000263Output logs to @var{filename}.
264ETEXI
265
Prerna Saxena22890ab2010-06-24 17:04:53 +0530266 {
267 .name = "trace-event",
268 .args_type = "name:s,option:b",
269 .params = "name on|off",
270 .help = "changes status of a specific trace event",
LluĂ­sfc764102011-08-31 20:31:18 +0200271 .mhandler.cmd = do_trace_event_set_state,
Prerna Saxena22890ab2010-06-24 17:04:53 +0530272 },
273
274STEXI
275@item trace-event
276@findex trace-event
277changes status of a trace event
278ETEXI
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100279
Michael Rothc45a8162011-10-02 08:44:37 -0500280#if defined(CONFIG_TRACE_SIMPLE)
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100281 {
282 .name = "trace-file",
283 .args_type = "op:s?,arg:F?",
284 .params = "on|off|flush|set [arg]",
285 .help = "open, close, or flush trace file, or set a new file name",
286 .mhandler.cmd = do_trace_file,
287 },
288
289STEXI
290@item trace-file on|off|flush
291@findex trace-file
292Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
293ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +0530294#endif
295
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300296 {
297 .name = "log",
298 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300299 .params = "item1[,...]",
Peter Maydell989b6972013-02-26 17:52:40 +0000300 .help = "activate logging of the specified items",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300301 .mhandler.cmd = do_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300302 },
303
Blue Swirl23130862009-06-06 08:22:04 +0000304STEXI
305@item log @var{item1}[,...]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100306@findex log
Peter Maydell989b6972013-02-26 17:52:40 +0000307Activate logging of the specified items.
Blue Swirl23130862009-06-06 08:22:04 +0000308ETEXI
309
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300310 {
311 .name = "savevm",
312 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300313 .params = "[tag|id]",
314 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300315 .mhandler.cmd = do_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300316 },
317
Blue Swirl23130862009-06-06 08:22:04 +0000318STEXI
319@item savevm [@var{tag}|@var{id}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100320@findex savevm
Blue Swirl23130862009-06-06 08:22:04 +0000321Create a snapshot of the whole virtual machine. If @var{tag} is
322provided, it is used as human readable identifier. If there is already
323a snapshot with the same tag or ID, it is replaced. More info at
324@ref{vm_snapshots}.
325ETEXI
326
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300327 {
328 .name = "loadvm",
329 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300330 .params = "tag|id",
331 .help = "restore a VM snapshot from its tag or id",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300332 .mhandler.cmd = do_loadvm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300333 },
334
Blue Swirl23130862009-06-06 08:22:04 +0000335STEXI
336@item loadvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100337@findex loadvm
Blue Swirl23130862009-06-06 08:22:04 +0000338Set the whole virtual machine to the snapshot identified by the tag
339@var{tag} or the unique snapshot ID @var{id}.
340ETEXI
341
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300342 {
343 .name = "delvm",
344 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300345 .params = "tag|id",
346 .help = "delete a VM snapshot from its tag or id",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300347 .mhandler.cmd = do_delvm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300348 },
349
Blue Swirl23130862009-06-06 08:22:04 +0000350STEXI
351@item delvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100352@findex delvm
Blue Swirl23130862009-06-06 08:22:04 +0000353Delete the snapshot identified by @var{tag} or @var{id}.
354ETEXI
355
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300356 {
357 .name = "singlestep",
358 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300359 .params = "[on|off]",
360 .help = "run emulation in singlestep mode or switch to normal mode",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300361 .mhandler.cmd = do_singlestep,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300362 },
363
Blue Swirl23130862009-06-06 08:22:04 +0000364STEXI
365@item singlestep [off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100366@findex singlestep
Blue Swirl23130862009-06-06 08:22:04 +0000367Run the emulation in single step mode.
368If called with option off, the emulation returns to normal mode.
369ETEXI
370
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300371 {
372 .name = "stop",
373 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300374 .params = "",
375 .help = "stop emulation",
Luiz Capitulino5f158f22011-09-15 14:34:39 -0300376 .mhandler.cmd = hmp_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300377 },
378
Blue Swirl23130862009-06-06 08:22:04 +0000379STEXI
380@item stop
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100381@findex stop
Blue Swirl23130862009-06-06 08:22:04 +0000382Stop emulation.
383ETEXI
384
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300385 {
386 .name = "c|cont",
387 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300388 .params = "",
389 .help = "resume emulation",
Luiz Capitulinoe42e8182011-11-22 17:58:31 -0200390 .mhandler.cmd = hmp_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300391 },
392
Blue Swirl23130862009-06-06 08:22:04 +0000393STEXI
394@item c or cont
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100395@findex cont
Blue Swirl23130862009-06-06 08:22:04 +0000396Resume emulation.
397ETEXI
398
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300399 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100400 .name = "system_wakeup",
401 .args_type = "",
402 .params = "",
403 .help = "wakeup guest from suspend",
404 .mhandler.cmd = hmp_system_wakeup,
405 },
406
407STEXI
408@item system_wakeup
409@findex system_wakeup
410Wakeup guest from suspend.
411ETEXI
412
413 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300414 .name = "gdbserver",
415 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300416 .params = "[device]",
417 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300418 .mhandler.cmd = do_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300419 },
420
Blue Swirl23130862009-06-06 08:22:04 +0000421STEXI
422@item gdbserver [@var{port}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100423@findex gdbserver
Blue Swirl23130862009-06-06 08:22:04 +0000424Start gdbserver session (default @var{port}=1234)
425ETEXI
426
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300427 {
428 .name = "x",
429 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300430 .params = "/fmt addr",
431 .help = "virtual memory dump starting at 'addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300432 .mhandler.cmd = do_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300433 },
434
Blue Swirl23130862009-06-06 08:22:04 +0000435STEXI
436@item x/fmt @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100437@findex x
Blue Swirl23130862009-06-06 08:22:04 +0000438Virtual memory dump starting at @var{addr}.
439ETEXI
440
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300441 {
442 .name = "xp",
443 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300444 .params = "/fmt addr",
445 .help = "physical memory dump starting at 'addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300446 .mhandler.cmd = do_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300447 },
448
Blue Swirl23130862009-06-06 08:22:04 +0000449STEXI
450@item xp /@var{fmt} @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100451@findex xp
Blue Swirl23130862009-06-06 08:22:04 +0000452Physical memory dump starting at @var{addr}.
453
454@var{fmt} is a format which tells the command how to format the
455data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
456
457@table @var
458@item count
459is the number of items to be dumped.
460
461@item format
462can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
463c (char) or i (asm instruction).
464
465@item size
466can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
467@code{h} or @code{w} can be specified with the @code{i} format to
468respectively select 16 or 32 bit code instruction size.
469
470@end table
471
472Examples:
473@itemize
474@item
475Dump 10 instructions at the current instruction pointer:
476@example
477(qemu) x/10i $eip
4780x90107063: ret
4790x90107064: sti
4800x90107065: lea 0x0(%esi,1),%esi
4810x90107069: lea 0x0(%edi,1),%edi
4820x90107070: ret
4830x90107071: jmp 0x90107080
4840x90107073: nop
4850x90107074: nop
4860x90107075: nop
4870x90107076: nop
488@end example
489
490@item
491Dump 80 16 bit values at the start of the video memory.
492@smallexample
493(qemu) xp/80hx 0xb8000
4940x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
4950x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
4960x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
4970x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
4980x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
4990x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
5000x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5010x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5020x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5030x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
504@end smallexample
505@end itemize
506ETEXI
507
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300508 {
509 .name = "p|print",
510 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300511 .params = "/fmt expr",
512 .help = "print expression value (use $reg for CPU register access)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300513 .mhandler.cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300514 },
515
Blue Swirl23130862009-06-06 08:22:04 +0000516STEXI
517@item p or print/@var{fmt} @var{expr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100518@findex print
Blue Swirl23130862009-06-06 08:22:04 +0000519
520Print expression value. Only the @var{format} part of @var{fmt} is
521used.
522ETEXI
523
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300524 {
525 .name = "i",
526 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300527 .params = "/fmt addr",
528 .help = "I/O port read",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300529 .mhandler.cmd = do_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300530 },
531
Blue Swirl23130862009-06-06 08:22:04 +0000532STEXI
533Read I/O port.
534ETEXI
535
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300536 {
537 .name = "o",
538 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300539 .params = "/fmt addr value",
540 .help = "I/O port write",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300541 .mhandler.cmd = do_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300542 },
543
Jan Kiszkaf1147842009-07-14 10:20:11 +0200544STEXI
545Write to I/O port.
546ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000547
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300548 {
549 .name = "sendkey",
Amos Kong2ef20c12012-08-31 10:56:22 +0800550 .args_type = "keys:s,hold-time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300551 .params = "keys [hold_ms]",
552 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Amos Konge4c8f002012-08-31 10:56:26 +0800553 .mhandler.cmd = hmp_send_key,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300554 },
555
Blue Swirl23130862009-06-06 08:22:04 +0000556STEXI
557@item sendkey @var{keys}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100558@findex sendkey
Blue Swirl23130862009-06-06 08:22:04 +0000559
Amos Kong886cc702012-08-31 10:56:20 +0800560Send @var{keys} to the guest. @var{keys} could be the name of the
561key or the raw value in hexadecimal format. Use @code{-} to press
562several keys simultaneously. Example:
Blue Swirl23130862009-06-06 08:22:04 +0000563@example
564sendkey ctrl-alt-f1
565@end example
566
567This command is useful to send keys that your graphical user interface
568intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
569ETEXI
570
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300571 {
572 .name = "system_reset",
573 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300574 .params = "",
575 .help = "reset the system",
Luiz Capitulino38d22652011-09-15 14:41:46 -0300576 .mhandler.cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300577 },
578
Blue Swirl23130862009-06-06 08:22:04 +0000579STEXI
580@item system_reset
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100581@findex system_reset
Blue Swirl23130862009-06-06 08:22:04 +0000582
583Reset the system.
584ETEXI
585
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300586 {
587 .name = "system_powerdown",
588 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300589 .params = "",
590 .help = "send system power down event",
Luiz Capitulino5bc465e2011-09-28 11:06:15 -0300591 .mhandler.cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300592 },
593
Blue Swirl23130862009-06-06 08:22:04 +0000594STEXI
595@item system_powerdown
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100596@findex system_powerdown
Blue Swirl23130862009-06-06 08:22:04 +0000597
598Power down the system (if supported).
599ETEXI
600
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300601 {
602 .name = "sum",
603 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300604 .params = "addr size",
605 .help = "compute the checksum of a memory region",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300606 .mhandler.cmd = do_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300607 },
608
Blue Swirl23130862009-06-06 08:22:04 +0000609STEXI
610@item sum @var{addr} @var{size}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100611@findex sum
Blue Swirl23130862009-06-06 08:22:04 +0000612
613Compute the checksum of a memory region.
614ETEXI
615
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300616 {
617 .name = "usb_add",
618 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300619 .params = "device",
620 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300621 .mhandler.cmd = do_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300622 },
623
Blue Swirl23130862009-06-06 08:22:04 +0000624STEXI
625@item usb_add @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100626@findex usb_add
Blue Swirl23130862009-06-06 08:22:04 +0000627
628Add the USB device @var{devname}. For details of available devices see
629@ref{usb_devices}
630ETEXI
631
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300632 {
633 .name = "usb_del",
634 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300635 .params = "device",
636 .help = "remove USB device 'bus.addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300637 .mhandler.cmd = do_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300638 },
639
Blue Swirl23130862009-06-06 08:22:04 +0000640STEXI
641@item usb_del @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100642@findex usb_del
Blue Swirl23130862009-06-06 08:22:04 +0000643
644Remove the USB device @var{devname} from the QEMU virtual USB
645hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
646command @code{info usb} to see the devices you can remove.
647ETEXI
648
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300649 {
650 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100651 .args_type = "device:O",
652 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300653 .help = "add device, like -device on the command line",
Markus Armbruster8bc27242010-02-10 20:52:01 +0100654 .user_print = monitor_user_noop,
655 .mhandler.cmd_new = do_device_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300656 },
657
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200658STEXI
659@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100660@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200661
662Add device.
663ETEXI
664
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300665 {
666 .name = "device_del",
667 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300668 .params = "device",
669 .help = "remove device",
Luiz Capitulinoa15fef22012-03-29 12:38:50 -0300670 .mhandler.cmd = hmp_device_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300671 },
672
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200673STEXI
674@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100675@findex device_del
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200676
677Remove device @var{id}.
678ETEXI
679
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300680 {
681 .name = "cpu",
682 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300683 .params = "index",
684 .help = "set the default CPU",
Luiz Capitulino755f1962011-10-06 14:31:39 -0300685 .mhandler.cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300686 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200687
Blue Swirl23130862009-06-06 08:22:04 +0000688STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200689@item cpu @var{index}
690@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000691Set the default CPU.
692ETEXI
693
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300694 {
695 .name = "mouse_move",
696 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300697 .params = "dx dy [dz]",
698 .help = "send mouse move events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300699 .mhandler.cmd = do_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300700 },
701
Blue Swirl23130862009-06-06 08:22:04 +0000702STEXI
703@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100704@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000705Move the active mouse to the specified coordinates @var{dx} @var{dy}
706with optional scroll axis @var{dz}.
707ETEXI
708
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300709 {
710 .name = "mouse_button",
711 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300712 .params = "state",
713 .help = "change mouse button state (1=L, 2=M, 4=R)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300714 .mhandler.cmd = do_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300715 },
716
Blue Swirl23130862009-06-06 08:22:04 +0000717STEXI
718@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100719@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000720Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
721ETEXI
722
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300723 {
724 .name = "mouse_set",
725 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300726 .params = "index",
727 .help = "set which mouse device receives events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300728 .mhandler.cmd = do_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300729 },
730
Blue Swirl23130862009-06-06 08:22:04 +0000731STEXI
732@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100733@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000734Set which mouse device receives events at given @var{index}, index
735can be obtained with
736@example
737info mice
738@end example
739ETEXI
740
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300741 {
742 .name = "wavcapture",
743 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300744 .params = "path [frequency [bits [channels]]]",
745 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300746 .mhandler.cmd = do_wav_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300747 },
Blue Swirl23130862009-06-06 08:22:04 +0000748STEXI
749@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100750@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000751Capture audio into @var{filename}. Using sample rate @var{frequency}
752bits per sample @var{bits} and number of channels @var{channels}.
753
754Defaults:
755@itemize @minus
756@item Sample rate = 44100 Hz - CD quality
757@item Bits = 16
758@item Number of channels = 2 - Stereo
759@end itemize
760ETEXI
761
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300762 {
763 .name = "stopcapture",
764 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300765 .params = "capture index",
766 .help = "stop capture",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300767 .mhandler.cmd = do_stop_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300768 },
Blue Swirl23130862009-06-06 08:22:04 +0000769STEXI
770@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100771@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000772Stop capture with a given @var{index}, index can be obtained with
773@example
774info capture
775@end example
776ETEXI
777
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300778 {
779 .name = "memsave",
780 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300781 .params = "addr size file",
782 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulino0cfd6a92011-11-22 16:32:37 -0200783 .mhandler.cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300784 },
785
Blue Swirl23130862009-06-06 08:22:04 +0000786STEXI
787@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100788@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000789save to disk virtual memory dump starting at @var{addr} of size @var{size}.
790ETEXI
791
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300792 {
793 .name = "pmemsave",
794 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300795 .params = "addr size file",
796 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulino6d3962b2011-11-22 17:26:46 -0200797 .mhandler.cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300798 },
799
Blue Swirl23130862009-06-06 08:22:04 +0000800STEXI
801@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100802@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000803save to disk physical memory dump starting at @var{addr} of size @var{size}.
804ETEXI
805
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300806 {
807 .name = "boot_set",
808 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300809 .params = "bootdevice",
810 .help = "define new values for the boot device list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300811 .mhandler.cmd = do_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300812 },
813
Blue Swirl23130862009-06-06 08:22:04 +0000814STEXI
815@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100816@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000817
818Define new values for the boot device list. Those values will override
819the values specified on the command line through the @code{-boot} option.
820
821The values that can be specified here depend on the machine type, but are
822the same that can be specified in the @code{-boot} command line option.
823ETEXI
824
825#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300826 {
827 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300828 .args_type = "",
829 .params = "",
830 .help = "inject an NMI on all guest's CPUs",
Luiz Capitulinoab49ab52011-11-23 12:55:53 -0200831 .mhandler.cmd = hmp_inject_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300832 },
Blue Swirl23130862009-06-06 08:22:04 +0000833#endif
834STEXI
835@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100836@findex nmi
Blue Swirl23130862009-06-06 08:22:04 +0000837Inject an NMI on the given CPU (x86 only).
Lei Li1f590cf2013-01-25 00:03:20 +0800838
839ETEXI
840
841 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100842 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800843 .args_type = "device:s,data:s",
844 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100845 .help = "Write to a ring buffer character device",
846 .mhandler.cmd = hmp_ringbuf_write,
Lei Li1f590cf2013-01-25 00:03:20 +0800847 },
848
849STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100850@item ringbuf_write @var{device} @var{data}
851@findex ringbuf_write
852Write @var{data} to ring buffer character device @var{device}.
853@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800854
Blue Swirl23130862009-06-06 08:22:04 +0000855ETEXI
856
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300857 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100858 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800859 .args_type = "device:s,size:i",
860 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100861 .help = "Read from a ring buffer character device",
862 .mhandler.cmd = hmp_ringbuf_read,
Lei Li49b6d722013-01-25 00:03:21 +0800863 },
864
865STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100866@item ringbuf_read @var{device}
867@findex ringbuf_read
868Read and print up to @var{size} bytes from ring buffer character
869device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100870Certain non-printable characters are printed \uXXXX, where XXXX is the
871character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100872Bug: can screw up when the buffer contains invalid UTF-8 sequences,
873NUL characters, after the ring buffer lost data, and when reading
874stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800875
876ETEXI
877
878 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300879 .name = "migrate",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200880 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
881 .params = "[-d] [-b] [-i] uri",
882 .help = "migrate to URI (using -d to not wait for completion)"
883 "\n\t\t\t -b for migration without shared storage with"
884 " full copy of disk\n\t\t\t -i for migration without "
885 "shared storage with incremental copy of disk "
886 "(base image shared between src and destination)",
Luiz Capitulinoe1c37d02011-12-05 14:48:01 -0200887 .mhandler.cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300888 },
889
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200890
Blue Swirl23130862009-06-06 08:22:04 +0000891STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200892@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100893@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000894Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200895 -b for migration with full copy of disk
896 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000897ETEXI
898
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300899 {
900 .name = "migrate_cancel",
901 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300902 .params = "",
903 .help = "cancel the current VM migration",
Luiz Capitulino6cdedb02011-11-27 22:54:09 -0200904 .mhandler.cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300905 },
906
Blue Swirl23130862009-06-06 08:22:04 +0000907STEXI
908@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100909@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000910Cancel the current VM migration.
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300911
912ETEXI
913
914 {
915 .name = "migrate_set_cache_size",
916 .args_type = "value:o",
917 .params = "value",
918 .help = "set cache size (in bytes) for XBZRLE migrations,"
919 "the cache size will be rounded down to the nearest "
920 "power of 2.\n"
921 "The cache size affects the number of cache misses."
922 "In case of a high cache miss ratio you need to increase"
923 " the cache size",
924 .mhandler.cmd = hmp_migrate_set_cache_size,
925 },
926
927STEXI
928@item migrate_set_cache_size @var{value}
929@findex migrate_set_cache_size
930Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +0000931ETEXI
932
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300933 {
934 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200935 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300936 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200937 .help = "set maximum speed (in bytes) for migrations. "
938 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Luiz Capitulino3dc85382011-11-28 11:59:37 -0200939 .mhandler.cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300940 },
941
Blue Swirl23130862009-06-06 08:22:04 +0000942STEXI
943@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100944@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +0000945Set maximum speed to @var{value} (in bytes) for migrations.
946ETEXI
947
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300948 {
949 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +0100950 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300951 .params = "value",
952 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulino4f0a9932011-11-27 23:18:01 -0200953 .mhandler.cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300954 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400955
956STEXI
957@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100958@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -0400959Set maximum tolerated downtime (in seconds) for migration.
960ETEXI
961
Jes Sorensenf8882562010-12-16 13:52:16 +0100962 {
Orit Wasserman00458432012-08-06 21:42:48 +0300963 .name = "migrate_set_capability",
964 .args_type = "capability:s,state:b",
965 .params = "capability state",
966 .help = "Enable/Disable the usage of a capability for migration",
967 .mhandler.cmd = hmp_migrate_set_capability,
968 },
969
970STEXI
971@item migrate_set_capability @var{capability} @var{state}
972@findex migrate_set_capability
973Enable/Disable the usage of a capability @var{capability} for migration.
974ETEXI
975
976 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +0100977 .name = "client_migrate_info",
978 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
979 .params = "protocol hostname port tls-port cert-subject",
980 .help = "send migration info to spice/vnc client",
981 .user_print = monitor_user_noop,
Yonit Halperinedc5cb12011-10-17 10:03:18 +0200982 .mhandler.cmd_async = client_migrate_info,
983 .flags = MONITOR_CMD_ASYNC,
Jes Sorensenf8882562010-12-16 13:52:16 +0100984 },
985
986STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +0200987@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
988@findex client_migrate_info
989Set the spice/vnc connection info for the migration target. The spice/vnc
990server will ask the spice/vnc client to automatically reconnect using the
991new parameters (if specified) once the vm migration finished successfully.
992ETEXI
993
Wen Congyang783e9b42012-05-07 12:10:47 +0800994#if defined(CONFIG_HAVE_CORE_DUMP)
995 {
996 .name = "dump-guest-memory",
Luiz Capitulino75363762012-09-21 13:53:00 -0300997 .args_type = "paging:-p,filename:F,begin:i?,length:i?",
998 .params = "[-p] filename [begin] [length]",
Wen Congyang783e9b42012-05-07 12:10:47 +0800999 .help = "dump guest memory to file"
1000 "\n\t\t\t begin(optional): the starting physical address"
1001 "\n\t\t\t length(optional): the memory size, in bytes",
Wen Congyang783e9b42012-05-07 12:10:47 +08001002 .mhandler.cmd = hmp_dump_guest_memory,
1003 },
1004
1005
1006STEXI
1007@item dump-guest-memory [-p] @var{protocol} @var{begin} @var{length}
1008@findex dump-guest-memory
1009Dump guest memory to @var{protocol}. The file can be processed with crash or
1010gdb.
Luiz Capitulino75363762012-09-21 13:53:00 -03001011 filename: dump file name
Wen Congyang783e9b42012-05-07 12:10:47 +08001012 paging: do paging to get guest's memory mapping
1013 begin: the starting physical address. It's optional, and should be
1014 specified with length together.
1015 length: the memory size, in bytes. It's optional, and should be specified
1016 with begin together.
1017ETEXI
1018#endif
1019
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001020 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001021 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001022 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1023 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001024 .help = "initiates a live snapshot\n\t\t\t"
1025 "of device. If a new image file is specified, the\n\t\t\t"
1026 "new image file will become the new root image.\n\t\t\t"
1027 "If format is specified, the snapshot file will\n\t\t\t"
1028 "be created in that format. Otherwise the\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001029 "snapshot will be internal! (currently unsupported).\n\t\t\t"
1030 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1031 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1032 "recreating it from scratch.",
Luiz Capitulino6106e242011-11-25 16:15:19 -02001033 .mhandler.cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001034 },
1035
1036STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001037@item snapshot_blkdev
1038@findex snapshot_blkdev
1039Snapshot device, using snapshot file as target if provided
1040ETEXI
1041
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001042 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001043 .name = "drive_mirror",
1044 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1045 .params = "[-n] [-f] device target [format]",
1046 .help = "initiates live storage\n\t\t\t"
1047 "migration for a device. The device's contents are\n\t\t\t"
1048 "copied to the new image file, including data that\n\t\t\t"
1049 "is written after the command is started.\n\t\t\t"
1050 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1051 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1052 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1053 "so that the result does not need a backing file.\n\t\t\t",
1054 .mhandler.cmd = hmp_drive_mirror,
1055 },
1056STEXI
1057@item drive_mirror
1058@findex drive_mirror
1059Start mirroring a block device's writes to a new destination,
1060using the specified target.
1061ETEXI
1062
1063 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001064 .name = "drive_add",
1065 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001066 .params = "[[<domain>:]<bus>:]<slot>\n"
1067 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001068 "[,unit=m][,media=d][,index=i]\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001069 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001070 "[,snapshot=on|off][,cache=on|off]\n"
1071 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001072 .help = "add drive to PCI storage controller",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001073 .mhandler.cmd = drive_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001074 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001075
Blue Swirl23130862009-06-06 08:22:04 +00001076STEXI
1077@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001078@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001079Add drive to PCI storage controller.
1080ETEXI
1081
1082#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001083 {
1084 .name = "pci_add",
1085 .args_type = "pci_addr:s,type:s,opts:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001086 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
1087 .help = "hot-add PCI device",
Markus Armbruster6c6a58a2010-05-12 10:53:00 +02001088 .mhandler.cmd = pci_device_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001089 },
Blue Swirl23130862009-06-06 08:22:04 +00001090#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001091
Blue Swirl23130862009-06-06 08:22:04 +00001092STEXI
1093@item pci_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001094@findex pci_add
Blue Swirl23130862009-06-06 08:22:04 +00001095Hot-add PCI device.
1096ETEXI
1097
1098#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001099 {
1100 .name = "pci_del",
1101 .args_type = "pci_addr:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001102 .params = "[[<domain>:]<bus>:]<slot>",
1103 .help = "hot remove PCI device",
Markus Armbrusterb752daf2010-05-12 10:53:01 +02001104 .mhandler.cmd = do_pci_device_hot_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001105 },
Blue Swirl23130862009-06-06 08:22:04 +00001106#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001107
Blue Swirl23130862009-06-06 08:22:04 +00001108STEXI
1109@item pci_del
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001110@findex pci_del
Blue Swirl23130862009-06-06 08:22:04 +00001111Hot remove PCI device.
1112ETEXI
1113
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001114 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001115 .name = "pcie_aer_inject_error",
1116 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1117 "id:s,error_status:s,"
1118 "header0:i?,header1:i?,header2:i?,header3:i?,"
1119 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1120 .params = "[-a] [-c] id "
1121 "<error_status> [<tlp header> [<tlp header prefix>]]",
1122 .help = "inject pcie aer error\n\t\t\t"
1123 " -a for advisory non fatal error\n\t\t\t"
1124 " -c for correctable error\n\t\t\t"
1125 "<id> = qdev device id\n\t\t\t"
1126 "<error_status> = error string or 32bit\n\t\t\t"
1127 "<tlb header> = 32bit x 4\n\t\t\t"
1128 "<tlb header prefix> = 32bit x 4",
1129 .user_print = pcie_aer_inject_error_print,
Zhi Yong Wu1f3392b2011-11-30 12:39:47 +08001130 .mhandler.cmd_new = do_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001131 },
1132
1133STEXI
1134@item pcie_aer_inject_error
1135@findex pcie_aer_inject_error
1136Inject PCIe AER error
1137ETEXI
1138
1139 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001140 .name = "host_net_add",
1141 .args_type = "device:s,opts:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001142 .params = "tap|user|socket|vde|dump [options]",
1143 .help = "add host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001144 .mhandler.cmd = net_host_device_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001145 },
1146
Blue Swirl23130862009-06-06 08:22:04 +00001147STEXI
1148@item host_net_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001149@findex host_net_add
Blue Swirl23130862009-06-06 08:22:04 +00001150Add host VLAN client.
1151ETEXI
1152
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001153 {
1154 .name = "host_net_remove",
1155 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001156 .params = "vlan_id name",
1157 .help = "remove host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001158 .mhandler.cmd = net_host_device_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001159 },
1160
Blue Swirl23130862009-06-06 08:22:04 +00001161STEXI
1162@item host_net_remove
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001163@findex host_net_remove
Blue Swirl23130862009-06-06 08:22:04 +00001164Remove host VLAN client.
1165ETEXI
1166
Markus Armbrusterae82d322010-03-25 17:22:40 +01001167 {
1168 .name = "netdev_add",
1169 .args_type = "netdev:O",
Stefan Hajnoczi40e8c262013-02-26 11:07:16 +01001170 .params = "[user|tap|socket|hubport],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001171 .help = "add host network device",
Luiz Capitulino928059a2012-04-18 17:34:15 -03001172 .mhandler.cmd = hmp_netdev_add,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001173 },
1174
1175STEXI
1176@item netdev_add
1177@findex netdev_add
1178Add host network device.
1179ETEXI
1180
1181 {
1182 .name = "netdev_del",
1183 .args_type = "id:s",
1184 .params = "id",
1185 .help = "remove host network device",
Luiz Capitulino5f964152012-04-16 14:36:32 -03001186 .mhandler.cmd = hmp_netdev_del,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001187 },
1188
1189STEXI
1190@item netdev_del
1191@findex netdev_del
1192Remove host network device.
1193ETEXI
1194
Blue Swirl23130862009-06-06 08:22:04 +00001195#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001196 {
1197 .name = "hostfwd_add",
1198 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001199 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1200 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001201 .mhandler.cmd = net_slirp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001202 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001203#endif
1204STEXI
1205@item hostfwd_add
1206@findex hostfwd_add
1207Redirect TCP or UDP connections from host to guest (requires -net user).
1208ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001209
Markus Armbruster21413d62010-05-04 13:20:30 +02001210#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001211 {
1212 .name = "hostfwd_remove",
1213 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001214 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1215 .help = "remove host-to-guest TCP or UDP redirection",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001216 .mhandler.cmd = net_slirp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001217 },
1218
Blue Swirl23130862009-06-06 08:22:04 +00001219#endif
1220STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001221@item hostfwd_remove
1222@findex hostfwd_remove
1223Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001224ETEXI
1225
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001226 {
1227 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001228 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001229 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001230 .help = "request VM to change its memory allocation (in MB)",
Luiz Capitulinod72f3262011-11-25 14:38:09 -02001231 .mhandler.cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001232 },
1233
Blue Swirl23130862009-06-06 08:22:04 +00001234STEXI
1235@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001236@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001237Request VM to change its memory allocation to @var{value} (in MB).
1238ETEXI
1239
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001240 {
1241 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001242 .args_type = "name:s,up:b",
1243 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001244 .help = "change the link status of a network adapter",
Luiz Capitulino4b371562011-11-23 13:11:55 -02001245 .mhandler.cmd = hmp_set_link,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001246 },
1247
Blue Swirl23130862009-06-06 08:22:04 +00001248STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001249@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001250@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001251Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001252ETEXI
1253
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001254 {
1255 .name = "watchdog_action",
1256 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001257 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1258 .help = "change watchdog action",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001259 .mhandler.cmd = do_watchdog_action,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001260 },
1261
Blue Swirl23130862009-06-06 08:22:04 +00001262STEXI
1263@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001264@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001265Change watchdog action.
1266ETEXI
1267
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001268 {
1269 .name = "acl_show",
1270 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001271 .params = "aclname",
1272 .help = "list rules in the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001273 .mhandler.cmd = do_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001274 },
1275
Blue Swirl23130862009-06-06 08:22:04 +00001276STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001277@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001278@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001279List all the matching rules in the access control list, and the default
1280policy. There are currently two named access control lists,
1281@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1282certificate distinguished name, and SASL username respectively.
1283ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001284
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001285 {
1286 .name = "acl_policy",
1287 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001288 .params = "aclname allow|deny",
1289 .help = "set default access control list policy",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001290 .mhandler.cmd = do_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001291 },
1292
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001293STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001294@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001295@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001296Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001297none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001298always @code{deny}.
1299ETEXI
1300
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001301 {
1302 .name = "acl_add",
1303 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001304 .params = "aclname match allow|deny [index]",
1305 .help = "add a match rule to the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001306 .mhandler.cmd = do_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001307 },
1308
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001309STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001310@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1311@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001312Add a match rule to the access control list, allowing or denying access.
1313The match will normally be an exact username or x509 distinguished name,
1314but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1315allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001316normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001317earlier in the list if the optional @var{index} parameter is supplied.
1318ETEXI
1319
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001320 {
1321 .name = "acl_remove",
1322 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001323 .params = "aclname match",
1324 .help = "remove a match rule from the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001325 .mhandler.cmd = do_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001326 },
1327
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001328STEXI
1329@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001330@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001331Remove the specified match rule from the access control list.
1332ETEXI
1333
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001334 {
1335 .name = "acl_reset",
1336 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001337 .params = "aclname",
1338 .help = "reset the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001339 .mhandler.cmd = do_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001340 },
1341
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001342STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001343@item acl_reset @var{aclname}
1344@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001345Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001346policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001347ETEXI
1348
Paolo Bonzini40577252012-08-23 11:53:04 +02001349 {
1350 .name = "nbd_server_start",
1351 .args_type = "all:-a,writable:-w,uri:s",
1352 .params = "nbd_server_start [-a] [-w] host:port",
1353 .help = "serve block devices on the given host and port",
1354 .mhandler.cmd = hmp_nbd_server_start,
1355 },
1356STEXI
1357@item nbd_server_start @var{host}:@var{port}
1358@findex nbd_server_start
1359Start an NBD server on the given host and/or port. If the @option{-a}
1360option is included, all of the virtual machine's block devices that
1361have an inserted media on them are automatically exported; in this case,
1362the @option{-w} option makes the devices writable too.
1363ETEXI
1364
1365 {
1366 .name = "nbd_server_add",
1367 .args_type = "writable:-w,device:B",
1368 .params = "nbd_server_add [-w] device",
1369 .help = "export a block device via NBD",
1370 .mhandler.cmd = hmp_nbd_server_add,
1371 },
1372STEXI
1373@item nbd_server_add @var{device}
1374@findex nbd_server_add
1375Export a block device through QEMU's NBD server, which must be started
1376beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1377exported device writable too.
1378ETEXI
1379
1380 {
1381 .name = "nbd_server_stop",
1382 .args_type = "",
1383 .params = "nbd_server_stop",
1384 .help = "stop serving block devices using the NBD protocol",
1385 .mhandler.cmd = hmp_nbd_server_stop,
1386 },
1387STEXI
1388@item nbd_server_stop
1389@findex nbd_server_stop
1390Stop the QEMU embedded NBD server.
1391ETEXI
1392
1393
Huang Ying79c4f6b2009-06-23 10:05:14 +08001394#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001395
1396 {
1397 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001398 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1399 .params = "[-b] cpu bank status mcgstatus addr misc",
1400 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001401 .mhandler.cmd = do_inject_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001402 },
1403
Huang Ying79c4f6b2009-06-23 10:05:14 +08001404#endif
1405STEXI
1406@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001407@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001408Inject an MCE on the given CPU (x86 only).
1409ETEXI
1410
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001411 {
1412 .name = "getfd",
1413 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001414 .params = "getfd name",
1415 .help = "receive a file descriptor via SCM rights and assign it a name",
Corey Bryant208c9d12012-06-22 14:36:09 -04001416 .mhandler.cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001417 },
1418
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001419STEXI
1420@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001421@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001422If a file descriptor is passed alongside this command using the SCM_RIGHTS
1423mechanism on unix sockets, it is stored using the name @var{fdname} for
1424later use by other monitor commands.
1425ETEXI
1426
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001427 {
1428 .name = "closefd",
1429 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001430 .params = "closefd name",
1431 .help = "close a file descriptor previously passed via SCM rights",
Corey Bryant208c9d12012-06-22 14:36:09 -04001432 .mhandler.cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001433 },
1434
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001435STEXI
1436@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001437@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001438Close the file descriptor previously assigned to @var{fdname} using the
1439@code{getfd} command. This is only needed if the file descriptor was never
1440used by another monitor command.
1441ETEXI
1442
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001443 {
1444 .name = "block_passwd",
1445 .args_type = "device:B,password:s",
1446 .params = "block_passwd device password",
1447 .help = "set the password of encrypted block devices",
Luiz Capitulinoa4dea8a2011-11-23 13:28:21 -02001448 .mhandler.cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001449 },
1450
1451STEXI
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001452@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1453@findex block_set_io_throttle
1454Change 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}
1455ETEXI
1456
1457 {
1458 .name = "block_set_io_throttle",
1459 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1460 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1461 .help = "change I/O throttle limits for a block drive",
Luiz Capitulino80047da2011-12-14 16:49:14 -02001462 .mhandler.cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001463 },
1464
1465STEXI
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001466@item block_passwd @var{device} @var{password}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001467@findex block_passwd
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001468Set the encrypted device @var{device} password to @var{password}
1469ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001470
Jan Kiszka33572ec2010-05-31 14:43:30 -03001471 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001472 .name = "set_password",
1473 .args_type = "protocol:s,password:s,connected:s?",
1474 .params = "protocol password action-if-connected",
1475 .help = "set spice/vnc password",
Luiz Capitulinofbf796f2011-12-07 11:17:51 -02001476 .mhandler.cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001477 },
1478
1479STEXI
1480@item set_password [ vnc | spice ] password [ action-if-connected ]
1481@findex set_password
1482
1483Change spice/vnc password. Use zero to make the password stay valid
1484forever. @var{action-if-connected} specifies what should happen in
1485case a connection is established: @var{fail} makes the password change
1486fail. @var{disconnect} changes the password and disconnects the
1487client. @var{keep} changes the password and keeps the connection up.
1488@var{keep} is the default.
1489ETEXI
1490
1491 {
1492 .name = "expire_password",
1493 .args_type = "protocol:s,time:s",
1494 .params = "protocol time",
1495 .help = "set spice/vnc password expire-time",
Luiz Capitulino9ad53722011-12-07 11:47:57 -02001496 .mhandler.cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001497 },
1498
1499STEXI
1500@item expire_password [ vnc | spice ] expire-time
1501@findex expire_password
1502
1503Specify when a password for spice/vnc becomes
1504invalid. @var{expire-time} accepts:
1505
1506@table @var
1507@item now
1508Invalidate password instantly.
1509
1510@item never
1511Password stays valid forever.
1512
1513@item +nsec
1514Password stays valid for @var{nsec} seconds starting now.
1515
1516@item nsec
1517Password is invalidated at the given time. @var{nsec} are the seconds
1518passed since 1970, i.e. unix epoch.
1519
1520@end table
1521ETEXI
1522
Gerd Hoffmann46920822013-02-28 08:46:10 +01001523 {
1524 .name = "chardev-add",
1525 .args_type = "args:s",
1526 .params = "args",
1527 .help = "add chardev",
1528 .mhandler.cmd = hmp_chardev_add,
1529 },
1530
1531STEXI
1532@item chardev_add args
1533@findex chardev_add
1534
1535chardev_add accepts the same parameters as the -chardev command line switch.
1536
1537ETEXI
1538
1539 {
1540 .name = "chardev-remove",
1541 .args_type = "id:s",
1542 .params = "id",
1543 .help = "remove chardev",
1544 .mhandler.cmd = hmp_chardev_remove,
1545 },
1546
1547STEXI
1548@item chardev_remove id
1549@findex chardev_remove
1550
1551Removes the chardev @var{id}.
1552
1553ETEXI
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001554
1555 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001556 .name = "qemu-io",
1557 .args_type = "device:B,command:s",
1558 .params = "[device] \"[command]\"",
1559 .help = "run a qemu-io command on a block device",
1560 .mhandler.cmd = hmp_qemu_io,
1561 },
1562
1563STEXI
1564@item qemu-io @var{device} @var{command}
1565@findex qemu-io
1566
1567Executes a qemu-io command on the given block device.
1568
1569ETEXI
1570
1571 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001572 .name = "info",
1573 .args_type = "item:s?",
1574 .params = "[subcommand]",
1575 .help = "show various information about the system state",
Wenchao Xia84c44612013-01-14 14:06:29 +08001576 .mhandler.cmd = do_info_help,
1577 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001578 },
1579
1580STEXI
1581@item info @var{subcommand}
1582@findex info
1583Show various information about the system state.
1584
1585@table @option
1586@item info version
1587show the version of QEMU
Jan Kiszka33572ec2010-05-31 14:43:30 -03001588@item info network
1589show the various VLANs and the associated devices
1590@item info chardev
1591show the character devices
1592@item info block
1593show the block devices
1594@item info blockstats
1595show block device statistics
1596@item info registers
1597show the cpu registers
1598@item info cpus
1599show infos for each CPU
1600@item info history
1601show the command line history
1602@item info irq
1603show the interrupts statistics (if available)
1604@item info pic
1605show i8259 (PIC) state
1606@item info pci
1607show emulated PCI device info
1608@item info tlb
Max Filippov692f7372012-01-07 20:02:40 +04001609show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001610@item info mem
1611show the active virtual memory mappings (i386 only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001612@item info jit
1613show dynamic compiler info
Jan Kiszka33572ec2010-05-31 14:43:30 -03001614@item info numa
1615show NUMA information
Jan Kiszkab40292e2010-05-31 14:43:31 -03001616@item info kvm
1617show KVM information
Jan Kiszka33572ec2010-05-31 14:43:30 -03001618@item info usb
1619show USB devices plugged on the virtual USB hub
1620@item info usbhost
1621show all USB host devices
1622@item info profile
1623show profiling information
1624@item info capture
1625show information about active capturing
1626@item info snapshots
1627show list of VM snapshots
1628@item info status
1629show the current VM status (running|paused)
1630@item info pcmcia
1631show guest PCMCIA status
1632@item info mice
1633show which guest mouse is receiving events
1634@item info vnc
1635show the vnc server status
1636@item info name
1637show the current VM name
1638@item info uuid
1639show the current VM UUID
1640@item info cpustats
1641show CPU statistics
1642@item info usernet
1643show user network stack connection states
1644@item info migrate
1645show migration status
Orit Wassermanbbf6da32012-08-06 21:42:47 +03001646@item info migrate_capabilities
1647show current migration capabilities
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +03001648@item info migrate_cache_size
1649show current migration XBZRLE cache size
Jan Kiszka33572ec2010-05-31 14:43:30 -03001650@item info balloon
1651show balloon information
1652@item info qtree
1653show device tree
1654@item info qdm
1655show qdev device model list
1656@item info roms
1657show roms
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05001658@item info tpm
1659show the TPM device
Jan Kiszka33572ec2010-05-31 14:43:30 -03001660@end table
1661ETEXI
1662
LluĂ­s31965ae2011-08-31 20:31:24 +02001663STEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301664@item info trace-events
1665show available trace events and their state
1666ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301667
Blue Swirl23130862009-06-06 08:22:04 +00001668STEXI
1669@end table
1670ETEXI