blob: 9cea4151b9cdb929e4235a255948ff61698c965b [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.
188ETEXI
189
190 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300191 .name = "change",
192 .args_type = "device:B,target:F,arg:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300193 .params = "device filename [format]",
194 .help = "change a removable medium, optional format",
Luiz Capitulino333a96e2011-12-08 11:13:50 -0200195 .mhandler.cmd = hmp_change,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300196 },
197
Blue Swirl23130862009-06-06 08:22:04 +0000198STEXI
199@item change @var{device} @var{setting}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100200@findex change
Blue Swirl23130862009-06-06 08:22:04 +0000201
202Change the configuration of a device.
203
204@table @option
205@item change @var{diskdevice} @var{filename} [@var{format}]
206Change the medium for a removable disk device to point to @var{filename}. eg
207
208@example
209(qemu) change ide1-cd0 /path/to/some.iso
210@end example
211
212@var{format} is optional.
213
214@item change vnc @var{display},@var{options}
215Change the configuration of the VNC server. The valid syntax for @var{display}
216and @var{options} are described at @ref{sec_invocation}. eg
217
218@example
219(qemu) change vnc localhost:1
220@end example
221
222@item change vnc password [@var{password}]
223
224Change the password associated with the VNC server. If the new password is not
225supplied, the monitor will prompt for it to be entered. VNC passwords are only
226significant up to 8 letters. eg
227
228@example
229(qemu) change vnc password
230Password: ********
231@end example
232
233@end table
234ETEXI
235
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300236 {
237 .name = "screendump",
238 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300239 .params = "filename",
240 .help = "save screen into PPM image 'filename'",
Luiz Capitulinoad39cf62012-05-24 13:48:23 -0300241 .mhandler.cmd = hmp_screen_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300242 },
243
Blue Swirl23130862009-06-06 08:22:04 +0000244STEXI
245@item screendump @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100246@findex screendump
Blue Swirl23130862009-06-06 08:22:04 +0000247Save screen into PPM image @var{filename}.
248ETEXI
249
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300250 {
251 .name = "logfile",
252 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300253 .params = "filename",
254 .help = "output logs to 'filename'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300255 .mhandler.cmd = do_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300256 },
257
Blue Swirl23130862009-06-06 08:22:04 +0000258STEXI
259@item logfile @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100260@findex logfile
Blue Swirl23130862009-06-06 08:22:04 +0000261Output logs to @var{filename}.
262ETEXI
263
Prerna Saxena22890ab2010-06-24 17:04:53 +0530264 {
265 .name = "trace-event",
266 .args_type = "name:s,option:b",
267 .params = "name on|off",
268 .help = "changes status of a specific trace event",
LluĂ­sfc764102011-08-31 20:31:18 +0200269 .mhandler.cmd = do_trace_event_set_state,
Prerna Saxena22890ab2010-06-24 17:04:53 +0530270 },
271
272STEXI
273@item trace-event
274@findex trace-event
275changes status of a trace event
276ETEXI
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100277
Michael Rothc45a8162011-10-02 08:44:37 -0500278#if defined(CONFIG_TRACE_SIMPLE)
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100279 {
280 .name = "trace-file",
281 .args_type = "op:s?,arg:F?",
282 .params = "on|off|flush|set [arg]",
283 .help = "open, close, or flush trace file, or set a new file name",
284 .mhandler.cmd = do_trace_file,
285 },
286
287STEXI
288@item trace-file on|off|flush
289@findex trace-file
290Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
291ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +0530292#endif
293
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300294 {
295 .name = "log",
296 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300297 .params = "item1[,...]",
Peter Maydell989b6972013-02-26 17:52:40 +0000298 .help = "activate logging of the specified items",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300299 .mhandler.cmd = do_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300300 },
301
Blue Swirl23130862009-06-06 08:22:04 +0000302STEXI
303@item log @var{item1}[,...]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100304@findex log
Peter Maydell989b6972013-02-26 17:52:40 +0000305Activate logging of the specified items.
Blue Swirl23130862009-06-06 08:22:04 +0000306ETEXI
307
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300308 {
309 .name = "savevm",
310 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300311 .params = "[tag|id]",
312 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300313 .mhandler.cmd = do_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300314 },
315
Blue Swirl23130862009-06-06 08:22:04 +0000316STEXI
317@item savevm [@var{tag}|@var{id}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100318@findex savevm
Blue Swirl23130862009-06-06 08:22:04 +0000319Create a snapshot of the whole virtual machine. If @var{tag} is
320provided, it is used as human readable identifier. If there is already
321a snapshot with the same tag or ID, it is replaced. More info at
322@ref{vm_snapshots}.
323ETEXI
324
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300325 {
326 .name = "loadvm",
327 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300328 .params = "tag|id",
329 .help = "restore a VM snapshot from its tag or id",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300330 .mhandler.cmd = do_loadvm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300331 },
332
Blue Swirl23130862009-06-06 08:22:04 +0000333STEXI
334@item loadvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100335@findex loadvm
Blue Swirl23130862009-06-06 08:22:04 +0000336Set the whole virtual machine to the snapshot identified by the tag
337@var{tag} or the unique snapshot ID @var{id}.
338ETEXI
339
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300340 {
341 .name = "delvm",
342 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300343 .params = "tag|id",
344 .help = "delete a VM snapshot from its tag or id",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300345 .mhandler.cmd = do_delvm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300346 },
347
Blue Swirl23130862009-06-06 08:22:04 +0000348STEXI
349@item delvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100350@findex delvm
Blue Swirl23130862009-06-06 08:22:04 +0000351Delete the snapshot identified by @var{tag} or @var{id}.
352ETEXI
353
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300354 {
355 .name = "singlestep",
356 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300357 .params = "[on|off]",
358 .help = "run emulation in singlestep mode or switch to normal mode",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300359 .mhandler.cmd = do_singlestep,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300360 },
361
Blue Swirl23130862009-06-06 08:22:04 +0000362STEXI
363@item singlestep [off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100364@findex singlestep
Blue Swirl23130862009-06-06 08:22:04 +0000365Run the emulation in single step mode.
366If called with option off, the emulation returns to normal mode.
367ETEXI
368
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300369 {
370 .name = "stop",
371 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300372 .params = "",
373 .help = "stop emulation",
Luiz Capitulino5f158f22011-09-15 14:34:39 -0300374 .mhandler.cmd = hmp_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300375 },
376
Blue Swirl23130862009-06-06 08:22:04 +0000377STEXI
378@item stop
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100379@findex stop
Blue Swirl23130862009-06-06 08:22:04 +0000380Stop emulation.
381ETEXI
382
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300383 {
384 .name = "c|cont",
385 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300386 .params = "",
387 .help = "resume emulation",
Luiz Capitulinoe42e8182011-11-22 17:58:31 -0200388 .mhandler.cmd = hmp_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300389 },
390
Blue Swirl23130862009-06-06 08:22:04 +0000391STEXI
392@item c or cont
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100393@findex cont
Blue Swirl23130862009-06-06 08:22:04 +0000394Resume emulation.
395ETEXI
396
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300397 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100398 .name = "system_wakeup",
399 .args_type = "",
400 .params = "",
401 .help = "wakeup guest from suspend",
402 .mhandler.cmd = hmp_system_wakeup,
403 },
404
405STEXI
406@item system_wakeup
407@findex system_wakeup
408Wakeup guest from suspend.
409ETEXI
410
411 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300412 .name = "gdbserver",
413 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300414 .params = "[device]",
415 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300416 .mhandler.cmd = do_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300417 },
418
Blue Swirl23130862009-06-06 08:22:04 +0000419STEXI
420@item gdbserver [@var{port}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100421@findex gdbserver
Blue Swirl23130862009-06-06 08:22:04 +0000422Start gdbserver session (default @var{port}=1234)
423ETEXI
424
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300425 {
426 .name = "x",
427 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300428 .params = "/fmt addr",
429 .help = "virtual memory dump starting at 'addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300430 .mhandler.cmd = do_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300431 },
432
Blue Swirl23130862009-06-06 08:22:04 +0000433STEXI
434@item x/fmt @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100435@findex x
Blue Swirl23130862009-06-06 08:22:04 +0000436Virtual memory dump starting at @var{addr}.
437ETEXI
438
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300439 {
440 .name = "xp",
441 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300442 .params = "/fmt addr",
443 .help = "physical memory dump starting at 'addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300444 .mhandler.cmd = do_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300445 },
446
Blue Swirl23130862009-06-06 08:22:04 +0000447STEXI
448@item xp /@var{fmt} @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100449@findex xp
Blue Swirl23130862009-06-06 08:22:04 +0000450Physical memory dump starting at @var{addr}.
451
452@var{fmt} is a format which tells the command how to format the
453data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
454
455@table @var
456@item count
457is the number of items to be dumped.
458
459@item format
460can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
461c (char) or i (asm instruction).
462
463@item size
464can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
465@code{h} or @code{w} can be specified with the @code{i} format to
466respectively select 16 or 32 bit code instruction size.
467
468@end table
469
470Examples:
471@itemize
472@item
473Dump 10 instructions at the current instruction pointer:
474@example
475(qemu) x/10i $eip
4760x90107063: ret
4770x90107064: sti
4780x90107065: lea 0x0(%esi,1),%esi
4790x90107069: lea 0x0(%edi,1),%edi
4800x90107070: ret
4810x90107071: jmp 0x90107080
4820x90107073: nop
4830x90107074: nop
4840x90107075: nop
4850x90107076: nop
486@end example
487
488@item
489Dump 80 16 bit values at the start of the video memory.
490@smallexample
491(qemu) xp/80hx 0xb8000
4920x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
4930x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
4940x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
4950x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
4960x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
4970x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
4980x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
4990x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5000x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5010x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
502@end smallexample
503@end itemize
504ETEXI
505
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300506 {
507 .name = "p|print",
508 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300509 .params = "/fmt expr",
510 .help = "print expression value (use $reg for CPU register access)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300511 .mhandler.cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300512 },
513
Blue Swirl23130862009-06-06 08:22:04 +0000514STEXI
515@item p or print/@var{fmt} @var{expr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100516@findex print
Blue Swirl23130862009-06-06 08:22:04 +0000517
518Print expression value. Only the @var{format} part of @var{fmt} is
519used.
520ETEXI
521
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300522 {
523 .name = "i",
524 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300525 .params = "/fmt addr",
526 .help = "I/O port read",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300527 .mhandler.cmd = do_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300528 },
529
Blue Swirl23130862009-06-06 08:22:04 +0000530STEXI
531Read I/O port.
532ETEXI
533
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300534 {
535 .name = "o",
536 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300537 .params = "/fmt addr value",
538 .help = "I/O port write",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300539 .mhandler.cmd = do_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300540 },
541
Jan Kiszkaf1147842009-07-14 10:20:11 +0200542STEXI
543Write to I/O port.
544ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000545
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300546 {
547 .name = "sendkey",
Amos Kong2ef20c12012-08-31 10:56:22 +0800548 .args_type = "keys:s,hold-time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300549 .params = "keys [hold_ms]",
550 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Amos Konge4c8f002012-08-31 10:56:26 +0800551 .mhandler.cmd = hmp_send_key,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300552 },
553
Blue Swirl23130862009-06-06 08:22:04 +0000554STEXI
555@item sendkey @var{keys}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100556@findex sendkey
Blue Swirl23130862009-06-06 08:22:04 +0000557
Amos Kong886cc702012-08-31 10:56:20 +0800558Send @var{keys} to the guest. @var{keys} could be the name of the
559key or the raw value in hexadecimal format. Use @code{-} to press
560several keys simultaneously. Example:
Blue Swirl23130862009-06-06 08:22:04 +0000561@example
562sendkey ctrl-alt-f1
563@end example
564
565This command is useful to send keys that your graphical user interface
566intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
567ETEXI
568
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300569 {
570 .name = "system_reset",
571 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300572 .params = "",
573 .help = "reset the system",
Luiz Capitulino38d22652011-09-15 14:41:46 -0300574 .mhandler.cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300575 },
576
Blue Swirl23130862009-06-06 08:22:04 +0000577STEXI
578@item system_reset
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100579@findex system_reset
Blue Swirl23130862009-06-06 08:22:04 +0000580
581Reset the system.
582ETEXI
583
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300584 {
585 .name = "system_powerdown",
586 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300587 .params = "",
588 .help = "send system power down event",
Luiz Capitulino5bc465e2011-09-28 11:06:15 -0300589 .mhandler.cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300590 },
591
Blue Swirl23130862009-06-06 08:22:04 +0000592STEXI
593@item system_powerdown
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100594@findex system_powerdown
Blue Swirl23130862009-06-06 08:22:04 +0000595
596Power down the system (if supported).
597ETEXI
598
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300599 {
600 .name = "sum",
601 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300602 .params = "addr size",
603 .help = "compute the checksum of a memory region",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300604 .mhandler.cmd = do_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300605 },
606
Blue Swirl23130862009-06-06 08:22:04 +0000607STEXI
608@item sum @var{addr} @var{size}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100609@findex sum
Blue Swirl23130862009-06-06 08:22:04 +0000610
611Compute the checksum of a memory region.
612ETEXI
613
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300614 {
615 .name = "usb_add",
616 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300617 .params = "device",
618 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300619 .mhandler.cmd = do_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300620 },
621
Blue Swirl23130862009-06-06 08:22:04 +0000622STEXI
623@item usb_add @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100624@findex usb_add
Blue Swirl23130862009-06-06 08:22:04 +0000625
626Add the USB device @var{devname}. For details of available devices see
627@ref{usb_devices}
628ETEXI
629
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300630 {
631 .name = "usb_del",
632 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300633 .params = "device",
634 .help = "remove USB device 'bus.addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300635 .mhandler.cmd = do_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300636 },
637
Blue Swirl23130862009-06-06 08:22:04 +0000638STEXI
639@item usb_del @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100640@findex usb_del
Blue Swirl23130862009-06-06 08:22:04 +0000641
642Remove the USB device @var{devname} from the QEMU virtual USB
643hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
644command @code{info usb} to see the devices you can remove.
645ETEXI
646
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300647 {
648 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100649 .args_type = "device:O",
650 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300651 .help = "add device, like -device on the command line",
Markus Armbruster8bc27242010-02-10 20:52:01 +0100652 .user_print = monitor_user_noop,
653 .mhandler.cmd_new = do_device_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300654 },
655
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200656STEXI
657@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100658@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200659
660Add device.
661ETEXI
662
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300663 {
664 .name = "device_del",
665 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300666 .params = "device",
667 .help = "remove device",
Luiz Capitulinoa15fef22012-03-29 12:38:50 -0300668 .mhandler.cmd = hmp_device_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300669 },
670
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200671STEXI
672@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100673@findex device_del
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200674
675Remove device @var{id}.
676ETEXI
677
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300678 {
679 .name = "cpu",
680 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300681 .params = "index",
682 .help = "set the default CPU",
Luiz Capitulino755f1962011-10-06 14:31:39 -0300683 .mhandler.cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300684 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200685
Blue Swirl23130862009-06-06 08:22:04 +0000686STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200687@item cpu @var{index}
688@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000689Set the default CPU.
690ETEXI
691
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300692 {
693 .name = "mouse_move",
694 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300695 .params = "dx dy [dz]",
696 .help = "send mouse move events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300697 .mhandler.cmd = do_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300698 },
699
Blue Swirl23130862009-06-06 08:22:04 +0000700STEXI
701@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100702@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000703Move the active mouse to the specified coordinates @var{dx} @var{dy}
704with optional scroll axis @var{dz}.
705ETEXI
706
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300707 {
708 .name = "mouse_button",
709 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300710 .params = "state",
711 .help = "change mouse button state (1=L, 2=M, 4=R)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300712 .mhandler.cmd = do_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300713 },
714
Blue Swirl23130862009-06-06 08:22:04 +0000715STEXI
716@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100717@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000718Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
719ETEXI
720
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300721 {
722 .name = "mouse_set",
723 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300724 .params = "index",
725 .help = "set which mouse device receives events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300726 .mhandler.cmd = do_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300727 },
728
Blue Swirl23130862009-06-06 08:22:04 +0000729STEXI
730@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100731@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000732Set which mouse device receives events at given @var{index}, index
733can be obtained with
734@example
735info mice
736@end example
737ETEXI
738
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300739 {
740 .name = "wavcapture",
741 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300742 .params = "path [frequency [bits [channels]]]",
743 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300744 .mhandler.cmd = do_wav_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300745 },
Blue Swirl23130862009-06-06 08:22:04 +0000746STEXI
747@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100748@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000749Capture audio into @var{filename}. Using sample rate @var{frequency}
750bits per sample @var{bits} and number of channels @var{channels}.
751
752Defaults:
753@itemize @minus
754@item Sample rate = 44100 Hz - CD quality
755@item Bits = 16
756@item Number of channels = 2 - Stereo
757@end itemize
758ETEXI
759
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300760 {
761 .name = "stopcapture",
762 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300763 .params = "capture index",
764 .help = "stop capture",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300765 .mhandler.cmd = do_stop_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300766 },
Blue Swirl23130862009-06-06 08:22:04 +0000767STEXI
768@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100769@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000770Stop capture with a given @var{index}, index can be obtained with
771@example
772info capture
773@end example
774ETEXI
775
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300776 {
777 .name = "memsave",
778 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300779 .params = "addr size file",
780 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulino0cfd6a92011-11-22 16:32:37 -0200781 .mhandler.cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300782 },
783
Blue Swirl23130862009-06-06 08:22:04 +0000784STEXI
785@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100786@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000787save to disk virtual memory dump starting at @var{addr} of size @var{size}.
788ETEXI
789
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300790 {
791 .name = "pmemsave",
792 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300793 .params = "addr size file",
794 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulino6d3962b2011-11-22 17:26:46 -0200795 .mhandler.cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300796 },
797
Blue Swirl23130862009-06-06 08:22:04 +0000798STEXI
799@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100800@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000801save to disk physical memory dump starting at @var{addr} of size @var{size}.
802ETEXI
803
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300804 {
805 .name = "boot_set",
806 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300807 .params = "bootdevice",
808 .help = "define new values for the boot device list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300809 .mhandler.cmd = do_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300810 },
811
Blue Swirl23130862009-06-06 08:22:04 +0000812STEXI
813@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100814@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000815
816Define new values for the boot device list. Those values will override
817the values specified on the command line through the @code{-boot} option.
818
819The values that can be specified here depend on the machine type, but are
820the same that can be specified in the @code{-boot} command line option.
821ETEXI
822
823#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300824 {
825 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300826 .args_type = "",
827 .params = "",
828 .help = "inject an NMI on all guest's CPUs",
Luiz Capitulinoab49ab52011-11-23 12:55:53 -0200829 .mhandler.cmd = hmp_inject_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300830 },
Blue Swirl23130862009-06-06 08:22:04 +0000831#endif
832STEXI
833@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100834@findex nmi
Blue Swirl23130862009-06-06 08:22:04 +0000835Inject an NMI on the given CPU (x86 only).
Lei Li1f590cf2013-01-25 00:03:20 +0800836
837ETEXI
838
839 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100840 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800841 .args_type = "device:s,data:s",
842 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100843 .help = "Write to a ring buffer character device",
844 .mhandler.cmd = hmp_ringbuf_write,
Lei Li1f590cf2013-01-25 00:03:20 +0800845 },
846
847STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100848@item ringbuf_write @var{device} @var{data}
849@findex ringbuf_write
850Write @var{data} to ring buffer character device @var{device}.
851@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800852
Blue Swirl23130862009-06-06 08:22:04 +0000853ETEXI
854
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300855 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100856 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800857 .args_type = "device:s,size:i",
858 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100859 .help = "Read from a ring buffer character device",
860 .mhandler.cmd = hmp_ringbuf_read,
Lei Li49b6d722013-01-25 00:03:21 +0800861 },
862
863STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100864@item ringbuf_read @var{device}
865@findex ringbuf_read
866Read and print up to @var{size} bytes from ring buffer character
867device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100868Certain non-printable characters are printed \uXXXX, where XXXX is the
869character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100870Bug: can screw up when the buffer contains invalid UTF-8 sequences,
871NUL characters, after the ring buffer lost data, and when reading
872stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800873
874ETEXI
875
876 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300877 .name = "migrate",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200878 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
879 .params = "[-d] [-b] [-i] uri",
880 .help = "migrate to URI (using -d to not wait for completion)"
881 "\n\t\t\t -b for migration without shared storage with"
882 " full copy of disk\n\t\t\t -i for migration without "
883 "shared storage with incremental copy of disk "
884 "(base image shared between src and destination)",
Luiz Capitulinoe1c37d02011-12-05 14:48:01 -0200885 .mhandler.cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300886 },
887
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200888
Blue Swirl23130862009-06-06 08:22:04 +0000889STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200890@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100891@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000892Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200893 -b for migration with full copy of disk
894 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000895ETEXI
896
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300897 {
898 .name = "migrate_cancel",
899 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300900 .params = "",
901 .help = "cancel the current VM migration",
Luiz Capitulino6cdedb02011-11-27 22:54:09 -0200902 .mhandler.cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300903 },
904
Blue Swirl23130862009-06-06 08:22:04 +0000905STEXI
906@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100907@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000908Cancel the current VM migration.
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300909
910ETEXI
911
912 {
913 .name = "migrate_set_cache_size",
914 .args_type = "value:o",
915 .params = "value",
916 .help = "set cache size (in bytes) for XBZRLE migrations,"
917 "the cache size will be rounded down to the nearest "
918 "power of 2.\n"
919 "The cache size affects the number of cache misses."
920 "In case of a high cache miss ratio you need to increase"
921 " the cache size",
922 .mhandler.cmd = hmp_migrate_set_cache_size,
923 },
924
925STEXI
926@item migrate_set_cache_size @var{value}
927@findex migrate_set_cache_size
928Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +0000929ETEXI
930
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300931 {
932 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200933 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300934 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200935 .help = "set maximum speed (in bytes) for migrations. "
936 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Luiz Capitulino3dc85382011-11-28 11:59:37 -0200937 .mhandler.cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300938 },
939
Blue Swirl23130862009-06-06 08:22:04 +0000940STEXI
941@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100942@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +0000943Set maximum speed to @var{value} (in bytes) for migrations.
944ETEXI
945
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300946 {
947 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +0100948 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300949 .params = "value",
950 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulino4f0a9932011-11-27 23:18:01 -0200951 .mhandler.cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300952 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400953
954STEXI
955@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100956@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -0400957Set maximum tolerated downtime (in seconds) for migration.
958ETEXI
959
Jes Sorensenf8882562010-12-16 13:52:16 +0100960 {
Orit Wasserman00458432012-08-06 21:42:48 +0300961 .name = "migrate_set_capability",
962 .args_type = "capability:s,state:b",
963 .params = "capability state",
964 .help = "Enable/Disable the usage of a capability for migration",
965 .mhandler.cmd = hmp_migrate_set_capability,
966 },
967
968STEXI
969@item migrate_set_capability @var{capability} @var{state}
970@findex migrate_set_capability
971Enable/Disable the usage of a capability @var{capability} for migration.
972ETEXI
973
974 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +0100975 .name = "client_migrate_info",
976 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
977 .params = "protocol hostname port tls-port cert-subject",
978 .help = "send migration info to spice/vnc client",
979 .user_print = monitor_user_noop,
Yonit Halperinedc5cb12011-10-17 10:03:18 +0200980 .mhandler.cmd_async = client_migrate_info,
981 .flags = MONITOR_CMD_ASYNC,
Jes Sorensenf8882562010-12-16 13:52:16 +0100982 },
983
984STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +0200985@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
986@findex client_migrate_info
987Set the spice/vnc connection info for the migration target. The spice/vnc
988server will ask the spice/vnc client to automatically reconnect using the
989new parameters (if specified) once the vm migration finished successfully.
990ETEXI
991
Wen Congyang783e9b42012-05-07 12:10:47 +0800992#if defined(CONFIG_HAVE_CORE_DUMP)
993 {
994 .name = "dump-guest-memory",
Luiz Capitulino75363762012-09-21 13:53:00 -0300995 .args_type = "paging:-p,filename:F,begin:i?,length:i?",
996 .params = "[-p] filename [begin] [length]",
Wen Congyang783e9b42012-05-07 12:10:47 +0800997 .help = "dump guest memory to file"
998 "\n\t\t\t begin(optional): the starting physical address"
999 "\n\t\t\t length(optional): the memory size, in bytes",
Wen Congyang783e9b42012-05-07 12:10:47 +08001000 .mhandler.cmd = hmp_dump_guest_memory,
1001 },
1002
1003
1004STEXI
1005@item dump-guest-memory [-p] @var{protocol} @var{begin} @var{length}
1006@findex dump-guest-memory
1007Dump guest memory to @var{protocol}. The file can be processed with crash or
1008gdb.
Luiz Capitulino75363762012-09-21 13:53:00 -03001009 filename: dump file name
Wen Congyang783e9b42012-05-07 12:10:47 +08001010 paging: do paging to get guest's memory mapping
1011 begin: the starting physical address. It's optional, and should be
1012 specified with length together.
1013 length: the memory size, in bytes. It's optional, and should be specified
1014 with begin together.
1015ETEXI
1016#endif
1017
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001018 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001019 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001020 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1021 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001022 .help = "initiates a live snapshot\n\t\t\t"
1023 "of device. If a new image file is specified, the\n\t\t\t"
1024 "new image file will become the new root image.\n\t\t\t"
1025 "If format is specified, the snapshot file will\n\t\t\t"
1026 "be created in that format. Otherwise the\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001027 "snapshot will be internal! (currently unsupported).\n\t\t\t"
1028 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1029 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1030 "recreating it from scratch.",
Luiz Capitulino6106e242011-11-25 16:15:19 -02001031 .mhandler.cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001032 },
1033
1034STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001035@item snapshot_blkdev
1036@findex snapshot_blkdev
1037Snapshot device, using snapshot file as target if provided
1038ETEXI
1039
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001040 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001041 .name = "drive_mirror",
1042 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1043 .params = "[-n] [-f] device target [format]",
1044 .help = "initiates live storage\n\t\t\t"
1045 "migration for a device. The device's contents are\n\t\t\t"
1046 "copied to the new image file, including data that\n\t\t\t"
1047 "is written after the command is started.\n\t\t\t"
1048 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1049 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1050 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1051 "so that the result does not need a backing file.\n\t\t\t",
1052 .mhandler.cmd = hmp_drive_mirror,
1053 },
1054STEXI
1055@item drive_mirror
1056@findex drive_mirror
1057Start mirroring a block device's writes to a new destination,
1058using the specified target.
1059ETEXI
1060
1061 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001062 .name = "drive_add",
1063 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001064 .params = "[[<domain>:]<bus>:]<slot>\n"
1065 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001066 "[,unit=m][,media=d][,index=i]\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001067 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001068 "[,snapshot=on|off][,cache=on|off]\n"
1069 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001070 .help = "add drive to PCI storage controller",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001071 .mhandler.cmd = drive_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001072 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001073
Blue Swirl23130862009-06-06 08:22:04 +00001074STEXI
1075@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001076@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001077Add drive to PCI storage controller.
1078ETEXI
1079
1080#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001081 {
1082 .name = "pci_add",
1083 .args_type = "pci_addr:s,type:s,opts:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001084 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
1085 .help = "hot-add PCI device",
Markus Armbruster6c6a58a2010-05-12 10:53:00 +02001086 .mhandler.cmd = pci_device_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001087 },
Blue Swirl23130862009-06-06 08:22:04 +00001088#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001089
Blue Swirl23130862009-06-06 08:22:04 +00001090STEXI
1091@item pci_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001092@findex pci_add
Blue Swirl23130862009-06-06 08:22:04 +00001093Hot-add PCI device.
1094ETEXI
1095
1096#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001097 {
1098 .name = "pci_del",
1099 .args_type = "pci_addr:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001100 .params = "[[<domain>:]<bus>:]<slot>",
1101 .help = "hot remove PCI device",
Markus Armbrusterb752daf2010-05-12 10:53:01 +02001102 .mhandler.cmd = do_pci_device_hot_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001103 },
Blue Swirl23130862009-06-06 08:22:04 +00001104#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001105
Blue Swirl23130862009-06-06 08:22:04 +00001106STEXI
1107@item pci_del
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001108@findex pci_del
Blue Swirl23130862009-06-06 08:22:04 +00001109Hot remove PCI device.
1110ETEXI
1111
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001112 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001113 .name = "pcie_aer_inject_error",
1114 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1115 "id:s,error_status:s,"
1116 "header0:i?,header1:i?,header2:i?,header3:i?,"
1117 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1118 .params = "[-a] [-c] id "
1119 "<error_status> [<tlp header> [<tlp header prefix>]]",
1120 .help = "inject pcie aer error\n\t\t\t"
1121 " -a for advisory non fatal error\n\t\t\t"
1122 " -c for correctable error\n\t\t\t"
1123 "<id> = qdev device id\n\t\t\t"
1124 "<error_status> = error string or 32bit\n\t\t\t"
1125 "<tlb header> = 32bit x 4\n\t\t\t"
1126 "<tlb header prefix> = 32bit x 4",
1127 .user_print = pcie_aer_inject_error_print,
Zhi Yong Wu1f3392b2011-11-30 12:39:47 +08001128 .mhandler.cmd_new = do_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001129 },
1130
1131STEXI
1132@item pcie_aer_inject_error
1133@findex pcie_aer_inject_error
1134Inject PCIe AER error
1135ETEXI
1136
1137 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001138 .name = "host_net_add",
1139 .args_type = "device:s,opts:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001140 .params = "tap|user|socket|vde|dump [options]",
1141 .help = "add host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001142 .mhandler.cmd = net_host_device_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001143 },
1144
Blue Swirl23130862009-06-06 08:22:04 +00001145STEXI
1146@item host_net_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001147@findex host_net_add
Blue Swirl23130862009-06-06 08:22:04 +00001148Add host VLAN client.
1149ETEXI
1150
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001151 {
1152 .name = "host_net_remove",
1153 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001154 .params = "vlan_id name",
1155 .help = "remove host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001156 .mhandler.cmd = net_host_device_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001157 },
1158
Blue Swirl23130862009-06-06 08:22:04 +00001159STEXI
1160@item host_net_remove
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001161@findex host_net_remove
Blue Swirl23130862009-06-06 08:22:04 +00001162Remove host VLAN client.
1163ETEXI
1164
Markus Armbrusterae82d322010-03-25 17:22:40 +01001165 {
1166 .name = "netdev_add",
1167 .args_type = "netdev:O",
Stefan Hajnoczi40e8c262013-02-26 11:07:16 +01001168 .params = "[user|tap|socket|hubport],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001169 .help = "add host network device",
Luiz Capitulino928059a2012-04-18 17:34:15 -03001170 .mhandler.cmd = hmp_netdev_add,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001171 },
1172
1173STEXI
1174@item netdev_add
1175@findex netdev_add
1176Add host network device.
1177ETEXI
1178
1179 {
1180 .name = "netdev_del",
1181 .args_type = "id:s",
1182 .params = "id",
1183 .help = "remove host network device",
Luiz Capitulino5f964152012-04-16 14:36:32 -03001184 .mhandler.cmd = hmp_netdev_del,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001185 },
1186
1187STEXI
1188@item netdev_del
1189@findex netdev_del
1190Remove host network device.
1191ETEXI
1192
Blue Swirl23130862009-06-06 08:22:04 +00001193#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001194 {
1195 .name = "hostfwd_add",
1196 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001197 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1198 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001199 .mhandler.cmd = net_slirp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001200 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001201#endif
1202STEXI
1203@item hostfwd_add
1204@findex hostfwd_add
1205Redirect TCP or UDP connections from host to guest (requires -net user).
1206ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001207
Markus Armbruster21413d62010-05-04 13:20:30 +02001208#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001209 {
1210 .name = "hostfwd_remove",
1211 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001212 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1213 .help = "remove host-to-guest TCP or UDP redirection",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001214 .mhandler.cmd = net_slirp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001215 },
1216
Blue Swirl23130862009-06-06 08:22:04 +00001217#endif
1218STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001219@item hostfwd_remove
1220@findex hostfwd_remove
1221Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001222ETEXI
1223
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001224 {
1225 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001226 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001227 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001228 .help = "request VM to change its memory allocation (in MB)",
Luiz Capitulinod72f3262011-11-25 14:38:09 -02001229 .mhandler.cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001230 },
1231
Blue Swirl23130862009-06-06 08:22:04 +00001232STEXI
1233@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001234@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001235Request VM to change its memory allocation to @var{value} (in MB).
1236ETEXI
1237
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001238 {
1239 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001240 .args_type = "name:s,up:b",
1241 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001242 .help = "change the link status of a network adapter",
Luiz Capitulino4b371562011-11-23 13:11:55 -02001243 .mhandler.cmd = hmp_set_link,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001244 },
1245
Blue Swirl23130862009-06-06 08:22:04 +00001246STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001247@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001248@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001249Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001250ETEXI
1251
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001252 {
1253 .name = "watchdog_action",
1254 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001255 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1256 .help = "change watchdog action",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001257 .mhandler.cmd = do_watchdog_action,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001258 },
1259
Blue Swirl23130862009-06-06 08:22:04 +00001260STEXI
1261@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001262@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001263Change watchdog action.
1264ETEXI
1265
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001266 {
1267 .name = "acl_show",
1268 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001269 .params = "aclname",
1270 .help = "list rules in the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001271 .mhandler.cmd = do_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001272 },
1273
Blue Swirl23130862009-06-06 08:22:04 +00001274STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001275@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001276@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001277List all the matching rules in the access control list, and the default
1278policy. There are currently two named access control lists,
1279@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1280certificate distinguished name, and SASL username respectively.
1281ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001282
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001283 {
1284 .name = "acl_policy",
1285 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001286 .params = "aclname allow|deny",
1287 .help = "set default access control list policy",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001288 .mhandler.cmd = do_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001289 },
1290
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001291STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001292@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001293@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001294Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001295none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001296always @code{deny}.
1297ETEXI
1298
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001299 {
1300 .name = "acl_add",
1301 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001302 .params = "aclname match allow|deny [index]",
1303 .help = "add a match rule to the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001304 .mhandler.cmd = do_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001305 },
1306
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001307STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001308@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1309@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001310Add a match rule to the access control list, allowing or denying access.
1311The match will normally be an exact username or x509 distinguished name,
1312but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1313allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001314normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001315earlier in the list if the optional @var{index} parameter is supplied.
1316ETEXI
1317
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001318 {
1319 .name = "acl_remove",
1320 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001321 .params = "aclname match",
1322 .help = "remove a match rule from the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001323 .mhandler.cmd = do_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001324 },
1325
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001326STEXI
1327@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001328@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001329Remove the specified match rule from the access control list.
1330ETEXI
1331
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001332 {
1333 .name = "acl_reset",
1334 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001335 .params = "aclname",
1336 .help = "reset the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001337 .mhandler.cmd = do_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001338 },
1339
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001340STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001341@item acl_reset @var{aclname}
1342@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001343Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001344policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001345ETEXI
1346
Paolo Bonzini40577252012-08-23 11:53:04 +02001347 {
1348 .name = "nbd_server_start",
1349 .args_type = "all:-a,writable:-w,uri:s",
1350 .params = "nbd_server_start [-a] [-w] host:port",
1351 .help = "serve block devices on the given host and port",
1352 .mhandler.cmd = hmp_nbd_server_start,
1353 },
1354STEXI
1355@item nbd_server_start @var{host}:@var{port}
1356@findex nbd_server_start
1357Start an NBD server on the given host and/or port. If the @option{-a}
1358option is included, all of the virtual machine's block devices that
1359have an inserted media on them are automatically exported; in this case,
1360the @option{-w} option makes the devices writable too.
1361ETEXI
1362
1363 {
1364 .name = "nbd_server_add",
1365 .args_type = "writable:-w,device:B",
1366 .params = "nbd_server_add [-w] device",
1367 .help = "export a block device via NBD",
1368 .mhandler.cmd = hmp_nbd_server_add,
1369 },
1370STEXI
1371@item nbd_server_add @var{device}
1372@findex nbd_server_add
1373Export a block device through QEMU's NBD server, which must be started
1374beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1375exported device writable too.
1376ETEXI
1377
1378 {
1379 .name = "nbd_server_stop",
1380 .args_type = "",
1381 .params = "nbd_server_stop",
1382 .help = "stop serving block devices using the NBD protocol",
1383 .mhandler.cmd = hmp_nbd_server_stop,
1384 },
1385STEXI
1386@item nbd_server_stop
1387@findex nbd_server_stop
1388Stop the QEMU embedded NBD server.
1389ETEXI
1390
1391
Huang Ying79c4f6b2009-06-23 10:05:14 +08001392#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001393
1394 {
1395 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001396 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1397 .params = "[-b] cpu bank status mcgstatus addr misc",
1398 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001399 .mhandler.cmd = do_inject_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001400 },
1401
Huang Ying79c4f6b2009-06-23 10:05:14 +08001402#endif
1403STEXI
1404@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001405@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001406Inject an MCE on the given CPU (x86 only).
1407ETEXI
1408
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001409 {
1410 .name = "getfd",
1411 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001412 .params = "getfd name",
1413 .help = "receive a file descriptor via SCM rights and assign it a name",
Corey Bryant208c9d12012-06-22 14:36:09 -04001414 .mhandler.cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001415 },
1416
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001417STEXI
1418@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001419@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001420If a file descriptor is passed alongside this command using the SCM_RIGHTS
1421mechanism on unix sockets, it is stored using the name @var{fdname} for
1422later use by other monitor commands.
1423ETEXI
1424
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001425 {
1426 .name = "closefd",
1427 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001428 .params = "closefd name",
1429 .help = "close a file descriptor previously passed via SCM rights",
Corey Bryant208c9d12012-06-22 14:36:09 -04001430 .mhandler.cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001431 },
1432
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001433STEXI
1434@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001435@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001436Close the file descriptor previously assigned to @var{fdname} using the
1437@code{getfd} command. This is only needed if the file descriptor was never
1438used by another monitor command.
1439ETEXI
1440
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001441 {
1442 .name = "block_passwd",
1443 .args_type = "device:B,password:s",
1444 .params = "block_passwd device password",
1445 .help = "set the password of encrypted block devices",
Luiz Capitulinoa4dea8a2011-11-23 13:28:21 -02001446 .mhandler.cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001447 },
1448
1449STEXI
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001450@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1451@findex block_set_io_throttle
1452Change 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}
1453ETEXI
1454
1455 {
1456 .name = "block_set_io_throttle",
1457 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1458 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1459 .help = "change I/O throttle limits for a block drive",
Luiz Capitulino80047da2011-12-14 16:49:14 -02001460 .mhandler.cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001461 },
1462
1463STEXI
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001464@item block_passwd @var{device} @var{password}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001465@findex block_passwd
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001466Set the encrypted device @var{device} password to @var{password}
1467ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001468
Jan Kiszka33572ec2010-05-31 14:43:30 -03001469 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001470 .name = "set_password",
1471 .args_type = "protocol:s,password:s,connected:s?",
1472 .params = "protocol password action-if-connected",
1473 .help = "set spice/vnc password",
Luiz Capitulinofbf796f2011-12-07 11:17:51 -02001474 .mhandler.cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001475 },
1476
1477STEXI
1478@item set_password [ vnc | spice ] password [ action-if-connected ]
1479@findex set_password
1480
1481Change spice/vnc password. Use zero to make the password stay valid
1482forever. @var{action-if-connected} specifies what should happen in
1483case a connection is established: @var{fail} makes the password change
1484fail. @var{disconnect} changes the password and disconnects the
1485client. @var{keep} changes the password and keeps the connection up.
1486@var{keep} is the default.
1487ETEXI
1488
1489 {
1490 .name = "expire_password",
1491 .args_type = "protocol:s,time:s",
1492 .params = "protocol time",
1493 .help = "set spice/vnc password expire-time",
Luiz Capitulino9ad53722011-12-07 11:47:57 -02001494 .mhandler.cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001495 },
1496
1497STEXI
1498@item expire_password [ vnc | spice ] expire-time
1499@findex expire_password
1500
1501Specify when a password for spice/vnc becomes
1502invalid. @var{expire-time} accepts:
1503
1504@table @var
1505@item now
1506Invalidate password instantly.
1507
1508@item never
1509Password stays valid forever.
1510
1511@item +nsec
1512Password stays valid for @var{nsec} seconds starting now.
1513
1514@item nsec
1515Password is invalidated at the given time. @var{nsec} are the seconds
1516passed since 1970, i.e. unix epoch.
1517
1518@end table
1519ETEXI
1520
Gerd Hoffmann46920822013-02-28 08:46:10 +01001521 {
1522 .name = "chardev-add",
1523 .args_type = "args:s",
1524 .params = "args",
1525 .help = "add chardev",
1526 .mhandler.cmd = hmp_chardev_add,
1527 },
1528
1529STEXI
1530@item chardev_add args
1531@findex chardev_add
1532
1533chardev_add accepts the same parameters as the -chardev command line switch.
1534
1535ETEXI
1536
1537 {
1538 .name = "chardev-remove",
1539 .args_type = "id:s",
1540 .params = "id",
1541 .help = "remove chardev",
1542 .mhandler.cmd = hmp_chardev_remove,
1543 },
1544
1545STEXI
1546@item chardev_remove id
1547@findex chardev_remove
1548
1549Removes the chardev @var{id}.
1550
1551ETEXI
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001552
1553 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001554 .name = "info",
1555 .args_type = "item:s?",
1556 .params = "[subcommand]",
1557 .help = "show various information about the system state",
Wenchao Xia84c44612013-01-14 14:06:29 +08001558 .mhandler.cmd = do_info_help,
1559 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001560 },
1561
1562STEXI
1563@item info @var{subcommand}
1564@findex info
1565Show various information about the system state.
1566
1567@table @option
1568@item info version
1569show the version of QEMU
Jan Kiszka33572ec2010-05-31 14:43:30 -03001570@item info network
1571show the various VLANs and the associated devices
1572@item info chardev
1573show the character devices
1574@item info block
1575show the block devices
1576@item info blockstats
1577show block device statistics
1578@item info registers
1579show the cpu registers
1580@item info cpus
1581show infos for each CPU
1582@item info history
1583show the command line history
1584@item info irq
1585show the interrupts statistics (if available)
1586@item info pic
1587show i8259 (PIC) state
1588@item info pci
1589show emulated PCI device info
1590@item info tlb
Max Filippov692f7372012-01-07 20:02:40 +04001591show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001592@item info mem
1593show the active virtual memory mappings (i386 only)
Jan Kiszka33572ec2010-05-31 14:43:30 -03001594@item info jit
1595show dynamic compiler info
Jan Kiszka33572ec2010-05-31 14:43:30 -03001596@item info numa
1597show NUMA information
Jan Kiszkab40292e2010-05-31 14:43:31 -03001598@item info kvm
1599show KVM information
Jan Kiszka33572ec2010-05-31 14:43:30 -03001600@item info usb
1601show USB devices plugged on the virtual USB hub
1602@item info usbhost
1603show all USB host devices
1604@item info profile
1605show profiling information
1606@item info capture
1607show information about active capturing
1608@item info snapshots
1609show list of VM snapshots
1610@item info status
1611show the current VM status (running|paused)
1612@item info pcmcia
1613show guest PCMCIA status
1614@item info mice
1615show which guest mouse is receiving events
1616@item info vnc
1617show the vnc server status
1618@item info name
1619show the current VM name
1620@item info uuid
1621show the current VM UUID
1622@item info cpustats
1623show CPU statistics
1624@item info usernet
1625show user network stack connection states
1626@item info migrate
1627show migration status
Orit Wassermanbbf6da32012-08-06 21:42:47 +03001628@item info migrate_capabilities
1629show current migration capabilities
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +03001630@item info migrate_cache_size
1631show current migration XBZRLE cache size
Jan Kiszka33572ec2010-05-31 14:43:30 -03001632@item info balloon
1633show balloon information
1634@item info qtree
1635show device tree
1636@item info qdm
1637show qdev device model list
1638@item info roms
1639show roms
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05001640@item info tpm
1641show the TPM device
Jan Kiszka33572ec2010-05-31 14:43:30 -03001642@end table
1643ETEXI
1644
LluĂ­s31965ae2011-08-31 20:31:24 +02001645STEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301646@item info trace-events
1647show available trace events and their state
1648ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +05301649
Blue Swirl23130862009-06-06 08:22:04 +00001650STEXI
1651@end table
1652ETEXI