blob: 7ce991f4dd31f162007a371bcbde29f449fa662c [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,
Dr. David Alan Gilbert31785f12018-06-20 16:39:42 +010018 .flags = "p",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030019 },
20
Blue Swirl23130862009-06-06 08:22:04 +000021STEXI
22@item help or ? [@var{cmd}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +010023@findex help
Blue Swirl23130862009-06-06 08:22:04 +000024Show the help for all commands or just for command @var{cmd}.
25ETEXI
26
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030027 {
28 .name = "commit",
29 .args_type = "device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030030 .params = "device|all",
31 .help = "commit changes to the disk images (if -snapshot is used) or backing files",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040032 .cmd = hmp_commit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030033 },
34
Blue Swirl23130862009-06-06 08:22:04 +000035STEXI
36@item commit
Stefan Weil70fcbbe2010-02-05 23:52:04 +010037@findex commit
Blue Swirl23130862009-06-06 08:22:04 +000038Commit changes to the disk images (if -snapshot is used) or backing files.
Jeff Cody37222902014-01-24 09:02:37 -050039If the backing file is smaller than the snapshot, then the backing file will be
40resized to be the same size as the snapshot. If the snapshot is smaller than
41the backing file, the backing file will not be truncated. If you want the
42backing file to match the size of the smaller snapshot, you can safely truncate
43it yourself once the commit operation successfully completes.
Blue Swirl23130862009-06-06 08:22:04 +000044ETEXI
45
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030046 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030047 .name = "q|quit",
48 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030049 .params = "",
50 .help = "quit the emulator",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040051 .cmd = hmp_quit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030052 },
53
Blue Swirl23130862009-06-06 08:22:04 +000054STEXI
55@item q or quit
Stefan Weil70fcbbe2010-02-05 23:52:04 +010056@findex quit
Blue Swirl23130862009-06-06 08:22:04 +000057Quit the emulator.
58ETEXI
59
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030060 {
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010061 .name = "block_resize",
62 .args_type = "device:B,size:o",
63 .params = "device size",
64 .help = "resize a block image",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040065 .cmd = hmp_block_resize,
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010066 },
67
68STEXI
69@item block_resize
70@findex block_resize
71Resize a block image while a guest is running. Usually requires guest
72action to see the updated size. Resize to a lower size is supported,
73but should be used with extreme caution. Note that this command only
74resizes image files, it can not resize block devices like LVM volumes.
75ETEXI
76
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000077 {
78 .name = "block_stream",
Stefan Hajnoczic83c66c2012-04-25 16:51:03 +010079 .args_type = "device:B,speed:o?,base:s?",
80 .params = "device [speed [base]]",
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000081 .help = "copy data from a backing file into a block device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040082 .cmd = hmp_block_stream,
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000083 },
84
85STEXI
86@item block_stream
87@findex block_stream
88Copy data from a backing file into a block device.
89ETEXI
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010090
91 {
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000092 .name = "block_job_set_speed",
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +010093 .args_type = "device:B,speed:o",
94 .params = "device speed",
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000095 .help = "set maximum speed for a background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040096 .cmd = hmp_block_job_set_speed,
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +000097 },
98
99STEXI
Paolo Bonzini4451b792012-04-13 12:03:46 +0200100@item block_job_set_speed
101@findex block_job_set_speed
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +0000102Set maximum speed for a background block operation.
103ETEXI
104
105 {
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000106 .name = "block_job_cancel",
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200107 .args_type = "force:-f,device:B",
108 .params = "[-f] device",
109 .help = "stop an active background block operation (use -f"
Liang Lib76e4452018-03-13 08:12:16 -0400110 "\n\t\t\t if you want to abort the operation immediately"
111 "\n\t\t\t instead of keep running until data is in sync)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400112 .cmd = hmp_block_job_cancel,
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000113 },
114
115STEXI
116@item block_job_cancel
117@findex block_job_cancel
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200118Stop an active background block operation (streaming, mirroring).
119ETEXI
120
121 {
122 .name = "block_job_complete",
123 .args_type = "device:B",
124 .params = "device",
125 .help = "stop an active background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400126 .cmd = hmp_block_job_complete,
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200127 },
128
129STEXI
130@item block_job_complete
131@findex block_job_complete
132Manually trigger completion of an active background block operation.
133For mirroring, this will switch the device to the destination path.
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000134ETEXI
135
136 {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200137 .name = "block_job_pause",
138 .args_type = "device:B",
139 .params = "device",
140 .help = "pause an active background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400141 .cmd = hmp_block_job_pause,
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200142 },
143
144STEXI
145@item block_job_pause
146@findex block_job_pause
147Pause an active block streaming operation.
148ETEXI
149
150 {
151 .name = "block_job_resume",
152 .args_type = "device:B",
153 .params = "device",
154 .help = "resume a paused background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400155 .cmd = hmp_block_job_resume,
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200156 },
157
158STEXI
159@item block_job_resume
160@findex block_job_resume
161Resume a paused block streaming operation.
162ETEXI
163
164 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300165 .name = "eject",
Luiz Capitulino78d714e2009-12-14 18:53:21 -0200166 .args_type = "force:-f,device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300167 .params = "[-f] device",
168 .help = "eject a removable medium (use -f to force it)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400169 .cmd = hmp_eject,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300170 },
171
Blue Swirl23130862009-06-06 08:22:04 +0000172STEXI
173@item eject [-f] @var{device}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100174@findex eject
Blue Swirl23130862009-06-06 08:22:04 +0000175Eject a removable medium (use -f to force it).
176ETEXI
177
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300178 {
Ryan Harper9063f812010-11-12 11:07:13 -0600179 .name = "drive_del",
Hani Benhabilesf7bdc412014-04-13 16:25:05 +0100180 .args_type = "id:B",
Ryan Harper9063f812010-11-12 11:07:13 -0600181 .params = "device",
182 .help = "remove host block device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400183 .cmd = hmp_drive_del,
Ryan Harper9063f812010-11-12 11:07:13 -0600184 },
185
186STEXI
187@item drive_del @var{device}
188@findex drive_del
189Remove host block device. The result is that guest generated IO is no longer
190submitted against the host device underlying the disk. Once a drive has
191been deleted, the QEMU Block layer returns -EIO which results in IO
192errors in the guest for applications that are reading/writing to the device.
Stefan Hajnoczi293c51a2013-06-05 10:33:14 +0200193These errors are always reported to the guest, regardless of the drive's error
194actions (drive options rerror, werror).
Ryan Harper9063f812010-11-12 11:07:13 -0600195ETEXI
196
197 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300198 .name = "change",
Max Reitzbaead0a2015-10-26 21:39:18 +0100199 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
200 .params = "device filename [format [read-only-mode]]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300201 .help = "change a removable medium, optional format",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400202 .cmd = hmp_change,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300203 },
204
Blue Swirl23130862009-06-06 08:22:04 +0000205STEXI
206@item change @var{device} @var{setting}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100207@findex change
Blue Swirl23130862009-06-06 08:22:04 +0000208Change the configuration of a device.
209
210@table @option
Max Reitzbaead0a2015-10-26 21:39:18 +0100211@item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
Blue Swirl23130862009-06-06 08:22:04 +0000212Change the medium for a removable disk device to point to @var{filename}. eg
213
214@example
215(qemu) change ide1-cd0 /path/to/some.iso
216@end example
217
218@var{format} is optional.
219
Max Reitzbaead0a2015-10-26 21:39:18 +0100220@var{read-only-mode} may be used to change the read-only status of the device.
221It accepts the following values:
222
223@table @var
224@item retain
225Retains the current status; this is the default.
226
227@item read-only
228Makes the device read-only.
229
230@item read-write
231Makes the device writable.
232@end table
233
Blue Swirl23130862009-06-06 08:22:04 +0000234@item change vnc @var{display},@var{options}
235Change the configuration of the VNC server. The valid syntax for @var{display}
236and @var{options} are described at @ref{sec_invocation}. eg
237
238@example
239(qemu) change vnc localhost:1
240@end example
241
242@item change vnc password [@var{password}]
243
244Change the password associated with the VNC server. If the new password is not
245supplied, the monitor will prompt for it to be entered. VNC passwords are only
246significant up to 8 letters. eg
247
248@example
249(qemu) change vnc password
250Password: ********
251@end example
252
253@end table
254ETEXI
255
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300256 {
257 .name = "screendump",
Thomas Huthf771c542018-03-05 17:37:48 +0100258 .args_type = "filename:F,device:s?,head:i?",
259 .params = "filename [device [head]]",
260 .help = "save screen from head 'head' of display device 'device' "
261 "into PPM image 'filename'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400262 .cmd = hmp_screendump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300263 },
264
Blue Swirl23130862009-06-06 08:22:04 +0000265STEXI
266@item screendump @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100267@findex screendump
Blue Swirl23130862009-06-06 08:22:04 +0000268Save screen into PPM image @var{filename}.
269ETEXI
270
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300271 {
272 .name = "logfile",
273 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300274 .params = "filename",
275 .help = "output logs to 'filename'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400276 .cmd = hmp_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300277 },
278
Blue Swirl23130862009-06-06 08:22:04 +0000279STEXI
280@item logfile @var{filename}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100281@findex logfile
Blue Swirl23130862009-06-06 08:22:04 +0000282Output logs to @var{filename}.
283ETEXI
284
Prerna Saxena22890ab2010-06-24 17:04:53 +0530285 {
286 .name = "trace-event",
Lluís Vilanova77e2b172016-07-11 12:53:57 +0200287 .args_type = "name:s,option:b,vcpu:i?",
288 .params = "name on|off [vcpu]",
289 .help = "changes status of a specific trace event "
290 "(vcpu: vCPU to set, default is all)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400291 .cmd = hmp_trace_event,
Dr. David Alan Gilbert987bd272015-08-14 11:27:43 +0100292 .command_completion = trace_event_completion,
Prerna Saxena22890ab2010-06-24 17:04:53 +0530293 },
294
295STEXI
296@item trace-event
297@findex trace-event
298changes status of a trace event
299ETEXI
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100300
Michael Rothc45a8162011-10-02 08:44:37 -0500301#if defined(CONFIG_TRACE_SIMPLE)
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100302 {
303 .name = "trace-file",
304 .args_type = "op:s?,arg:F?",
305 .params = "on|off|flush|set [arg]",
306 .help = "open, close, or flush trace file, or set a new file name",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400307 .cmd = hmp_trace_file,
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100308 },
309
310STEXI
311@item trace-file on|off|flush
312@findex trace-file
313Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
314ETEXI
Prerna Saxena22890ab2010-06-24 17:04:53 +0530315#endif
316
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300317 {
318 .name = "log",
319 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300320 .params = "item1[,...]",
Peter Maydell989b6972013-02-26 17:52:40 +0000321 .help = "activate logging of the specified items",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400322 .cmd = hmp_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300323 },
324
Blue Swirl23130862009-06-06 08:22:04 +0000325STEXI
326@item log @var{item1}[,...]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100327@findex log
Peter Maydell989b6972013-02-26 17:52:40 +0000328Activate logging of the specified items.
Blue Swirl23130862009-06-06 08:22:04 +0000329ETEXI
330
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300331 {
332 .name = "savevm",
333 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300334 .params = "[tag|id]",
335 .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 +0400336 .cmd = hmp_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300337 },
338
Blue Swirl23130862009-06-06 08:22:04 +0000339STEXI
340@item savevm [@var{tag}|@var{id}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100341@findex savevm
Blue Swirl23130862009-06-06 08:22:04 +0000342Create a snapshot of the whole virtual machine. If @var{tag} is
343provided, it is used as human readable identifier. If there is already
344a snapshot with the same tag or ID, it is replaced. More info at
345@ref{vm_snapshots}.
346ETEXI
347
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300348 {
349 .name = "loadvm",
350 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300351 .params = "tag|id",
352 .help = "restore a VM snapshot from its tag or id",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400353 .cmd = hmp_loadvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100354 .command_completion = loadvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300355 },
356
Blue Swirl23130862009-06-06 08:22:04 +0000357STEXI
358@item loadvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100359@findex loadvm
Blue Swirl23130862009-06-06 08:22:04 +0000360Set the whole virtual machine to the snapshot identified by the tag
361@var{tag} or the unique snapshot ID @var{id}.
362ETEXI
363
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300364 {
365 .name = "delvm",
366 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300367 .params = "tag|id",
368 .help = "delete a VM snapshot from its tag or id",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400369 .cmd = hmp_delvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100370 .command_completion = delvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300371 },
372
Blue Swirl23130862009-06-06 08:22:04 +0000373STEXI
374@item delvm @var{tag}|@var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100375@findex delvm
Blue Swirl23130862009-06-06 08:22:04 +0000376Delete the snapshot identified by @var{tag} or @var{id}.
377ETEXI
378
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300379 {
380 .name = "singlestep",
381 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300382 .params = "[on|off]",
383 .help = "run emulation in singlestep mode or switch to normal mode",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400384 .cmd = hmp_singlestep,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300385 },
386
Blue Swirl23130862009-06-06 08:22:04 +0000387STEXI
388@item singlestep [off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100389@findex singlestep
Blue Swirl23130862009-06-06 08:22:04 +0000390Run the emulation in single step mode.
391If called with option off, the emulation returns to normal mode.
392ETEXI
393
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300394 {
395 .name = "stop",
396 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300397 .params = "",
398 .help = "stop emulation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400399 .cmd = hmp_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300400 },
401
Blue Swirl23130862009-06-06 08:22:04 +0000402STEXI
403@item stop
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100404@findex stop
Blue Swirl23130862009-06-06 08:22:04 +0000405Stop emulation.
406ETEXI
407
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300408 {
409 .name = "c|cont",
410 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300411 .params = "",
412 .help = "resume emulation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400413 .cmd = hmp_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300414 },
415
Blue Swirl23130862009-06-06 08:22:04 +0000416STEXI
417@item c or cont
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100418@findex cont
Blue Swirl23130862009-06-06 08:22:04 +0000419Resume emulation.
420ETEXI
421
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300422 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100423 .name = "system_wakeup",
424 .args_type = "",
425 .params = "",
426 .help = "wakeup guest from suspend",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400427 .cmd = hmp_system_wakeup,
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100428 },
429
430STEXI
431@item system_wakeup
432@findex system_wakeup
433Wakeup guest from suspend.
434ETEXI
435
436 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300437 .name = "gdbserver",
438 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300439 .params = "[device]",
440 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400441 .cmd = hmp_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300442 },
443
Blue Swirl23130862009-06-06 08:22:04 +0000444STEXI
445@item gdbserver [@var{port}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100446@findex gdbserver
Blue Swirl23130862009-06-06 08:22:04 +0000447Start gdbserver session (default @var{port}=1234)
448ETEXI
449
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300450 {
451 .name = "x",
452 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300453 .params = "/fmt addr",
454 .help = "virtual memory dump starting at 'addr'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400455 .cmd = hmp_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300456 },
457
Blue Swirl23130862009-06-06 08:22:04 +0000458STEXI
459@item x/fmt @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100460@findex x
Blue Swirl23130862009-06-06 08:22:04 +0000461Virtual memory dump starting at @var{addr}.
462ETEXI
463
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300464 {
465 .name = "xp",
466 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300467 .params = "/fmt addr",
468 .help = "physical memory dump starting at 'addr'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400469 .cmd = hmp_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300470 },
471
Blue Swirl23130862009-06-06 08:22:04 +0000472STEXI
473@item xp /@var{fmt} @var{addr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100474@findex xp
Blue Swirl23130862009-06-06 08:22:04 +0000475Physical memory dump starting at @var{addr}.
476
477@var{fmt} is a format which tells the command how to format the
478data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
479
480@table @var
481@item count
482is the number of items to be dumped.
483
484@item format
485can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
486c (char) or i (asm instruction).
487
488@item size
489can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
490@code{h} or @code{w} can be specified with the @code{i} format to
491respectively select 16 or 32 bit code instruction size.
492
493@end table
494
495Examples:
496@itemize
497@item
498Dump 10 instructions at the current instruction pointer:
499@example
500(qemu) x/10i $eip
5010x90107063: ret
5020x90107064: sti
5030x90107065: lea 0x0(%esi,1),%esi
5040x90107069: lea 0x0(%edi,1),%edi
5050x90107070: ret
5060x90107071: jmp 0x90107080
5070x90107073: nop
5080x90107074: nop
5090x90107075: nop
5100x90107076: nop
511@end example
512
513@item
514Dump 80 16 bit values at the start of the video memory.
515@smallexample
516(qemu) xp/80hx 0xb8000
5170x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
5180x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
5190x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
5200x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
5210x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
5220x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
5230x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5240x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5250x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
5260x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
527@end smallexample
528@end itemize
529ETEXI
530
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300531 {
Paolo Bonzinie9628442017-04-20 15:30:58 +0200532 .name = "gpa2hva",
533 .args_type = "addr:l",
534 .params = "addr",
535 .help = "print the host virtual address corresponding to a guest physical address",
536 .cmd = hmp_gpa2hva,
537 },
538
539STEXI
540@item gpa2hva @var{addr}
541@findex gpa2hva
542Print the host virtual address at which the guest's physical address @var{addr}
543is mapped.
544ETEXI
545
546#ifdef CONFIG_LINUX
547 {
548 .name = "gpa2hpa",
549 .args_type = "addr:l",
550 .params = "addr",
551 .help = "print the host physical address corresponding to a guest physical address",
552 .cmd = hmp_gpa2hpa,
553 },
554#endif
555
556STEXI
557@item gpa2hpa @var{addr}
558@findex gpa2hpa
559Print the host physical address at which the guest's physical address @var{addr}
560is mapped.
561ETEXI
562
563 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300564 .name = "p|print",
565 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300566 .params = "/fmt expr",
567 .help = "print expression value (use $reg for CPU register access)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400568 .cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300569 },
570
Blue Swirl23130862009-06-06 08:22:04 +0000571STEXI
572@item p or print/@var{fmt} @var{expr}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100573@findex print
Blue Swirl23130862009-06-06 08:22:04 +0000574Print expression value. Only the @var{format} part of @var{fmt} is
575used.
576ETEXI
577
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300578 {
579 .name = "i",
580 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300581 .params = "/fmt addr",
582 .help = "I/O port read",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400583 .cmd = hmp_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300584 },
585
Blue Swirl23130862009-06-06 08:22:04 +0000586STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100587@item i/@var{fmt} @var{addr} [.@var{index}]
588@findex i
Blue Swirl23130862009-06-06 08:22:04 +0000589Read I/O port.
590ETEXI
591
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300592 {
593 .name = "o",
594 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300595 .params = "/fmt addr value",
596 .help = "I/O port write",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400597 .cmd = hmp_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300598 },
599
Jan Kiszkaf1147842009-07-14 10:20:11 +0200600STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +0100601@item o/@var{fmt} @var{addr} @var{val}
602@findex o
Jan Kiszkaf1147842009-07-14 10:20:11 +0200603Write to I/O port.
604ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000605
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300606 {
607 .name = "sendkey",
Amos Kong2ef20c12012-08-31 10:56:22 +0800608 .args_type = "keys:s,hold-time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300609 .params = "keys [hold_ms]",
610 .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 +0400611 .cmd = hmp_sendkey,
Hani Benhabiles29136cd2014-05-07 23:41:27 +0100612 .command_completion = sendkey_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300613 },
614
Blue Swirl23130862009-06-06 08:22:04 +0000615STEXI
616@item sendkey @var{keys}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100617@findex sendkey
Amos Kong886cc702012-08-31 10:56:20 +0800618Send @var{keys} to the guest. @var{keys} could be the name of the
619key or the raw value in hexadecimal format. Use @code{-} to press
620several keys simultaneously. Example:
Blue Swirl23130862009-06-06 08:22:04 +0000621@example
622sendkey ctrl-alt-f1
623@end example
624
625This command is useful to send keys that your graphical user interface
626intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
627ETEXI
628
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300629 {
630 .name = "system_reset",
631 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300632 .params = "",
633 .help = "reset the system",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400634 .cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300635 },
636
Blue Swirl23130862009-06-06 08:22:04 +0000637STEXI
638@item system_reset
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100639@findex system_reset
Blue Swirl23130862009-06-06 08:22:04 +0000640Reset the system.
641ETEXI
642
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300643 {
644 .name = "system_powerdown",
645 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300646 .params = "",
647 .help = "send system power down event",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400648 .cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300649 },
650
Blue Swirl23130862009-06-06 08:22:04 +0000651STEXI
652@item system_powerdown
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100653@findex system_powerdown
Blue Swirl23130862009-06-06 08:22:04 +0000654Power down the system (if supported).
655ETEXI
656
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300657 {
658 .name = "sum",
659 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300660 .params = "addr size",
661 .help = "compute the checksum of a memory region",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400662 .cmd = hmp_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300663 },
664
Blue Swirl23130862009-06-06 08:22:04 +0000665STEXI
666@item sum @var{addr} @var{size}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100667@findex sum
Blue Swirl23130862009-06-06 08:22:04 +0000668Compute the checksum of a memory region.
669ETEXI
670
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300671 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300672 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100673 .args_type = "device:O",
674 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300675 .help = "add device, like -device on the command line",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400676 .cmd = hmp_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100677 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300678 },
679
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200680STEXI
681@item device_add @var{config}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100682@findex device_add
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200683Add device.
684ETEXI
685
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300686 {
687 .name = "device_del",
688 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300689 .params = "device",
690 .help = "remove device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400691 .cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100692 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300693 },
694
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200695STEXI
696@item device_del @var{id}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100697@findex device_del
Daniel P. Berrange6287d822015-09-11 13:33:56 +0100698Remove device @var{id}. @var{id} may be a short ID
699or a QOM object path.
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200700ETEXI
701
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300702 {
703 .name = "cpu",
704 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300705 .params = "index",
706 .help = "set the default CPU",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400707 .cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300708 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200709
Blue Swirl23130862009-06-06 08:22:04 +0000710STEXI
Markus Armbrusterc427ea92010-05-04 13:20:32 +0200711@item cpu @var{index}
712@findex cpu
Blue Swirl23130862009-06-06 08:22:04 +0000713Set the default CPU.
714ETEXI
715
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300716 {
717 .name = "mouse_move",
718 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300719 .params = "dx dy [dz]",
720 .help = "send mouse move events",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400721 .cmd = hmp_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300722 },
723
Blue Swirl23130862009-06-06 08:22:04 +0000724STEXI
725@item mouse_move @var{dx} @var{dy} [@var{dz}]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100726@findex mouse_move
Blue Swirl23130862009-06-06 08:22:04 +0000727Move the active mouse to the specified coordinates @var{dx} @var{dy}
728with optional scroll axis @var{dz}.
729ETEXI
730
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300731 {
732 .name = "mouse_button",
733 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300734 .params = "state",
735 .help = "change mouse button state (1=L, 2=M, 4=R)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400736 .cmd = hmp_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300737 },
738
Blue Swirl23130862009-06-06 08:22:04 +0000739STEXI
740@item mouse_button @var{val}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100741@findex mouse_button
Blue Swirl23130862009-06-06 08:22:04 +0000742Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
743ETEXI
744
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300745 {
746 .name = "mouse_set",
747 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300748 .params = "index",
749 .help = "set which mouse device receives events",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400750 .cmd = hmp_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300751 },
752
Blue Swirl23130862009-06-06 08:22:04 +0000753STEXI
754@item mouse_set @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100755@findex mouse_set
Blue Swirl23130862009-06-06 08:22:04 +0000756Set which mouse device receives events at given @var{index}, index
757can be obtained with
758@example
759info mice
760@end example
761ETEXI
762
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300763 {
764 .name = "wavcapture",
765 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300766 .params = "path [frequency [bits [channels]]]",
767 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400768 .cmd = hmp_wavcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300769 },
Blue Swirl23130862009-06-06 08:22:04 +0000770STEXI
771@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100772@findex wavcapture
Blue Swirl23130862009-06-06 08:22:04 +0000773Capture audio into @var{filename}. Using sample rate @var{frequency}
774bits per sample @var{bits} and number of channels @var{channels}.
775
776Defaults:
777@itemize @minus
778@item Sample rate = 44100 Hz - CD quality
779@item Bits = 16
780@item Number of channels = 2 - Stereo
781@end itemize
782ETEXI
783
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300784 {
785 .name = "stopcapture",
786 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300787 .params = "capture index",
788 .help = "stop capture",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400789 .cmd = hmp_stopcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300790 },
Blue Swirl23130862009-06-06 08:22:04 +0000791STEXI
792@item stopcapture @var{index}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100793@findex stopcapture
Blue Swirl23130862009-06-06 08:22:04 +0000794Stop capture with a given @var{index}, index can be obtained with
795@example
796info capture
797@end example
798ETEXI
799
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300800 {
801 .name = "memsave",
802 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300803 .params = "addr size file",
804 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400805 .cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300806 },
807
Blue Swirl23130862009-06-06 08:22:04 +0000808STEXI
809@item memsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100810@findex memsave
Blue Swirl23130862009-06-06 08:22:04 +0000811save to disk virtual memory dump starting at @var{addr} of size @var{size}.
812ETEXI
813
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300814 {
815 .name = "pmemsave",
816 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300817 .params = "addr size file",
818 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400819 .cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300820 },
821
Blue Swirl23130862009-06-06 08:22:04 +0000822STEXI
823@item pmemsave @var{addr} @var{size} @var{file}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100824@findex pmemsave
Blue Swirl23130862009-06-06 08:22:04 +0000825save to disk physical memory dump starting at @var{addr} of size @var{size}.
826ETEXI
827
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300828 {
829 .name = "boot_set",
830 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300831 .params = "bootdevice",
832 .help = "define new values for the boot device list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400833 .cmd = hmp_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300834 },
835
Blue Swirl23130862009-06-06 08:22:04 +0000836STEXI
837@item boot_set @var{bootdevicelist}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100838@findex boot_set
Blue Swirl23130862009-06-06 08:22:04 +0000839Define new values for the boot device list. Those values will override
840the values specified on the command line through the @code{-boot} option.
841
842The values that can be specified here depend on the machine type, but are
843the same that can be specified in the @code{-boot} command line option.
844ETEXI
845
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300846 {
847 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300848 .args_type = "",
849 .params = "",
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000850 .help = "inject an NMI",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400851 .cmd = hmp_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300852 },
Blue Swirl23130862009-06-06 08:22:04 +0000853STEXI
854@item nmi @var{cpu}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100855@findex nmi
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000856Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
Lei Li1f590cf2013-01-25 00:03:20 +0800857
858ETEXI
859
860 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100861 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800862 .args_type = "device:s,data:s",
863 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100864 .help = "Write to a ring buffer character device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400865 .cmd = hmp_ringbuf_write,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100866 .command_completion = ringbuf_write_completion,
Lei Li1f590cf2013-01-25 00:03:20 +0800867 },
868
869STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100870@item ringbuf_write @var{device} @var{data}
871@findex ringbuf_write
872Write @var{data} to ring buffer character device @var{device}.
873@var{data} must be a UTF-8 string.
Lei Li1f590cf2013-01-25 00:03:20 +0800874
Blue Swirl23130862009-06-06 08:22:04 +0000875ETEXI
876
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300877 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100878 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800879 .args_type = "device:s,size:i",
880 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100881 .help = "Read from a ring buffer character device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400882 .cmd = hmp_ringbuf_read,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100883 .command_completion = ringbuf_write_completion,
Lei Li49b6d722013-01-25 00:03:21 +0800884 },
885
886STEXI
Markus Armbruster3949e592013-02-06 21:27:24 +0100887@item ringbuf_read @var{device}
888@findex ringbuf_read
889Read and print up to @var{size} bytes from ring buffer character
890device @var{device}.
Markus Armbruster543f3412013-02-06 21:27:26 +0100891Certain non-printable characters are printed \uXXXX, where XXXX is the
892character code in hexadecimal. Character \ is printed \\.
Markus Armbruster3949e592013-02-06 21:27:24 +0100893Bug: can screw up when the buffer contains invalid UTF-8 sequences,
894NUL characters, after the ring buffer lost data, and when reading
895stops because the size limit is reached.
Lei Li49b6d722013-01-25 00:03:21 +0800896
897ETEXI
898
899 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300900 .name = "migrate",
Peter Xu7a4da282018-05-02 18:47:23 +0800901 .args_type = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
902 .params = "[-d] [-b] [-i] [-r] uri",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200903 .help = "migrate to URI (using -d to not wait for completion)"
904 "\n\t\t\t -b for migration without shared storage with"
905 " full copy of disk\n\t\t\t -i for migration without "
906 "shared storage with incremental copy of disk "
Peter Xu7a4da282018-05-02 18:47:23 +0800907 "(base image shared between src and destination)"
908 "\n\t\t\t -r to resume a paused migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400909 .cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300910 },
911
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200912
Blue Swirl23130862009-06-06 08:22:04 +0000913STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200914@item migrate [-d] [-b] [-i] @var{uri}
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100915@findex migrate
Blue Swirl23130862009-06-06 08:22:04 +0000916Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200917 -b for migration with full copy of disk
918 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000919ETEXI
920
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300921 {
922 .name = "migrate_cancel",
923 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300924 .params = "",
925 .help = "cancel the current VM migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400926 .cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300927 },
928
Blue Swirl23130862009-06-06 08:22:04 +0000929STEXI
930@item migrate_cancel
Stefan Weil70fcbbe2010-02-05 23:52:04 +0100931@findex migrate_cancel
Blue Swirl23130862009-06-06 08:22:04 +0000932Cancel the current VM migration.
Dr. David Alan Gilbert94ae12c2017-10-20 10:05:54 +0100933ETEXI
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300934
Dr. David Alan Gilbert94ae12c2017-10-20 10:05:54 +0100935 {
936 .name = "migrate_continue",
937 .args_type = "state:s",
938 .params = "state",
939 .help = "Continue migration from the given paused state",
940 .cmd = hmp_migrate_continue,
941 },
942STEXI
943@item migrate_continue @var{state}
944@findex migrate_continue
945Continue migration from the paused state @var{state}
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300946ETEXI
947
948 {
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000949 .name = "migrate_incoming",
950 .args_type = "uri:s",
951 .params = "uri",
952 .help = "Continue an incoming migration from an -incoming defer",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400953 .cmd = hmp_migrate_incoming,
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000954 },
955
956STEXI
957@item migrate_incoming @var{uri}
958@findex migrate_incoming
959Continue an incoming migration using the @var{uri} (that has the same syntax
960as the -incoming option).
Peter Xu3b563c42018-05-02 18:47:37 +0800961ETEXI
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000962
Peter Xu3b563c42018-05-02 18:47:37 +0800963 {
964 .name = "migrate_recover",
965 .args_type = "uri:s",
966 .params = "uri",
967 .help = "Continue a paused incoming postcopy migration",
968 .cmd = hmp_migrate_recover,
969 },
970
971STEXI
972@item migrate_recover @var{uri}
973@findex migrate_recover
974Continue a paused incoming postcopy migration using the @var{uri}.
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000975ETEXI
976
977 {
Peter Xud37297d2018-05-02 18:47:40 +0800978 .name = "migrate_pause",
979 .args_type = "",
980 .params = "",
981 .help = "Pause an ongoing migration (postcopy-only)",
982 .cmd = hmp_migrate_pause,
983 },
984
985STEXI
986@item migrate_pause
987@findex migrate_pause
988Pause an ongoing migration. Currently it only supports postcopy.
989ETEXI
990
991 {
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300992 .name = "migrate_set_cache_size",
993 .args_type = "value:o",
994 .params = "value",
995 .help = "set cache size (in bytes) for XBZRLE migrations,"
996 "the cache size will be rounded down to the nearest "
997 "power of 2.\n"
998 "The cache size affects the number of cache misses."
999 "In case of a high cache miss ratio you need to increase"
1000 " the cache size",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001001 .cmd = hmp_migrate_set_cache_size,
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +03001002 },
1003
1004STEXI
1005@item migrate_set_cache_size @var{value}
1006@findex migrate_set_cache_size
1007Set cache size to @var{value} (in bytes) for xbzrle migrations.
Blue Swirl23130862009-06-06 08:22:04 +00001008ETEXI
1009
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001010 {
1011 .name = "migrate_set_speed",
Jes Sorensened3d4a82010-10-21 17:15:48 +02001012 .args_type = "value:o",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001013 .params = "value",
Jes Sorensened3d4a82010-10-21 17:15:48 +02001014 .help = "set maximum speed (in bytes) for migrations. "
1015 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001016 .cmd = hmp_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001017 },
1018
Blue Swirl23130862009-06-06 08:22:04 +00001019STEXI
1020@item migrate_set_speed @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001021@findex migrate_set_speed
Blue Swirl23130862009-06-06 08:22:04 +00001022Set maximum speed to @var{value} (in bytes) for migrations.
1023ETEXI
1024
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001025 {
1026 .name = "migrate_set_downtime",
Markus Armbrusterb0fbf7d2010-01-25 14:23:07 +01001027 .args_type = "value:T",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001028 .params = "value",
1029 .help = "set maximum tolerated downtime (in seconds) for migrations",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001030 .cmd = hmp_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001031 },
Glauber Costa2ea42952009-05-28 15:22:58 -04001032
1033STEXI
1034@item migrate_set_downtime @var{second}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001035@findex migrate_set_downtime
Glauber Costa2ea42952009-05-28 15:22:58 -04001036Set maximum tolerated downtime (in seconds) for migration.
1037ETEXI
1038
Jes Sorensenf8882562010-12-16 13:52:16 +01001039 {
Orit Wasserman00458432012-08-06 21:42:48 +03001040 .name = "migrate_set_capability",
1041 .args_type = "capability:s,state:b",
1042 .params = "capability state",
1043 .help = "Enable/Disable the usage of a capability for migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001044 .cmd = hmp_migrate_set_capability,
Hani Benhabilesc68a0402014-05-27 23:39:32 +01001045 .command_completion = migrate_set_capability_completion,
Orit Wasserman00458432012-08-06 21:42:48 +03001046 },
1047
1048STEXI
1049@item migrate_set_capability @var{capability} @var{state}
1050@findex migrate_set_capability
1051Enable/Disable the usage of a capability @var{capability} for migration.
1052ETEXI
1053
1054 {
Liang Li50e9a622015-03-23 16:32:29 +08001055 .name = "migrate_set_parameter",
Daniel P. Berrange69ef1f32016-04-27 11:05:15 +01001056 .args_type = "parameter:s,value:s",
Liang Li50e9a622015-03-23 16:32:29 +08001057 .params = "parameter value",
1058 .help = "Set the parameter for migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001059 .cmd = hmp_migrate_set_parameter,
Liang Li50e9a622015-03-23 16:32:29 +08001060 .command_completion = migrate_set_parameter_completion,
1061 },
1062
1063STEXI
1064@item migrate_set_parameter @var{parameter} @var{value}
1065@findex migrate_set_parameter
1066Set the parameter @var{parameter} for migration.
1067ETEXI
1068
1069 {
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001070 .name = "migrate_start_postcopy",
1071 .args_type = "",
1072 .params = "",
Dr. David Alan Gilberta54d3402015-11-12 11:34:44 +00001073 .help = "Followup to a migration command to switch the migration"
Dr. David Alan Gilbert32c3db52016-03-11 09:53:36 +00001074 " to postcopy mode. The postcopy-ram capability must "
Greg Kurzc2eb7f22018-02-07 16:41:43 +01001075 "be set on both source and destination before the "
1076 "original migration command .",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001077 .cmd = hmp_migrate_start_postcopy,
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001078 },
1079
1080STEXI
1081@item migrate_start_postcopy
1082@findex migrate_start_postcopy
1083Switch in-progress migration to postcopy mode. Ignored after the end of
1084migration (or once already in postcopy).
1085ETEXI
1086
1087 {
zhanghailiangd89e6662016-10-27 14:43:03 +08001088 .name = "x_colo_lost_heartbeat",
1089 .args_type = "",
1090 .params = "",
1091 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1092 "a failover or takeover is needed.",
1093 .cmd = hmp_x_colo_lost_heartbeat,
1094 },
1095
1096STEXI
1097@item x_colo_lost_heartbeat
1098@findex x_colo_lost_heartbeat
1099Tell COLO that heartbeat is lost, a failover or takeover is needed.
1100ETEXI
1101
1102 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001103 .name = "client_migrate_info",
1104 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1105 .params = "protocol hostname port tls-port cert-subject",
Markus Armbruster13cadef2015-03-05 19:16:58 +01001106 .help = "set migration information for remote display",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001107 .cmd = hmp_client_migrate_info,
Jes Sorensenf8882562010-12-16 13:52:16 +01001108 },
1109
1110STEXI
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001111@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1112@findex client_migrate_info
Markus Armbruster13cadef2015-03-05 19:16:58 +01001113Set migration information for remote display. This makes the server
1114ask the client to automatically reconnect using the new parameters
1115once migration finished successfully. Only implemented for SPICE.
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001116ETEXI
1117
Wen Congyang783e9b42012-05-07 12:10:47 +08001118 {
1119 .name = "dump-guest-memory",
Suraj Jitindar Singh65fa57b2018-06-20 10:32:02 +10001120 .args_type = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:l?,length:l?",
Peter Xu228de9c2016-02-18 13:16:47 +08001121 .params = "[-p] [-d] [-z|-l|-s] filename [begin length]",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001122 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1123 "-p: do paging to get guest's memory mapping.\n\t\t\t"
Peter Xu228de9c2016-02-18 13:16:47 +08001124 "-d: return immediately (do not wait for completion).\n\t\t\t"
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001125 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1126 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1127 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001128 "begin: the starting physical address.\n\t\t\t"
1129 "length: the memory size, in bytes.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001130 .cmd = hmp_dump_guest_memory,
Wen Congyang783e9b42012-05-07 12:10:47 +08001131 },
1132
1133
1134STEXI
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001135@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001136@item dump-guest-memory [-z|-l|-s] @var{filename}
Wen Congyang783e9b42012-05-07 12:10:47 +08001137@findex dump-guest-memory
1138Dump guest memory to @var{protocol}. The file can be processed with crash or
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001139gdb. Without -z|-l|-s, the dump format is ELF.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001140 -p: do paging to get guest's memory mapping.
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001141 -z: dump in kdump-compressed format, with zlib compression.
1142 -l: dump in kdump-compressed format, with lzo compression.
1143 -s: dump in kdump-compressed format, with snappy compression.
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001144 filename: dump file name.
Wen Congyang783e9b42012-05-07 12:10:47 +08001145 begin: the starting physical address. It's optional, and should be
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001146 specified together with length.
Wen Congyang783e9b42012-05-07 12:10:47 +08001147 length: the memory size, in bytes. It's optional, and should be specified
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001148 together with begin.
Wen Congyang783e9b42012-05-07 12:10:47 +08001149ETEXI
Wen Congyang783e9b42012-05-07 12:10:47 +08001150
Jason J. Hernea4538a52015-06-26 14:07:21 -04001151#if defined(TARGET_S390X)
1152 {
1153 .name = "dump-skeys",
1154 .args_type = "filename:F",
1155 .params = "",
1156 .help = "Save guest storage keys into file 'filename'.\n",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001157 .cmd = hmp_dump_skeys,
Jason J. Hernea4538a52015-06-26 14:07:21 -04001158 },
1159#endif
1160
1161STEXI
1162@item dump-skeys @var{filename}
1163@findex dump-skeys
1164Save guest storage keys to a file.
1165ETEXI
1166
Claudio Imbrendaf860d492016-08-15 18:44:04 +02001167#if defined(TARGET_S390X)
1168 {
1169 .name = "migration_mode",
1170 .args_type = "mode:i",
1171 .params = "mode",
1172 .help = "Enables or disables migration mode\n",
1173 .cmd = hmp_migrationmode,
1174 },
1175#endif
1176
1177STEXI
1178@item migration_mode @var{mode}
1179@findex migration_mode
1180Enables or disables migration mode.
1181ETEXI
1182
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001183 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001184 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001185 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1186 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001187 .help = "initiates a live snapshot\n\t\t\t"
1188 "of device. If a new image file is specified, the\n\t\t\t"
1189 "new image file will become the new root image.\n\t\t\t"
1190 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001191 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001192 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1193 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1194 "recreating it from scratch.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001195 .cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001196 },
1197
1198STEXI
Jes Sorensenf8882562010-12-16 13:52:16 +01001199@item snapshot_blkdev
1200@findex snapshot_blkdev
1201Snapshot device, using snapshot file as target if provided
1202ETEXI
1203
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001204 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001205 .name = "snapshot_blkdev_internal",
1206 .args_type = "device:B,name:s",
1207 .params = "device name",
1208 .help = "take an internal snapshot of device.\n\t\t\t"
1209 "The format of the image used by device must\n\t\t\t"
1210 "support it, such as qcow2.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001211 .cmd = hmp_snapshot_blkdev_internal,
Wenchao Xia775ca882013-09-11 14:04:37 +08001212 },
1213
1214STEXI
1215@item snapshot_blkdev_internal
1216@findex snapshot_blkdev_internal
1217Take an internal snapshot on device if it support
1218ETEXI
1219
1220 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001221 .name = "snapshot_delete_blkdev_internal",
1222 .args_type = "device:B,name:s,id:s?",
1223 .params = "device name [id]",
1224 .help = "delete an internal snapshot of device.\n\t\t\t"
1225 "If id is specified, qemu will try delete\n\t\t\t"
1226 "the snapshot matching both id and name.\n\t\t\t"
1227 "The format of the image used by device must\n\t\t\t"
1228 "support it, such as qcow2.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001229 .cmd = hmp_snapshot_delete_blkdev_internal,
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001230 },
1231
1232STEXI
1233@item snapshot_delete_blkdev_internal
1234@findex snapshot_delete_blkdev_internal
1235Delete an internal snapshot on device if it support
1236ETEXI
1237
1238 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001239 .name = "drive_mirror",
1240 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1241 .params = "[-n] [-f] device target [format]",
1242 .help = "initiates live storage\n\t\t\t"
1243 "migration for a device. The device's contents are\n\t\t\t"
1244 "copied to the new image file, including data that\n\t\t\t"
1245 "is written after the command is started.\n\t\t\t"
1246 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1247 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1248 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1249 "so that the result does not need a backing file.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001250 .cmd = hmp_drive_mirror,
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001251 },
1252STEXI
1253@item drive_mirror
1254@findex drive_mirror
1255Start mirroring a block device's writes to a new destination,
1256using the specified target.
1257ETEXI
1258
1259 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001260 .name = "drive_backup",
Pavel Butsykin13b94142016-07-22 11:17:52 +03001261 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1262 .params = "[-n] [-f] [-c] device target [format]",
Stefan Hajnoczide909302013-06-26 14:11:58 +02001263 .help = "initiates a point-in-time\n\t\t\t"
1264 "copy for a device. The device's contents are\n\t\t\t"
1265 "copied to the new image file, excluding data that\n\t\t\t"
1266 "is written after the command is started.\n\t\t\t"
1267 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1268 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1269 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
Pavel Butsykin13b94142016-07-22 11:17:52 +03001270 "so that the result does not need a backing file.\n\t\t\t"
1271 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1272 "(if the target format supports it).\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001273 .cmd = hmp_drive_backup,
Stefan Hajnoczide909302013-06-26 14:11:58 +02001274 },
1275STEXI
1276@item drive_backup
1277@findex drive_backup
1278Start a point-in-time copy of a block device to a specificed target.
1279ETEXI
1280
1281 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001282 .name = "drive_add",
Kevin Wolfabb21ac2016-02-23 17:33:24 +01001283 .args_type = "node:-n,pci_addr:s,opts:s",
1284 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001285 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001286 "[,unit=m][,media=d][,index=i]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001287 "[,snapshot=on|off][,cache=on|off]\n"
1288 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001289 .help = "add drive to PCI storage controller",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001290 .cmd = hmp_drive_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001291 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001292
Blue Swirl23130862009-06-06 08:22:04 +00001293STEXI
1294@item drive_add
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001295@findex drive_add
Blue Swirl23130862009-06-06 08:22:04 +00001296Add drive to PCI storage controller.
1297ETEXI
1298
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001299 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001300 .name = "pcie_aer_inject_error",
1301 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1302 "id:s,error_status:s,"
1303 "header0:i?,header1:i?,header2:i?,header3:i?,"
1304 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1305 .params = "[-a] [-c] id "
1306 "<error_status> [<tlp header> [<tlp header prefix>]]",
1307 .help = "inject pcie aer error\n\t\t\t"
1308 " -a for advisory non fatal error\n\t\t\t"
1309 " -c for correctable error\n\t\t\t"
1310 "<id> = qdev device id\n\t\t\t"
1311 "<error_status> = error string or 32bit\n\t\t\t"
1312 "<tlb header> = 32bit x 4\n\t\t\t"
1313 "<tlb header prefix> = 32bit x 4",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001314 .cmd = hmp_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001315 },
1316
1317STEXI
1318@item pcie_aer_inject_error
1319@findex pcie_aer_inject_error
1320Inject PCIe AER error
1321ETEXI
1322
1323 {
Markus Armbrusterae82d322010-03-25 17:22:40 +01001324 .name = "netdev_add",
1325 .args_type = "netdev:O",
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03001326 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001327 .help = "add host network device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001328 .cmd = hmp_netdev_add,
Hani Benhabilesb162b492014-05-07 23:41:31 +01001329 .command_completion = netdev_add_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001330 },
1331
1332STEXI
1333@item netdev_add
1334@findex netdev_add
1335Add host network device.
1336ETEXI
1337
1338 {
1339 .name = "netdev_del",
1340 .args_type = "id:s",
1341 .params = "id",
1342 .help = "remove host network device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001343 .cmd = hmp_netdev_del,
Hani Benhabiles11b389f2014-05-07 23:41:32 +01001344 .command_completion = netdev_del_completion,
Markus Armbrusterae82d322010-03-25 17:22:40 +01001345 },
1346
1347STEXI
1348@item netdev_del
1349@findex netdev_del
1350Remove host network device.
1351ETEXI
1352
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001353 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001354 .name = "object_add",
1355 .args_type = "object:O",
1356 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1357 .help = "create QOM object",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001358 .cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001359 .command_completion = object_add_completion,
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001360 },
1361
1362STEXI
1363@item object_add
1364@findex object_add
1365Create QOM object.
1366ETEXI
1367
1368 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001369 .name = "object_del",
1370 .args_type = "id:s",
1371 .params = "id",
1372 .help = "destroy QOM object",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001373 .cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001374 .command_completion = object_del_completion,
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001375 },
1376
1377STEXI
1378@item object_del
1379@findex object_del
1380Destroy QOM object.
1381ETEXI
1382
Blue Swirl23130862009-06-06 08:22:04 +00001383#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001384 {
1385 .name = "hostfwd_add",
1386 .args_type = "arg1:s,arg2:s?,arg3:s?",
Thomas Huth93653062018-01-11 21:02:40 +01001387 .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001388 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001389 .cmd = hmp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001390 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001391#endif
1392STEXI
1393@item hostfwd_add
1394@findex hostfwd_add
1395Redirect TCP or UDP connections from host to guest (requires -net user).
1396ETEXI
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001397
Markus Armbruster21413d62010-05-04 13:20:30 +02001398#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001399 {
1400 .name = "hostfwd_remove",
1401 .args_type = "arg1:s,arg2:s?,arg3:s?",
Thomas Huth93653062018-01-11 21:02:40 +01001402 .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001403 .help = "remove host-to-guest TCP or UDP redirection",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001404 .cmd = hmp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001405 },
1406
Blue Swirl23130862009-06-06 08:22:04 +00001407#endif
1408STEXI
Markus Armbruster21413d62010-05-04 13:20:30 +02001409@item hostfwd_remove
1410@findex hostfwd_remove
1411Remove host-to-guest TCP or UDP redirection.
Blue Swirl23130862009-06-06 08:22:04 +00001412ETEXI
1413
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001414 {
1415 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001416 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001417 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001418 .help = "request VM to change its memory allocation (in MB)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001419 .cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001420 },
1421
Blue Swirl23130862009-06-06 08:22:04 +00001422STEXI
1423@item balloon @var{value}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001424@findex balloon
Blue Swirl23130862009-06-06 08:22:04 +00001425Request VM to change its memory allocation to @var{value} (in MB).
1426ETEXI
1427
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001428 {
1429 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001430 .args_type = "name:s,up:b",
1431 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001432 .help = "change the link status of a network adapter",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001433 .cmd = hmp_set_link,
Hani Benhabiles40d19392014-05-07 23:41:30 +01001434 .command_completion = set_link_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001435 },
1436
Blue Swirl23130862009-06-06 08:22:04 +00001437STEXI
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001438@item set_link @var{name} [on|off]
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001439@findex set_link
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001440Switch link @var{name} on (i.e. up) or off (i.e. down).
Blue Swirl23130862009-06-06 08:22:04 +00001441ETEXI
1442
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001443 {
1444 .name = "watchdog_action",
1445 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001446 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1447 .help = "change watchdog action",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001448 .cmd = hmp_watchdog_action,
Hani Benhabilesd0ece342014-05-27 23:39:31 +01001449 .command_completion = watchdog_action_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001450 },
1451
Blue Swirl23130862009-06-06 08:22:04 +00001452STEXI
1453@item watchdog_action
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001454@findex watchdog_action
Blue Swirl23130862009-06-06 08:22:04 +00001455Change watchdog action.
1456ETEXI
1457
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001458 {
1459 .name = "acl_show",
1460 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001461 .params = "aclname",
1462 .help = "list rules in the access control list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001463 .cmd = hmp_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001464 },
1465
Blue Swirl23130862009-06-06 08:22:04 +00001466STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001467@item acl_show @var{aclname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001468@findex acl_show
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001469List all the matching rules in the access control list, and the default
1470policy. There are currently two named access control lists,
1471@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1472certificate distinguished name, and SASL username respectively.
1473ETEXI
Blue Swirl23130862009-06-06 08:22:04 +00001474
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001475 {
1476 .name = "acl_policy",
1477 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001478 .params = "aclname allow|deny",
1479 .help = "set default access control list policy",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001480 .cmd = hmp_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001481 },
1482
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001483STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +02001484@item acl_policy @var{aclname} @code{allow|deny}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001485@findex acl_policy
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001486Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +00001487none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001488always @code{deny}.
1489ETEXI
1490
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001491 {
1492 .name = "acl_add",
1493 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001494 .params = "aclname match allow|deny [index]",
1495 .help = "add a match rule to the access control list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001496 .cmd = hmp_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001497 },
1498
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001499STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001500@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1501@findex acl_add
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001502Add a match rule to the access control list, allowing or denying access.
1503The match will normally be an exact username or x509 distinguished name,
1504but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1505allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +00001506normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001507earlier in the list if the optional @var{index} parameter is supplied.
1508ETEXI
1509
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001510 {
1511 .name = "acl_remove",
1512 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001513 .params = "aclname match",
1514 .help = "remove a match rule from the access control list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001515 .cmd = hmp_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001516 },
1517
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001518STEXI
1519@item acl_remove @var{aclname} @var{match}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001520@findex acl_remove
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001521Remove the specified match rule from the access control list.
1522ETEXI
1523
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001524 {
1525 .name = "acl_reset",
1526 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001527 .params = "aclname",
1528 .help = "reset the access control list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001529 .cmd = hmp_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001530 },
1531
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001532STEXI
Markus Armbruster0e4aec92010-05-04 13:20:31 +02001533@item acl_reset @var{aclname}
1534@findex acl_reset
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001535Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001536policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001537ETEXI
1538
Paolo Bonzini40577252012-08-23 11:53:04 +02001539 {
1540 .name = "nbd_server_start",
1541 .args_type = "all:-a,writable:-w,uri:s",
1542 .params = "nbd_server_start [-a] [-w] host:port",
1543 .help = "serve block devices on the given host and port",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001544 .cmd = hmp_nbd_server_start,
Paolo Bonzini40577252012-08-23 11:53:04 +02001545 },
1546STEXI
1547@item nbd_server_start @var{host}:@var{port}
1548@findex nbd_server_start
1549Start an NBD server on the given host and/or port. If the @option{-a}
1550option is included, all of the virtual machine's block devices that
1551have an inserted media on them are automatically exported; in this case,
1552the @option{-w} option makes the devices writable too.
1553ETEXI
1554
1555 {
1556 .name = "nbd_server_add",
Eric Blakedba49322018-01-09 13:28:02 -06001557 .args_type = "writable:-w,device:B,name:s?",
1558 .params = "nbd_server_add [-w] device [name]",
Paolo Bonzini40577252012-08-23 11:53:04 +02001559 .help = "export a block device via NBD",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001560 .cmd = hmp_nbd_server_add,
Paolo Bonzini40577252012-08-23 11:53:04 +02001561 },
1562STEXI
Eric Blakedba49322018-01-09 13:28:02 -06001563@item nbd_server_add @var{device} [ @var{name} ]
Paolo Bonzini40577252012-08-23 11:53:04 +02001564@findex nbd_server_add
1565Export a block device through QEMU's NBD server, which must be started
1566beforehand with @command{nbd_server_start}. The @option{-w} option makes the
Eric Blakedba49322018-01-09 13:28:02 -06001567exported device writable too. The export name is controlled by @var{name},
1568defaulting to @var{device}.
Paolo Bonzini40577252012-08-23 11:53:04 +02001569ETEXI
1570
1571 {
Eric Blake08fb10a2018-01-25 08:45:57 -06001572 .name = "nbd_server_remove",
1573 .args_type = "force:-f,name:s",
1574 .params = "nbd_server_remove [-f] name",
1575 .help = "remove an export previously exposed via NBD",
1576 .cmd = hmp_nbd_server_remove,
1577 },
1578STEXI
1579@item nbd_server_remove [-f] @var{name}
1580@findex nbd_server_remove
1581Stop exporting a block device through QEMU's NBD server, which was
1582previously started with @command{nbd_server_add}. The @option{-f}
1583option forces the server to drop the export immediately even if
1584clients are connected; otherwise the command fails unless there are no
1585clients.
1586ETEXI
1587
1588 {
Paolo Bonzini40577252012-08-23 11:53:04 +02001589 .name = "nbd_server_stop",
1590 .args_type = "",
1591 .params = "nbd_server_stop",
1592 .help = "stop serving block devices using the NBD protocol",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001593 .cmd = hmp_nbd_server_stop,
Paolo Bonzini40577252012-08-23 11:53:04 +02001594 },
1595STEXI
1596@item nbd_server_stop
1597@findex nbd_server_stop
1598Stop the QEMU embedded NBD server.
1599ETEXI
1600
1601
Huang Ying79c4f6b2009-06-23 10:05:14 +08001602#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001603
1604 {
1605 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001606 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1607 .params = "[-b] cpu bank status mcgstatus addr misc",
1608 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001609 .cmd = hmp_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001610 },
1611
Huang Ying79c4f6b2009-06-23 10:05:14 +08001612#endif
1613STEXI
1614@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001615@findex mce (x86)
Huang Ying79c4f6b2009-06-23 10:05:14 +08001616Inject an MCE on the given CPU (x86 only).
1617ETEXI
1618
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001619 {
1620 .name = "getfd",
1621 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001622 .params = "getfd name",
1623 .help = "receive a file descriptor via SCM rights and assign it a name",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001624 .cmd = hmp_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001625 },
1626
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001627STEXI
1628@item getfd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001629@findex getfd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001630If a file descriptor is passed alongside this command using the SCM_RIGHTS
1631mechanism on unix sockets, it is stored using the name @var{fdname} for
1632later use by other monitor commands.
1633ETEXI
1634
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001635 {
1636 .name = "closefd",
1637 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001638 .params = "closefd name",
1639 .help = "close a file descriptor previously passed via SCM rights",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001640 .cmd = hmp_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001641 },
1642
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001643STEXI
1644@item closefd @var{fdname}
Stefan Weil70fcbbe2010-02-05 23:52:04 +01001645@findex closefd
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001646Close the file descriptor previously assigned to @var{fdname} using the
1647@code{getfd} command. This is only needed if the file descriptor was never
1648used by another monitor command.
1649ETEXI
1650
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001651 {
1652 .name = "block_passwd",
1653 .args_type = "device:B,password:s",
1654 .params = "block_passwd device password",
1655 .help = "set the password of encrypted block devices",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001656 .cmd = hmp_block_passwd,
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001657 },
1658
1659STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001660@item block_passwd @var{device} @var{password}
1661@findex block_passwd
1662Set the encrypted device @var{device} password to @var{password}
Daniel P. Berrangec01c2142017-06-23 17:24:16 +01001663
1664This command is now obsolete and will always return an error since 2.10
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001665ETEXI
1666
1667 {
1668 .name = "block_set_io_throttle",
1669 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1670 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1671 .help = "change I/O throttle limits for a block drive",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001672 .cmd = hmp_block_set_io_throttle,
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001673 },
1674
1675STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001676@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1677@findex block_set_io_throttle
Alberto Garcia83592182018-03-09 16:11:07 +02001678Change 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}.
1679@var{device} can be a block device name, a qdev ID or a QOM path.
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001680ETEXI
Jan Kiszkab40292e2010-05-31 14:43:31 -03001681
Jan Kiszka33572ec2010-05-31 14:43:30 -03001682 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001683 .name = "set_password",
1684 .args_type = "protocol:s,password:s,connected:s?",
1685 .params = "protocol password action-if-connected",
1686 .help = "set spice/vnc password",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001687 .cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001688 },
1689
1690STEXI
1691@item set_password [ vnc | spice ] password [ action-if-connected ]
1692@findex set_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001693Change spice/vnc password. Use zero to make the password stay valid
1694forever. @var{action-if-connected} specifies what should happen in
1695case a connection is established: @var{fail} makes the password change
1696fail. @var{disconnect} changes the password and disconnects the
1697client. @var{keep} changes the password and keeps the connection up.
1698@var{keep} is the default.
1699ETEXI
1700
1701 {
1702 .name = "expire_password",
1703 .args_type = "protocol:s,time:s",
1704 .params = "protocol time",
1705 .help = "set spice/vnc password expire-time",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001706 .cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001707 },
1708
1709STEXI
1710@item expire_password [ vnc | spice ] expire-time
1711@findex expire_password
Gerd Hoffmann75721502010-10-07 12:22:54 +02001712Specify when a password for spice/vnc becomes
1713invalid. @var{expire-time} accepts:
1714
1715@table @var
1716@item now
1717Invalidate password instantly.
1718
1719@item never
1720Password stays valid forever.
1721
1722@item +nsec
1723Password stays valid for @var{nsec} seconds starting now.
1724
1725@item nsec
1726Password is invalidated at the given time. @var{nsec} are the seconds
1727passed since 1970, i.e. unix epoch.
1728
1729@end table
1730ETEXI
1731
Gerd Hoffmann46920822013-02-28 08:46:10 +01001732 {
1733 .name = "chardev-add",
1734 .args_type = "args:s",
1735 .params = "args",
1736 .help = "add chardev",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001737 .cmd = hmp_chardev_add,
Hani Benhabiles13e315d2014-05-07 23:41:29 +01001738 .command_completion = chardev_add_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001739 },
1740
1741STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001742@item chardev-add args
1743@findex chardev-add
Anton Nefedov75b60162017-07-06 15:08:57 +03001744chardev-add accepts the same parameters as the -chardev command line switch.
1745
1746ETEXI
1747
1748 {
1749 .name = "chardev-change",
1750 .args_type = "id:s,args:s",
1751 .params = "id args",
1752 .help = "change chardev",
1753 .cmd = hmp_chardev_change,
1754 },
1755
1756STEXI
1757@item chardev-change args
1758@findex chardev-change
1759chardev-change accepts existing chardev @var{id} and then the same arguments
1760as the -chardev command line switch (except for "id").
Gerd Hoffmann46920822013-02-28 08:46:10 +01001761
1762ETEXI
1763
1764 {
1765 .name = "chardev-remove",
1766 .args_type = "id:s",
1767 .params = "id",
1768 .help = "remove chardev",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001769 .cmd = hmp_chardev_remove,
Hani Benhabiles6297d9a2014-05-07 23:41:28 +01001770 .command_completion = chardev_remove_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001771 },
1772
1773STEXI
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001774@item chardev-remove id
1775@findex chardev-remove
Gerd Hoffmann46920822013-02-28 08:46:10 +01001776Removes the chardev @var{id}.
1777
1778ETEXI
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001779
1780 {
Stefan Fritschbd1d5ad2017-06-11 09:48:17 +02001781 .name = "chardev-send-break",
1782 .args_type = "id:s",
1783 .params = "id",
1784 .help = "send a break on chardev",
1785 .cmd = hmp_chardev_send_break,
1786 .command_completion = chardev_remove_completion,
1787 },
1788
1789STEXI
1790@item chardev-send-break id
1791@findex chardev-send-break
1792Send a break on the chardev @var{id}.
1793
1794ETEXI
1795
1796 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001797 .name = "qemu-io",
1798 .args_type = "device:B,command:s",
1799 .params = "[device] \"[command]\"",
1800 .help = "run a qemu-io command on a block device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001801 .cmd = hmp_qemu_io,
Kevin Wolf587da2c2013-06-05 14:19:41 +02001802 },
1803
1804STEXI
1805@item qemu-io @var{device} @var{command}
1806@findex qemu-io
Kevin Wolf587da2c2013-06-05 14:19:41 +02001807Executes a qemu-io command on the given block device.
1808
1809ETEXI
1810
1811 {
Jason J. Herneabf23322013-12-11 13:24:14 -05001812 .name = "cpu-add",
1813 .args_type = "id:i",
1814 .params = "id",
1815 .help = "add cpu",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001816 .cmd = hmp_cpu_add,
Jason J. Herneabf23322013-12-11 13:24:14 -05001817 },
1818
1819STEXI
1820@item cpu-add @var{id}
Markus Armbrusterb76d7992015-03-10 13:23:04 +01001821@findex cpu-add
Jason J. Herneabf23322013-12-11 13:24:14 -05001822Add CPU with id @var{id}
1823ETEXI
1824
1825 {
Andreas Färber89d7fa92014-05-07 18:08:29 +02001826 .name = "qom-list",
1827 .args_type = "path:s?",
1828 .params = "path",
1829 .help = "list QOM properties",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001830 .cmd = hmp_qom_list,
Andreas Färber89d7fa92014-05-07 18:08:29 +02001831 },
1832
1833STEXI
1834@item qom-list [@var{path}]
1835Print QOM properties of object at location @var{path}
1836ETEXI
1837
1838 {
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001839 .name = "qom-set",
1840 .args_type = "path:s,property:s,value:s",
1841 .params = "path property value",
1842 .help = "set QOM property",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001843 .cmd = hmp_qom_set,
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001844 },
1845
1846STEXI
1847@item qom-set @var{path} @var{property} @var{value}
1848Set QOM property @var{property} of object at location @var{path} to value @var{value}
1849ETEXI
1850
1851 {
Jan Kiszka33572ec2010-05-31 14:43:30 -03001852 .name = "info",
1853 .args_type = "item:s?",
1854 .params = "[subcommand]",
1855 .help = "show various information about the system state",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001856 .cmd = hmp_info_help,
1857 .sub_table = info_cmds,
Jan Kiszka33572ec2010-05-31 14:43:30 -03001858 },
1859
1860STEXI
Pavel Butsykin70703342015-09-10 18:39:00 +03001861@end table
1862ETEXI