blob: 0de7c4c29e1fa742560d0a37418fa359bf621283 [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"
Liang Lib76e4452018-03-13 08:12:16 -0400109 "\n\t\t\t if you want to abort the operation immediately"
110 "\n\t\t\t instead of keep running until data is in sync)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400111 .cmd = hmp_block_job_cancel,
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000112 },
113
114STEXI
115@item block_job_cancel
116@findex block_job_cancel
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200117Stop an active background block operation (streaming, mirroring).
118ETEXI
119
120 {
121 .name = "block_job_complete",
122 .args_type = "device:B",
123 .params = "device",
124 .help = "stop an active background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400125 .cmd = hmp_block_job_complete,
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200126 },
127
128STEXI
129@item block_job_complete
130@findex block_job_complete
131Manually trigger completion of an active background block operation.
132For mirroring, this will switch the device to the destination path.
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000133ETEXI
134
135 {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200136 .name = "block_job_pause",
137 .args_type = "device:B",
138 .params = "device",
139 .help = "pause an active background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400140 .cmd = hmp_block_job_pause,
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200141 },
142
143STEXI
144@item block_job_pause
145@findex block_job_pause
146Pause an active block streaming operation.
147ETEXI
148
149 {
150 .name = "block_job_resume",
151 .args_type = "device:B",
152 .params = "device",
153 .help = "resume a paused background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400154 .cmd = hmp_block_job_resume,
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200155 },
156
157STEXI
158@item block_job_resume
159@findex block_job_resume
160Resume a paused block streaming operation.
161ETEXI
162
163 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300164 .name = "eject",
Luiz Capitulino78d714e2009-12-14 18:53:21 -0200165 .args_type = "force:-f,device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300166 .params = "[-f] device",
167 .help = "eject a removable medium (use -f to force it)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400168 .cmd = hmp_eject,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300169 },
170
Blue Swirl23130862009-06-06 08:22:04 +0000171STEXI
172@item eject [-f] @var{device}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100173@findex eject
Blue Swirl23130862009-06-06 08:22:04 +0000174Eject a removable medium (use -f to force it).
175ETEXI
176
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300177 {
Ryan Harper9063f812010-11-12 11:07:13 -0600178 .name = "drive_del",
Hani Benhabilesf7bdc412014-04-13 16:25:05 +0100179 .args_type = "id:B",
Ryan Harper9063f812010-11-12 11:07:13 -0600180 .params = "device",
181 .help = "remove host block device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400182 .cmd = hmp_drive_del,
Ryan Harper9063f812010-11-12 11:07:13 -0600183 },
184
185STEXI
186@item drive_del @var{device}
187@findex drive_del
188Remove host block device. The result is that guest generated IO is no longer
189submitted against the host device underlying the disk. Once a drive has
190been deleted, the QEMU Block layer returns -EIO which results in IO
191errors in the guest for applications that are reading/writing to the device.
Stefan Hajnoczi293c51a2013-06-05 10:33:14 +0200192These errors are always reported to the guest, regardless of the drive's error
193actions (drive options rerror, werror).
Ryan Harper9063f812010-11-12 11:07:13 -0600194ETEXI
195
196 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300197 .name = "change",
Max Reitzbaead0a2015-10-26 21:39:18 +0100198 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
199 .params = "device filename [format [read-only-mode]]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300200 .help = "change a removable medium, optional format",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400201 .cmd = hmp_change,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300202 },
203
Blue Swirl23130862009-06-06 08:22:04 +0000204STEXI
205@item change @var{device} @var{setting}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100206@findex change
Blue Swirl23130862009-06-06 08:22:04 +0000207Change the configuration of a device.
208
209@table @option
Max Reitzbaead0a2015-10-26 21:39:18 +0100210@item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
Blue Swirl23130862009-06-06 08:22:04 +0000211Change the medium for a removable disk device to point to @var{filename}. eg
212
213@example
214(qemu) change ide1-cd0 /path/to/some.iso
215@end example
216
217@var{format} is optional.
218
Max Reitzbaead0a2015-10-26 21:39:18 +0100219@var{read-only-mode} may be used to change the read-only status of the device.
220It accepts the following values:
221
222@table @var
223@item retain
224Retains the current status; this is the default.
225
226@item read-only
227Makes the device read-only.
228
229@item read-write
230Makes the device writable.
231@end table
232
Blue Swirl23130862009-06-06 08:22:04 +0000233@item change vnc @var{display},@var{options}
234Change the configuration of the VNC server. The valid syntax for @var{display}
235and @var{options} are described at @ref{sec_invocation}. eg
236
237@example
238(qemu) change vnc localhost:1
239@end example
240
241@item change vnc password [@var{password}]
242
243Change the password associated with the VNC server. If the new password is not
244supplied, the monitor will prompt for it to be entered. VNC passwords are only
245significant up to 8 letters. eg
246
247@example
248(qemu) change vnc password
249Password: ********
250@end example
251
252@end table
253ETEXI
254
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300255 {
256 .name = "screendump",
Thomas Huthf771c542018-03-05 17:37:48 +0100257 .args_type = "filename:F,device:s?,head:i?",
258 .params = "filename [device [head]]",
259 .help = "save screen from head 'head' of display device 'device' "
260 "into PPM image 'filename'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400261 .cmd = hmp_screendump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300262 },
263
Blue Swirl23130862009-06-06 08:22:04 +0000264STEXI
265@item screendump @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100266@findex screendump
Blue Swirl23130862009-06-06 08:22:04 +0000267Save screen into PPM image @var{filename}.
268ETEXI
269
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300270 {
271 .name = "logfile",
272 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300273 .params = "filename",
274 .help = "output logs to 'filename'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400275 .cmd = hmp_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300276 },
277
Blue Swirl23130862009-06-06 08:22:04 +0000278STEXI
279@item logfile @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100280@findex logfile
Blue Swirl23130862009-06-06 08:22:04 +0000281Output logs to @var{filename}.
282ETEXI
283
Prerna Saxena22890ab2010-06-24 17:04:53 +0530284 {
285 .name = "trace-event",
Lluís Vilanova77e2b172016-07-11 12:53:57 +0200286 .args_type = "name:s,option:b,vcpu:i?",
287 .params = "name on|off [vcpu]",
288 .help = "changes status of a specific trace event "
289 "(vcpu: vCPU to set, default is all)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400290 .cmd = hmp_trace_event,
Dr. David Alan Gilbert987bd272015-08-14 11:27:43 +0100291 .command_completion = trace_event_completion,
Prerna Saxena22890ab2010-06-24 17:04:53 +0530292 },
293
294STEXI
295@item trace-event
296@findex trace-event
297changes status of a trace event
298ETEXI
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100299
Michael Rothc45a8162011-10-02 08:44:37 -0500300#if defined(CONFIG_TRACE_SIMPLE)
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100301 {
302 .name = "trace-file",
303 .args_type = "op:s?,arg:F?",
304 .params = "on|off|flush|set [arg]",
305 .help = "open, close, or flush trace file, or set a new file name",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400306 .cmd = hmp_trace_file,
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100307 },
308
309STEXI
310@item trace-file on|off|flush
311@findex trace-file
312Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
313ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +0530314#endif
315
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300316 {
317 .name = "log",
318 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300319 .params = "item1[,...]",
Peter Maydell989b6972013-02-26 17:52:40 +0000320 .help = "activate logging of the specified items",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400321 .cmd = hmp_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300322 },
323
Blue Swirl23130862009-06-06 08:22:04 +0000324STEXI
325@item log @var{item1}[,...]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100326@findex log
Peter Maydell989b6972013-02-26 17:52:40 +0000327Activate logging of the specified items.
Blue Swirl23130862009-06-06 08:22:04 +0000328ETEXI
329
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300330 {
331 .name = "savevm",
332 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300333 .params = "[tag|id]",
334 .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 +0400335 .cmd = hmp_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300336 },
337
Blue Swirl23130862009-06-06 08:22:04 +0000338STEXI
339@item savevm [@var{tag}|@var{id}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100340@findex savevm
Blue Swirl23130862009-06-06 08:22:04 +0000341Create a snapshot of the whole virtual machine. If @var{tag} is
342provided, it is used as human readable identifier. If there is already
343a snapshot with the same tag or ID, it is replaced. More info at
344@ref{vm_snapshots}.
345ETEXI
346
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300347 {
348 .name = "loadvm",
349 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300350 .params = "tag|id",
351 .help = "restore a VM snapshot from its tag or id",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400352 .cmd = hmp_loadvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100353 .command_completion = loadvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300354 },
355
Blue Swirl23130862009-06-06 08:22:04 +0000356STEXI
357@item loadvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100358@findex loadvm
Blue Swirl23130862009-06-06 08:22:04 +0000359Set the whole virtual machine to the snapshot identified by the tag
360@var{tag} or the unique snapshot ID @var{id}.
361ETEXI
362
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300363 {
364 .name = "delvm",
365 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300366 .params = "tag|id",
367 .help = "delete a VM snapshot from its tag or id",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400368 .cmd = hmp_delvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100369 .command_completion = delvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300370 },
371
Blue Swirl23130862009-06-06 08:22:04 +0000372STEXI
373@item delvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100374@findex delvm
Blue Swirl23130862009-06-06 08:22:04 +0000375Delete the snapshot identified by @var{tag} or @var{id}.
376ETEXI
377
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300378 {
379 .name = "singlestep",
380 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300381 .params = "[on|off]",
382 .help = "run emulation in singlestep mode or switch to normal mode",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400383 .cmd = hmp_singlestep,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300384 },
385
Blue Swirl23130862009-06-06 08:22:04 +0000386STEXI
387@item singlestep [off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100388@findex singlestep
Blue Swirl23130862009-06-06 08:22:04 +0000389Run the emulation in single step mode.
390If called with option off, the emulation returns to normal mode.
391ETEXI
392
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300393 {
394 .name = "stop",
395 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300396 .params = "",
397 .help = "stop emulation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400398 .cmd = hmp_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300399 },
400
Blue Swirl23130862009-06-06 08:22:04 +0000401STEXI
402@item stop
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100403@findex stop
Blue Swirl23130862009-06-06 08:22:04 +0000404Stop emulation.
405ETEXI
406
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300407 {
408 .name = "c|cont",
409 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300410 .params = "",
411 .help = "resume emulation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400412 .cmd = hmp_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300413 },
414
Blue Swirl23130862009-06-06 08:22:04 +0000415STEXI
416@item c or cont
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100417@findex cont
Blue Swirl23130862009-06-06 08:22:04 +0000418Resume emulation.
419ETEXI
420
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300421 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100422 .name = "system_wakeup",
423 .args_type = "",
424 .params = "",
425 .help = "wakeup guest from suspend",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400426 .cmd = hmp_system_wakeup,
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100427 },
428
429STEXI
430@item system_wakeup
431@findex system_wakeup
432Wakeup guest from suspend.
433ETEXI
434
435 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300436 .name = "gdbserver",
437 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300438 .params = "[device]",
439 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400440 .cmd = hmp_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300441 },
442
Blue Swirl23130862009-06-06 08:22:04 +0000443STEXI
444@item gdbserver [@var{port}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100445@findex gdbserver
Blue Swirl23130862009-06-06 08:22:04 +0000446Start gdbserver session (default @var{port}=1234)
447ETEXI
448
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300449 {
450 .name = "x",
451 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300452 .params = "/fmt addr",
453 .help = "virtual memory dump starting at 'addr'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400454 .cmd = hmp_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300455 },
456
Blue Swirl23130862009-06-06 08:22:04 +0000457STEXI
458@item x/fmt @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100459@findex x
Blue Swirl23130862009-06-06 08:22:04 +0000460Virtual memory dump starting at @var{addr}.
461ETEXI
462
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300463 {
464 .name = "xp",
465 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300466 .params = "/fmt addr",
467 .help = "physical memory dump starting at 'addr'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400468 .cmd = hmp_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300469 },
470
Blue Swirl23130862009-06-06 08:22:04 +0000471STEXI
472@item xp /@var{fmt} @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100473@findex xp
Blue Swirl23130862009-06-06 08:22:04 +0000474Physical memory dump starting at @var{addr}.
475
476@var{fmt} is a format which tells the command how to format the
477data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
478
479@table @var
480@item count
481is the number of items to be dumped.
482
483@item format
484can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
485c (char) or i (asm instruction).
486
487@item size
488can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
489@code{h} or @code{w} can be specified with the @code{i} format to
490respectively select 16 or 32 bit code instruction size.
491
492@end table
493
494Examples:
495@itemize
496@item
497Dump 10 instructions at the current instruction pointer:
498@example
499(qemu) x/10i $eip
5000x90107063: ret
5010x90107064: sti
5020x90107065: lea 0x0(%esi,1),%esi
5030x90107069: lea 0x0(%edi,1),%edi
5040x90107070: ret
5050x90107071: jmp 0x90107080
5060x90107073: nop
5070x90107074: nop
5080x90107075: nop
5090x90107076: nop
510@end example
511
512@item
513Dump 80 16 bit values at the start of the video memory.
514@smallexample
515(qemu) xp/80hx 0xb8000
5160x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
5170x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
5180x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
5190x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
5200x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
5210x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
5220x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5230x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5240x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5250x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
526@end smallexample
527@end itemize
528ETEXI
529
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300530 {
Paolo Bonzinie9628442017-04-20 15:30:58 +0200531 .name = "gpa2hva",
532 .args_type = "addr:l",
533 .params = "addr",
534 .help = "print the host virtual address corresponding to a guest physical address",
535 .cmd = hmp_gpa2hva,
536 },
537
538STEXI
539@item gpa2hva @var{addr}
540@findex gpa2hva
541Print the host virtual address at which the guest's physical address @var{addr}
542is mapped.
543ETEXI
544
545#ifdef CONFIG_LINUX
546 {
547 .name = "gpa2hpa",
548 .args_type = "addr:l",
549 .params = "addr",
550 .help = "print the host physical address corresponding to a guest physical address",
551 .cmd = hmp_gpa2hpa,
552 },
553#endif
554
555STEXI
556@item gpa2hpa @var{addr}
557@findex gpa2hpa
558Print the host physical address at which the guest's physical address @var{addr}
559is mapped.
560ETEXI
561
562 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300563 .name = "p|print",
564 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300565 .params = "/fmt expr",
566 .help = "print expression value (use $reg for CPU register access)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400567 .cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300568 },
569
Blue Swirl23130862009-06-06 08:22:04 +0000570STEXI
571@item p or print/@var{fmt} @var{expr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100572@findex print
Blue Swirl23130862009-06-06 08:22:04 +0000573Print expression value. Only the @var{format} part of @var{fmt} is
574used.
575ETEXI
576
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300577 {
578 .name = "i",
579 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300580 .params = "/fmt addr",
581 .help = "I/O port read",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400582 .cmd = hmp_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300583 },
584
Blue Swirl23130862009-06-06 08:22:04 +0000585STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100586@item i/@var{fmt} @var{addr} [.@var{index}]
587@findex i
Blue Swirl23130862009-06-06 08:22:04 +0000588Read I/O port.
589ETEXI
590
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300591 {
592 .name = "o",
593 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300594 .params = "/fmt addr value",
595 .help = "I/O port write",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400596 .cmd = hmp_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300597 },
598
Jan Kiszkaf1147842009-07-14 10:20:11 +0200599STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100600@item o/@var{fmt} @var{addr} @var{val}
601@findex o
Jan Kiszkaf1147842009-07-14 10:20:11 +0200602Write to I/O port.
603ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000604
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300605 {
606 .name = "sendkey",
Amos Kong2ef20c12012-08-31 10:56:22 +0800607 .args_type = "keys:s,hold-time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300608 .params = "keys [hold_ms]",
609 .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 +0400610 .cmd = hmp_sendkey,
Hani Benhabiles29136cd2014-05-07 23:41:27 +0100611 .command_completion = sendkey_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300612 },
613
Blue Swirl23130862009-06-06 08:22:04 +0000614STEXI
615@item sendkey @var{keys}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100616@findex sendkey
Amos Kong886cc702012-08-31 10:56:20 +0800617Send @var{keys} to the guest. @var{keys} could be the name of the
618key or the raw value in hexadecimal format. Use @code{-} to press
619several keys simultaneously. Example:
Blue Swirl23130862009-06-06 08:22:04 +0000620@example
621sendkey ctrl-alt-f1
622@end example
623
624This command is useful to send keys that your graphical user interface
625intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
626ETEXI
627
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300628 {
629 .name = "system_reset",
630 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300631 .params = "",
632 .help = "reset the system",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400633 .cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300634 },
635
Blue Swirl23130862009-06-06 08:22:04 +0000636STEXI
637@item system_reset
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100638@findex system_reset
Blue Swirl23130862009-06-06 08:22:04 +0000639Reset the system.
640ETEXI
641
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300642 {
643 .name = "system_powerdown",
644 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300645 .params = "",
646 .help = "send system power down event",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400647 .cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300648 },
649
Blue Swirl23130862009-06-06 08:22:04 +0000650STEXI
651@item system_powerdown
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100652@findex system_powerdown
Blue Swirl23130862009-06-06 08:22:04 +0000653Power down the system (if supported).
654ETEXI
655
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300656 {
657 .name = "sum",
658 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300659 .params = "addr size",
660 .help = "compute the checksum of a memory region",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400661 .cmd = hmp_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300662 },
663
Blue Swirl23130862009-06-06 08:22:04 +0000664STEXI
665@item sum @var{addr} @var{size}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100666@findex sum
Blue Swirl23130862009-06-06 08:22:04 +0000667Compute the checksum of a memory region.
668ETEXI
669
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300670 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300671 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100672 .args_type = "device:O",
673 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300674 .help = "add device, like -device on the command line",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400675 .cmd = hmp_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100676 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300677 },
678
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200679STEXI
680@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100681@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200682Add device.
683ETEXI
684
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300685 {
686 .name = "device_del",
687 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300688 .params = "device",
689 .help = "remove device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400690 .cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100691 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300692 },
693
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200694STEXI
695@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100696@findex device_del
Daniel P. Berrange6287d822015-09-11 13:33:56 +0100697Remove device @var{id}. @var{id} may be a short ID
698or a QOM object path.
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200699ETEXI
700
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300701 {
702 .name = "cpu",
703 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300704 .params = "index",
705 .help = "set the default CPU",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400706 .cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300707 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200708
Blue Swirl23130862009-06-06 08:22:04 +0000709STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200710@item cpu @var{index}
711@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000712Set the default CPU.
713ETEXI
714
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300715 {
716 .name = "mouse_move",
717 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300718 .params = "dx dy [dz]",
719 .help = "send mouse move events",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400720 .cmd = hmp_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300721 },
722
Blue Swirl23130862009-06-06 08:22:04 +0000723STEXI
724@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100725@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000726Move the active mouse to the specified coordinates @var{dx} @var{dy}
727with optional scroll axis @var{dz}.
728ETEXI
729
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300730 {
731 .name = "mouse_button",
732 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300733 .params = "state",
734 .help = "change mouse button state (1=L, 2=M, 4=R)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400735 .cmd = hmp_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300736 },
737
Blue Swirl23130862009-06-06 08:22:04 +0000738STEXI
739@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100740@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000741Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
742ETEXI
743
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300744 {
745 .name = "mouse_set",
746 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300747 .params = "index",
748 .help = "set which mouse device receives events",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400749 .cmd = hmp_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300750 },
751
Blue Swirl23130862009-06-06 08:22:04 +0000752STEXI
753@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100754@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000755Set which mouse device receives events at given @var{index}, index
756can be obtained with
757@example
758info mice
759@end example
760ETEXI
761
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300762 {
763 .name = "wavcapture",
764 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300765 .params = "path [frequency [bits [channels]]]",
766 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400767 .cmd = hmp_wavcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300768 },
Blue Swirl23130862009-06-06 08:22:04 +0000769STEXI
770@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100771@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000772Capture audio into @var{filename}. Using sample rate @var{frequency}
773bits per sample @var{bits} and number of channels @var{channels}.
774
775Defaults:
776@itemize @minus
777@item Sample rate = 44100 Hz - CD quality
778@item Bits = 16
779@item Number of channels = 2 - Stereo
780@end itemize
781ETEXI
782
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300783 {
784 .name = "stopcapture",
785 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300786 .params = "capture index",
787 .help = "stop capture",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400788 .cmd = hmp_stopcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300789 },
Blue Swirl23130862009-06-06 08:22:04 +0000790STEXI
791@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100792@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000793Stop capture with a given @var{index}, index can be obtained with
794@example
795info capture
796@end example
797ETEXI
798
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300799 {
800 .name = "memsave",
801 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300802 .params = "addr size file",
803 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400804 .cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300805 },
806
Blue Swirl23130862009-06-06 08:22:04 +0000807STEXI
808@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100809@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000810save to disk virtual memory dump starting at @var{addr} of size @var{size}.
811ETEXI
812
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300813 {
814 .name = "pmemsave",
815 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300816 .params = "addr size file",
817 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400818 .cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300819 },
820
Blue Swirl23130862009-06-06 08:22:04 +0000821STEXI
822@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100823@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000824save to disk physical memory dump starting at @var{addr} of size @var{size}.
825ETEXI
826
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300827 {
828 .name = "boot_set",
829 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300830 .params = "bootdevice",
831 .help = "define new values for the boot device list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400832 .cmd = hmp_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300833 },
834
Blue Swirl23130862009-06-06 08:22:04 +0000835STEXI
836@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100837@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000838Define new values for the boot device list. Those values will override
839the values specified on the command line through the @code{-boot} option.
840
841The values that can be specified here depend on the machine type, but are
842the same that can be specified in the @code{-boot} command line option.
843ETEXI
844
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300845 {
846 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300847 .args_type = "",
848 .params = "",
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000849 .help = "inject an NMI",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400850 .cmd = hmp_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300851 },
Blue Swirl23130862009-06-06 08:22:04 +0000852STEXI
853@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100854@findex nmi
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000855Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
Lei Li1f590cf2013-01-25 00:03:20 +0800856
857ETEXI
858
859 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100860 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800861 .args_type = "device:s,data:s",
862 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100863 .help = "Write to a ring buffer character device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400864 .cmd = hmp_ringbuf_write,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100865 .command_completion = ringbuf_write_completion,
Lei Li1f590cf2013-01-25 00:03:20 +0800866 },
867
868STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100869@item ringbuf_write @var{device} @var{data}
870@findex ringbuf_write
871Write @var{data} to ring buffer character device @var{device}.
872@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800873
Blue Swirl23130862009-06-06 08:22:04 +0000874ETEXI
875
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300876 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100877 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800878 .args_type = "device:s,size:i",
879 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100880 .help = "Read from a ring buffer character device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400881 .cmd = hmp_ringbuf_read,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100882 .command_completion = ringbuf_write_completion,
Lei Li49b6d722013-01-25 00:03:21 +0800883 },
884
885STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100886@item ringbuf_read @var{device}
887@findex ringbuf_read
888Read and print up to @var{size} bytes from ring buffer character
889device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100890Certain non-printable characters are printed \uXXXX, where XXXX is the
891character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100892Bug: can screw up when the buffer contains invalid UTF-8 sequences,
893NUL characters, after the ring buffer lost data, and when reading
894stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800895
896ETEXI
897
898 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300899 .name = "migrate",
Peter Xu7a4da282018-05-02 18:47:23 +0800900 .args_type = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
901 .params = "[-d] [-b] [-i] [-r] uri",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200902 .help = "migrate to URI (using -d to not wait for completion)"
903 "\n\t\t\t -b for migration without shared storage with"
904 " full copy of disk\n\t\t\t -i for migration without "
905 "shared storage with incremental copy of disk "
Peter Xu7a4da282018-05-02 18:47:23 +0800906 "(base image shared between src and destination)"
907 "\n\t\t\t -r to resume a paused migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400908 .cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300909 },
910
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200911
Blue Swirl23130862009-06-06 08:22:04 +0000912STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200913@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100914@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000915Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200916 -b for migration with full copy of disk
917 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000918ETEXI
919
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300920 {
921 .name = "migrate_cancel",
922 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300923 .params = "",
924 .help = "cancel the current VM migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400925 .cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300926 },
927
Blue Swirl23130862009-06-06 08:22:04 +0000928STEXI
929@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100930@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000931Cancel the current VM migration.
Dr. David Alan Gilbert94ae12c2017-10-20 10:05:54 +0100932ETEXI
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300933
Dr. David Alan Gilbert94ae12c2017-10-20 10:05:54 +0100934 {
935 .name = "migrate_continue",
936 .args_type = "state:s",
937 .params = "state",
938 .help = "Continue migration from the given paused state",
939 .cmd = hmp_migrate_continue,
940 },
941STEXI
942@item migrate_continue @var{state}
943@findex migrate_continue
944Continue migration from the paused state @var{state}
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300945ETEXI
946
947 {
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000948 .name = "migrate_incoming",
949 .args_type = "uri:s",
950 .params = "uri",
951 .help = "Continue an incoming migration from an -incoming defer",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400952 .cmd = hmp_migrate_incoming,
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000953 },
954
955STEXI
956@item migrate_incoming @var{uri}
957@findex migrate_incoming
958Continue an incoming migration using the @var{uri} (that has the same syntax
959as the -incoming option).
Peter Xu3b563c42018-05-02 18:47:37 +0800960ETEXI
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000961
Peter Xu3b563c42018-05-02 18:47:37 +0800962 {
963 .name = "migrate_recover",
964 .args_type = "uri:s",
965 .params = "uri",
966 .help = "Continue a paused incoming postcopy migration",
967 .cmd = hmp_migrate_recover,
968 },
969
970STEXI
971@item migrate_recover @var{uri}
972@findex migrate_recover
973Continue a paused incoming postcopy migration using the @var{uri}.
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000974ETEXI
975
976 {
Peter Xud37297d2018-05-02 18:47:40 +0800977 .name = "migrate_pause",
978 .args_type = "",
979 .params = "",
980 .help = "Pause an ongoing migration (postcopy-only)",
981 .cmd = hmp_migrate_pause,
982 },
983
984STEXI
985@item migrate_pause
986@findex migrate_pause
987Pause an ongoing migration. Currently it only supports postcopy.
988ETEXI
989
990 {
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300991 .name = "migrate_set_cache_size",
992 .args_type = "value:o",
993 .params = "value",
994 .help = "set cache size (in bytes) for XBZRLE migrations,"
995 "the cache size will be rounded down to the nearest "
996 "power of 2.\n"
997 "The cache size affects the number of cache misses."
998 "In case of a high cache miss ratio you need to increase"
999 " the cache size",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001000 .cmd = hmp_migrate_set_cache_size,
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +03001001 },
1002
1003STEXI
1004@item migrate_set_cache_size @var{value}
1005@findex migrate_set_cache_size
1006Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +00001007ETEXI
1008
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001009 {
1010 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +02001011 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001012 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +02001013 .help = "set maximum speed (in bytes) for migrations. "
1014 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001015 .cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001016 },
1017
Blue Swirl23130862009-06-06 08:22:04 +00001018STEXI
1019@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001020@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +00001021Set maximum speed to @var{value} (in bytes) for migrations.
1022ETEXI
1023
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001024 {
1025 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +01001026 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001027 .params = "value",
1028 .help = "set maximum tolerated downtime (in seconds) for migrations",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001029 .cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001030 },
Glauber Costa2ea42952009-05-28 15:22:58 -04001031
1032STEXI
1033@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001034@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -04001035Set maximum tolerated downtime (in seconds) for migration.
1036ETEXI
1037
Jes Sorensenf8882562010-12-16 13:52:16 +01001038 {
Orit Wasserman00458432012-08-06 21:42:48 +03001039 .name = "migrate_set_capability",
1040 .args_type = "capability:s,state:b",
1041 .params = "capability state",
1042 .help = "Enable/Disable the usage of a capability for migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001043 .cmd = hmp_migrate_set_capability,
Hani Benhabilesc68a0402014-05-27 23:39:32 +01001044 .command_completion = migrate_set_capability_completion,
Orit Wasserman00458432012-08-06 21:42:48 +03001045 },
1046
1047STEXI
1048@item migrate_set_capability @var{capability} @var{state}
1049@findex migrate_set_capability
1050Enable/Disable the usage of a capability @var{capability} for migration.
1051ETEXI
1052
1053 {
Liang Li50e9a622015-03-23 16:32:29 +08001054 .name = "migrate_set_parameter",
Daniel P. Berrange69ef1f32016-04-27 11:05:15 +01001055 .args_type = "parameter:s,value:s",
Liang Li50e9a622015-03-23 16:32:29 +08001056 .params = "parameter value",
1057 .help = "Set the parameter for migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001058 .cmd = hmp_migrate_set_parameter,
Liang Li50e9a622015-03-23 16:32:29 +08001059 .command_completion = migrate_set_parameter_completion,
1060 },
1061
1062STEXI
1063@item migrate_set_parameter @var{parameter} @var{value}
1064@findex migrate_set_parameter
1065Set the parameter @var{parameter} for migration.
1066ETEXI
1067
1068 {
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001069 .name = "migrate_start_postcopy",
1070 .args_type = "",
1071 .params = "",
Dr. David Alan Gilberta54d3402015-11-12 11:34:44 +00001072 .help = "Followup to a migration command to switch the migration"
Dr. David Alan Gilbert32c3db52016-03-11 09:53:36 +00001073 " to postcopy mode. The postcopy-ram capability must "
Greg Kurzc2eb7f22018-02-07 16:41:43 +01001074 "be set on both source and destination before the "
1075 "original migration command .",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001076 .cmd = hmp_migrate_start_postcopy,
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001077 },
1078
1079STEXI
1080@item migrate_start_postcopy
1081@findex migrate_start_postcopy
1082Switch in-progress migration to postcopy mode. Ignored after the end of
1083migration (or once already in postcopy).
1084ETEXI
1085
1086 {
zhanghailiangd89e6662016-10-27 14:43:03 +08001087 .name = "x_colo_lost_heartbeat",
1088 .args_type = "",
1089 .params = "",
1090 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1091 "a failover or takeover is needed.",
1092 .cmd = hmp_x_colo_lost_heartbeat,
1093 },
1094
1095STEXI
1096@item x_colo_lost_heartbeat
1097@findex x_colo_lost_heartbeat
1098Tell COLO that heartbeat is lost, a failover or takeover is needed.
1099ETEXI
1100
1101 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001102 .name = "client_migrate_info",
1103 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1104 .params = "protocol hostname port tls-port cert-subject",
Markus Armbruster13cadef2015-03-05 19:16:58 +01001105 .help = "set migration information for remote display",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001106 .cmd = hmp_client_migrate_info,
Jes Sorensenf8882562010-12-16 13:52:16 +01001107 },
1108
1109STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001110@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1111@findex client_migrate_info
Markus Armbruster13cadef2015-03-05 19:16:58 +01001112Set migration information for remote display. This makes the server
1113ask the client to automatically reconnect using the new parameters
1114once migration finished successfully. Only implemented for SPICE.
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001115ETEXI
1116
Wen Congyang783e9b42012-05-07 12:10:47 +08001117 {
1118 .name = "dump-guest-memory",
Peter Xu228de9c2016-02-18 13:16:47 +08001119 .args_type = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1120 .params = "[-p] [-d] [-z|-l|-s] filename [begin length]",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001121 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1122 "-p: do paging to get guest's memory mapping.\n\t\t\t"
Peter Xu228de9c2016-02-18 13:16:47 +08001123 "-d: return immediately (do not wait for completion).\n\t\t\t"
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001124 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1125 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1126 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001127 "begin: the starting physical address.\n\t\t\t"
1128 "length: the memory size, in bytes.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001129 .cmd = hmp_dump_guest_memory,
Wen Congyang783e9b42012-05-07 12:10:47 +08001130 },
1131
1132
1133STEXI
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001134@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001135@item dump-guest-memory [-z|-l|-s] @var{filename}
Wen Congyang783e9b42012-05-07 12:10:47 +08001136@findex dump-guest-memory
1137Dump guest memory to @var{protocol}. The file can be processed with crash or
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001138gdb. Without -z|-l|-s, the dump format is ELF.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001139 -p: do paging to get guest's memory mapping.
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001140 -z: dump in kdump-compressed format, with zlib compression.
1141 -l: dump in kdump-compressed format, with lzo compression.
1142 -s: dump in kdump-compressed format, with snappy compression.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001143 filename: dump file name.
Wen Congyang783e9b42012-05-07 12:10:47 +08001144 begin: the starting physical address. It's optional, and should be
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001145 specified together with length.
Wen Congyang783e9b42012-05-07 12:10:47 +08001146 length: the memory size, in bytes. It's optional, and should be specified
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001147 together with begin.
Wen Congyang783e9b42012-05-07 12:10:47 +08001148ETEXI
Wen Congyang783e9b42012-05-07 12:10:47 +08001149
Jason J. Hernea4538a52015-06-26 14:07:21 -04001150#if defined(TARGET_S390X)
1151 {
1152 .name = "dump-skeys",
1153 .args_type = "filename:F",
1154 .params = "",
1155 .help = "Save guest storage keys into file 'filename'.\n",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001156 .cmd = hmp_dump_skeys,
Jason J. Hernea4538a52015-06-26 14:07:21 -04001157 },
1158#endif
1159
1160STEXI
1161@item dump-skeys @var{filename}
1162@findex dump-skeys
1163Save guest storage keys to a file.
1164ETEXI
1165
Claudio Imbrendaf860d492016-08-15 18:44:04 +02001166#if defined(TARGET_S390X)
1167 {
1168 .name = "migration_mode",
1169 .args_type = "mode:i",
1170 .params = "mode",
1171 .help = "Enables or disables migration mode\n",
1172 .cmd = hmp_migrationmode,
1173 },
1174#endif
1175
1176STEXI
1177@item migration_mode @var{mode}
1178@findex migration_mode
1179Enables or disables migration mode.
1180ETEXI
1181
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001182 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001183 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001184 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1185 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001186 .help = "initiates a live snapshot\n\t\t\t"
1187 "of device. If a new image file is specified, the\n\t\t\t"
1188 "new image file will become the new root image.\n\t\t\t"
1189 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001190 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001191 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1192 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1193 "recreating it from scratch.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001194 .cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001195 },
1196
1197STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001198@item snapshot_blkdev
1199@findex snapshot_blkdev
1200Snapshot device, using snapshot file as target if provided
1201ETEXI
1202
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001203 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001204 .name = "snapshot_blkdev_internal",
1205 .args_type = "device:B,name:s",
1206 .params = "device name",
1207 .help = "take an internal snapshot of device.\n\t\t\t"
1208 "The format of the image used by device must\n\t\t\t"
1209 "support it, such as qcow2.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001210 .cmd = hmp_snapshot_blkdev_internal,
Wenchao Xia775ca882013-09-11 14:04:37 +08001211 },
1212
1213STEXI
1214@item snapshot_blkdev_internal
1215@findex snapshot_blkdev_internal
1216Take an internal snapshot on device if it support
1217ETEXI
1218
1219 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001220 .name = "snapshot_delete_blkdev_internal",
1221 .args_type = "device:B,name:s,id:s?",
1222 .params = "device name [id]",
1223 .help = "delete an internal snapshot of device.\n\t\t\t"
1224 "If id is specified, qemu will try delete\n\t\t\t"
1225 "the snapshot matching both id and name.\n\t\t\t"
1226 "The format of the image used by device must\n\t\t\t"
1227 "support it, such as qcow2.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001228 .cmd = hmp_snapshot_delete_blkdev_internal,
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001229 },
1230
1231STEXI
1232@item snapshot_delete_blkdev_internal
1233@findex snapshot_delete_blkdev_internal
1234Delete an internal snapshot on device if it support
1235ETEXI
1236
1237 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001238 .name = "drive_mirror",
1239 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1240 .params = "[-n] [-f] device target [format]",
1241 .help = "initiates live storage\n\t\t\t"
1242 "migration for a device. The device's contents are\n\t\t\t"
1243 "copied to the new image file, including data that\n\t\t\t"
1244 "is written after the command is started.\n\t\t\t"
1245 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1246 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1247 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1248 "so that the result does not need a backing file.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001249 .cmd = hmp_drive_mirror,
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001250 },
1251STEXI
1252@item drive_mirror
1253@findex drive_mirror
1254Start mirroring a block device's writes to a new destination,
1255using the specified target.
1256ETEXI
1257
1258 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001259 .name = "drive_backup",
Pavel Butsykin13b94142016-07-22 11:17:52 +03001260 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1261 .params = "[-n] [-f] [-c] device target [format]",
Stefan Hajnoczide909302013-06-26 14:11:58 +02001262 .help = "initiates a point-in-time\n\t\t\t"
1263 "copy for a device. The device's contents are\n\t\t\t"
1264 "copied to the new image file, excluding data that\n\t\t\t"
1265 "is written after the command is started.\n\t\t\t"
1266 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1267 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1268 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
Pavel Butsykin13b94142016-07-22 11:17:52 +03001269 "so that the result does not need a backing file.\n\t\t\t"
1270 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1271 "(if the target format supports it).\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001272 .cmd = hmp_drive_backup,
Stefan Hajnoczide909302013-06-26 14:11:58 +02001273 },
1274STEXI
1275@item drive_backup
1276@findex drive_backup
1277Start a point-in-time copy of a block device to a specificed target.
1278ETEXI
1279
1280 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001281 .name = "drive_add",
Kevin Wolfabb21ac2016-02-23 17:33:24 +01001282 .args_type = "node:-n,pci_addr:s,opts:s",
1283 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001284 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001285 "[,unit=m][,media=d][,index=i]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001286 "[,snapshot=on|off][,cache=on|off]\n"
1287 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001288 .help = "add drive to PCI storage controller",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001289 .cmd = hmp_drive_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001290 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001291
Blue Swirl23130862009-06-06 08:22:04 +00001292STEXI
1293@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001294@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001295Add drive to PCI storage controller.
1296ETEXI
1297
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001298 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001299 .name = "pcie_aer_inject_error",
1300 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1301 "id:s,error_status:s,"
1302 "header0:i?,header1:i?,header2:i?,header3:i?,"
1303 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1304 .params = "[-a] [-c] id "
1305 "<error_status> [<tlp header> [<tlp header prefix>]]",
1306 .help = "inject pcie aer error\n\t\t\t"
1307 " -a for advisory non fatal error\n\t\t\t"
1308 " -c for correctable error\n\t\t\t"
1309 "<id> = qdev device id\n\t\t\t"
1310 "<error_status> = error string or 32bit\n\t\t\t"
1311 "<tlb header> = 32bit x 4\n\t\t\t"
1312 "<tlb header prefix> = 32bit x 4",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001313 .cmd = hmp_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001314 },
1315
1316STEXI
1317@item pcie_aer_inject_error
1318@findex pcie_aer_inject_error
1319Inject PCIe AER error
1320ETEXI
1321
1322 {
Markus Armbrusterae82d322010-03-25 17:22:40 +01001323 .name = "netdev_add",
1324 .args_type = "netdev:O",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001325 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001326 .help = "add host network device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001327 .cmd = hmp_netdev_add,
Hani Benhabilesb162b492014-05-07 23:41:31 +01001328 .command_completion = netdev_add_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001329 },
1330
1331STEXI
1332@item netdev_add
1333@findex netdev_add
1334Add host network device.
1335ETEXI
1336
1337 {
1338 .name = "netdev_del",
1339 .args_type = "id:s",
1340 .params = "id",
1341 .help = "remove host network device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001342 .cmd = hmp_netdev_del,
Hani Benhabiles11b389f2014-05-07 23:41:32 +01001343 .command_completion = netdev_del_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001344 },
1345
1346STEXI
1347@item netdev_del
1348@findex netdev_del
1349Remove host network device.
1350ETEXI
1351
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001352 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001353 .name = "object_add",
1354 .args_type = "object:O",
1355 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1356 .help = "create QOM object",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001357 .cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001358 .command_completion = object_add_completion,
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001359 },
1360
1361STEXI
1362@item object_add
1363@findex object_add
1364Create QOM object.
1365ETEXI
1366
1367 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001368 .name = "object_del",
1369 .args_type = "id:s",
1370 .params = "id",
1371 .help = "destroy QOM object",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001372 .cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001373 .command_completion = object_del_completion,
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001374 },
1375
1376STEXI
1377@item object_del
1378@findex object_del
1379Destroy QOM object.
1380ETEXI
1381
Blue Swirl23130862009-06-06 08:22:04 +00001382#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001383 {
1384 .name = "hostfwd_add",
1385 .args_type = "arg1:s,arg2:s?,arg3:s?",
Thomas Huth93653062018-01-11 21:02:40 +01001386 .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001387 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001388 .cmd = hmp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001389 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001390#endif
1391STEXI
1392@item hostfwd_add
1393@findex hostfwd_add
1394Redirect TCP or UDP connections from host to guest (requires -net user).
1395ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001396
Markus Armbruster21413d62010-05-04 13:20:30 +02001397#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001398 {
1399 .name = "hostfwd_remove",
1400 .args_type = "arg1:s,arg2:s?,arg3:s?",
Thomas Huth93653062018-01-11 21:02:40 +01001401 .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001402 .help = "remove host-to-guest TCP or UDP redirection",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001403 .cmd = hmp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001404 },
1405
Blue Swirl23130862009-06-06 08:22:04 +00001406#endif
1407STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001408@item hostfwd_remove
1409@findex hostfwd_remove
1410Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001411ETEXI
1412
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001413 {
1414 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001415 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001416 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001417 .help = "request VM to change its memory allocation (in MB)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001418 .cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001419 },
1420
Blue Swirl23130862009-06-06 08:22:04 +00001421STEXI
1422@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001423@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001424Request VM to change its memory allocation to @var{value} (in MB).
1425ETEXI
1426
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001427 {
1428 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001429 .args_type = "name:s,up:b",
1430 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001431 .help = "change the link status of a network adapter",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001432 .cmd = hmp_set_link,
Hani Benhabiles40d19392014-05-07 23:41:30 +01001433 .command_completion = set_link_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001434 },
1435
Blue Swirl23130862009-06-06 08:22:04 +00001436STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001437@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001438@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001439Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001440ETEXI
1441
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001442 {
1443 .name = "watchdog_action",
1444 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001445 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1446 .help = "change watchdog action",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001447 .cmd = hmp_watchdog_action,
Hani Benhabilesd0ece342014-05-27 23:39:31 +01001448 .command_completion = watchdog_action_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001449 },
1450
Blue Swirl23130862009-06-06 08:22:04 +00001451STEXI
1452@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001453@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001454Change watchdog action.
1455ETEXI
1456
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001457 {
1458 .name = "acl_show",
1459 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001460 .params = "aclname",
1461 .help = "list rules in the access control list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001462 .cmd = hmp_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001463 },
1464
Blue Swirl23130862009-06-06 08:22:04 +00001465STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001466@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001467@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001468List all the matching rules in the access control list, and the default
1469policy. There are currently two named access control lists,
1470@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1471certificate distinguished name, and SASL username respectively.
1472ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001473
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001474 {
1475 .name = "acl_policy",
1476 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001477 .params = "aclname allow|deny",
1478 .help = "set default access control list policy",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001479 .cmd = hmp_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001480 },
1481
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001482STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001483@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001484@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001485Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001486none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001487always @code{deny}.
1488ETEXI
1489
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001490 {
1491 .name = "acl_add",
1492 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001493 .params = "aclname match allow|deny [index]",
1494 .help = "add a match rule to the access control list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001495 .cmd = hmp_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001496 },
1497
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001498STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001499@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1500@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001501Add a match rule to the access control list, allowing or denying access.
1502The match will normally be an exact username or x509 distinguished name,
1503but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1504allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001505normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001506earlier in the list if the optional @var{index} parameter is supplied.
1507ETEXI
1508
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001509 {
1510 .name = "acl_remove",
1511 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001512 .params = "aclname match",
1513 .help = "remove a match rule from the access control list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001514 .cmd = hmp_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001515 },
1516
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001517STEXI
1518@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001519@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001520Remove the specified match rule from the access control list.
1521ETEXI
1522
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001523 {
1524 .name = "acl_reset",
1525 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001526 .params = "aclname",
1527 .help = "reset the access control list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001528 .cmd = hmp_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001529 },
1530
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001531STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001532@item acl_reset @var{aclname}
1533@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001534Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001535policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001536ETEXI
1537
Paolo Bonzini40577252012-08-23 11:53:04 +02001538 {
1539 .name = "nbd_server_start",
1540 .args_type = "all:-a,writable:-w,uri:s",
1541 .params = "nbd_server_start [-a] [-w] host:port",
1542 .help = "serve block devices on the given host and port",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001543 .cmd = hmp_nbd_server_start,
Paolo Bonzini40577252012-08-23 11:53:04 +02001544 },
1545STEXI
1546@item nbd_server_start @var{host}:@var{port}
1547@findex nbd_server_start
1548Start an NBD server on the given host and/or port. If the @option{-a}
1549option is included, all of the virtual machine's block devices that
1550have an inserted media on them are automatically exported; in this case,
1551the @option{-w} option makes the devices writable too.
1552ETEXI
1553
1554 {
1555 .name = "nbd_server_add",
Eric Blakedba49322018-01-09 13:28:02 -06001556 .args_type = "writable:-w,device:B,name:s?",
1557 .params = "nbd_server_add [-w] device [name]",
Paolo Bonzini40577252012-08-23 11:53:04 +02001558 .help = "export a block device via NBD",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001559 .cmd = hmp_nbd_server_add,
Paolo Bonzini40577252012-08-23 11:53:04 +02001560 },
1561STEXI
Eric Blakedba49322018-01-09 13:28:02 -06001562@item nbd_server_add @var{device} [ @var{name} ]
Paolo Bonzini40577252012-08-23 11:53:04 +02001563@findex nbd_server_add
1564Export a block device through QEMU's NBD server, which must be started
1565beforehand with @command{nbd_server_start}. The @option{-w} option makes the
Eric Blakedba49322018-01-09 13:28:02 -06001566exported device writable too. The export name is controlled by @var{name},
1567defaulting to @var{device}.
Paolo Bonzini40577252012-08-23 11:53:04 +02001568ETEXI
1569
1570 {
Eric Blake08fb10a2018-01-25 08:45:57 -06001571 .name = "nbd_server_remove",
1572 .args_type = "force:-f,name:s",
1573 .params = "nbd_server_remove [-f] name",
1574 .help = "remove an export previously exposed via NBD",
1575 .cmd = hmp_nbd_server_remove,
1576 },
1577STEXI
1578@item nbd_server_remove [-f] @var{name}
1579@findex nbd_server_remove
1580Stop exporting a block device through QEMU's NBD server, which was
1581previously started with @command{nbd_server_add}. The @option{-f}
1582option forces the server to drop the export immediately even if
1583clients are connected; otherwise the command fails unless there are no
1584clients.
1585ETEXI
1586
1587 {
Paolo Bonzini40577252012-08-23 11:53:04 +02001588 .name = "nbd_server_stop",
1589 .args_type = "",
1590 .params = "nbd_server_stop",
1591 .help = "stop serving block devices using the NBD protocol",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001592 .cmd = hmp_nbd_server_stop,
Paolo Bonzini40577252012-08-23 11:53:04 +02001593 },
1594STEXI
1595@item nbd_server_stop
1596@findex nbd_server_stop
1597Stop the QEMU embedded NBD server.
1598ETEXI
1599
1600
Huang Ying79c4f6b2009-06-23 10:05:14 +08001601#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001602
1603 {
1604 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001605 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1606 .params = "[-b] cpu bank status mcgstatus addr misc",
1607 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001608 .cmd = hmp_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001609 },
1610
Huang Ying79c4f6b2009-06-23 10:05:14 +08001611#endif
1612STEXI
1613@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001614@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001615Inject an MCE on the given CPU (x86 only).
1616ETEXI
1617
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001618 {
1619 .name = "getfd",
1620 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001621 .params = "getfd name",
1622 .help = "receive a file descriptor via SCM rights and assign it a name",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001623 .cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001624 },
1625
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001626STEXI
1627@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001628@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001629If a file descriptor is passed alongside this command using the SCM_RIGHTS
1630mechanism on unix sockets, it is stored using the name @var{fdname} for
1631later use by other monitor commands.
1632ETEXI
1633
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001634 {
1635 .name = "closefd",
1636 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001637 .params = "closefd name",
1638 .help = "close a file descriptor previously passed via SCM rights",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001639 .cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001640 },
1641
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001642STEXI
1643@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001644@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001645Close the file descriptor previously assigned to @var{fdname} using the
1646@code{getfd} command. This is only needed if the file descriptor was never
1647used by another monitor command.
1648ETEXI
1649
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001650 {
1651 .name = "block_passwd",
1652 .args_type = "device:B,password:s",
1653 .params = "block_passwd device password",
1654 .help = "set the password of encrypted block devices",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001655 .cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001656 },
1657
1658STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001659@item block_passwd @var{device} @var{password}
1660@findex block_passwd
1661Set the encrypted device @var{device} password to @var{password}
Daniel P. Berrangec01c2142017-06-23 17:24:16 +01001662
1663This command is now obsolete and will always return an error since 2.10
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001664ETEXI
1665
1666 {
1667 .name = "block_set_io_throttle",
1668 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1669 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1670 .help = "change I/O throttle limits for a block drive",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001671 .cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001672 },
1673
1674STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001675@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1676@findex block_set_io_throttle
Alberto Garcia83592182018-03-09 16:11:07 +02001677Change 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}.
1678@var{device} can be a block device name, a qdev ID or a QOM path.
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001679ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001680
Jan Kiszka33572ec2010-05-31 14:43:30 -03001681 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001682 .name = "set_password",
1683 .args_type = "protocol:s,password:s,connected:s?",
1684 .params = "protocol password action-if-connected",
1685 .help = "set spice/vnc password",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001686 .cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001687 },
1688
1689STEXI
1690@item set_password [ vnc | spice ] password [ action-if-connected ]
1691@findex set_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001692Change spice/vnc password. Use zero to make the password stay valid
1693forever. @var{action-if-connected} specifies what should happen in
1694case a connection is established: @var{fail} makes the password change
1695fail. @var{disconnect} changes the password and disconnects the
1696client. @var{keep} changes the password and keeps the connection up.
1697@var{keep} is the default.
1698ETEXI
1699
1700 {
1701 .name = "expire_password",
1702 .args_type = "protocol:s,time:s",
1703 .params = "protocol time",
1704 .help = "set spice/vnc password expire-time",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001705 .cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001706 },
1707
1708STEXI
1709@item expire_password [ vnc | spice ] expire-time
1710@findex expire_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001711Specify when a password for spice/vnc becomes
1712invalid. @var{expire-time} accepts:
1713
1714@table @var
1715@item now
1716Invalidate password instantly.
1717
1718@item never
1719Password stays valid forever.
1720
1721@item +nsec
1722Password stays valid for @var{nsec} seconds starting now.
1723
1724@item nsec
1725Password is invalidated at the given time. @var{nsec} are the seconds
1726passed since 1970, i.e. unix epoch.
1727
1728@end table
1729ETEXI
1730
Gerd Hoffmann46920822013-02-28 08:46:10 +01001731 {
1732 .name = "chardev-add",
1733 .args_type = "args:s",
1734 .params = "args",
1735 .help = "add chardev",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001736 .cmd = hmp_chardev_add,
Hani Benhabiles13e315d2014-05-07 23:41:29 +01001737 .command_completion = chardev_add_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001738 },
1739
1740STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001741@item chardev-add args
1742@findex chardev-add
Anton Nefedov75b60162017-07-06 15:08:57 +03001743chardev-add accepts the same parameters as the -chardev command line switch.
1744
1745ETEXI
1746
1747 {
1748 .name = "chardev-change",
1749 .args_type = "id:s,args:s",
1750 .params = "id args",
1751 .help = "change chardev",
1752 .cmd = hmp_chardev_change,
1753 },
1754
1755STEXI
1756@item chardev-change args
1757@findex chardev-change
1758chardev-change accepts existing chardev @var{id} and then the same arguments
1759as the -chardev command line switch (except for "id").
Gerd Hoffmann46920822013-02-28 08:46:10 +01001760
1761ETEXI
1762
1763 {
1764 .name = "chardev-remove",
1765 .args_type = "id:s",
1766 .params = "id",
1767 .help = "remove chardev",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001768 .cmd = hmp_chardev_remove,
Hani Benhabiles6297d9a2014-05-07 23:41:28 +01001769 .command_completion = chardev_remove_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001770 },
1771
1772STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001773@item chardev-remove id
1774@findex chardev-remove
Gerd Hoffmann46920822013-02-28 08:46:10 +01001775Removes the chardev @var{id}.
1776
1777ETEXI
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001778
1779 {
Stefan Fritschbd1d5ad2017-06-11 09:48:17 +02001780 .name = "chardev-send-break",
1781 .args_type = "id:s",
1782 .params = "id",
1783 .help = "send a break on chardev",
1784 .cmd = hmp_chardev_send_break,
1785 .command_completion = chardev_remove_completion,
1786 },
1787
1788STEXI
1789@item chardev-send-break id
1790@findex chardev-send-break
1791Send a break on the chardev @var{id}.
1792
1793ETEXI
1794
1795 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001796 .name = "qemu-io",
1797 .args_type = "device:B,command:s",
1798 .params = "[device] \"[command]\"",
1799 .help = "run a qemu-io command on a block device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001800 .cmd = hmp_qemu_io,
Kevin Wolf587da2c2013-06-05 14:19:41 +02001801 },
1802
1803STEXI
1804@item qemu-io @var{device} @var{command}
1805@findex qemu-io
Kevin Wolf587da2c2013-06-05 14:19:41 +02001806Executes a qemu-io command on the given block device.
1807
1808ETEXI
1809
1810 {
Jason J. Herneabf23322013-12-11 13:24:14 -05001811 .name = "cpu-add",
1812 .args_type = "id:i",
1813 .params = "id",
1814 .help = "add cpu",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001815 .cmd = hmp_cpu_add,
Jason J. Herneabf23322013-12-11 13:24:14 -05001816 },
1817
1818STEXI
1819@item cpu-add @var{id}
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001820@findex cpu-add
Jason J. Herneabf23322013-12-11 13:24:14 -05001821Add CPU with id @var{id}
1822ETEXI
1823
1824 {
Andreas Färber89d7fa92014-05-07 18:08:29 +02001825 .name = "qom-list",
1826 .args_type = "path:s?",
1827 .params = "path",
1828 .help = "list QOM properties",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001829 .cmd = hmp_qom_list,
Andreas Färber89d7fa92014-05-07 18:08:29 +02001830 },
1831
1832STEXI
1833@item qom-list [@var{path}]
1834Print QOM properties of object at location @var{path}
1835ETEXI
1836
1837 {
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001838 .name = "qom-set",
1839 .args_type = "path:s,property:s,value:s",
1840 .params = "path property value",
1841 .help = "set QOM property",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001842 .cmd = hmp_qom_set,
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001843 },
1844
1845STEXI
1846@item qom-set @var{path} @var{property} @var{value}
1847Set QOM property @var{property} of object at location @var{path} to value @var{value}
1848ETEXI
1849
1850 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001851 .name = "info",
1852 .args_type = "item:s?",
1853 .params = "[subcommand]",
1854 .help = "show various information about the system state",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001855 .cmd = hmp_info_help,
1856 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001857 },
1858
1859STEXI
Pavel Butsykin70703342015-09-10 18:39:00 +03001860@end table
1861ETEXI