blob: 88192817b259099b6bdebc23962ec612e049462a [file] [log] [blame]
Blue Swirl23130862009-06-06 08:22:04 +00001HXCOMM Use DEFHEADING() to define headings in both help text and texi
2HXCOMM Text between STEXI and ETEXI are copied to texi version and
3HXCOMM discarded from C version
4HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5HXCOMM monitor commands
6HXCOMM HXCOMM can be used for comments, discarded from both texi and C
7
8STEXI
9@table @option
10ETEXI
11
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030012 {
13 .name = "help|?",
Wenchao Xia129be002013-08-27 20:38:26 +080014 .args_type = "name:S?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030015 .params = "[cmd]",
16 .help = "show the help",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040017 .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",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040031 .cmd = hmp_commit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030032 },
33
Blue Swirl23130862009-06-06 08:22:04 +000034STEXI
35@item commit
Stefan Weil70fcbbe2010-02-05 23:52:04 +010036@findex commit
Blue Swirl23130862009-06-06 08:22:04 +000037Commit changes to the disk images (if -snapshot is used) or backing files.
Jeff Cody37222902014-01-24 09:02:37 -050038If the backing file is smaller than the snapshot, then the backing file will be
39resized to be the same size as the snapshot. If the snapshot is smaller than
40the backing file, the backing file will not be truncated. If you want the
41backing file to match the size of the smaller snapshot, you can safely truncate
42it yourself once the commit operation successfully completes.
Blue Swirl23130862009-06-06 08:22:04 +000043ETEXI
44
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030045 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030046 .name = "q|quit",
47 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030048 .params = "",
49 .help = "quit the emulator",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040050 .cmd = hmp_quit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030051 },
52
Blue Swirl23130862009-06-06 08:22:04 +000053STEXI
54@item q or quit
Stefan Weil70fcbbe2010-02-05 23:52:04 +010055@findex quit
Blue Swirl23130862009-06-06 08:22:04 +000056Quit the emulator.
57ETEXI
58
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030059 {
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010060 .name = "block_resize",
61 .args_type = "device:B,size:o",
62 .params = "device size",
63 .help = "resize a block image",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040064 .cmd = hmp_block_resize,
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010065 },
66
67STEXI
68@item block_resize
69@findex block_resize
70Resize a block image while a guest is running. Usually requires guest
71action to see the updated size. Resize to a lower size is supported,
72but should be used with extreme caution. Note that this command only
73resizes image files, it can not resize block devices like LVM volumes.
74ETEXI
75
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000076 {
77 .name = "block_stream",
Stefan Hajnoczic83c66c2012-04-25 16:51:03 +010078 .args_type = "device:B,speed:o?,base:s?",
79 .params = "device [speed [base]]",
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000080 .help = "copy data from a backing file into a block device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040081 .cmd = hmp_block_stream,
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000082 },
83
84STEXI
85@item block_stream
86@findex block_stream
87Copy data from a backing file into a block device.
88ETEXI
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010089
90 {
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000091 .name = "block_job_set_speed",
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +010092 .args_type = "device:B,speed:o",
93 .params = "device speed",
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000094 .help = "set maximum speed for a background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040095 .cmd = hmp_block_job_set_speed,
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000096 },
97
98STEXI
Paolo Bonzini4451b792012-04-13 12:03:46 +020099@item block_job_set_speed
100@findex block_job_set_speed
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +0000101Set maximum speed for a background block operation.
102ETEXI
103
104 {
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000105 .name = "block_job_cancel",
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200106 .args_type = "force:-f,device:B",
107 .params = "[-f] device",
108 .help = "stop an active background block operation (use -f"
109 "\n\t\t\t if the operation is currently paused)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400110 .cmd = hmp_block_job_cancel,
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000111 },
112
113STEXI
114@item block_job_cancel
115@findex block_job_cancel
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200116Stop an active background block operation (streaming, mirroring).
117ETEXI
118
119 {
120 .name = "block_job_complete",
121 .args_type = "device:B",
122 .params = "device",
123 .help = "stop an active background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400124 .cmd = hmp_block_job_complete,
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200125 },
126
127STEXI
128@item block_job_complete
129@findex block_job_complete
130Manually trigger completion of an active background block operation.
131For mirroring, this will switch the device to the destination path.
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000132ETEXI
133
134 {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200135 .name = "block_job_pause",
136 .args_type = "device:B",
137 .params = "device",
138 .help = "pause an active background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400139 .cmd = hmp_block_job_pause,
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200140 },
141
142STEXI
143@item block_job_pause
144@findex block_job_pause
145Pause an active block streaming operation.
146ETEXI
147
148 {
149 .name = "block_job_resume",
150 .args_type = "device:B",
151 .params = "device",
152 .help = "resume a paused background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400153 .cmd = hmp_block_job_resume,
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200154 },
155
156STEXI
157@item block_job_resume
158@findex block_job_resume
159Resume a paused block streaming operation.
160ETEXI
161
162 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300163 .name = "eject",
Luiz Capitulino78d714e2009-12-14 18:53:21 -0200164 .args_type = "force:-f,device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300165 .params = "[-f] device",
166 .help = "eject a removable medium (use -f to force it)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400167 .cmd = hmp_eject,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300168 },
169
Blue Swirl23130862009-06-06 08:22:04 +0000170STEXI
171@item eject [-f] @var{device}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100172@findex eject
Blue Swirl23130862009-06-06 08:22:04 +0000173Eject a removable medium (use -f to force it).
174ETEXI
175
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300176 {
Ryan Harper9063f812010-11-12 11:07:13 -0600177 .name = "drive_del",
Hani Benhabilesf7bdc412014-04-13 16:25:05 +0100178 .args_type = "id:B",
Ryan Harper9063f812010-11-12 11:07:13 -0600179 .params = "device",
180 .help = "remove host block device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400181 .cmd = hmp_drive_del,
Ryan Harper9063f812010-11-12 11:07:13 -0600182 },
183
184STEXI
185@item drive_del @var{device}
186@findex drive_del
187Remove host block device. The result is that guest generated IO is no longer
188submitted against the host device underlying the disk. Once a drive has
189been deleted, the QEMU Block layer returns -EIO which results in IO
190errors in the guest for applications that are reading/writing to the device.
Stefan Hajnoczi293c51a2013-06-05 10:33:14 +0200191These errors are always reported to the guest, regardless of the drive's error
192actions (drive options rerror, werror).
Ryan Harper9063f812010-11-12 11:07:13 -0600193ETEXI
194
195 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300196 .name = "change",
Max Reitzbaead0a2015-10-26 21:39:18 +0100197 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
198 .params = "device filename [format [read-only-mode]]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300199 .help = "change a removable medium, optional format",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400200 .cmd = hmp_change,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300201 },
202
Blue Swirl23130862009-06-06 08:22:04 +0000203STEXI
204@item change @var{device} @var{setting}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100205@findex change
Blue Swirl23130862009-06-06 08:22:04 +0000206Change the configuration of a device.
207
208@table @option
Max Reitzbaead0a2015-10-26 21:39:18 +0100209@item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
Blue Swirl23130862009-06-06 08:22:04 +0000210Change the medium for a removable disk device to point to @var{filename}. eg
211
212@example
213(qemu) change ide1-cd0 /path/to/some.iso
214@end example
215
216@var{format} is optional.
217
Max Reitzbaead0a2015-10-26 21:39:18 +0100218@var{read-only-mode} may be used to change the read-only status of the device.
219It accepts the following values:
220
221@table @var
222@item retain
223Retains the current status; this is the default.
224
225@item read-only
226Makes the device read-only.
227
228@item read-write
229Makes the device writable.
230@end table
231
Blue Swirl23130862009-06-06 08:22:04 +0000232@item change vnc @var{display},@var{options}
233Change the configuration of the VNC server. The valid syntax for @var{display}
234and @var{options} are described at @ref{sec_invocation}. eg
235
236@example
237(qemu) change vnc localhost:1
238@end example
239
240@item change vnc password [@var{password}]
241
242Change the password associated with the VNC server. If the new password is not
243supplied, the monitor will prompt for it to be entered. VNC passwords are only
244significant up to 8 letters. eg
245
246@example
247(qemu) change vnc password
248Password: ********
249@end example
250
251@end table
252ETEXI
253
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300254 {
255 .name = "screendump",
256 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300257 .params = "filename",
258 .help = "save screen into PPM image 'filename'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400259 .cmd = hmp_screendump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300260 },
261
Blue Swirl23130862009-06-06 08:22:04 +0000262STEXI
263@item screendump @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100264@findex screendump
Blue Swirl23130862009-06-06 08:22:04 +0000265Save screen into PPM image @var{filename}.
266ETEXI
267
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300268 {
269 .name = "logfile",
270 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300271 .params = "filename",
272 .help = "output logs to 'filename'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400273 .cmd = hmp_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300274 },
275
Blue Swirl23130862009-06-06 08:22:04 +0000276STEXI
277@item logfile @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100278@findex logfile
Blue Swirl23130862009-06-06 08:22:04 +0000279Output logs to @var{filename}.
280ETEXI
281
Prerna Saxena22890ab2010-06-24 17:04:53 +0530282 {
283 .name = "trace-event",
Lluís Vilanova77e2b172016-07-11 12:53:57 +0200284 .args_type = "name:s,option:b,vcpu:i?",
285 .params = "name on|off [vcpu]",
286 .help = "changes status of a specific trace event "
287 "(vcpu: vCPU to set, default is all)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400288 .cmd = hmp_trace_event,
Dr. David Alan Gilbert987bd272015-08-14 11:27:43 +0100289 .command_completion = trace_event_completion,
Prerna Saxena22890ab2010-06-24 17:04:53 +0530290 },
291
292STEXI
293@item trace-event
294@findex trace-event
295changes status of a trace event
296ETEXI
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100297
Michael Rothc45a8162011-10-02 08:44:37 -0500298#if defined(CONFIG_TRACE_SIMPLE)
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100299 {
300 .name = "trace-file",
301 .args_type = "op:s?,arg:F?",
302 .params = "on|off|flush|set [arg]",
303 .help = "open, close, or flush trace file, or set a new file name",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400304 .cmd = hmp_trace_file,
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100305 },
306
307STEXI
308@item trace-file on|off|flush
309@findex trace-file
310Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
311ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +0530312#endif
313
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300314 {
315 .name = "log",
316 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300317 .params = "item1[,...]",
Peter Maydell989b6972013-02-26 17:52:40 +0000318 .help = "activate logging of the specified items",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400319 .cmd = hmp_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300320 },
321
Blue Swirl23130862009-06-06 08:22:04 +0000322STEXI
323@item log @var{item1}[,...]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100324@findex log
Peter Maydell989b6972013-02-26 17:52:40 +0000325Activate logging of the specified items.
Blue Swirl23130862009-06-06 08:22:04 +0000326ETEXI
327
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300328 {
329 .name = "savevm",
330 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300331 .params = "[tag|id]",
332 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400333 .cmd = hmp_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300334 },
335
Blue Swirl23130862009-06-06 08:22:04 +0000336STEXI
337@item savevm [@var{tag}|@var{id}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100338@findex savevm
Blue Swirl23130862009-06-06 08:22:04 +0000339Create a snapshot of the whole virtual machine. If @var{tag} is
340provided, it is used as human readable identifier. If there is already
341a snapshot with the same tag or ID, it is replaced. More info at
342@ref{vm_snapshots}.
343ETEXI
344
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300345 {
346 .name = "loadvm",
347 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300348 .params = "tag|id",
349 .help = "restore a VM snapshot from its tag or id",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400350 .cmd = hmp_loadvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100351 .command_completion = loadvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300352 },
353
Blue Swirl23130862009-06-06 08:22:04 +0000354STEXI
355@item loadvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100356@findex loadvm
Blue Swirl23130862009-06-06 08:22:04 +0000357Set the whole virtual machine to the snapshot identified by the tag
358@var{tag} or the unique snapshot ID @var{id}.
359ETEXI
360
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300361 {
362 .name = "delvm",
363 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300364 .params = "tag|id",
365 .help = "delete a VM snapshot from its tag or id",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400366 .cmd = hmp_delvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100367 .command_completion = delvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300368 },
369
Blue Swirl23130862009-06-06 08:22:04 +0000370STEXI
371@item delvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100372@findex delvm
Blue Swirl23130862009-06-06 08:22:04 +0000373Delete the snapshot identified by @var{tag} or @var{id}.
374ETEXI
375
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300376 {
377 .name = "singlestep",
378 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300379 .params = "[on|off]",
380 .help = "run emulation in singlestep mode or switch to normal mode",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400381 .cmd = hmp_singlestep,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300382 },
383
Blue Swirl23130862009-06-06 08:22:04 +0000384STEXI
385@item singlestep [off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100386@findex singlestep
Blue Swirl23130862009-06-06 08:22:04 +0000387Run the emulation in single step mode.
388If called with option off, the emulation returns to normal mode.
389ETEXI
390
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300391 {
392 .name = "stop",
393 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300394 .params = "",
395 .help = "stop emulation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400396 .cmd = hmp_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300397 },
398
Blue Swirl23130862009-06-06 08:22:04 +0000399STEXI
400@item stop
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100401@findex stop
Blue Swirl23130862009-06-06 08:22:04 +0000402Stop emulation.
403ETEXI
404
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300405 {
406 .name = "c|cont",
407 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300408 .params = "",
409 .help = "resume emulation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400410 .cmd = hmp_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300411 },
412
Blue Swirl23130862009-06-06 08:22:04 +0000413STEXI
414@item c or cont
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100415@findex cont
Blue Swirl23130862009-06-06 08:22:04 +0000416Resume emulation.
417ETEXI
418
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300419 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100420 .name = "system_wakeup",
421 .args_type = "",
422 .params = "",
423 .help = "wakeup guest from suspend",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400424 .cmd = hmp_system_wakeup,
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100425 },
426
427STEXI
428@item system_wakeup
429@findex system_wakeup
430Wakeup guest from suspend.
431ETEXI
432
433 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300434 .name = "gdbserver",
435 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300436 .params = "[device]",
437 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400438 .cmd = hmp_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300439 },
440
Blue Swirl23130862009-06-06 08:22:04 +0000441STEXI
442@item gdbserver [@var{port}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100443@findex gdbserver
Blue Swirl23130862009-06-06 08:22:04 +0000444Start gdbserver session (default @var{port}=1234)
445ETEXI
446
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300447 {
448 .name = "x",
449 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300450 .params = "/fmt addr",
451 .help = "virtual memory dump starting at 'addr'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400452 .cmd = hmp_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300453 },
454
Blue Swirl23130862009-06-06 08:22:04 +0000455STEXI
456@item x/fmt @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100457@findex x
Blue Swirl23130862009-06-06 08:22:04 +0000458Virtual memory dump starting at @var{addr}.
459ETEXI
460
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300461 {
462 .name = "xp",
463 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300464 .params = "/fmt addr",
465 .help = "physical memory dump starting at 'addr'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400466 .cmd = hmp_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300467 },
468
Blue Swirl23130862009-06-06 08:22:04 +0000469STEXI
470@item xp /@var{fmt} @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100471@findex xp
Blue Swirl23130862009-06-06 08:22:04 +0000472Physical memory dump starting at @var{addr}.
473
474@var{fmt} is a format which tells the command how to format the
475data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
476
477@table @var
478@item count
479is the number of items to be dumped.
480
481@item format
482can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
483c (char) or i (asm instruction).
484
485@item size
486can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
487@code{h} or @code{w} can be specified with the @code{i} format to
488respectively select 16 or 32 bit code instruction size.
489
490@end table
491
492Examples:
493@itemize
494@item
495Dump 10 instructions at the current instruction pointer:
496@example
497(qemu) x/10i $eip
4980x90107063: ret
4990x90107064: sti
5000x90107065: lea 0x0(%esi,1),%esi
5010x90107069: lea 0x0(%edi,1),%edi
5020x90107070: ret
5030x90107071: jmp 0x90107080
5040x90107073: nop
5050x90107074: nop
5060x90107075: nop
5070x90107076: nop
508@end example
509
510@item
511Dump 80 16 bit values at the start of the video memory.
512@smallexample
513(qemu) xp/80hx 0xb8000
5140x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
5150x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
5160x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
5170x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
5180x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
5190x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
5200x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5210x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5220x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5230x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
524@end smallexample
525@end itemize
526ETEXI
527
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300528 {
529 .name = "p|print",
530 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300531 .params = "/fmt expr",
532 .help = "print expression value (use $reg for CPU register access)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400533 .cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300534 },
535
Blue Swirl23130862009-06-06 08:22:04 +0000536STEXI
537@item p or print/@var{fmt} @var{expr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100538@findex print
Blue Swirl23130862009-06-06 08:22:04 +0000539Print expression value. Only the @var{format} part of @var{fmt} is
540used.
541ETEXI
542
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300543 {
544 .name = "i",
545 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300546 .params = "/fmt addr",
547 .help = "I/O port read",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400548 .cmd = hmp_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300549 },
550
Blue Swirl23130862009-06-06 08:22:04 +0000551STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100552@item i/@var{fmt} @var{addr} [.@var{index}]
553@findex i
Blue Swirl23130862009-06-06 08:22:04 +0000554Read I/O port.
555ETEXI
556
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300557 {
558 .name = "o",
559 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300560 .params = "/fmt addr value",
561 .help = "I/O port write",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400562 .cmd = hmp_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300563 },
564
Jan Kiszkaf1147842009-07-14 10:20:11 +0200565STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100566@item o/@var{fmt} @var{addr} @var{val}
567@findex o
Jan Kiszkaf1147842009-07-14 10:20:11 +0200568Write to I/O port.
569ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000570
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300571 {
572 .name = "sendkey",
Amos Kong2ef20c12012-08-31 10:56:22 +0800573 .args_type = "keys:s,hold-time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300574 .params = "keys [hold_ms]",
575 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400576 .cmd = hmp_sendkey,
Hani Benhabiles29136cd2014-05-07 23:41:27 +0100577 .command_completion = sendkey_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300578 },
579
Blue Swirl23130862009-06-06 08:22:04 +0000580STEXI
581@item sendkey @var{keys}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100582@findex sendkey
Amos Kong886cc702012-08-31 10:56:20 +0800583Send @var{keys} to the guest. @var{keys} could be the name of the
584key or the raw value in hexadecimal format. Use @code{-} to press
585several keys simultaneously. Example:
Blue Swirl23130862009-06-06 08:22:04 +0000586@example
587sendkey ctrl-alt-f1
588@end example
589
590This command is useful to send keys that your graphical user interface
591intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
592ETEXI
593
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300594 {
595 .name = "system_reset",
596 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300597 .params = "",
598 .help = "reset the system",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400599 .cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300600 },
601
Blue Swirl23130862009-06-06 08:22:04 +0000602STEXI
603@item system_reset
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100604@findex system_reset
Blue Swirl23130862009-06-06 08:22:04 +0000605Reset the system.
606ETEXI
607
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300608 {
609 .name = "system_powerdown",
610 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300611 .params = "",
612 .help = "send system power down event",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400613 .cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300614 },
615
Blue Swirl23130862009-06-06 08:22:04 +0000616STEXI
617@item system_powerdown
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100618@findex system_powerdown
Blue Swirl23130862009-06-06 08:22:04 +0000619Power down the system (if supported).
620ETEXI
621
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300622 {
623 .name = "sum",
624 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300625 .params = "addr size",
626 .help = "compute the checksum of a memory region",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400627 .cmd = hmp_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300628 },
629
Blue Swirl23130862009-06-06 08:22:04 +0000630STEXI
631@item sum @var{addr} @var{size}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100632@findex sum
Blue Swirl23130862009-06-06 08:22:04 +0000633Compute the checksum of a memory region.
634ETEXI
635
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300636 {
637 .name = "usb_add",
638 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300639 .params = "device",
640 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400641 .cmd = hmp_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300642 },
643
Blue Swirl23130862009-06-06 08:22:04 +0000644STEXI
645@item usb_add @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100646@findex usb_add
Blue Swirl23130862009-06-06 08:22:04 +0000647Add the USB device @var{devname}. For details of available devices see
648@ref{usb_devices}
649ETEXI
650
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300651 {
652 .name = "usb_del",
653 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300654 .params = "device",
655 .help = "remove USB device 'bus.addr'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400656 .cmd = hmp_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300657 },
658
Blue Swirl23130862009-06-06 08:22:04 +0000659STEXI
660@item usb_del @var{devname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100661@findex usb_del
Blue Swirl23130862009-06-06 08:22:04 +0000662Remove the USB device @var{devname} from the QEMU virtual USB
663hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
664command @code{info usb} to see the devices you can remove.
665ETEXI
666
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300667 {
668 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100669 .args_type = "device:O",
670 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300671 .help = "add device, like -device on the command line",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400672 .cmd = hmp_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100673 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300674 },
675
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200676STEXI
677@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100678@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200679Add device.
680ETEXI
681
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300682 {
683 .name = "device_del",
684 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300685 .params = "device",
686 .help = "remove device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400687 .cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100688 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300689 },
690
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200691STEXI
692@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100693@findex device_del
Daniel P. Berrange6287d822015-09-11 13:33:56 +0100694Remove device @var{id}. @var{id} may be a short ID
695or a QOM object path.
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200696ETEXI
697
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300698 {
699 .name = "cpu",
700 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300701 .params = "index",
702 .help = "set the default CPU",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400703 .cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300704 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200705
Blue Swirl23130862009-06-06 08:22:04 +0000706STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200707@item cpu @var{index}
708@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000709Set the default CPU.
710ETEXI
711
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300712 {
713 .name = "mouse_move",
714 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300715 .params = "dx dy [dz]",
716 .help = "send mouse move events",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400717 .cmd = hmp_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300718 },
719
Blue Swirl23130862009-06-06 08:22:04 +0000720STEXI
721@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100722@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000723Move the active mouse to the specified coordinates @var{dx} @var{dy}
724with optional scroll axis @var{dz}.
725ETEXI
726
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300727 {
728 .name = "mouse_button",
729 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300730 .params = "state",
731 .help = "change mouse button state (1=L, 2=M, 4=R)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400732 .cmd = hmp_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300733 },
734
Blue Swirl23130862009-06-06 08:22:04 +0000735STEXI
736@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100737@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000738Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
739ETEXI
740
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300741 {
742 .name = "mouse_set",
743 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300744 .params = "index",
745 .help = "set which mouse device receives events",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400746 .cmd = hmp_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300747 },
748
Blue Swirl23130862009-06-06 08:22:04 +0000749STEXI
750@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100751@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000752Set which mouse device receives events at given @var{index}, index
753can be obtained with
754@example
755info mice
756@end example
757ETEXI
758
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300759 {
760 .name = "wavcapture",
761 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300762 .params = "path [frequency [bits [channels]]]",
763 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400764 .cmd = hmp_wavcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300765 },
Blue Swirl23130862009-06-06 08:22:04 +0000766STEXI
767@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100768@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000769Capture audio into @var{filename}. Using sample rate @var{frequency}
770bits per sample @var{bits} and number of channels @var{channels}.
771
772Defaults:
773@itemize @minus
774@item Sample rate = 44100 Hz - CD quality
775@item Bits = 16
776@item Number of channels = 2 - Stereo
777@end itemize
778ETEXI
779
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300780 {
781 .name = "stopcapture",
782 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300783 .params = "capture index",
784 .help = "stop capture",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400785 .cmd = hmp_stopcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300786 },
Blue Swirl23130862009-06-06 08:22:04 +0000787STEXI
788@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100789@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000790Stop capture with a given @var{index}, index can be obtained with
791@example
792info capture
793@end example
794ETEXI
795
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300796 {
797 .name = "memsave",
798 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300799 .params = "addr size file",
800 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400801 .cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300802 },
803
Blue Swirl23130862009-06-06 08:22:04 +0000804STEXI
805@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100806@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000807save to disk virtual memory dump starting at @var{addr} of size @var{size}.
808ETEXI
809
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300810 {
811 .name = "pmemsave",
812 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300813 .params = "addr size file",
814 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400815 .cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300816 },
817
Blue Swirl23130862009-06-06 08:22:04 +0000818STEXI
819@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100820@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000821save to disk physical memory dump starting at @var{addr} of size @var{size}.
822ETEXI
823
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300824 {
825 .name = "boot_set",
826 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300827 .params = "bootdevice",
828 .help = "define new values for the boot device list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400829 .cmd = hmp_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300830 },
831
Blue Swirl23130862009-06-06 08:22:04 +0000832STEXI
833@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100834@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000835Define new values for the boot device list. Those values will override
836the values specified on the command line through the @code{-boot} option.
837
838The values that can be specified here depend on the machine type, but are
839the same that can be specified in the @code{-boot} command line option.
840ETEXI
841
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300842 {
843 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300844 .args_type = "",
845 .params = "",
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000846 .help = "inject an NMI",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400847 .cmd = hmp_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300848 },
Blue Swirl23130862009-06-06 08:22:04 +0000849STEXI
850@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100851@findex nmi
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000852Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
Lei Li1f590cf2013-01-25 00:03:20 +0800853
854ETEXI
855
856 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100857 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800858 .args_type = "device:s,data:s",
859 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100860 .help = "Write to a ring buffer character device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400861 .cmd = hmp_ringbuf_write,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100862 .command_completion = ringbuf_write_completion,
Lei Li1f590cf2013-01-25 00:03:20 +0800863 },
864
865STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100866@item ringbuf_write @var{device} @var{data}
867@findex ringbuf_write
868Write @var{data} to ring buffer character device @var{device}.
869@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800870
Blue Swirl23130862009-06-06 08:22:04 +0000871ETEXI
872
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300873 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100874 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800875 .args_type = "device:s,size:i",
876 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100877 .help = "Read from a ring buffer character device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400878 .cmd = hmp_ringbuf_read,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100879 .command_completion = ringbuf_write_completion,
Lei Li49b6d722013-01-25 00:03:21 +0800880 },
881
882STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100883@item ringbuf_read @var{device}
884@findex ringbuf_read
885Read and print up to @var{size} bytes from ring buffer character
886device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100887Certain non-printable characters are printed \uXXXX, where XXXX is the
888character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100889Bug: can screw up when the buffer contains invalid UTF-8 sequences,
890NUL characters, after the ring buffer lost data, and when reading
891stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800892
893ETEXI
894
895 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300896 .name = "migrate",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200897 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
898 .params = "[-d] [-b] [-i] uri",
899 .help = "migrate to URI (using -d to not wait for completion)"
900 "\n\t\t\t -b for migration without shared storage with"
901 " full copy of disk\n\t\t\t -i for migration without "
902 "shared storage with incremental copy of disk "
903 "(base image shared between src and destination)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400904 .cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300905 },
906
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200907
Blue Swirl23130862009-06-06 08:22:04 +0000908STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200909@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100910@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000911Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200912 -b for migration with full copy of disk
913 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000914ETEXI
915
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300916 {
917 .name = "migrate_cancel",
918 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300919 .params = "",
920 .help = "cancel the current VM migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400921 .cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300922 },
923
Blue Swirl23130862009-06-06 08:22:04 +0000924STEXI
925@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100926@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000927Cancel the current VM migration.
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300928
929ETEXI
930
931 {
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000932 .name = "migrate_incoming",
933 .args_type = "uri:s",
934 .params = "uri",
935 .help = "Continue an incoming migration from an -incoming defer",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400936 .cmd = hmp_migrate_incoming,
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000937 },
938
939STEXI
940@item migrate_incoming @var{uri}
941@findex migrate_incoming
942Continue an incoming migration using the @var{uri} (that has the same syntax
943as the -incoming option).
944
945ETEXI
946
947 {
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300948 .name = "migrate_set_cache_size",
949 .args_type = "value:o",
950 .params = "value",
951 .help = "set cache size (in bytes) for XBZRLE migrations,"
952 "the cache size will be rounded down to the nearest "
953 "power of 2.\n"
954 "The cache size affects the number of cache misses."
955 "In case of a high cache miss ratio you need to increase"
956 " the cache size",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400957 .cmd = hmp_migrate_set_cache_size,
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300958 },
959
960STEXI
961@item migrate_set_cache_size @var{value}
962@findex migrate_set_cache_size
963Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +0000964ETEXI
965
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300966 {
967 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200968 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300969 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +0200970 .help = "set maximum speed (in bytes) for migrations. "
971 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400972 .cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300973 },
974
Blue Swirl23130862009-06-06 08:22:04 +0000975STEXI
976@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100977@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +0000978Set maximum speed to @var{value} (in bytes) for migrations.
979ETEXI
980
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300981 {
982 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +0100983 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300984 .params = "value",
985 .help = "set maximum tolerated downtime (in seconds) for migrations",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400986 .cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300987 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400988
989STEXI
990@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100991@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -0400992Set maximum tolerated downtime (in seconds) for migration.
993ETEXI
994
Jes Sorensenf8882562010-12-16 13:52:16 +0100995 {
Orit Wasserman00458432012-08-06 21:42:48 +0300996 .name = "migrate_set_capability",
997 .args_type = "capability:s,state:b",
998 .params = "capability state",
999 .help = "Enable/Disable the usage of a capability for migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001000 .cmd = hmp_migrate_set_capability,
Hani Benhabilesc68a0402014-05-27 23:39:32 +01001001 .command_completion = migrate_set_capability_completion,
Orit Wasserman00458432012-08-06 21:42:48 +03001002 },
1003
1004STEXI
1005@item migrate_set_capability @var{capability} @var{state}
1006@findex migrate_set_capability
1007Enable/Disable the usage of a capability @var{capability} for migration.
1008ETEXI
1009
1010 {
Liang Li50e9a622015-03-23 16:32:29 +08001011 .name = "migrate_set_parameter",
Daniel P. Berrange69ef1f32016-04-27 11:05:15 +01001012 .args_type = "parameter:s,value:s",
Liang Li50e9a622015-03-23 16:32:29 +08001013 .params = "parameter value",
1014 .help = "Set the parameter for migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001015 .cmd = hmp_migrate_set_parameter,
Liang Li50e9a622015-03-23 16:32:29 +08001016 .command_completion = migrate_set_parameter_completion,
1017 },
1018
1019STEXI
1020@item migrate_set_parameter @var{parameter} @var{value}
1021@findex migrate_set_parameter
1022Set the parameter @var{parameter} for migration.
1023ETEXI
1024
1025 {
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001026 .name = "migrate_start_postcopy",
1027 .args_type = "",
1028 .params = "",
Dr. David Alan Gilberta54d3402015-11-12 11:34:44 +00001029 .help = "Followup to a migration command to switch the migration"
Dr. David Alan Gilbert32c3db52016-03-11 09:53:36 +00001030 " to postcopy mode. The postcopy-ram capability must "
Dr. David Alan Gilberta54d3402015-11-12 11:34:44 +00001031 "be set before the original migration command.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001032 .cmd = hmp_migrate_start_postcopy,
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001033 },
1034
1035STEXI
1036@item migrate_start_postcopy
1037@findex migrate_start_postcopy
1038Switch in-progress migration to postcopy mode. Ignored after the end of
1039migration (or once already in postcopy).
1040ETEXI
1041
1042 {
zhanghailiangd89e6662016-10-27 14:43:03 +08001043 .name = "x_colo_lost_heartbeat",
1044 .args_type = "",
1045 .params = "",
1046 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1047 "a failover or takeover is needed.",
1048 .cmd = hmp_x_colo_lost_heartbeat,
1049 },
1050
1051STEXI
1052@item x_colo_lost_heartbeat
1053@findex x_colo_lost_heartbeat
1054Tell COLO that heartbeat is lost, a failover or takeover is needed.
1055ETEXI
1056
1057 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001058 .name = "client_migrate_info",
1059 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1060 .params = "protocol hostname port tls-port cert-subject",
Markus Armbruster13cadef2015-03-05 19:16:58 +01001061 .help = "set migration information for remote display",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001062 .cmd = hmp_client_migrate_info,
Jes Sorensenf8882562010-12-16 13:52:16 +01001063 },
1064
1065STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001066@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1067@findex client_migrate_info
Markus Armbruster13cadef2015-03-05 19:16:58 +01001068Set migration information for remote display. This makes the server
1069ask the client to automatically reconnect using the new parameters
1070once migration finished successfully. Only implemented for SPICE.
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001071ETEXI
1072
Wen Congyang783e9b42012-05-07 12:10:47 +08001073 {
1074 .name = "dump-guest-memory",
Peter Xu228de9c2016-02-18 13:16:47 +08001075 .args_type = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1076 .params = "[-p] [-d] [-z|-l|-s] filename [begin length]",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001077 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1078 "-p: do paging to get guest's memory mapping.\n\t\t\t"
Peter Xu228de9c2016-02-18 13:16:47 +08001079 "-d: return immediately (do not wait for completion).\n\t\t\t"
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001080 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1081 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1082 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001083 "begin: the starting physical address.\n\t\t\t"
1084 "length: the memory size, in bytes.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001085 .cmd = hmp_dump_guest_memory,
Wen Congyang783e9b42012-05-07 12:10:47 +08001086 },
1087
1088
1089STEXI
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001090@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001091@item dump-guest-memory [-z|-l|-s] @var{filename}
Wen Congyang783e9b42012-05-07 12:10:47 +08001092@findex dump-guest-memory
1093Dump guest memory to @var{protocol}. The file can be processed with crash or
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001094gdb. Without -z|-l|-s, the dump format is ELF.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001095 -p: do paging to get guest's memory mapping.
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001096 -z: dump in kdump-compressed format, with zlib compression.
1097 -l: dump in kdump-compressed format, with lzo compression.
1098 -s: dump in kdump-compressed format, with snappy compression.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001099 filename: dump file name.
Wen Congyang783e9b42012-05-07 12:10:47 +08001100 begin: the starting physical address. It's optional, and should be
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001101 specified together with length.
Wen Congyang783e9b42012-05-07 12:10:47 +08001102 length: the memory size, in bytes. It's optional, and should be specified
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001103 together with begin.
Wen Congyang783e9b42012-05-07 12:10:47 +08001104ETEXI
Wen Congyang783e9b42012-05-07 12:10:47 +08001105
Jason J. Hernea4538a52015-06-26 14:07:21 -04001106#if defined(TARGET_S390X)
1107 {
1108 .name = "dump-skeys",
1109 .args_type = "filename:F",
1110 .params = "",
1111 .help = "Save guest storage keys into file 'filename'.\n",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001112 .cmd = hmp_dump_skeys,
Jason J. Hernea4538a52015-06-26 14:07:21 -04001113 },
1114#endif
1115
1116STEXI
1117@item dump-skeys @var{filename}
1118@findex dump-skeys
1119Save guest storage keys to a file.
1120ETEXI
1121
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001122 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001123 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001124 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1125 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001126 .help = "initiates a live snapshot\n\t\t\t"
1127 "of device. If a new image file is specified, the\n\t\t\t"
1128 "new image file will become the new root image.\n\t\t\t"
1129 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001130 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001131 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1132 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1133 "recreating it from scratch.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001134 .cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001135 },
1136
1137STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001138@item snapshot_blkdev
1139@findex snapshot_blkdev
1140Snapshot device, using snapshot file as target if provided
1141ETEXI
1142
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001143 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001144 .name = "snapshot_blkdev_internal",
1145 .args_type = "device:B,name:s",
1146 .params = "device name",
1147 .help = "take an internal snapshot of device.\n\t\t\t"
1148 "The format of the image used by device must\n\t\t\t"
1149 "support it, such as qcow2.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001150 .cmd = hmp_snapshot_blkdev_internal,
Wenchao Xia775ca882013-09-11 14:04:37 +08001151 },
1152
1153STEXI
1154@item snapshot_blkdev_internal
1155@findex snapshot_blkdev_internal
1156Take an internal snapshot on device if it support
1157ETEXI
1158
1159 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001160 .name = "snapshot_delete_blkdev_internal",
1161 .args_type = "device:B,name:s,id:s?",
1162 .params = "device name [id]",
1163 .help = "delete an internal snapshot of device.\n\t\t\t"
1164 "If id is specified, qemu will try delete\n\t\t\t"
1165 "the snapshot matching both id and name.\n\t\t\t"
1166 "The format of the image used by device must\n\t\t\t"
1167 "support it, such as qcow2.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001168 .cmd = hmp_snapshot_delete_blkdev_internal,
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001169 },
1170
1171STEXI
1172@item snapshot_delete_blkdev_internal
1173@findex snapshot_delete_blkdev_internal
1174Delete an internal snapshot on device if it support
1175ETEXI
1176
1177 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001178 .name = "drive_mirror",
1179 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1180 .params = "[-n] [-f] device target [format]",
1181 .help = "initiates live storage\n\t\t\t"
1182 "migration for a device. The device's contents are\n\t\t\t"
1183 "copied to the new image file, including data that\n\t\t\t"
1184 "is written after the command is started.\n\t\t\t"
1185 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1186 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1187 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1188 "so that the result does not need a backing file.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001189 .cmd = hmp_drive_mirror,
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001190 },
1191STEXI
1192@item drive_mirror
1193@findex drive_mirror
1194Start mirroring a block device's writes to a new destination,
1195using the specified target.
1196ETEXI
1197
1198 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001199 .name = "drive_backup",
Pavel Butsykin13b94142016-07-22 11:17:52 +03001200 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1201 .params = "[-n] [-f] [-c] device target [format]",
Stefan Hajnoczide909302013-06-26 14:11:58 +02001202 .help = "initiates a point-in-time\n\t\t\t"
1203 "copy for a device. The device's contents are\n\t\t\t"
1204 "copied to the new image file, excluding data that\n\t\t\t"
1205 "is written after the command is started.\n\t\t\t"
1206 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1207 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1208 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
Pavel Butsykin13b94142016-07-22 11:17:52 +03001209 "so that the result does not need a backing file.\n\t\t\t"
1210 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1211 "(if the target format supports it).\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001212 .cmd = hmp_drive_backup,
Stefan Hajnoczide909302013-06-26 14:11:58 +02001213 },
1214STEXI
1215@item drive_backup
1216@findex drive_backup
1217Start a point-in-time copy of a block device to a specificed target.
1218ETEXI
1219
1220 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001221 .name = "drive_add",
Kevin Wolfabb21ac2016-02-23 17:33:24 +01001222 .args_type = "node:-n,pci_addr:s,opts:s",
1223 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001224 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001225 "[,unit=m][,media=d][,index=i]\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001226 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001227 "[,snapshot=on|off][,cache=on|off]\n"
1228 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001229 .help = "add drive to PCI storage controller",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001230 .cmd = hmp_drive_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001231 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001232
Blue Swirl23130862009-06-06 08:22:04 +00001233STEXI
1234@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001235@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001236Add drive to PCI storage controller.
1237ETEXI
1238
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001239 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001240 .name = "pcie_aer_inject_error",
1241 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1242 "id:s,error_status:s,"
1243 "header0:i?,header1:i?,header2:i?,header3:i?,"
1244 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1245 .params = "[-a] [-c] id "
1246 "<error_status> [<tlp header> [<tlp header prefix>]]",
1247 .help = "inject pcie aer error\n\t\t\t"
1248 " -a for advisory non fatal error\n\t\t\t"
1249 " -c for correctable error\n\t\t\t"
1250 "<id> = qdev device id\n\t\t\t"
1251 "<error_status> = error string or 32bit\n\t\t\t"
1252 "<tlb header> = 32bit x 4\n\t\t\t"
1253 "<tlb header prefix> = 32bit x 4",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001254 .cmd = hmp_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001255 },
1256
1257STEXI
1258@item pcie_aer_inject_error
1259@findex pcie_aer_inject_error
1260Inject PCIe AER error
1261ETEXI
1262
1263 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001264 .name = "host_net_add",
1265 .args_type = "device:s,opts:s?",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001266 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001267 .help = "add host VLAN client",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001268 .cmd = hmp_host_net_add,
Hani Benhabilese3bb5322014-05-27 23:39:34 +01001269 .command_completion = host_net_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001270 },
1271
Blue Swirl23130862009-06-06 08:22:04 +00001272STEXI
1273@item host_net_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001274@findex host_net_add
Blue Swirl23130862009-06-06 08:22:04 +00001275Add host VLAN client.
1276ETEXI
1277
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001278 {
1279 .name = "host_net_remove",
1280 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001281 .params = "vlan_id name",
1282 .help = "remove host VLAN client",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001283 .cmd = hmp_host_net_remove,
Hani Benhabilesddd6b452014-05-27 23:39:36 +01001284 .command_completion = host_net_remove_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001285 },
1286
Blue Swirl23130862009-06-06 08:22:04 +00001287STEXI
1288@item host_net_remove
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001289@findex host_net_remove
Blue Swirl23130862009-06-06 08:22:04 +00001290Remove host VLAN client.
1291ETEXI
1292
Markus Armbrusterae82d322010-03-25 17:22:40 +01001293 {
1294 .name = "netdev_add",
1295 .args_type = "netdev:O",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001296 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001297 .help = "add host network device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001298 .cmd = hmp_netdev_add,
Hani Benhabilesb162b492014-05-07 23:41:31 +01001299 .command_completion = netdev_add_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001300 },
1301
1302STEXI
1303@item netdev_add
1304@findex netdev_add
1305Add host network device.
1306ETEXI
1307
1308 {
1309 .name = "netdev_del",
1310 .args_type = "id:s",
1311 .params = "id",
1312 .help = "remove host network device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001313 .cmd = hmp_netdev_del,
Hani Benhabiles11b389f2014-05-07 23:41:32 +01001314 .command_completion = netdev_del_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001315 },
1316
1317STEXI
1318@item netdev_del
1319@findex netdev_del
1320Remove host network device.
1321ETEXI
1322
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001323 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001324 .name = "object_add",
1325 .args_type = "object:O",
1326 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1327 .help = "create QOM object",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001328 .cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001329 .command_completion = object_add_completion,
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001330 },
1331
1332STEXI
1333@item object_add
1334@findex object_add
1335Create QOM object.
1336ETEXI
1337
1338 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001339 .name = "object_del",
1340 .args_type = "id:s",
1341 .params = "id",
1342 .help = "destroy QOM object",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001343 .cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001344 .command_completion = object_del_completion,
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001345 },
1346
1347STEXI
1348@item object_del
1349@findex object_del
1350Destroy QOM object.
1351ETEXI
1352
Blue Swirl23130862009-06-06 08:22:04 +00001353#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001354 {
1355 .name = "hostfwd_add",
1356 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001357 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1358 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001359 .cmd = hmp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001360 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001361#endif
1362STEXI
1363@item hostfwd_add
1364@findex hostfwd_add
1365Redirect TCP or UDP connections from host to guest (requires -net user).
1366ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001367
Markus Armbruster21413d62010-05-04 13:20:30 +02001368#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001369 {
1370 .name = "hostfwd_remove",
1371 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001372 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1373 .help = "remove host-to-guest TCP or UDP redirection",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001374 .cmd = hmp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001375 },
1376
Blue Swirl23130862009-06-06 08:22:04 +00001377#endif
1378STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001379@item hostfwd_remove
1380@findex hostfwd_remove
1381Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001382ETEXI
1383
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001384 {
1385 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001386 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001387 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001388 .help = "request VM to change its memory allocation (in MB)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001389 .cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001390 },
1391
Blue Swirl23130862009-06-06 08:22:04 +00001392STEXI
1393@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001394@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001395Request VM to change its memory allocation to @var{value} (in MB).
1396ETEXI
1397
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001398 {
1399 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001400 .args_type = "name:s,up:b",
1401 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001402 .help = "change the link status of a network adapter",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001403 .cmd = hmp_set_link,
Hani Benhabiles40d19392014-05-07 23:41:30 +01001404 .command_completion = set_link_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001405 },
1406
Blue Swirl23130862009-06-06 08:22:04 +00001407STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001408@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001409@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001410Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001411ETEXI
1412
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001413 {
1414 .name = "watchdog_action",
1415 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001416 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1417 .help = "change watchdog action",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001418 .cmd = hmp_watchdog_action,
Hani Benhabilesd0ece342014-05-27 23:39:31 +01001419 .command_completion = watchdog_action_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001420 },
1421
Blue Swirl23130862009-06-06 08:22:04 +00001422STEXI
1423@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001424@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001425Change watchdog action.
1426ETEXI
1427
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001428 {
1429 .name = "acl_show",
1430 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001431 .params = "aclname",
1432 .help = "list rules in the access control list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001433 .cmd = hmp_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001434 },
1435
Blue Swirl23130862009-06-06 08:22:04 +00001436STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001437@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001438@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001439List all the matching rules in the access control list, and the default
1440policy. There are currently two named access control lists,
1441@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1442certificate distinguished name, and SASL username respectively.
1443ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001444
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001445 {
1446 .name = "acl_policy",
1447 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001448 .params = "aclname allow|deny",
1449 .help = "set default access control list policy",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001450 .cmd = hmp_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001451 },
1452
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001453STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001454@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001455@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001456Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001457none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001458always @code{deny}.
1459ETEXI
1460
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001461 {
1462 .name = "acl_add",
1463 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001464 .params = "aclname match allow|deny [index]",
1465 .help = "add a match rule to the access control list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001466 .cmd = hmp_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001467 },
1468
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001469STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001470@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1471@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001472Add a match rule to the access control list, allowing or denying access.
1473The match will normally be an exact username or x509 distinguished name,
1474but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1475allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001476normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001477earlier in the list if the optional @var{index} parameter is supplied.
1478ETEXI
1479
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001480 {
1481 .name = "acl_remove",
1482 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001483 .params = "aclname match",
1484 .help = "remove a match rule from the access control list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001485 .cmd = hmp_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001486 },
1487
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001488STEXI
1489@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001490@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001491Remove the specified match rule from the access control list.
1492ETEXI
1493
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001494 {
1495 .name = "acl_reset",
1496 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001497 .params = "aclname",
1498 .help = "reset the access control list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001499 .cmd = hmp_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001500 },
1501
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001502STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001503@item acl_reset @var{aclname}
1504@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001505Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001506policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001507ETEXI
1508
Paolo Bonzini40577252012-08-23 11:53:04 +02001509 {
1510 .name = "nbd_server_start",
1511 .args_type = "all:-a,writable:-w,uri:s",
1512 .params = "nbd_server_start [-a] [-w] host:port",
1513 .help = "serve block devices on the given host and port",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001514 .cmd = hmp_nbd_server_start,
Paolo Bonzini40577252012-08-23 11:53:04 +02001515 },
1516STEXI
1517@item nbd_server_start @var{host}:@var{port}
1518@findex nbd_server_start
1519Start an NBD server on the given host and/or port. If the @option{-a}
1520option is included, all of the virtual machine's block devices that
1521have an inserted media on them are automatically exported; in this case,
1522the @option{-w} option makes the devices writable too.
1523ETEXI
1524
1525 {
1526 .name = "nbd_server_add",
1527 .args_type = "writable:-w,device:B",
1528 .params = "nbd_server_add [-w] device",
1529 .help = "export a block device via NBD",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001530 .cmd = hmp_nbd_server_add,
Paolo Bonzini40577252012-08-23 11:53:04 +02001531 },
1532STEXI
1533@item nbd_server_add @var{device}
1534@findex nbd_server_add
1535Export a block device through QEMU's NBD server, which must be started
1536beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1537exported device writable too.
1538ETEXI
1539
1540 {
1541 .name = "nbd_server_stop",
1542 .args_type = "",
1543 .params = "nbd_server_stop",
1544 .help = "stop serving block devices using the NBD protocol",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001545 .cmd = hmp_nbd_server_stop,
Paolo Bonzini40577252012-08-23 11:53:04 +02001546 },
1547STEXI
1548@item nbd_server_stop
1549@findex nbd_server_stop
1550Stop the QEMU embedded NBD server.
1551ETEXI
1552
1553
Huang Ying79c4f6b2009-06-23 10:05:14 +08001554#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001555
1556 {
1557 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001558 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1559 .params = "[-b] cpu bank status mcgstatus addr misc",
1560 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001561 .cmd = hmp_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001562 },
1563
Huang Ying79c4f6b2009-06-23 10:05:14 +08001564#endif
1565STEXI
1566@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001567@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001568Inject an MCE on the given CPU (x86 only).
1569ETEXI
1570
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001571 {
1572 .name = "getfd",
1573 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001574 .params = "getfd name",
1575 .help = "receive a file descriptor via SCM rights and assign it a name",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001576 .cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001577 },
1578
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001579STEXI
1580@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001581@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001582If a file descriptor is passed alongside this command using the SCM_RIGHTS
1583mechanism on unix sockets, it is stored using the name @var{fdname} for
1584later use by other monitor commands.
1585ETEXI
1586
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001587 {
1588 .name = "closefd",
1589 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001590 .params = "closefd name",
1591 .help = "close a file descriptor previously passed via SCM rights",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001592 .cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001593 },
1594
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001595STEXI
1596@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001597@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001598Close the file descriptor previously assigned to @var{fdname} using the
1599@code{getfd} command. This is only needed if the file descriptor was never
1600used by another monitor command.
1601ETEXI
1602
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001603 {
1604 .name = "block_passwd",
1605 .args_type = "device:B,password:s",
1606 .params = "block_passwd device password",
1607 .help = "set the password of encrypted block devices",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001608 .cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001609 },
1610
1611STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001612@item block_passwd @var{device} @var{password}
1613@findex block_passwd
1614Set the encrypted device @var{device} password to @var{password}
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001615ETEXI
1616
1617 {
1618 .name = "block_set_io_throttle",
1619 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1620 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1621 .help = "change I/O throttle limits for a block drive",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001622 .cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001623 },
1624
1625STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001626@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1627@findex block_set_io_throttle
1628Change I/O throttle limits for a block drive to @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001629ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001630
Jan Kiszka33572ec2010-05-31 14:43:30 -03001631 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001632 .name = "set_password",
1633 .args_type = "protocol:s,password:s,connected:s?",
1634 .params = "protocol password action-if-connected",
1635 .help = "set spice/vnc password",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001636 .cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001637 },
1638
1639STEXI
1640@item set_password [ vnc | spice ] password [ action-if-connected ]
1641@findex set_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001642Change spice/vnc password. Use zero to make the password stay valid
1643forever. @var{action-if-connected} specifies what should happen in
1644case a connection is established: @var{fail} makes the password change
1645fail. @var{disconnect} changes the password and disconnects the
1646client. @var{keep} changes the password and keeps the connection up.
1647@var{keep} is the default.
1648ETEXI
1649
1650 {
1651 .name = "expire_password",
1652 .args_type = "protocol:s,time:s",
1653 .params = "protocol time",
1654 .help = "set spice/vnc password expire-time",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001655 .cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001656 },
1657
1658STEXI
1659@item expire_password [ vnc | spice ] expire-time
1660@findex expire_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001661Specify when a password for spice/vnc becomes
1662invalid. @var{expire-time} accepts:
1663
1664@table @var
1665@item now
1666Invalidate password instantly.
1667
1668@item never
1669Password stays valid forever.
1670
1671@item +nsec
1672Password stays valid for @var{nsec} seconds starting now.
1673
1674@item nsec
1675Password is invalidated at the given time. @var{nsec} are the seconds
1676passed since 1970, i.e. unix epoch.
1677
1678@end table
1679ETEXI
1680
Gerd Hoffmann46920822013-02-28 08:46:10 +01001681 {
1682 .name = "chardev-add",
1683 .args_type = "args:s",
1684 .params = "args",
1685 .help = "add chardev",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001686 .cmd = hmp_chardev_add,
Hani Benhabiles13e315d2014-05-07 23:41:29 +01001687 .command_completion = chardev_add_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001688 },
1689
1690STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001691@item chardev-add args
1692@findex chardev-add
Gerd Hoffmann46920822013-02-28 08:46:10 +01001693chardev_add accepts the same parameters as the -chardev command line switch.
1694
1695ETEXI
1696
1697 {
1698 .name = "chardev-remove",
1699 .args_type = "id:s",
1700 .params = "id",
1701 .help = "remove chardev",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001702 .cmd = hmp_chardev_remove,
Hani Benhabiles6297d9a2014-05-07 23:41:28 +01001703 .command_completion = chardev_remove_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001704 },
1705
1706STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001707@item chardev-remove id
1708@findex chardev-remove
Gerd Hoffmann46920822013-02-28 08:46:10 +01001709Removes the chardev @var{id}.
1710
1711ETEXI
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001712
1713 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001714 .name = "qemu-io",
1715 .args_type = "device:B,command:s",
1716 .params = "[device] \"[command]\"",
1717 .help = "run a qemu-io command on a block device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001718 .cmd = hmp_qemu_io,
Kevin Wolf587da2c2013-06-05 14:19:41 +02001719 },
1720
1721STEXI
1722@item qemu-io @var{device} @var{command}
1723@findex qemu-io
Kevin Wolf587da2c2013-06-05 14:19:41 +02001724Executes a qemu-io command on the given block device.
1725
1726ETEXI
1727
1728 {
Jason J. Herneabf23322013-12-11 13:24:14 -05001729 .name = "cpu-add",
1730 .args_type = "id:i",
1731 .params = "id",
1732 .help = "add cpu",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001733 .cmd = hmp_cpu_add,
Jason J. Herneabf23322013-12-11 13:24:14 -05001734 },
1735
1736STEXI
1737@item cpu-add @var{id}
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001738@findex cpu-add
Jason J. Herneabf23322013-12-11 13:24:14 -05001739Add CPU with id @var{id}
1740ETEXI
1741
1742 {
Andreas Färber89d7fa92014-05-07 18:08:29 +02001743 .name = "qom-list",
1744 .args_type = "path:s?",
1745 .params = "path",
1746 .help = "list QOM properties",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001747 .cmd = hmp_qom_list,
Andreas Färber89d7fa92014-05-07 18:08:29 +02001748 },
1749
1750STEXI
1751@item qom-list [@var{path}]
1752Print QOM properties of object at location @var{path}
1753ETEXI
1754
1755 {
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001756 .name = "qom-set",
1757 .args_type = "path:s,property:s,value:s",
1758 .params = "path property value",
1759 .help = "set QOM property",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001760 .cmd = hmp_qom_set,
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001761 },
1762
1763STEXI
1764@item qom-set @var{path} @var{property} @var{value}
1765Set QOM property @var{property} of object at location @var{path} to value @var{value}
1766ETEXI
1767
1768 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001769 .name = "info",
1770 .args_type = "item:s?",
1771 .params = "[subcommand]",
1772 .help = "show various information about the system state",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001773 .cmd = hmp_info_help,
1774 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001775 },
1776
1777STEXI
Pavel Butsykin70703342015-09-10 18:39:00 +03001778@end table
1779ETEXI