root / hmp-commands.hx @ dc1c13d9
History | View | Annotate | Download (39.4 kB)
1 | 2313086a | Blue Swirl | HXCOMM Use DEFHEADING() to define headings in both help text and texi |
---|---|---|---|
2 | 2313086a | Blue Swirl | HXCOMM Text between STEXI and ETEXI are copied to texi version and |
3 | 2313086a | Blue Swirl | HXCOMM discarded from C version |
4 | 2313086a | Blue Swirl | HXCOMM DEF(command, args, callback, arg_string, help) is used to construct |
5 | 2313086a | Blue Swirl | HXCOMM monitor commands |
6 | 2313086a | Blue Swirl | HXCOMM HXCOMM can be used for comments, discarded from both texi and C |
7 | 2313086a | Blue Swirl | |
8 | 2313086a | Blue Swirl | STEXI |
9 | 2313086a | Blue Swirl | @table @option |
10 | 2313086a | Blue Swirl | ETEXI |
11 | 2313086a | Blue Swirl | |
12 | d7f9b689 | Luiz Capitulino | { |
13 | d7f9b689 | Luiz Capitulino | .name = "help|?", |
14 | d7f9b689 | Luiz Capitulino | .args_type = "name:s?", |
15 | d7f9b689 | Luiz Capitulino | .params = "[cmd]", |
16 | d7f9b689 | Luiz Capitulino | .help = "show the help", |
17 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_help_cmd, |
18 | d7f9b689 | Luiz Capitulino | }, |
19 | d7f9b689 | Luiz Capitulino | |
20 | 2313086a | Blue Swirl | STEXI |
21 | 2313086a | Blue Swirl | @item help or ? [@var{cmd}] |
22 | 70fcbbe7 | Stefan Weil | @findex help |
23 | 2313086a | Blue Swirl | Show the help for all commands or just for command @var{cmd}. |
24 | 2313086a | Blue Swirl | ETEXI |
25 | 2313086a | Blue Swirl | |
26 | d7f9b689 | Luiz Capitulino | { |
27 | d7f9b689 | Luiz Capitulino | .name = "commit", |
28 | d7f9b689 | Luiz Capitulino | .args_type = "device:B", |
29 | d7f9b689 | Luiz Capitulino | .params = "device|all", |
30 | d7f9b689 | Luiz Capitulino | .help = "commit changes to the disk images (if -snapshot is used) or backing files", |
31 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_commit, |
32 | d7f9b689 | Luiz Capitulino | }, |
33 | d7f9b689 | Luiz Capitulino | |
34 | 2313086a | Blue Swirl | STEXI |
35 | 2313086a | Blue Swirl | @item commit |
36 | 70fcbbe7 | Stefan Weil | @findex commit |
37 | 2313086a | Blue Swirl | Commit changes to the disk images (if -snapshot is used) or backing files. |
38 | 2313086a | Blue Swirl | ETEXI |
39 | 2313086a | Blue Swirl | |
40 | d7f9b689 | Luiz Capitulino | { |
41 | d7f9b689 | Luiz Capitulino | .name = "q|quit", |
42 | d7f9b689 | Luiz Capitulino | .args_type = "", |
43 | d7f9b689 | Luiz Capitulino | .params = "", |
44 | d7f9b689 | Luiz Capitulino | .help = "quit the emulator", |
45 | b223f35f | Luiz Capitulino | .user_print = monitor_user_noop, |
46 | 7a7f325e | Luiz Capitulino | .mhandler.cmd = hmp_quit, |
47 | d7f9b689 | Luiz Capitulino | }, |
48 | d7f9b689 | Luiz Capitulino | |
49 | 2313086a | Blue Swirl | STEXI |
50 | 2313086a | Blue Swirl | @item q or quit |
51 | 70fcbbe7 | Stefan Weil | @findex quit |
52 | 2313086a | Blue Swirl | Quit the emulator. |
53 | 2313086a | Blue Swirl | ETEXI |
54 | 2313086a | Blue Swirl | |
55 | d7f9b689 | Luiz Capitulino | { |
56 | 6d4a2b3a | Christoph Hellwig | .name = "block_resize", |
57 | 6d4a2b3a | Christoph Hellwig | .args_type = "device:B,size:o", |
58 | 6d4a2b3a | Christoph Hellwig | .params = "device size", |
59 | 6d4a2b3a | Christoph Hellwig | .help = "resize a block image", |
60 | 5e7caacb | Luiz Capitulino | .mhandler.cmd = hmp_block_resize, |
61 | 6d4a2b3a | Christoph Hellwig | }, |
62 | 6d4a2b3a | Christoph Hellwig | |
63 | 6d4a2b3a | Christoph Hellwig | STEXI |
64 | 6d4a2b3a | Christoph Hellwig | @item block_resize |
65 | 6d4a2b3a | Christoph Hellwig | @findex block_resize |
66 | 6d4a2b3a | Christoph Hellwig | Resize a block image while a guest is running. Usually requires guest |
67 | 6d4a2b3a | Christoph Hellwig | action to see the updated size. Resize to a lower size is supported, |
68 | 6d4a2b3a | Christoph Hellwig | but should be used with extreme caution. Note that this command only |
69 | 6d4a2b3a | Christoph Hellwig | resizes image files, it can not resize block devices like LVM volumes. |
70 | 6d4a2b3a | Christoph Hellwig | ETEXI |
71 | 6d4a2b3a | Christoph Hellwig | |
72 | 12bd451f | Stefan Hajnoczi | { |
73 | 12bd451f | Stefan Hajnoczi | .name = "block_stream", |
74 | c83c66c3 | Stefan Hajnoczi | .args_type = "device:B,speed:o?,base:s?", |
75 | c83c66c3 | Stefan Hajnoczi | .params = "device [speed [base]]", |
76 | 12bd451f | Stefan Hajnoczi | .help = "copy data from a backing file into a block device", |
77 | 12bd451f | Stefan Hajnoczi | .mhandler.cmd = hmp_block_stream, |
78 | 12bd451f | Stefan Hajnoczi | }, |
79 | 12bd451f | Stefan Hajnoczi | |
80 | 12bd451f | Stefan Hajnoczi | STEXI |
81 | 12bd451f | Stefan Hajnoczi | @item block_stream |
82 | 12bd451f | Stefan Hajnoczi | @findex block_stream |
83 | 12bd451f | Stefan Hajnoczi | Copy data from a backing file into a block device. |
84 | 12bd451f | Stefan Hajnoczi | ETEXI |
85 | 6d4a2b3a | Christoph Hellwig | |
86 | 6d4a2b3a | Christoph Hellwig | { |
87 | 2d47c6e9 | Stefan Hajnoczi | .name = "block_job_set_speed", |
88 | 882ec7ce | Stefan Hajnoczi | .args_type = "device:B,speed:o", |
89 | 882ec7ce | Stefan Hajnoczi | .params = "device speed", |
90 | 2d47c6e9 | Stefan Hajnoczi | .help = "set maximum speed for a background block operation", |
91 | 2d47c6e9 | Stefan Hajnoczi | .mhandler.cmd = hmp_block_job_set_speed, |
92 | 2d47c6e9 | Stefan Hajnoczi | }, |
93 | 2d47c6e9 | Stefan Hajnoczi | |
94 | 2d47c6e9 | Stefan Hajnoczi | STEXI |
95 | 4451b799 | Paolo Bonzini | @item block_job_set_speed |
96 | 4451b799 | Paolo Bonzini | @findex block_job_set_speed |
97 | 2d47c6e9 | Stefan Hajnoczi | Set maximum speed for a background block operation. |
98 | 2d47c6e9 | Stefan Hajnoczi | ETEXI |
99 | 2d47c6e9 | Stefan Hajnoczi | |
100 | 2d47c6e9 | Stefan Hajnoczi | { |
101 | 370521a1 | Stefan Hajnoczi | .name = "block_job_cancel", |
102 | 370521a1 | Stefan Hajnoczi | .args_type = "device:B", |
103 | 370521a1 | Stefan Hajnoczi | .params = "device", |
104 | 05290d80 | Paolo Bonzini | .help = "stop an active background block operation", |
105 | 370521a1 | Stefan Hajnoczi | .mhandler.cmd = hmp_block_job_cancel, |
106 | 370521a1 | Stefan Hajnoczi | }, |
107 | 370521a1 | Stefan Hajnoczi | |
108 | 370521a1 | Stefan Hajnoczi | STEXI |
109 | 370521a1 | Stefan Hajnoczi | @item block_job_cancel |
110 | 370521a1 | Stefan Hajnoczi | @findex block_job_cancel |
111 | 370521a1 | Stefan Hajnoczi | Stop an active block streaming operation. |
112 | 370521a1 | Stefan Hajnoczi | ETEXI |
113 | 370521a1 | Stefan Hajnoczi | |
114 | 370521a1 | Stefan Hajnoczi | { |
115 | d7f9b689 | Luiz Capitulino | .name = "eject", |
116 | 78d714e0 | Luiz Capitulino | .args_type = "force:-f,device:B", |
117 | d7f9b689 | Luiz Capitulino | .params = "[-f] device", |
118 | d7f9b689 | Luiz Capitulino | .help = "eject a removable medium (use -f to force it)", |
119 | c245b6a3 | Luiz Capitulino | .mhandler.cmd = hmp_eject, |
120 | d7f9b689 | Luiz Capitulino | }, |
121 | d7f9b689 | Luiz Capitulino | |
122 | 2313086a | Blue Swirl | STEXI |
123 | 2313086a | Blue Swirl | @item eject [-f] @var{device} |
124 | 70fcbbe7 | Stefan Weil | @findex eject |
125 | 2313086a | Blue Swirl | Eject a removable medium (use -f to force it). |
126 | 2313086a | Blue Swirl | ETEXI |
127 | 2313086a | Blue Swirl | |
128 | d7f9b689 | Luiz Capitulino | { |
129 | 9063f814 | Ryan Harper | .name = "drive_del", |
130 | 9063f814 | Ryan Harper | .args_type = "id:s", |
131 | 9063f814 | Ryan Harper | .params = "device", |
132 | 9063f814 | Ryan Harper | .help = "remove host block device", |
133 | 9063f814 | Ryan Harper | .user_print = monitor_user_noop, |
134 | 9063f814 | Ryan Harper | .mhandler.cmd_new = do_drive_del, |
135 | 9063f814 | Ryan Harper | }, |
136 | 9063f814 | Ryan Harper | |
137 | 9063f814 | Ryan Harper | STEXI |
138 | 9063f814 | Ryan Harper | @item drive_del @var{device} |
139 | 9063f814 | Ryan Harper | @findex drive_del |
140 | 9063f814 | Ryan Harper | Remove host block device. The result is that guest generated IO is no longer |
141 | 9063f814 | Ryan Harper | submitted against the host device underlying the disk. Once a drive has |
142 | 9063f814 | Ryan Harper | been deleted, the QEMU Block layer returns -EIO which results in IO |
143 | 9063f814 | Ryan Harper | errors in the guest for applications that are reading/writing to the device. |
144 | 9063f814 | Ryan Harper | ETEXI |
145 | 9063f814 | Ryan Harper | |
146 | 9063f814 | Ryan Harper | { |
147 | d7f9b689 | Luiz Capitulino | .name = "change", |
148 | d7f9b689 | Luiz Capitulino | .args_type = "device:B,target:F,arg:s?", |
149 | d7f9b689 | Luiz Capitulino | .params = "device filename [format]", |
150 | d7f9b689 | Luiz Capitulino | .help = "change a removable medium, optional format", |
151 | 333a96ec | Luiz Capitulino | .mhandler.cmd = hmp_change, |
152 | d7f9b689 | Luiz Capitulino | }, |
153 | d7f9b689 | Luiz Capitulino | |
154 | 2313086a | Blue Swirl | STEXI |
155 | 2313086a | Blue Swirl | @item change @var{device} @var{setting} |
156 | 70fcbbe7 | Stefan Weil | @findex change |
157 | 2313086a | Blue Swirl | |
158 | 2313086a | Blue Swirl | Change the configuration of a device. |
159 | 2313086a | Blue Swirl | |
160 | 2313086a | Blue Swirl | @table @option |
161 | 2313086a | Blue Swirl | @item change @var{diskdevice} @var{filename} [@var{format}] |
162 | 2313086a | Blue Swirl | Change the medium for a removable disk device to point to @var{filename}. eg |
163 | 2313086a | Blue Swirl | |
164 | 2313086a | Blue Swirl | @example |
165 | 2313086a | Blue Swirl | (qemu) change ide1-cd0 /path/to/some.iso |
166 | 2313086a | Blue Swirl | @end example |
167 | 2313086a | Blue Swirl | |
168 | 2313086a | Blue Swirl | @var{format} is optional. |
169 | 2313086a | Blue Swirl | |
170 | 2313086a | Blue Swirl | @item change vnc @var{display},@var{options} |
171 | 2313086a | Blue Swirl | Change the configuration of the VNC server. The valid syntax for @var{display} |
172 | 2313086a | Blue Swirl | and @var{options} are described at @ref{sec_invocation}. eg |
173 | 2313086a | Blue Swirl | |
174 | 2313086a | Blue Swirl | @example |
175 | 2313086a | Blue Swirl | (qemu) change vnc localhost:1 |
176 | 2313086a | Blue Swirl | @end example |
177 | 2313086a | Blue Swirl | |
178 | 2313086a | Blue Swirl | @item change vnc password [@var{password}] |
179 | 2313086a | Blue Swirl | |
180 | 2313086a | Blue Swirl | Change the password associated with the VNC server. If the new password is not |
181 | 2313086a | Blue Swirl | supplied, the monitor will prompt for it to be entered. VNC passwords are only |
182 | 2313086a | Blue Swirl | significant up to 8 letters. eg |
183 | 2313086a | Blue Swirl | |
184 | 2313086a | Blue Swirl | @example |
185 | 2313086a | Blue Swirl | (qemu) change vnc password |
186 | 2313086a | Blue Swirl | Password: ******** |
187 | 2313086a | Blue Swirl | @end example |
188 | 2313086a | Blue Swirl | |
189 | 2313086a | Blue Swirl | @end table |
190 | 2313086a | Blue Swirl | ETEXI |
191 | 2313086a | Blue Swirl | |
192 | d7f9b689 | Luiz Capitulino | { |
193 | d7f9b689 | Luiz Capitulino | .name = "screendump", |
194 | d7f9b689 | Luiz Capitulino | .args_type = "filename:F", |
195 | d7f9b689 | Luiz Capitulino | .params = "filename", |
196 | d7f9b689 | Luiz Capitulino | .help = "save screen into PPM image 'filename'", |
197 | ad39cf6d | Luiz Capitulino | .mhandler.cmd = hmp_screen_dump, |
198 | d7f9b689 | Luiz Capitulino | }, |
199 | d7f9b689 | Luiz Capitulino | |
200 | 2313086a | Blue Swirl | STEXI |
201 | 2313086a | Blue Swirl | @item screendump @var{filename} |
202 | 70fcbbe7 | Stefan Weil | @findex screendump |
203 | 2313086a | Blue Swirl | Save screen into PPM image @var{filename}. |
204 | 2313086a | Blue Swirl | ETEXI |
205 | 2313086a | Blue Swirl | |
206 | d7f9b689 | Luiz Capitulino | { |
207 | d7f9b689 | Luiz Capitulino | .name = "logfile", |
208 | d7f9b689 | Luiz Capitulino | .args_type = "filename:F", |
209 | d7f9b689 | Luiz Capitulino | .params = "filename", |
210 | d7f9b689 | Luiz Capitulino | .help = "output logs to 'filename'", |
211 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_logfile, |
212 | d7f9b689 | Luiz Capitulino | }, |
213 | d7f9b689 | Luiz Capitulino | |
214 | 2313086a | Blue Swirl | STEXI |
215 | 2313086a | Blue Swirl | @item logfile @var{filename} |
216 | 70fcbbe7 | Stefan Weil | @findex logfile |
217 | 2313086a | Blue Swirl | Output logs to @var{filename}. |
218 | 2313086a | Blue Swirl | ETEXI |
219 | 2313086a | Blue Swirl | |
220 | 22890ab5 | Prerna Saxena | { |
221 | 22890ab5 | Prerna Saxena | .name = "trace-event", |
222 | 22890ab5 | Prerna Saxena | .args_type = "name:s,option:b", |
223 | 22890ab5 | Prerna Saxena | .params = "name on|off", |
224 | 22890ab5 | Prerna Saxena | .help = "changes status of a specific trace event", |
225 | fc764105 | Lluís | .mhandler.cmd = do_trace_event_set_state, |
226 | 22890ab5 | Prerna Saxena | }, |
227 | 22890ab5 | Prerna Saxena | |
228 | 22890ab5 | Prerna Saxena | STEXI |
229 | 22890ab5 | Prerna Saxena | @item trace-event |
230 | 22890ab5 | Prerna Saxena | @findex trace-event |
231 | 22890ab5 | Prerna Saxena | changes status of a trace event |
232 | 22890ab5 | Prerna Saxena | ETEXI |
233 | c5ceb523 | Stefan Hajnoczi | |
234 | c45a8168 | Michael Roth | #if defined(CONFIG_TRACE_SIMPLE) |
235 | c5ceb523 | Stefan Hajnoczi | { |
236 | c5ceb523 | Stefan Hajnoczi | .name = "trace-file", |
237 | c5ceb523 | Stefan Hajnoczi | .args_type = "op:s?,arg:F?", |
238 | c5ceb523 | Stefan Hajnoczi | .params = "on|off|flush|set [arg]", |
239 | c5ceb523 | Stefan Hajnoczi | .help = "open, close, or flush trace file, or set a new file name", |
240 | c5ceb523 | Stefan Hajnoczi | .mhandler.cmd = do_trace_file, |
241 | c5ceb523 | Stefan Hajnoczi | }, |
242 | c5ceb523 | Stefan Hajnoczi | |
243 | c5ceb523 | Stefan Hajnoczi | STEXI |
244 | c5ceb523 | Stefan Hajnoczi | @item trace-file on|off|flush |
245 | c5ceb523 | Stefan Hajnoczi | @findex trace-file |
246 | c5ceb523 | Stefan Hajnoczi | Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed. |
247 | c5ceb523 | Stefan Hajnoczi | ETEXI |
248 | 22890ab5 | Prerna Saxena | #endif |
249 | 22890ab5 | Prerna Saxena | |
250 | d7f9b689 | Luiz Capitulino | { |
251 | d7f9b689 | Luiz Capitulino | .name = "log", |
252 | d7f9b689 | Luiz Capitulino | .args_type = "items:s", |
253 | d7f9b689 | Luiz Capitulino | .params = "item1[,...]", |
254 | d7f9b689 | Luiz Capitulino | .help = "activate logging of the specified items to '/tmp/qemu.log'", |
255 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_log, |
256 | d7f9b689 | Luiz Capitulino | }, |
257 | d7f9b689 | Luiz Capitulino | |
258 | 2313086a | Blue Swirl | STEXI |
259 | 2313086a | Blue Swirl | @item log @var{item1}[,...] |
260 | 70fcbbe7 | Stefan Weil | @findex log |
261 | 2313086a | Blue Swirl | Activate logging of the specified items to @file{/tmp/qemu.log}. |
262 | 2313086a | Blue Swirl | ETEXI |
263 | 2313086a | Blue Swirl | |
264 | d7f9b689 | Luiz Capitulino | { |
265 | d7f9b689 | Luiz Capitulino | .name = "savevm", |
266 | d7f9b689 | Luiz Capitulino | .args_type = "name:s?", |
267 | d7f9b689 | Luiz Capitulino | .params = "[tag|id]", |
268 | d7f9b689 | Luiz Capitulino | .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created", |
269 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_savevm, |
270 | d7f9b689 | Luiz Capitulino | }, |
271 | d7f9b689 | Luiz Capitulino | |
272 | 2313086a | Blue Swirl | STEXI |
273 | 2313086a | Blue Swirl | @item savevm [@var{tag}|@var{id}] |
274 | 70fcbbe7 | Stefan Weil | @findex savevm |
275 | 2313086a | Blue Swirl | Create a snapshot of the whole virtual machine. If @var{tag} is |
276 | 2313086a | Blue Swirl | provided, it is used as human readable identifier. If there is already |
277 | 2313086a | Blue Swirl | a snapshot with the same tag or ID, it is replaced. More info at |
278 | 2313086a | Blue Swirl | @ref{vm_snapshots}. |
279 | 2313086a | Blue Swirl | ETEXI |
280 | 2313086a | Blue Swirl | |
281 | d7f9b689 | Luiz Capitulino | { |
282 | d7f9b689 | Luiz Capitulino | .name = "loadvm", |
283 | d7f9b689 | Luiz Capitulino | .args_type = "name:s", |
284 | d7f9b689 | Luiz Capitulino | .params = "tag|id", |
285 | d7f9b689 | Luiz Capitulino | .help = "restore a VM snapshot from its tag or id", |
286 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_loadvm, |
287 | d7f9b689 | Luiz Capitulino | }, |
288 | d7f9b689 | Luiz Capitulino | |
289 | 2313086a | Blue Swirl | STEXI |
290 | 2313086a | Blue Swirl | @item loadvm @var{tag}|@var{id} |
291 | 70fcbbe7 | Stefan Weil | @findex loadvm |
292 | 2313086a | Blue Swirl | Set the whole virtual machine to the snapshot identified by the tag |
293 | 2313086a | Blue Swirl | @var{tag} or the unique snapshot ID @var{id}. |
294 | 2313086a | Blue Swirl | ETEXI |
295 | 2313086a | Blue Swirl | |
296 | d7f9b689 | Luiz Capitulino | { |
297 | d7f9b689 | Luiz Capitulino | .name = "delvm", |
298 | d7f9b689 | Luiz Capitulino | .args_type = "name:s", |
299 | d7f9b689 | Luiz Capitulino | .params = "tag|id", |
300 | d7f9b689 | Luiz Capitulino | .help = "delete a VM snapshot from its tag or id", |
301 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_delvm, |
302 | d7f9b689 | Luiz Capitulino | }, |
303 | d7f9b689 | Luiz Capitulino | |
304 | 2313086a | Blue Swirl | STEXI |
305 | 2313086a | Blue Swirl | @item delvm @var{tag}|@var{id} |
306 | 70fcbbe7 | Stefan Weil | @findex delvm |
307 | 2313086a | Blue Swirl | Delete the snapshot identified by @var{tag} or @var{id}. |
308 | 2313086a | Blue Swirl | ETEXI |
309 | 2313086a | Blue Swirl | |
310 | d7f9b689 | Luiz Capitulino | { |
311 | d7f9b689 | Luiz Capitulino | .name = "singlestep", |
312 | d7f9b689 | Luiz Capitulino | .args_type = "option:s?", |
313 | d7f9b689 | Luiz Capitulino | .params = "[on|off]", |
314 | d7f9b689 | Luiz Capitulino | .help = "run emulation in singlestep mode or switch to normal mode", |
315 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_singlestep, |
316 | d7f9b689 | Luiz Capitulino | }, |
317 | d7f9b689 | Luiz Capitulino | |
318 | 2313086a | Blue Swirl | STEXI |
319 | 2313086a | Blue Swirl | @item singlestep [off] |
320 | 70fcbbe7 | Stefan Weil | @findex singlestep |
321 | 2313086a | Blue Swirl | Run the emulation in single step mode. |
322 | 2313086a | Blue Swirl | If called with option off, the emulation returns to normal mode. |
323 | 2313086a | Blue Swirl | ETEXI |
324 | 2313086a | Blue Swirl | |
325 | d7f9b689 | Luiz Capitulino | { |
326 | d7f9b689 | Luiz Capitulino | .name = "stop", |
327 | d7f9b689 | Luiz Capitulino | .args_type = "", |
328 | d7f9b689 | Luiz Capitulino | .params = "", |
329 | d7f9b689 | Luiz Capitulino | .help = "stop emulation", |
330 | 5f158f21 | Luiz Capitulino | .mhandler.cmd = hmp_stop, |
331 | d7f9b689 | Luiz Capitulino | }, |
332 | d7f9b689 | Luiz Capitulino | |
333 | 2313086a | Blue Swirl | STEXI |
334 | 2313086a | Blue Swirl | @item stop |
335 | 70fcbbe7 | Stefan Weil | @findex stop |
336 | 2313086a | Blue Swirl | Stop emulation. |
337 | 2313086a | Blue Swirl | ETEXI |
338 | 2313086a | Blue Swirl | |
339 | d7f9b689 | Luiz Capitulino | { |
340 | d7f9b689 | Luiz Capitulino | .name = "c|cont", |
341 | d7f9b689 | Luiz Capitulino | .args_type = "", |
342 | d7f9b689 | Luiz Capitulino | .params = "", |
343 | d7f9b689 | Luiz Capitulino | .help = "resume emulation", |
344 | e42e818b | Luiz Capitulino | .mhandler.cmd = hmp_cont, |
345 | d7f9b689 | Luiz Capitulino | }, |
346 | d7f9b689 | Luiz Capitulino | |
347 | 2313086a | Blue Swirl | STEXI |
348 | 2313086a | Blue Swirl | @item c or cont |
349 | 70fcbbe7 | Stefan Weil | @findex cont |
350 | 2313086a | Blue Swirl | Resume emulation. |
351 | 2313086a | Blue Swirl | ETEXI |
352 | 2313086a | Blue Swirl | |
353 | d7f9b689 | Luiz Capitulino | { |
354 | 9b9df25a | Gerd Hoffmann | .name = "system_wakeup", |
355 | 9b9df25a | Gerd Hoffmann | .args_type = "", |
356 | 9b9df25a | Gerd Hoffmann | .params = "", |
357 | 9b9df25a | Gerd Hoffmann | .help = "wakeup guest from suspend", |
358 | 9b9df25a | Gerd Hoffmann | .mhandler.cmd = hmp_system_wakeup, |
359 | 9b9df25a | Gerd Hoffmann | }, |
360 | 9b9df25a | Gerd Hoffmann | |
361 | 9b9df25a | Gerd Hoffmann | STEXI |
362 | 9b9df25a | Gerd Hoffmann | @item system_wakeup |
363 | 9b9df25a | Gerd Hoffmann | @findex system_wakeup |
364 | 9b9df25a | Gerd Hoffmann | Wakeup guest from suspend. |
365 | 9b9df25a | Gerd Hoffmann | ETEXI |
366 | 9b9df25a | Gerd Hoffmann | |
367 | 9b9df25a | Gerd Hoffmann | { |
368 | d7f9b689 | Luiz Capitulino | .name = "gdbserver", |
369 | d7f9b689 | Luiz Capitulino | .args_type = "device:s?", |
370 | d7f9b689 | Luiz Capitulino | .params = "[device]", |
371 | d7f9b689 | Luiz Capitulino | .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'", |
372 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_gdbserver, |
373 | d7f9b689 | Luiz Capitulino | }, |
374 | d7f9b689 | Luiz Capitulino | |
375 | 2313086a | Blue Swirl | STEXI |
376 | 2313086a | Blue Swirl | @item gdbserver [@var{port}] |
377 | 70fcbbe7 | Stefan Weil | @findex gdbserver |
378 | 2313086a | Blue Swirl | Start gdbserver session (default @var{port}=1234) |
379 | 2313086a | Blue Swirl | ETEXI |
380 | 2313086a | Blue Swirl | |
381 | d7f9b689 | Luiz Capitulino | { |
382 | d7f9b689 | Luiz Capitulino | .name = "x", |
383 | d7f9b689 | Luiz Capitulino | .args_type = "fmt:/,addr:l", |
384 | d7f9b689 | Luiz Capitulino | .params = "/fmt addr", |
385 | d7f9b689 | Luiz Capitulino | .help = "virtual memory dump starting at 'addr'", |
386 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_memory_dump, |
387 | d7f9b689 | Luiz Capitulino | }, |
388 | d7f9b689 | Luiz Capitulino | |
389 | 2313086a | Blue Swirl | STEXI |
390 | 2313086a | Blue Swirl | @item x/fmt @var{addr} |
391 | 70fcbbe7 | Stefan Weil | @findex x |
392 | 2313086a | Blue Swirl | Virtual memory dump starting at @var{addr}. |
393 | 2313086a | Blue Swirl | ETEXI |
394 | 2313086a | Blue Swirl | |
395 | d7f9b689 | Luiz Capitulino | { |
396 | d7f9b689 | Luiz Capitulino | .name = "xp", |
397 | d7f9b689 | Luiz Capitulino | .args_type = "fmt:/,addr:l", |
398 | d7f9b689 | Luiz Capitulino | .params = "/fmt addr", |
399 | d7f9b689 | Luiz Capitulino | .help = "physical memory dump starting at 'addr'", |
400 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_physical_memory_dump, |
401 | d7f9b689 | Luiz Capitulino | }, |
402 | d7f9b689 | Luiz Capitulino | |
403 | 2313086a | Blue Swirl | STEXI |
404 | 2313086a | Blue Swirl | @item xp /@var{fmt} @var{addr} |
405 | 70fcbbe7 | Stefan Weil | @findex xp |
406 | 2313086a | Blue Swirl | Physical memory dump starting at @var{addr}. |
407 | 2313086a | Blue Swirl | |
408 | 2313086a | Blue Swirl | @var{fmt} is a format which tells the command how to format the |
409 | 2313086a | Blue Swirl | data. Its syntax is: @option{/@{count@}@{format@}@{size@}} |
410 | 2313086a | Blue Swirl | |
411 | 2313086a | Blue Swirl | @table @var |
412 | 2313086a | Blue Swirl | @item count |
413 | 2313086a | Blue Swirl | is the number of items to be dumped. |
414 | 2313086a | Blue Swirl | |
415 | 2313086a | Blue Swirl | @item format |
416 | 2313086a | Blue Swirl | can be x (hex), d (signed decimal), u (unsigned decimal), o (octal), |
417 | 2313086a | Blue Swirl | c (char) or i (asm instruction). |
418 | 2313086a | Blue Swirl | |
419 | 2313086a | Blue Swirl | @item size |
420 | 2313086a | Blue Swirl | can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86, |
421 | 2313086a | Blue Swirl | @code{h} or @code{w} can be specified with the @code{i} format to |
422 | 2313086a | Blue Swirl | respectively select 16 or 32 bit code instruction size. |
423 | 2313086a | Blue Swirl | |
424 | 2313086a | Blue Swirl | @end table |
425 | 2313086a | Blue Swirl | |
426 | 2313086a | Blue Swirl | Examples: |
427 | 2313086a | Blue Swirl | @itemize |
428 | 2313086a | Blue Swirl | @item |
429 | 2313086a | Blue Swirl | Dump 10 instructions at the current instruction pointer: |
430 | 2313086a | Blue Swirl | @example |
431 | 2313086a | Blue Swirl | (qemu) x/10i $eip |
432 | 2313086a | Blue Swirl | 0x90107063: ret |
433 | 2313086a | Blue Swirl | 0x90107064: sti |
434 | 2313086a | Blue Swirl | 0x90107065: lea 0x0(%esi,1),%esi |
435 | 2313086a | Blue Swirl | 0x90107069: lea 0x0(%edi,1),%edi |
436 | 2313086a | Blue Swirl | 0x90107070: ret |
437 | 2313086a | Blue Swirl | 0x90107071: jmp 0x90107080 |
438 | 2313086a | Blue Swirl | 0x90107073: nop |
439 | 2313086a | Blue Swirl | 0x90107074: nop |
440 | 2313086a | Blue Swirl | 0x90107075: nop |
441 | 2313086a | Blue Swirl | 0x90107076: nop |
442 | 2313086a | Blue Swirl | @end example |
443 | 2313086a | Blue Swirl | |
444 | 2313086a | Blue Swirl | @item |
445 | 2313086a | Blue Swirl | Dump 80 16 bit values at the start of the video memory. |
446 | 2313086a | Blue Swirl | @smallexample |
447 | 2313086a | Blue Swirl | (qemu) xp/80hx 0xb8000 |
448 | 2313086a | Blue Swirl | 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42 |
449 | 2313086a | Blue Swirl | 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41 |
450 | 2313086a | Blue Swirl | 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72 |
451 | 2313086a | Blue Swirl | 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73 |
452 | 2313086a | Blue Swirl | 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20 |
453 | 2313086a | Blue Swirl | 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720 |
454 | 2313086a | Blue Swirl | 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
455 | 2313086a | Blue Swirl | 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
456 | 2313086a | Blue Swirl | 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
457 | 2313086a | Blue Swirl | 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
458 | 2313086a | Blue Swirl | @end smallexample |
459 | 2313086a | Blue Swirl | @end itemize |
460 | 2313086a | Blue Swirl | ETEXI |
461 | 2313086a | Blue Swirl | |
462 | d7f9b689 | Luiz Capitulino | { |
463 | d7f9b689 | Luiz Capitulino | .name = "p|print", |
464 | d7f9b689 | Luiz Capitulino | .args_type = "fmt:/,val:l", |
465 | d7f9b689 | Luiz Capitulino | .params = "/fmt expr", |
466 | d7f9b689 | Luiz Capitulino | .help = "print expression value (use $reg for CPU register access)", |
467 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_print, |
468 | d7f9b689 | Luiz Capitulino | }, |
469 | d7f9b689 | Luiz Capitulino | |
470 | 2313086a | Blue Swirl | STEXI |
471 | 2313086a | Blue Swirl | @item p or print/@var{fmt} @var{expr} |
472 | 70fcbbe7 | Stefan Weil | @findex print |
473 | 2313086a | Blue Swirl | |
474 | 2313086a | Blue Swirl | Print expression value. Only the @var{format} part of @var{fmt} is |
475 | 2313086a | Blue Swirl | used. |
476 | 2313086a | Blue Swirl | ETEXI |
477 | 2313086a | Blue Swirl | |
478 | d7f9b689 | Luiz Capitulino | { |
479 | d7f9b689 | Luiz Capitulino | .name = "i", |
480 | d7f9b689 | Luiz Capitulino | .args_type = "fmt:/,addr:i,index:i.", |
481 | d7f9b689 | Luiz Capitulino | .params = "/fmt addr", |
482 | d7f9b689 | Luiz Capitulino | .help = "I/O port read", |
483 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_ioport_read, |
484 | d7f9b689 | Luiz Capitulino | }, |
485 | d7f9b689 | Luiz Capitulino | |
486 | 2313086a | Blue Swirl | STEXI |
487 | 2313086a | Blue Swirl | Read I/O port. |
488 | 2313086a | Blue Swirl | ETEXI |
489 | 2313086a | Blue Swirl | |
490 | d7f9b689 | Luiz Capitulino | { |
491 | d7f9b689 | Luiz Capitulino | .name = "o", |
492 | d7f9b689 | Luiz Capitulino | .args_type = "fmt:/,addr:i,val:i", |
493 | d7f9b689 | Luiz Capitulino | .params = "/fmt addr value", |
494 | d7f9b689 | Luiz Capitulino | .help = "I/O port write", |
495 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_ioport_write, |
496 | d7f9b689 | Luiz Capitulino | }, |
497 | d7f9b689 | Luiz Capitulino | |
498 | f114784f | Jan Kiszka | STEXI |
499 | f114784f | Jan Kiszka | Write to I/O port. |
500 | f114784f | Jan Kiszka | ETEXI |
501 | 2313086a | Blue Swirl | |
502 | d7f9b689 | Luiz Capitulino | { |
503 | d7f9b689 | Luiz Capitulino | .name = "sendkey", |
504 | 2ef20c15 | Amos Kong | .args_type = "keys:s,hold-time:i?", |
505 | d7f9b689 | Luiz Capitulino | .params = "keys [hold_ms]", |
506 | d7f9b689 | Luiz Capitulino | .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)", |
507 | e4c8f004 | Amos Kong | .mhandler.cmd = hmp_send_key, |
508 | d7f9b689 | Luiz Capitulino | }, |
509 | d7f9b689 | Luiz Capitulino | |
510 | 2313086a | Blue Swirl | STEXI |
511 | 2313086a | Blue Swirl | @item sendkey @var{keys} |
512 | 70fcbbe7 | Stefan Weil | @findex sendkey |
513 | 2313086a | Blue Swirl | |
514 | 886cc706 | Amos Kong | Send @var{keys} to the guest. @var{keys} could be the name of the |
515 | 886cc706 | Amos Kong | key or the raw value in hexadecimal format. Use @code{-} to press |
516 | 886cc706 | Amos Kong | several keys simultaneously. Example: |
517 | 2313086a | Blue Swirl | @example |
518 | 2313086a | Blue Swirl | sendkey ctrl-alt-f1 |
519 | 2313086a | Blue Swirl | @end example |
520 | 2313086a | Blue Swirl | |
521 | 2313086a | Blue Swirl | This command is useful to send keys that your graphical user interface |
522 | 2313086a | Blue Swirl | intercepts at low level, such as @code{ctrl-alt-f1} in X Window. |
523 | 2313086a | Blue Swirl | ETEXI |
524 | 2313086a | Blue Swirl | |
525 | d7f9b689 | Luiz Capitulino | { |
526 | d7f9b689 | Luiz Capitulino | .name = "system_reset", |
527 | d7f9b689 | Luiz Capitulino | .args_type = "", |
528 | d7f9b689 | Luiz Capitulino | .params = "", |
529 | d7f9b689 | Luiz Capitulino | .help = "reset the system", |
530 | 38d22653 | Luiz Capitulino | .mhandler.cmd = hmp_system_reset, |
531 | d7f9b689 | Luiz Capitulino | }, |
532 | d7f9b689 | Luiz Capitulino | |
533 | 2313086a | Blue Swirl | STEXI |
534 | 2313086a | Blue Swirl | @item system_reset |
535 | 70fcbbe7 | Stefan Weil | @findex system_reset |
536 | 2313086a | Blue Swirl | |
537 | 2313086a | Blue Swirl | Reset the system. |
538 | 2313086a | Blue Swirl | ETEXI |
539 | 2313086a | Blue Swirl | |
540 | d7f9b689 | Luiz Capitulino | { |
541 | d7f9b689 | Luiz Capitulino | .name = "system_powerdown", |
542 | d7f9b689 | Luiz Capitulino | .args_type = "", |
543 | d7f9b689 | Luiz Capitulino | .params = "", |
544 | d7f9b689 | Luiz Capitulino | .help = "send system power down event", |
545 | 5bc465e4 | Luiz Capitulino | .mhandler.cmd = hmp_system_powerdown, |
546 | d7f9b689 | Luiz Capitulino | }, |
547 | d7f9b689 | Luiz Capitulino | |
548 | 2313086a | Blue Swirl | STEXI |
549 | 2313086a | Blue Swirl | @item system_powerdown |
550 | 70fcbbe7 | Stefan Weil | @findex system_powerdown |
551 | 2313086a | Blue Swirl | |
552 | 2313086a | Blue Swirl | Power down the system (if supported). |
553 | 2313086a | Blue Swirl | ETEXI |
554 | 2313086a | Blue Swirl | |
555 | d7f9b689 | Luiz Capitulino | { |
556 | d7f9b689 | Luiz Capitulino | .name = "sum", |
557 | d7f9b689 | Luiz Capitulino | .args_type = "start:i,size:i", |
558 | d7f9b689 | Luiz Capitulino | .params = "addr size", |
559 | d7f9b689 | Luiz Capitulino | .help = "compute the checksum of a memory region", |
560 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_sum, |
561 | d7f9b689 | Luiz Capitulino | }, |
562 | d7f9b689 | Luiz Capitulino | |
563 | 2313086a | Blue Swirl | STEXI |
564 | 2313086a | Blue Swirl | @item sum @var{addr} @var{size} |
565 | 70fcbbe7 | Stefan Weil | @findex sum |
566 | 2313086a | Blue Swirl | |
567 | 2313086a | Blue Swirl | Compute the checksum of a memory region. |
568 | 2313086a | Blue Swirl | ETEXI |
569 | 2313086a | Blue Swirl | |
570 | d7f9b689 | Luiz Capitulino | { |
571 | d7f9b689 | Luiz Capitulino | .name = "usb_add", |
572 | d7f9b689 | Luiz Capitulino | .args_type = "devname:s", |
573 | d7f9b689 | Luiz Capitulino | .params = "device", |
574 | d7f9b689 | Luiz Capitulino | .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')", |
575 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_usb_add, |
576 | d7f9b689 | Luiz Capitulino | }, |
577 | d7f9b689 | Luiz Capitulino | |
578 | 2313086a | Blue Swirl | STEXI |
579 | 2313086a | Blue Swirl | @item usb_add @var{devname} |
580 | 70fcbbe7 | Stefan Weil | @findex usb_add |
581 | 2313086a | Blue Swirl | |
582 | 2313086a | Blue Swirl | Add the USB device @var{devname}. For details of available devices see |
583 | 2313086a | Blue Swirl | @ref{usb_devices} |
584 | 2313086a | Blue Swirl | ETEXI |
585 | 2313086a | Blue Swirl | |
586 | d7f9b689 | Luiz Capitulino | { |
587 | d7f9b689 | Luiz Capitulino | .name = "usb_del", |
588 | d7f9b689 | Luiz Capitulino | .args_type = "devname:s", |
589 | d7f9b689 | Luiz Capitulino | .params = "device", |
590 | d7f9b689 | Luiz Capitulino | .help = "remove USB device 'bus.addr'", |
591 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_usb_del, |
592 | d7f9b689 | Luiz Capitulino | }, |
593 | d7f9b689 | Luiz Capitulino | |
594 | 2313086a | Blue Swirl | STEXI |
595 | 2313086a | Blue Swirl | @item usb_del @var{devname} |
596 | 70fcbbe7 | Stefan Weil | @findex usb_del |
597 | 2313086a | Blue Swirl | |
598 | 2313086a | Blue Swirl | Remove the USB device @var{devname} from the QEMU virtual USB |
599 | 2313086a | Blue Swirl | hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor |
600 | 2313086a | Blue Swirl | command @code{info usb} to see the devices you can remove. |
601 | 2313086a | Blue Swirl | ETEXI |
602 | 2313086a | Blue Swirl | |
603 | d7f9b689 | Luiz Capitulino | { |
604 | d7f9b689 | Luiz Capitulino | .name = "device_add", |
605 | c7e4e8ce | Markus Armbruster | .args_type = "device:O", |
606 | c7e4e8ce | Markus Armbruster | .params = "driver[,prop=value][,...]", |
607 | d7f9b689 | Luiz Capitulino | .help = "add device, like -device on the command line", |
608 | 8bc27249 | Markus Armbruster | .user_print = monitor_user_noop, |
609 | 8bc27249 | Markus Armbruster | .mhandler.cmd_new = do_device_add, |
610 | d7f9b689 | Luiz Capitulino | }, |
611 | d7f9b689 | Luiz Capitulino | |
612 | 3418bd25 | Gerd Hoffmann | STEXI |
613 | 3418bd25 | Gerd Hoffmann | @item device_add @var{config} |
614 | 70fcbbe7 | Stefan Weil | @findex device_add |
615 | 3418bd25 | Gerd Hoffmann | |
616 | 3418bd25 | Gerd Hoffmann | Add device. |
617 | 3418bd25 | Gerd Hoffmann | ETEXI |
618 | 3418bd25 | Gerd Hoffmann | |
619 | d7f9b689 | Luiz Capitulino | { |
620 | d7f9b689 | Luiz Capitulino | .name = "device_del", |
621 | d7f9b689 | Luiz Capitulino | .args_type = "id:s", |
622 | d7f9b689 | Luiz Capitulino | .params = "device", |
623 | d7f9b689 | Luiz Capitulino | .help = "remove device", |
624 | a15fef21 | Luiz Capitulino | .mhandler.cmd = hmp_device_del, |
625 | d7f9b689 | Luiz Capitulino | }, |
626 | d7f9b689 | Luiz Capitulino | |
627 | 3418bd25 | Gerd Hoffmann | STEXI |
628 | 3418bd25 | Gerd Hoffmann | @item device_del @var{id} |
629 | 70fcbbe7 | Stefan Weil | @findex device_del |
630 | 3418bd25 | Gerd Hoffmann | |
631 | 3418bd25 | Gerd Hoffmann | Remove device @var{id}. |
632 | 3418bd25 | Gerd Hoffmann | ETEXI |
633 | 3418bd25 | Gerd Hoffmann | |
634 | d7f9b689 | Luiz Capitulino | { |
635 | d7f9b689 | Luiz Capitulino | .name = "cpu", |
636 | d7f9b689 | Luiz Capitulino | .args_type = "index:i", |
637 | d7f9b689 | Luiz Capitulino | .params = "index", |
638 | d7f9b689 | Luiz Capitulino | .help = "set the default CPU", |
639 | 755f1968 | Luiz Capitulino | .mhandler.cmd = hmp_cpu, |
640 | d7f9b689 | Luiz Capitulino | }, |
641 | 3418bd25 | Gerd Hoffmann | |
642 | 2313086a | Blue Swirl | STEXI |
643 | c427ea9c | Markus Armbruster | @item cpu @var{index} |
644 | c427ea9c | Markus Armbruster | @findex cpu |
645 | 2313086a | Blue Swirl | Set the default CPU. |
646 | 2313086a | Blue Swirl | ETEXI |
647 | 2313086a | Blue Swirl | |
648 | d7f9b689 | Luiz Capitulino | { |
649 | d7f9b689 | Luiz Capitulino | .name = "mouse_move", |
650 | d7f9b689 | Luiz Capitulino | .args_type = "dx_str:s,dy_str:s,dz_str:s?", |
651 | d7f9b689 | Luiz Capitulino | .params = "dx dy [dz]", |
652 | d7f9b689 | Luiz Capitulino | .help = "send mouse move events", |
653 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_mouse_move, |
654 | d7f9b689 | Luiz Capitulino | }, |
655 | d7f9b689 | Luiz Capitulino | |
656 | 2313086a | Blue Swirl | STEXI |
657 | 2313086a | Blue Swirl | @item mouse_move @var{dx} @var{dy} [@var{dz}] |
658 | 70fcbbe7 | Stefan Weil | @findex mouse_move |
659 | 2313086a | Blue Swirl | Move the active mouse to the specified coordinates @var{dx} @var{dy} |
660 | 2313086a | Blue Swirl | with optional scroll axis @var{dz}. |
661 | 2313086a | Blue Swirl | ETEXI |
662 | 2313086a | Blue Swirl | |
663 | d7f9b689 | Luiz Capitulino | { |
664 | d7f9b689 | Luiz Capitulino | .name = "mouse_button", |
665 | d7f9b689 | Luiz Capitulino | .args_type = "button_state:i", |
666 | d7f9b689 | Luiz Capitulino | .params = "state", |
667 | d7f9b689 | Luiz Capitulino | .help = "change mouse button state (1=L, 2=M, 4=R)", |
668 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_mouse_button, |
669 | d7f9b689 | Luiz Capitulino | }, |
670 | d7f9b689 | Luiz Capitulino | |
671 | 2313086a | Blue Swirl | STEXI |
672 | 2313086a | Blue Swirl | @item mouse_button @var{val} |
673 | 70fcbbe7 | Stefan Weil | @findex mouse_button |
674 | 2313086a | Blue Swirl | Change the active mouse button state @var{val} (1=L, 2=M, 4=R). |
675 | 2313086a | Blue Swirl | ETEXI |
676 | 2313086a | Blue Swirl | |
677 | d7f9b689 | Luiz Capitulino | { |
678 | d7f9b689 | Luiz Capitulino | .name = "mouse_set", |
679 | d7f9b689 | Luiz Capitulino | .args_type = "index:i", |
680 | d7f9b689 | Luiz Capitulino | .params = "index", |
681 | d7f9b689 | Luiz Capitulino | .help = "set which mouse device receives events", |
682 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_mouse_set, |
683 | d7f9b689 | Luiz Capitulino | }, |
684 | d7f9b689 | Luiz Capitulino | |
685 | 2313086a | Blue Swirl | STEXI |
686 | 2313086a | Blue Swirl | @item mouse_set @var{index} |
687 | 70fcbbe7 | Stefan Weil | @findex mouse_set |
688 | 2313086a | Blue Swirl | Set which mouse device receives events at given @var{index}, index |
689 | 2313086a | Blue Swirl | can be obtained with |
690 | 2313086a | Blue Swirl | @example |
691 | 2313086a | Blue Swirl | info mice |
692 | 2313086a | Blue Swirl | @end example |
693 | 2313086a | Blue Swirl | ETEXI |
694 | 2313086a | Blue Swirl | |
695 | 2313086a | Blue Swirl | #ifdef HAS_AUDIO |
696 | d7f9b689 | Luiz Capitulino | { |
697 | d7f9b689 | Luiz Capitulino | .name = "wavcapture", |
698 | d7f9b689 | Luiz Capitulino | .args_type = "path:F,freq:i?,bits:i?,nchannels:i?", |
699 | d7f9b689 | Luiz Capitulino | .params = "path [frequency [bits [channels]]]", |
700 | d7f9b689 | Luiz Capitulino | .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)", |
701 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_wav_capture, |
702 | d7f9b689 | Luiz Capitulino | }, |
703 | 2313086a | Blue Swirl | #endif |
704 | 2313086a | Blue Swirl | STEXI |
705 | 2313086a | Blue Swirl | @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]] |
706 | 70fcbbe7 | Stefan Weil | @findex wavcapture |
707 | 2313086a | Blue Swirl | Capture audio into @var{filename}. Using sample rate @var{frequency} |
708 | 2313086a | Blue Swirl | bits per sample @var{bits} and number of channels @var{channels}. |
709 | 2313086a | Blue Swirl | |
710 | 2313086a | Blue Swirl | Defaults: |
711 | 2313086a | Blue Swirl | @itemize @minus |
712 | 2313086a | Blue Swirl | @item Sample rate = 44100 Hz - CD quality |
713 | 2313086a | Blue Swirl | @item Bits = 16 |
714 | 2313086a | Blue Swirl | @item Number of channels = 2 - Stereo |
715 | 2313086a | Blue Swirl | @end itemize |
716 | 2313086a | Blue Swirl | ETEXI |
717 | 2313086a | Blue Swirl | |
718 | 2313086a | Blue Swirl | #ifdef HAS_AUDIO |
719 | d7f9b689 | Luiz Capitulino | { |
720 | d7f9b689 | Luiz Capitulino | .name = "stopcapture", |
721 | d7f9b689 | Luiz Capitulino | .args_type = "n:i", |
722 | d7f9b689 | Luiz Capitulino | .params = "capture index", |
723 | d7f9b689 | Luiz Capitulino | .help = "stop capture", |
724 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_stop_capture, |
725 | d7f9b689 | Luiz Capitulino | }, |
726 | 2313086a | Blue Swirl | #endif |
727 | 2313086a | Blue Swirl | STEXI |
728 | 2313086a | Blue Swirl | @item stopcapture @var{index} |
729 | 70fcbbe7 | Stefan Weil | @findex stopcapture |
730 | 2313086a | Blue Swirl | Stop capture with a given @var{index}, index can be obtained with |
731 | 2313086a | Blue Swirl | @example |
732 | 2313086a | Blue Swirl | info capture |
733 | 2313086a | Blue Swirl | @end example |
734 | 2313086a | Blue Swirl | ETEXI |
735 | 2313086a | Blue Swirl | |
736 | d7f9b689 | Luiz Capitulino | { |
737 | d7f9b689 | Luiz Capitulino | .name = "memsave", |
738 | d7f9b689 | Luiz Capitulino | .args_type = "val:l,size:i,filename:s", |
739 | d7f9b689 | Luiz Capitulino | .params = "addr size file", |
740 | d7f9b689 | Luiz Capitulino | .help = "save to disk virtual memory dump starting at 'addr' of size 'size'", |
741 | 0cfd6a9a | Luiz Capitulino | .mhandler.cmd = hmp_memsave, |
742 | d7f9b689 | Luiz Capitulino | }, |
743 | d7f9b689 | Luiz Capitulino | |
744 | 2313086a | Blue Swirl | STEXI |
745 | 2313086a | Blue Swirl | @item memsave @var{addr} @var{size} @var{file} |
746 | 70fcbbe7 | Stefan Weil | @findex memsave |
747 | 2313086a | Blue Swirl | save to disk virtual memory dump starting at @var{addr} of size @var{size}. |
748 | 2313086a | Blue Swirl | ETEXI |
749 | 2313086a | Blue Swirl | |
750 | d7f9b689 | Luiz Capitulino | { |
751 | d7f9b689 | Luiz Capitulino | .name = "pmemsave", |
752 | d7f9b689 | Luiz Capitulino | .args_type = "val:l,size:i,filename:s", |
753 | d7f9b689 | Luiz Capitulino | .params = "addr size file", |
754 | d7f9b689 | Luiz Capitulino | .help = "save to disk physical memory dump starting at 'addr' of size 'size'", |
755 | 6d3962bf | Luiz Capitulino | .mhandler.cmd = hmp_pmemsave, |
756 | d7f9b689 | Luiz Capitulino | }, |
757 | d7f9b689 | Luiz Capitulino | |
758 | 2313086a | Blue Swirl | STEXI |
759 | 2313086a | Blue Swirl | @item pmemsave @var{addr} @var{size} @var{file} |
760 | 70fcbbe7 | Stefan Weil | @findex pmemsave |
761 | 2313086a | Blue Swirl | save to disk physical memory dump starting at @var{addr} of size @var{size}. |
762 | 2313086a | Blue Swirl | ETEXI |
763 | 2313086a | Blue Swirl | |
764 | d7f9b689 | Luiz Capitulino | { |
765 | d7f9b689 | Luiz Capitulino | .name = "boot_set", |
766 | d7f9b689 | Luiz Capitulino | .args_type = "bootdevice:s", |
767 | d7f9b689 | Luiz Capitulino | .params = "bootdevice", |
768 | d7f9b689 | Luiz Capitulino | .help = "define new values for the boot device list", |
769 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_boot_set, |
770 | d7f9b689 | Luiz Capitulino | }, |
771 | d7f9b689 | Luiz Capitulino | |
772 | 2313086a | Blue Swirl | STEXI |
773 | 2313086a | Blue Swirl | @item boot_set @var{bootdevicelist} |
774 | 70fcbbe7 | Stefan Weil | @findex boot_set |
775 | 2313086a | Blue Swirl | |
776 | 2313086a | Blue Swirl | Define new values for the boot device list. Those values will override |
777 | 2313086a | Blue Swirl | the values specified on the command line through the @code{-boot} option. |
778 | 2313086a | Blue Swirl | |
779 | 2313086a | Blue Swirl | The values that can be specified here depend on the machine type, but are |
780 | 2313086a | Blue Swirl | the same that can be specified in the @code{-boot} command line option. |
781 | 2313086a | Blue Swirl | ETEXI |
782 | 2313086a | Blue Swirl | |
783 | 2313086a | Blue Swirl | #if defined(TARGET_I386) |
784 | d7f9b689 | Luiz Capitulino | { |
785 | d7f9b689 | Luiz Capitulino | .name = "nmi", |
786 | e9b4b432 | Luiz Capitulino | .args_type = "", |
787 | e9b4b432 | Luiz Capitulino | .params = "", |
788 | e9b4b432 | Luiz Capitulino | .help = "inject an NMI on all guest's CPUs", |
789 | ab49ab5c | Luiz Capitulino | .mhandler.cmd = hmp_inject_nmi, |
790 | d7f9b689 | Luiz Capitulino | }, |
791 | 2313086a | Blue Swirl | #endif |
792 | 2313086a | Blue Swirl | STEXI |
793 | 2313086a | Blue Swirl | @item nmi @var{cpu} |
794 | 70fcbbe7 | Stefan Weil | @findex nmi |
795 | 2313086a | Blue Swirl | Inject an NMI on the given CPU (x86 only). |
796 | 2313086a | Blue Swirl | ETEXI |
797 | 2313086a | Blue Swirl | |
798 | d7f9b689 | Luiz Capitulino | { |
799 | d7f9b689 | Luiz Capitulino | .name = "migrate", |
800 | fbc3d96c | lirans@il.ibm.com | .args_type = "detach:-d,blk:-b,inc:-i,uri:s", |
801 | fbc3d96c | lirans@il.ibm.com | .params = "[-d] [-b] [-i] uri", |
802 | fbc3d96c | lirans@il.ibm.com | .help = "migrate to URI (using -d to not wait for completion)" |
803 | fbc3d96c | lirans@il.ibm.com | "\n\t\t\t -b for migration without shared storage with" |
804 | fbc3d96c | lirans@il.ibm.com | " full copy of disk\n\t\t\t -i for migration without " |
805 | fbc3d96c | lirans@il.ibm.com | "shared storage with incremental copy of disk " |
806 | fbc3d96c | lirans@il.ibm.com | "(base image shared between src and destination)", |
807 | e1c37d0e | Luiz Capitulino | .mhandler.cmd = hmp_migrate, |
808 | d7f9b689 | Luiz Capitulino | }, |
809 | d7f9b689 | Luiz Capitulino | |
810 | fbc3d96c | lirans@il.ibm.com | |
811 | 2313086a | Blue Swirl | STEXI |
812 | fbc3d96c | lirans@il.ibm.com | @item migrate [-d] [-b] [-i] @var{uri} |
813 | 70fcbbe7 | Stefan Weil | @findex migrate |
814 | 2313086a | Blue Swirl | Migrate to @var{uri} (using -d to not wait for completion). |
815 | fbc3d96c | lirans@il.ibm.com | -b for migration with full copy of disk |
816 | fbc3d96c | lirans@il.ibm.com | -i for migration with incremental copy of disk (base image is shared) |
817 | 2313086a | Blue Swirl | ETEXI |
818 | 2313086a | Blue Swirl | |
819 | d7f9b689 | Luiz Capitulino | { |
820 | d7f9b689 | Luiz Capitulino | .name = "migrate_cancel", |
821 | d7f9b689 | Luiz Capitulino | .args_type = "", |
822 | d7f9b689 | Luiz Capitulino | .params = "", |
823 | d7f9b689 | Luiz Capitulino | .help = "cancel the current VM migration", |
824 | 6cdedb07 | Luiz Capitulino | .mhandler.cmd = hmp_migrate_cancel, |
825 | d7f9b689 | Luiz Capitulino | }, |
826 | d7f9b689 | Luiz Capitulino | |
827 | 2313086a | Blue Swirl | STEXI |
828 | 2313086a | Blue Swirl | @item migrate_cancel |
829 | 70fcbbe7 | Stefan Weil | @findex migrate_cancel |
830 | 2313086a | Blue Swirl | Cancel the current VM migration. |
831 | 9e1ba4cc | Orit Wasserman | |
832 | 9e1ba4cc | Orit Wasserman | ETEXI |
833 | 9e1ba4cc | Orit Wasserman | |
834 | 9e1ba4cc | Orit Wasserman | { |
835 | 9e1ba4cc | Orit Wasserman | .name = "migrate_set_cache_size", |
836 | 9e1ba4cc | Orit Wasserman | .args_type = "value:o", |
837 | 9e1ba4cc | Orit Wasserman | .params = "value", |
838 | 9e1ba4cc | Orit Wasserman | .help = "set cache size (in bytes) for XBZRLE migrations," |
839 | 9e1ba4cc | Orit Wasserman | "the cache size will be rounded down to the nearest " |
840 | 9e1ba4cc | Orit Wasserman | "power of 2.\n" |
841 | 9e1ba4cc | Orit Wasserman | "The cache size affects the number of cache misses." |
842 | 9e1ba4cc | Orit Wasserman | "In case of a high cache miss ratio you need to increase" |
843 | 9e1ba4cc | Orit Wasserman | " the cache size", |
844 | 9e1ba4cc | Orit Wasserman | .mhandler.cmd = hmp_migrate_set_cache_size, |
845 | 9e1ba4cc | Orit Wasserman | }, |
846 | 9e1ba4cc | Orit Wasserman | |
847 | 9e1ba4cc | Orit Wasserman | STEXI |
848 | 9e1ba4cc | Orit Wasserman | @item migrate_set_cache_size @var{value} |
849 | 9e1ba4cc | Orit Wasserman | @findex migrate_set_cache_size |
850 | 9e1ba4cc | Orit Wasserman | Set cache size to @var{value} (in bytes) for xbzrle migrations. |
851 | 2313086a | Blue Swirl | ETEXI |
852 | 2313086a | Blue Swirl | |
853 | d7f9b689 | Luiz Capitulino | { |
854 | d7f9b689 | Luiz Capitulino | .name = "migrate_set_speed", |
855 | ed3d4a80 | Jes Sorensen | .args_type = "value:o", |
856 | d7f9b689 | Luiz Capitulino | .params = "value", |
857 | ed3d4a80 | Jes Sorensen | .help = "set maximum speed (in bytes) for migrations. " |
858 | ed3d4a80 | Jes Sorensen | "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T", |
859 | 3dc85383 | Luiz Capitulino | .mhandler.cmd = hmp_migrate_set_speed, |
860 | d7f9b689 | Luiz Capitulino | }, |
861 | d7f9b689 | Luiz Capitulino | |
862 | 2313086a | Blue Swirl | STEXI |
863 | 2313086a | Blue Swirl | @item migrate_set_speed @var{value} |
864 | 70fcbbe7 | Stefan Weil | @findex migrate_set_speed |
865 | 2313086a | Blue Swirl | Set maximum speed to @var{value} (in bytes) for migrations. |
866 | 2313086a | Blue Swirl | ETEXI |
867 | 2313086a | Blue Swirl | |
868 | d7f9b689 | Luiz Capitulino | { |
869 | d7f9b689 | Luiz Capitulino | .name = "migrate_set_downtime", |
870 | b0fbf7d3 | Markus Armbruster | .args_type = "value:T", |
871 | d7f9b689 | Luiz Capitulino | .params = "value", |
872 | d7f9b689 | Luiz Capitulino | .help = "set maximum tolerated downtime (in seconds) for migrations", |
873 | 4f0a993b | Luiz Capitulino | .mhandler.cmd = hmp_migrate_set_downtime, |
874 | d7f9b689 | Luiz Capitulino | }, |
875 | 2ea42952 | Glauber Costa | |
876 | 2ea42952 | Glauber Costa | STEXI |
877 | 2ea42952 | Glauber Costa | @item migrate_set_downtime @var{second} |
878 | 70fcbbe7 | Stefan Weil | @findex migrate_set_downtime |
879 | 2ea42952 | Glauber Costa | Set maximum tolerated downtime (in seconds) for migration. |
880 | 2ea42952 | Glauber Costa | ETEXI |
881 | 2ea42952 | Glauber Costa | |
882 | f8882568 | Jes Sorensen | { |
883 | 00458433 | Orit Wasserman | .name = "migrate_set_capability", |
884 | 00458433 | Orit Wasserman | .args_type = "capability:s,state:b", |
885 | 00458433 | Orit Wasserman | .params = "capability state", |
886 | 00458433 | Orit Wasserman | .help = "Enable/Disable the usage of a capability for migration", |
887 | 00458433 | Orit Wasserman | .mhandler.cmd = hmp_migrate_set_capability, |
888 | 00458433 | Orit Wasserman | }, |
889 | 00458433 | Orit Wasserman | |
890 | 00458433 | Orit Wasserman | STEXI |
891 | 00458433 | Orit Wasserman | @item migrate_set_capability @var{capability} @var{state} |
892 | 00458433 | Orit Wasserman | @findex migrate_set_capability |
893 | 00458433 | Orit Wasserman | Enable/Disable the usage of a capability @var{capability} for migration. |
894 | 00458433 | Orit Wasserman | ETEXI |
895 | 00458433 | Orit Wasserman | |
896 | 00458433 | Orit Wasserman | { |
897 | 2ea720db | Jes Sorensen | .name = "client_migrate_info", |
898 | 2ea720db | Jes Sorensen | .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?", |
899 | 2ea720db | Jes Sorensen | .params = "protocol hostname port tls-port cert-subject", |
900 | 2ea720db | Jes Sorensen | .help = "send migration info to spice/vnc client", |
901 | 2ea720db | Jes Sorensen | .user_print = monitor_user_noop, |
902 | edc5cb1a | Yonit Halperin | .mhandler.cmd_async = client_migrate_info, |
903 | edc5cb1a | Yonit Halperin | .flags = MONITOR_CMD_ASYNC, |
904 | f8882568 | Jes Sorensen | }, |
905 | f8882568 | Jes Sorensen | |
906 | f8882568 | Jes Sorensen | STEXI |
907 | e866e239 | Gerd Hoffmann | @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject} |
908 | e866e239 | Gerd Hoffmann | @findex client_migrate_info |
909 | e866e239 | Gerd Hoffmann | Set the spice/vnc connection info for the migration target. The spice/vnc |
910 | e866e239 | Gerd Hoffmann | server will ask the spice/vnc client to automatically reconnect using the |
911 | e866e239 | Gerd Hoffmann | new parameters (if specified) once the vm migration finished successfully. |
912 | e866e239 | Gerd Hoffmann | ETEXI |
913 | e866e239 | Gerd Hoffmann | |
914 | 783e9b48 | Wen Congyang | #if defined(CONFIG_HAVE_CORE_DUMP) |
915 | 783e9b48 | Wen Congyang | { |
916 | 783e9b48 | Wen Congyang | .name = "dump-guest-memory", |
917 | 783e9b48 | Wen Congyang | .args_type = "paging:-p,protocol:s,begin:i?,length:i?", |
918 | 783e9b48 | Wen Congyang | .params = "[-p] protocol [begin] [length]", |
919 | 783e9b48 | Wen Congyang | .help = "dump guest memory to file" |
920 | 783e9b48 | Wen Congyang | "\n\t\t\t begin(optional): the starting physical address" |
921 | 783e9b48 | Wen Congyang | "\n\t\t\t length(optional): the memory size, in bytes", |
922 | 783e9b48 | Wen Congyang | .user_print = monitor_user_noop, |
923 | 783e9b48 | Wen Congyang | .mhandler.cmd = hmp_dump_guest_memory, |
924 | 783e9b48 | Wen Congyang | }, |
925 | 783e9b48 | Wen Congyang | |
926 | 783e9b48 | Wen Congyang | |
927 | 783e9b48 | Wen Congyang | STEXI |
928 | 783e9b48 | Wen Congyang | @item dump-guest-memory [-p] @var{protocol} @var{begin} @var{length} |
929 | 783e9b48 | Wen Congyang | @findex dump-guest-memory |
930 | 783e9b48 | Wen Congyang | Dump guest memory to @var{protocol}. The file can be processed with crash or |
931 | 783e9b48 | Wen Congyang | gdb. |
932 | 783e9b48 | Wen Congyang | protocol: destination file(started with "file:") or destination file |
933 | 783e9b48 | Wen Congyang | descriptor (started with "fd:") |
934 | 783e9b48 | Wen Congyang | paging: do paging to get guest's memory mapping |
935 | 783e9b48 | Wen Congyang | begin: the starting physical address. It's optional, and should be |
936 | 783e9b48 | Wen Congyang | specified with length together. |
937 | 783e9b48 | Wen Congyang | length: the memory size, in bytes. It's optional, and should be specified |
938 | 783e9b48 | Wen Congyang | with begin together. |
939 | 783e9b48 | Wen Congyang | ETEXI |
940 | 783e9b48 | Wen Congyang | #endif |
941 | 783e9b48 | Wen Congyang | |
942 | e866e239 | Gerd Hoffmann | { |
943 | 2ea720db | Jes Sorensen | .name = "snapshot_blkdev", |
944 | 6cc2a415 | Paolo Bonzini | .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?", |
945 | 6cc2a415 | Paolo Bonzini | .params = "[-n] device [new-image-file] [format]", |
946 | 2ea720db | Jes Sorensen | .help = "initiates a live snapshot\n\t\t\t" |
947 | 2ea720db | Jes Sorensen | "of device. If a new image file is specified, the\n\t\t\t" |
948 | 2ea720db | Jes Sorensen | "new image file will become the new root image.\n\t\t\t" |
949 | 2ea720db | Jes Sorensen | "If format is specified, the snapshot file will\n\t\t\t" |
950 | 2ea720db | Jes Sorensen | "be created in that format. Otherwise the\n\t\t\t" |
951 | 6cc2a415 | Paolo Bonzini | "snapshot will be internal! (currently unsupported).\n\t\t\t" |
952 | 6cc2a415 | Paolo Bonzini | "The default format is qcow2. The -n flag requests QEMU\n\t\t\t" |
953 | 6cc2a415 | Paolo Bonzini | "to reuse the image found in new-image-file, instead of\n\t\t\t" |
954 | 6cc2a415 | Paolo Bonzini | "recreating it from scratch.", |
955 | 6106e249 | Luiz Capitulino | .mhandler.cmd = hmp_snapshot_blkdev, |
956 | e866e239 | Gerd Hoffmann | }, |
957 | e866e239 | Gerd Hoffmann | |
958 | e866e239 | Gerd Hoffmann | STEXI |
959 | f8882568 | Jes Sorensen | @item snapshot_blkdev |
960 | f8882568 | Jes Sorensen | @findex snapshot_blkdev |
961 | f8882568 | Jes Sorensen | Snapshot device, using snapshot file as target if provided |
962 | f8882568 | Jes Sorensen | ETEXI |
963 | f8882568 | Jes Sorensen | |
964 | d7f9b689 | Luiz Capitulino | { |
965 | d7f9b689 | Luiz Capitulino | .name = "drive_add", |
966 | d7f9b689 | Luiz Capitulino | .args_type = "pci_addr:s,opts:s", |
967 | d7f9b689 | Luiz Capitulino | .params = "[[<domain>:]<bus>:]<slot>\n" |
968 | d7f9b689 | Luiz Capitulino | "[file=file][,if=type][,bus=n]\n" |
969 | fb0490f6 | Stefan Hajnoczi | "[,unit=m][,media=d][,index=i]\n" |
970 | d7f9b689 | Luiz Capitulino | "[,cyls=c,heads=h,secs=s[,trans=t]]\n" |
971 | fb0490f6 | Stefan Hajnoczi | "[,snapshot=on|off][,cache=on|off]\n" |
972 | fb0490f6 | Stefan Hajnoczi | "[,readonly=on|off][,copy-on-read=on|off]", |
973 | d7f9b689 | Luiz Capitulino | .help = "add drive to PCI storage controller", |
974 | af4ce882 | Luiz Capitulino | .mhandler.cmd = drive_hot_add, |
975 | d7f9b689 | Luiz Capitulino | }, |
976 | d7f9b689 | Luiz Capitulino | |
977 | 2313086a | Blue Swirl | STEXI |
978 | 2313086a | Blue Swirl | @item drive_add |
979 | 70fcbbe7 | Stefan Weil | @findex drive_add |
980 | 2313086a | Blue Swirl | Add drive to PCI storage controller. |
981 | 2313086a | Blue Swirl | ETEXI |
982 | 2313086a | Blue Swirl | |
983 | 2313086a | Blue Swirl | #if defined(TARGET_I386) |
984 | d7f9b689 | Luiz Capitulino | { |
985 | d7f9b689 | Luiz Capitulino | .name = "pci_add", |
986 | d7f9b689 | Luiz Capitulino | .args_type = "pci_addr:s,type:s,opts:s?", |
987 | d7f9b689 | Luiz Capitulino | .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...", |
988 | d7f9b689 | Luiz Capitulino | .help = "hot-add PCI device", |
989 | 6c6a58ae | Markus Armbruster | .mhandler.cmd = pci_device_hot_add, |
990 | d7f9b689 | Luiz Capitulino | }, |
991 | 2313086a | Blue Swirl | #endif |
992 | d7f9b689 | Luiz Capitulino | |
993 | 2313086a | Blue Swirl | STEXI |
994 | 2313086a | Blue Swirl | @item pci_add |
995 | 70fcbbe7 | Stefan Weil | @findex pci_add |
996 | 2313086a | Blue Swirl | Hot-add PCI device. |
997 | 2313086a | Blue Swirl | ETEXI |
998 | 2313086a | Blue Swirl | |
999 | 2313086a | Blue Swirl | #if defined(TARGET_I386) |
1000 | d7f9b689 | Luiz Capitulino | { |
1001 | d7f9b689 | Luiz Capitulino | .name = "pci_del", |
1002 | d7f9b689 | Luiz Capitulino | .args_type = "pci_addr:s", |
1003 | d7f9b689 | Luiz Capitulino | .params = "[[<domain>:]<bus>:]<slot>", |
1004 | d7f9b689 | Luiz Capitulino | .help = "hot remove PCI device", |
1005 | b752daf0 | Markus Armbruster | .mhandler.cmd = do_pci_device_hot_remove, |
1006 | d7f9b689 | Luiz Capitulino | }, |
1007 | 2313086a | Blue Swirl | #endif |
1008 | d7f9b689 | Luiz Capitulino | |
1009 | 2313086a | Blue Swirl | STEXI |
1010 | 2313086a | Blue Swirl | @item pci_del |
1011 | 70fcbbe7 | Stefan Weil | @findex pci_del |
1012 | 2313086a | Blue Swirl | Hot remove PCI device. |
1013 | 2313086a | Blue Swirl | ETEXI |
1014 | 2313086a | Blue Swirl | |
1015 | d7f9b689 | Luiz Capitulino | { |
1016 | 2ae63bda | Isaku Yamahata | .name = "pcie_aer_inject_error", |
1017 | 2ae63bda | Isaku Yamahata | .args_type = "advisory_non_fatal:-a,correctable:-c," |
1018 | 2ae63bda | Isaku Yamahata | "id:s,error_status:s," |
1019 | 2ae63bda | Isaku Yamahata | "header0:i?,header1:i?,header2:i?,header3:i?," |
1020 | 2ae63bda | Isaku Yamahata | "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?", |
1021 | 2ae63bda | Isaku Yamahata | .params = "[-a] [-c] id " |
1022 | 2ae63bda | Isaku Yamahata | "<error_status> [<tlp header> [<tlp header prefix>]]", |
1023 | 2ae63bda | Isaku Yamahata | .help = "inject pcie aer error\n\t\t\t" |
1024 | 2ae63bda | Isaku Yamahata | " -a for advisory non fatal error\n\t\t\t" |
1025 | 2ae63bda | Isaku Yamahata | " -c for correctable error\n\t\t\t" |
1026 | 2ae63bda | Isaku Yamahata | "<id> = qdev device id\n\t\t\t" |
1027 | 2ae63bda | Isaku Yamahata | "<error_status> = error string or 32bit\n\t\t\t" |
1028 | 2ae63bda | Isaku Yamahata | "<tlb header> = 32bit x 4\n\t\t\t" |
1029 | 2ae63bda | Isaku Yamahata | "<tlb header prefix> = 32bit x 4", |
1030 | 2ae63bda | Isaku Yamahata | .user_print = pcie_aer_inject_error_print, |
1031 | 1f3392b7 | Zhi Yong Wu | .mhandler.cmd_new = do_pcie_aer_inject_error, |
1032 | 2ae63bda | Isaku Yamahata | }, |
1033 | 2ae63bda | Isaku Yamahata | |
1034 | 2ae63bda | Isaku Yamahata | STEXI |
1035 | 2ae63bda | Isaku Yamahata | @item pcie_aer_inject_error |
1036 | 2ae63bda | Isaku Yamahata | @findex pcie_aer_inject_error |
1037 | 2ae63bda | Isaku Yamahata | Inject PCIe AER error |
1038 | 2ae63bda | Isaku Yamahata | ETEXI |
1039 | 2ae63bda | Isaku Yamahata | |
1040 | 2ae63bda | Isaku Yamahata | { |
1041 | d7f9b689 | Luiz Capitulino | .name = "host_net_add", |
1042 | d7f9b689 | Luiz Capitulino | .args_type = "device:s,opts:s?", |
1043 | d7f9b689 | Luiz Capitulino | .params = "tap|user|socket|vde|dump [options]", |
1044 | d7f9b689 | Luiz Capitulino | .help = "add host VLAN client", |
1045 | af4ce882 | Luiz Capitulino | .mhandler.cmd = net_host_device_add, |
1046 | d7f9b689 | Luiz Capitulino | }, |
1047 | d7f9b689 | Luiz Capitulino | |
1048 | 2313086a | Blue Swirl | STEXI |
1049 | 2313086a | Blue Swirl | @item host_net_add |
1050 | 70fcbbe7 | Stefan Weil | @findex host_net_add |
1051 | 2313086a | Blue Swirl | Add host VLAN client. |
1052 | 2313086a | Blue Swirl | ETEXI |
1053 | 2313086a | Blue Swirl | |
1054 | d7f9b689 | Luiz Capitulino | { |
1055 | d7f9b689 | Luiz Capitulino | .name = "host_net_remove", |
1056 | d7f9b689 | Luiz Capitulino | .args_type = "vlan_id:i,device:s", |
1057 | d7f9b689 | Luiz Capitulino | .params = "vlan_id name", |
1058 | d7f9b689 | Luiz Capitulino | .help = "remove host VLAN client", |
1059 | af4ce882 | Luiz Capitulino | .mhandler.cmd = net_host_device_remove, |
1060 | d7f9b689 | Luiz Capitulino | }, |
1061 | d7f9b689 | Luiz Capitulino | |
1062 | 2313086a | Blue Swirl | STEXI |
1063 | 2313086a | Blue Swirl | @item host_net_remove |
1064 | 70fcbbe7 | Stefan Weil | @findex host_net_remove |
1065 | 2313086a | Blue Swirl | Remove host VLAN client. |
1066 | 2313086a | Blue Swirl | ETEXI |
1067 | 2313086a | Blue Swirl | |
1068 | ae82d324 | Markus Armbruster | { |
1069 | ae82d324 | Markus Armbruster | .name = "netdev_add", |
1070 | ae82d324 | Markus Armbruster | .args_type = "netdev:O", |
1071 | ae82d324 | Markus Armbruster | .params = "[user|tap|socket],id=str[,prop=value][,...]", |
1072 | ae82d324 | Markus Armbruster | .help = "add host network device", |
1073 | 928059a3 | Luiz Capitulino | .mhandler.cmd = hmp_netdev_add, |
1074 | ae82d324 | Markus Armbruster | }, |
1075 | ae82d324 | Markus Armbruster | |
1076 | ae82d324 | Markus Armbruster | STEXI |
1077 | ae82d324 | Markus Armbruster | @item netdev_add |
1078 | ae82d324 | Markus Armbruster | @findex netdev_add |
1079 | ae82d324 | Markus Armbruster | Add host network device. |
1080 | ae82d324 | Markus Armbruster | ETEXI |
1081 | ae82d324 | Markus Armbruster | |
1082 | ae82d324 | Markus Armbruster | { |
1083 | ae82d324 | Markus Armbruster | .name = "netdev_del", |
1084 | ae82d324 | Markus Armbruster | .args_type = "id:s", |
1085 | ae82d324 | Markus Armbruster | .params = "id", |
1086 | ae82d324 | Markus Armbruster | .help = "remove host network device", |
1087 | 5f964155 | Luiz Capitulino | .mhandler.cmd = hmp_netdev_del, |
1088 | ae82d324 | Markus Armbruster | }, |
1089 | ae82d324 | Markus Armbruster | |
1090 | ae82d324 | Markus Armbruster | STEXI |
1091 | ae82d324 | Markus Armbruster | @item netdev_del |
1092 | ae82d324 | Markus Armbruster | @findex netdev_del |
1093 | ae82d324 | Markus Armbruster | Remove host network device. |
1094 | ae82d324 | Markus Armbruster | ETEXI |
1095 | ae82d324 | Markus Armbruster | |
1096 | 2313086a | Blue Swirl | #ifdef CONFIG_SLIRP |
1097 | d7f9b689 | Luiz Capitulino | { |
1098 | d7f9b689 | Luiz Capitulino | .name = "hostfwd_add", |
1099 | d7f9b689 | Luiz Capitulino | .args_type = "arg1:s,arg2:s?,arg3:s?", |
1100 | d7f9b689 | Luiz Capitulino | .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport", |
1101 | d7f9b689 | Luiz Capitulino | .help = "redirect TCP or UDP connections from host to guest (requires -net user)", |
1102 | af4ce882 | Luiz Capitulino | .mhandler.cmd = net_slirp_hostfwd_add, |
1103 | d7f9b689 | Luiz Capitulino | }, |
1104 | 21413d68 | Markus Armbruster | #endif |
1105 | 21413d68 | Markus Armbruster | STEXI |
1106 | 21413d68 | Markus Armbruster | @item hostfwd_add |
1107 | 21413d68 | Markus Armbruster | @findex hostfwd_add |
1108 | 21413d68 | Markus Armbruster | Redirect TCP or UDP connections from host to guest (requires -net user). |
1109 | 21413d68 | Markus Armbruster | ETEXI |
1110 | d7f9b689 | Luiz Capitulino | |
1111 | 21413d68 | Markus Armbruster | #ifdef CONFIG_SLIRP |
1112 | d7f9b689 | Luiz Capitulino | { |
1113 | d7f9b689 | Luiz Capitulino | .name = "hostfwd_remove", |
1114 | d7f9b689 | Luiz Capitulino | .args_type = "arg1:s,arg2:s?,arg3:s?", |
1115 | d7f9b689 | Luiz Capitulino | .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport", |
1116 | d7f9b689 | Luiz Capitulino | .help = "remove host-to-guest TCP or UDP redirection", |
1117 | af4ce882 | Luiz Capitulino | .mhandler.cmd = net_slirp_hostfwd_remove, |
1118 | d7f9b689 | Luiz Capitulino | }, |
1119 | d7f9b689 | Luiz Capitulino | |
1120 | 2313086a | Blue Swirl | #endif |
1121 | 2313086a | Blue Swirl | STEXI |
1122 | 21413d68 | Markus Armbruster | @item hostfwd_remove |
1123 | 21413d68 | Markus Armbruster | @findex hostfwd_remove |
1124 | 21413d68 | Markus Armbruster | Remove host-to-guest TCP or UDP redirection. |
1125 | 2313086a | Blue Swirl | ETEXI |
1126 | 2313086a | Blue Swirl | |
1127 | d7f9b689 | Luiz Capitulino | { |
1128 | d7f9b689 | Luiz Capitulino | .name = "balloon", |
1129 | 3b0bd6ec | Luiz Capitulino | .args_type = "value:M", |
1130 | d7f9b689 | Luiz Capitulino | .params = "target", |
1131 | 3c05613a | Riccardo Magliocchetti | .help = "request VM to change its memory allocation (in MB)", |
1132 | d72f3264 | Luiz Capitulino | .mhandler.cmd = hmp_balloon, |
1133 | d7f9b689 | Luiz Capitulino | }, |
1134 | d7f9b689 | Luiz Capitulino | |
1135 | 2313086a | Blue Swirl | STEXI |
1136 | 2313086a | Blue Swirl | @item balloon @var{value} |
1137 | 70fcbbe7 | Stefan Weil | @findex balloon |
1138 | 2313086a | Blue Swirl | Request VM to change its memory allocation to @var{value} (in MB). |
1139 | 2313086a | Blue Swirl | ETEXI |
1140 | 2313086a | Blue Swirl | |
1141 | d7f9b689 | Luiz Capitulino | { |
1142 | d7f9b689 | Luiz Capitulino | .name = "set_link", |
1143 | c9b26a4c | Markus Armbruster | .args_type = "name:s,up:b", |
1144 | c9b26a4c | Markus Armbruster | .params = "name on|off", |
1145 | d7f9b689 | Luiz Capitulino | .help = "change the link status of a network adapter", |
1146 | 4b37156c | Luiz Capitulino | .mhandler.cmd = hmp_set_link, |
1147 | d7f9b689 | Luiz Capitulino | }, |
1148 | d7f9b689 | Luiz Capitulino | |
1149 | 2313086a | Blue Swirl | STEXI |
1150 | c9b26a4c | Markus Armbruster | @item set_link @var{name} [on|off] |
1151 | 70fcbbe7 | Stefan Weil | @findex set_link |
1152 | c9b26a4c | Markus Armbruster | Switch link @var{name} on (i.e. up) or off (i.e. down). |
1153 | 2313086a | Blue Swirl | ETEXI |
1154 | 2313086a | Blue Swirl | |
1155 | d7f9b689 | Luiz Capitulino | { |
1156 | d7f9b689 | Luiz Capitulino | .name = "watchdog_action", |
1157 | d7f9b689 | Luiz Capitulino | .args_type = "action:s", |
1158 | d7f9b689 | Luiz Capitulino | .params = "[reset|shutdown|poweroff|pause|debug|none]", |
1159 | d7f9b689 | Luiz Capitulino | .help = "change watchdog action", |
1160 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_watchdog_action, |
1161 | d7f9b689 | Luiz Capitulino | }, |
1162 | d7f9b689 | Luiz Capitulino | |
1163 | 2313086a | Blue Swirl | STEXI |
1164 | 2313086a | Blue Swirl | @item watchdog_action |
1165 | 70fcbbe7 | Stefan Weil | @findex watchdog_action |
1166 | 2313086a | Blue Swirl | Change watchdog action. |
1167 | 2313086a | Blue Swirl | ETEXI |
1168 | 2313086a | Blue Swirl | |
1169 | d7f9b689 | Luiz Capitulino | { |
1170 | d7f9b689 | Luiz Capitulino | .name = "acl_show", |
1171 | d7f9b689 | Luiz Capitulino | .args_type = "aclname:s", |
1172 | d7f9b689 | Luiz Capitulino | .params = "aclname", |
1173 | d7f9b689 | Luiz Capitulino | .help = "list rules in the access control list", |
1174 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_acl_show, |
1175 | d7f9b689 | Luiz Capitulino | }, |
1176 | d7f9b689 | Luiz Capitulino | |
1177 | 2313086a | Blue Swirl | STEXI |
1178 | 15dfcd45 | Jan Kiszka | @item acl_show @var{aclname} |
1179 | 70fcbbe7 | Stefan Weil | @findex acl_show |
1180 | 15dfcd45 | Jan Kiszka | List all the matching rules in the access control list, and the default |
1181 | 15dfcd45 | Jan Kiszka | policy. There are currently two named access control lists, |
1182 | 15dfcd45 | Jan Kiszka | @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client |
1183 | 15dfcd45 | Jan Kiszka | certificate distinguished name, and SASL username respectively. |
1184 | 15dfcd45 | Jan Kiszka | ETEXI |
1185 | 2313086a | Blue Swirl | |
1186 | d7f9b689 | Luiz Capitulino | { |
1187 | d7f9b689 | Luiz Capitulino | .name = "acl_policy", |
1188 | d7f9b689 | Luiz Capitulino | .args_type = "aclname:s,policy:s", |
1189 | d7f9b689 | Luiz Capitulino | .params = "aclname allow|deny", |
1190 | d7f9b689 | Luiz Capitulino | .help = "set default access control list policy", |
1191 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_acl_policy, |
1192 | d7f9b689 | Luiz Capitulino | }, |
1193 | d7f9b689 | Luiz Capitulino | |
1194 | 15dfcd45 | Jan Kiszka | STEXI |
1195 | cbbfacc6 | Jan Kiszka | @item acl_policy @var{aclname} @code{allow|deny} |
1196 | 70fcbbe7 | Stefan Weil | @findex acl_policy |
1197 | 15dfcd45 | Jan Kiszka | Set the default access control list policy, used in the event that |
1198 | 2313086a | Blue Swirl | none of the explicit rules match. The default policy at startup is |
1199 | 15dfcd45 | Jan Kiszka | always @code{deny}. |
1200 | 15dfcd45 | Jan Kiszka | ETEXI |
1201 | 15dfcd45 | Jan Kiszka | |
1202 | d7f9b689 | Luiz Capitulino | { |
1203 | d7f9b689 | Luiz Capitulino | .name = "acl_add", |
1204 | d7f9b689 | Luiz Capitulino | .args_type = "aclname:s,match:s,policy:s,index:i?", |
1205 | d7f9b689 | Luiz Capitulino | .params = "aclname match allow|deny [index]", |
1206 | d7f9b689 | Luiz Capitulino | .help = "add a match rule to the access control list", |
1207 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_acl_add, |
1208 | d7f9b689 | Luiz Capitulino | }, |
1209 | d7f9b689 | Luiz Capitulino | |
1210 | 15dfcd45 | Jan Kiszka | STEXI |
1211 | 0e4aec98 | Markus Armbruster | @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}] |
1212 | 0e4aec98 | Markus Armbruster | @findex acl_add |
1213 | 15dfcd45 | Jan Kiszka | Add a match rule to the access control list, allowing or denying access. |
1214 | 15dfcd45 | Jan Kiszka | The match will normally be an exact username or x509 distinguished name, |
1215 | 15dfcd45 | Jan Kiszka | but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to |
1216 | 15dfcd45 | Jan Kiszka | allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will |
1217 | 2313086a | Blue Swirl | normally be appended to the end of the ACL, but can be inserted |
1218 | 15dfcd45 | Jan Kiszka | earlier in the list if the optional @var{index} parameter is supplied. |
1219 | 15dfcd45 | Jan Kiszka | ETEXI |
1220 | 15dfcd45 | Jan Kiszka | |
1221 | d7f9b689 | Luiz Capitulino | { |
1222 | d7f9b689 | Luiz Capitulino | .name = "acl_remove", |
1223 | d7f9b689 | Luiz Capitulino | .args_type = "aclname:s,match:s", |
1224 | d7f9b689 | Luiz Capitulino | .params = "aclname match", |
1225 | d7f9b689 | Luiz Capitulino | .help = "remove a match rule from the access control list", |
1226 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_acl_remove, |
1227 | d7f9b689 | Luiz Capitulino | }, |
1228 | d7f9b689 | Luiz Capitulino | |
1229 | 15dfcd45 | Jan Kiszka | STEXI |
1230 | 15dfcd45 | Jan Kiszka | @item acl_remove @var{aclname} @var{match} |
1231 | 70fcbbe7 | Stefan Weil | @findex acl_remove |
1232 | 15dfcd45 | Jan Kiszka | Remove the specified match rule from the access control list. |
1233 | 15dfcd45 | Jan Kiszka | ETEXI |
1234 | 15dfcd45 | Jan Kiszka | |
1235 | d7f9b689 | Luiz Capitulino | { |
1236 | d7f9b689 | Luiz Capitulino | .name = "acl_reset", |
1237 | d7f9b689 | Luiz Capitulino | .args_type = "aclname:s", |
1238 | d7f9b689 | Luiz Capitulino | .params = "aclname", |
1239 | d7f9b689 | Luiz Capitulino | .help = "reset the access control list", |
1240 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_acl_reset, |
1241 | d7f9b689 | Luiz Capitulino | }, |
1242 | d7f9b689 | Luiz Capitulino | |
1243 | 15dfcd45 | Jan Kiszka | STEXI |
1244 | 0e4aec98 | Markus Armbruster | @item acl_reset @var{aclname} |
1245 | 0e4aec98 | Markus Armbruster | @findex acl_reset |
1246 | 15dfcd45 | Jan Kiszka | Remove all matches from the access control list, and set the default |
1247 | 2313086a | Blue Swirl | policy back to @code{deny}. |
1248 | 2313086a | Blue Swirl | ETEXI |
1249 | 2313086a | Blue Swirl | |
1250 | 79c4f6b0 | Huang Ying | #if defined(TARGET_I386) |
1251 | d7f9b689 | Luiz Capitulino | |
1252 | d7f9b689 | Luiz Capitulino | { |
1253 | d7f9b689 | Luiz Capitulino | .name = "mce", |
1254 | 31ce5e0c | Jin Dongming | .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l", |
1255 | 31ce5e0c | Jin Dongming | .params = "[-b] cpu bank status mcgstatus addr misc", |
1256 | 31ce5e0c | Jin Dongming | .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]", |
1257 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_inject_mce, |
1258 | d7f9b689 | Luiz Capitulino | }, |
1259 | d7f9b689 | Luiz Capitulino | |
1260 | 79c4f6b0 | Huang Ying | #endif |
1261 | 79c4f6b0 | Huang Ying | STEXI |
1262 | 79c4f6b0 | Huang Ying | @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc} |
1263 | 70fcbbe7 | Stefan Weil | @findex mce (x86) |
1264 | 79c4f6b0 | Huang Ying | Inject an MCE on the given CPU (x86 only). |
1265 | 79c4f6b0 | Huang Ying | ETEXI |
1266 | 79c4f6b0 | Huang Ying | |
1267 | d7f9b689 | Luiz Capitulino | { |
1268 | d7f9b689 | Luiz Capitulino | .name = "getfd", |
1269 | d7f9b689 | Luiz Capitulino | .args_type = "fdname:s", |
1270 | d7f9b689 | Luiz Capitulino | .params = "getfd name", |
1271 | d7f9b689 | Luiz Capitulino | .help = "receive a file descriptor via SCM rights and assign it a name", |
1272 | 208c9d1b | Corey Bryant | .mhandler.cmd = hmp_getfd, |
1273 | d7f9b689 | Luiz Capitulino | }, |
1274 | d7f9b689 | Luiz Capitulino | |
1275 | f07918fd | Mark McLoughlin | STEXI |
1276 | f07918fd | Mark McLoughlin | @item getfd @var{fdname} |
1277 | 70fcbbe7 | Stefan Weil | @findex getfd |
1278 | f07918fd | Mark McLoughlin | If a file descriptor is passed alongside this command using the SCM_RIGHTS |
1279 | f07918fd | Mark McLoughlin | mechanism on unix sockets, it is stored using the name @var{fdname} for |
1280 | f07918fd | Mark McLoughlin | later use by other monitor commands. |
1281 | f07918fd | Mark McLoughlin | ETEXI |
1282 | f07918fd | Mark McLoughlin | |
1283 | d7f9b689 | Luiz Capitulino | { |
1284 | d7f9b689 | Luiz Capitulino | .name = "closefd", |
1285 | d7f9b689 | Luiz Capitulino | .args_type = "fdname:s", |
1286 | d7f9b689 | Luiz Capitulino | .params = "closefd name", |
1287 | d7f9b689 | Luiz Capitulino | .help = "close a file descriptor previously passed via SCM rights", |
1288 | 208c9d1b | Corey Bryant | .mhandler.cmd = hmp_closefd, |
1289 | d7f9b689 | Luiz Capitulino | }, |
1290 | d7f9b689 | Luiz Capitulino | |
1291 | f07918fd | Mark McLoughlin | STEXI |
1292 | f07918fd | Mark McLoughlin | @item closefd @var{fdname} |
1293 | 70fcbbe7 | Stefan Weil | @findex closefd |
1294 | f07918fd | Mark McLoughlin | Close the file descriptor previously assigned to @var{fdname} using the |
1295 | f07918fd | Mark McLoughlin | @code{getfd} command. This is only needed if the file descriptor was never |
1296 | f07918fd | Mark McLoughlin | used by another monitor command. |
1297 | f07918fd | Mark McLoughlin | ETEXI |
1298 | f07918fd | Mark McLoughlin | |
1299 | a3a55a2e | Luiz Capitulino | { |
1300 | a3a55a2e | Luiz Capitulino | .name = "block_passwd", |
1301 | a3a55a2e | Luiz Capitulino | .args_type = "device:B,password:s", |
1302 | a3a55a2e | Luiz Capitulino | .params = "block_passwd device password", |
1303 | a3a55a2e | Luiz Capitulino | .help = "set the password of encrypted block devices", |
1304 | a4dea8a9 | Luiz Capitulino | .mhandler.cmd = hmp_block_passwd, |
1305 | a3a55a2e | Luiz Capitulino | }, |
1306 | a3a55a2e | Luiz Capitulino | |
1307 | a3a55a2e | Luiz Capitulino | STEXI |
1308 | 727f005e | Zhi Yong Wu | @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr} |
1309 | 727f005e | Zhi Yong Wu | @findex block_set_io_throttle |
1310 | 727f005e | Zhi Yong Wu | Change 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} |
1311 | 727f005e | Zhi Yong Wu | ETEXI |
1312 | 727f005e | Zhi Yong Wu | |
1313 | 727f005e | Zhi Yong Wu | { |
1314 | 727f005e | Zhi Yong Wu | .name = "block_set_io_throttle", |
1315 | 727f005e | Zhi Yong Wu | .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l", |
1316 | 727f005e | Zhi Yong Wu | .params = "device bps bps_rd bps_wr iops iops_rd iops_wr", |
1317 | 727f005e | Zhi Yong Wu | .help = "change I/O throttle limits for a block drive", |
1318 | 80047da5 | Luiz Capitulino | .mhandler.cmd = hmp_block_set_io_throttle, |
1319 | 727f005e | Zhi Yong Wu | }, |
1320 | 727f005e | Zhi Yong Wu | |
1321 | 727f005e | Zhi Yong Wu | STEXI |
1322 | a3a55a2e | Luiz Capitulino | @item block_passwd @var{device} @var{password} |
1323 | 70fcbbe7 | Stefan Weil | @findex block_passwd |
1324 | a3a55a2e | Luiz Capitulino | Set the encrypted device @var{device} password to @var{password} |
1325 | a3a55a2e | Luiz Capitulino | ETEXI |
1326 | b40292e7 | Jan Kiszka | |
1327 | 33572ece | Jan Kiszka | { |
1328 | 7572150c | Gerd Hoffmann | .name = "set_password", |
1329 | 7572150c | Gerd Hoffmann | .args_type = "protocol:s,password:s,connected:s?", |
1330 | 7572150c | Gerd Hoffmann | .params = "protocol password action-if-connected", |
1331 | 7572150c | Gerd Hoffmann | .help = "set spice/vnc password", |
1332 | fbf796fd | Luiz Capitulino | .mhandler.cmd = hmp_set_password, |
1333 | 7572150c | Gerd Hoffmann | }, |
1334 | 7572150c | Gerd Hoffmann | |
1335 | 7572150c | Gerd Hoffmann | STEXI |
1336 | 7572150c | Gerd Hoffmann | @item set_password [ vnc | spice ] password [ action-if-connected ] |
1337 | 7572150c | Gerd Hoffmann | @findex set_password |
1338 | 7572150c | Gerd Hoffmann | |
1339 | 7572150c | Gerd Hoffmann | Change spice/vnc password. Use zero to make the password stay valid |
1340 | 7572150c | Gerd Hoffmann | forever. @var{action-if-connected} specifies what should happen in |
1341 | 7572150c | Gerd Hoffmann | case a connection is established: @var{fail} makes the password change |
1342 | 7572150c | Gerd Hoffmann | fail. @var{disconnect} changes the password and disconnects the |
1343 | 7572150c | Gerd Hoffmann | client. @var{keep} changes the password and keeps the connection up. |
1344 | 7572150c | Gerd Hoffmann | @var{keep} is the default. |
1345 | 7572150c | Gerd Hoffmann | ETEXI |
1346 | 7572150c | Gerd Hoffmann | |
1347 | 7572150c | Gerd Hoffmann | { |
1348 | 7572150c | Gerd Hoffmann | .name = "expire_password", |
1349 | 7572150c | Gerd Hoffmann | .args_type = "protocol:s,time:s", |
1350 | 7572150c | Gerd Hoffmann | .params = "protocol time", |
1351 | 7572150c | Gerd Hoffmann | .help = "set spice/vnc password expire-time", |
1352 | 9ad5372d | Luiz Capitulino | .mhandler.cmd = hmp_expire_password, |
1353 | 7572150c | Gerd Hoffmann | }, |
1354 | 7572150c | Gerd Hoffmann | |
1355 | 7572150c | Gerd Hoffmann | STEXI |
1356 | 7572150c | Gerd Hoffmann | @item expire_password [ vnc | spice ] expire-time |
1357 | 7572150c | Gerd Hoffmann | @findex expire_password |
1358 | 7572150c | Gerd Hoffmann | |
1359 | 7572150c | Gerd Hoffmann | Specify when a password for spice/vnc becomes |
1360 | 7572150c | Gerd Hoffmann | invalid. @var{expire-time} accepts: |
1361 | 7572150c | Gerd Hoffmann | |
1362 | 7572150c | Gerd Hoffmann | @table @var |
1363 | 7572150c | Gerd Hoffmann | @item now |
1364 | 7572150c | Gerd Hoffmann | Invalidate password instantly. |
1365 | 7572150c | Gerd Hoffmann | |
1366 | 7572150c | Gerd Hoffmann | @item never |
1367 | 7572150c | Gerd Hoffmann | Password stays valid forever. |
1368 | 7572150c | Gerd Hoffmann | |
1369 | 7572150c | Gerd Hoffmann | @item +nsec |
1370 | 7572150c | Gerd Hoffmann | Password stays valid for @var{nsec} seconds starting now. |
1371 | 7572150c | Gerd Hoffmann | |
1372 | 7572150c | Gerd Hoffmann | @item nsec |
1373 | 7572150c | Gerd Hoffmann | Password is invalidated at the given time. @var{nsec} are the seconds |
1374 | 7572150c | Gerd Hoffmann | passed since 1970, i.e. unix epoch. |
1375 | 7572150c | Gerd Hoffmann | |
1376 | 7572150c | Gerd Hoffmann | @end table |
1377 | 7572150c | Gerd Hoffmann | ETEXI |
1378 | 7572150c | Gerd Hoffmann | |
1379 | 7572150c | Gerd Hoffmann | { |
1380 | 33572ece | Jan Kiszka | .name = "info", |
1381 | 33572ece | Jan Kiszka | .args_type = "item:s?", |
1382 | 33572ece | Jan Kiszka | .params = "[subcommand]", |
1383 | 33572ece | Jan Kiszka | .help = "show various information about the system state", |
1384 | 1162daa6 | Luiz Capitulino | .mhandler.cmd = do_info, |
1385 | 33572ece | Jan Kiszka | }, |
1386 | 33572ece | Jan Kiszka | |
1387 | 33572ece | Jan Kiszka | STEXI |
1388 | 33572ece | Jan Kiszka | @item info @var{subcommand} |
1389 | 33572ece | Jan Kiszka | @findex info |
1390 | 33572ece | Jan Kiszka | Show various information about the system state. |
1391 | 33572ece | Jan Kiszka | |
1392 | 33572ece | Jan Kiszka | @table @option |
1393 | 33572ece | Jan Kiszka | @item info version |
1394 | 33572ece | Jan Kiszka | show the version of QEMU |
1395 | 33572ece | Jan Kiszka | @item info network |
1396 | 33572ece | Jan Kiszka | show the various VLANs and the associated devices |
1397 | 33572ece | Jan Kiszka | @item info chardev |
1398 | 33572ece | Jan Kiszka | show the character devices |
1399 | 33572ece | Jan Kiszka | @item info block |
1400 | 33572ece | Jan Kiszka | show the block devices |
1401 | 33572ece | Jan Kiszka | @item info blockstats |
1402 | 33572ece | Jan Kiszka | show block device statistics |
1403 | 33572ece | Jan Kiszka | @item info registers |
1404 | 33572ece | Jan Kiszka | show the cpu registers |
1405 | 33572ece | Jan Kiszka | @item info cpus |
1406 | 33572ece | Jan Kiszka | show infos for each CPU |
1407 | 33572ece | Jan Kiszka | @item info history |
1408 | 33572ece | Jan Kiszka | show the command line history |
1409 | 33572ece | Jan Kiszka | @item info irq |
1410 | 33572ece | Jan Kiszka | show the interrupts statistics (if available) |
1411 | 33572ece | Jan Kiszka | @item info pic |
1412 | 33572ece | Jan Kiszka | show i8259 (PIC) state |
1413 | 33572ece | Jan Kiszka | @item info pci |
1414 | 33572ece | Jan Kiszka | show emulated PCI device info |
1415 | 33572ece | Jan Kiszka | @item info tlb |
1416 | 692f737c | Max Filippov | show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only) |
1417 | 33572ece | Jan Kiszka | @item info mem |
1418 | 33572ece | Jan Kiszka | show the active virtual memory mappings (i386 only) |
1419 | 33572ece | Jan Kiszka | @item info jit |
1420 | 33572ece | Jan Kiszka | show dynamic compiler info |
1421 | 33572ece | Jan Kiszka | @item info numa |
1422 | 33572ece | Jan Kiszka | show NUMA information |
1423 | b40292e7 | Jan Kiszka | @item info kvm |
1424 | b40292e7 | Jan Kiszka | show KVM information |
1425 | 33572ece | Jan Kiszka | @item info usb |
1426 | 33572ece | Jan Kiszka | show USB devices plugged on the virtual USB hub |
1427 | 33572ece | Jan Kiszka | @item info usbhost |
1428 | 33572ece | Jan Kiszka | show all USB host devices |
1429 | 33572ece | Jan Kiszka | @item info profile |
1430 | 33572ece | Jan Kiszka | show profiling information |
1431 | 33572ece | Jan Kiszka | @item info capture |
1432 | 33572ece | Jan Kiszka | show information about active capturing |
1433 | 33572ece | Jan Kiszka | @item info snapshots |
1434 | 33572ece | Jan Kiszka | show list of VM snapshots |
1435 | 33572ece | Jan Kiszka | @item info status |
1436 | 33572ece | Jan Kiszka | show the current VM status (running|paused) |
1437 | 33572ece | Jan Kiszka | @item info pcmcia |
1438 | 33572ece | Jan Kiszka | show guest PCMCIA status |
1439 | 33572ece | Jan Kiszka | @item info mice |
1440 | 33572ece | Jan Kiszka | show which guest mouse is receiving events |
1441 | 33572ece | Jan Kiszka | @item info vnc |
1442 | 33572ece | Jan Kiszka | show the vnc server status |
1443 | 33572ece | Jan Kiszka | @item info name |
1444 | 33572ece | Jan Kiszka | show the current VM name |
1445 | 33572ece | Jan Kiszka | @item info uuid |
1446 | 33572ece | Jan Kiszka | show the current VM UUID |
1447 | 33572ece | Jan Kiszka | @item info cpustats |
1448 | 33572ece | Jan Kiszka | show CPU statistics |
1449 | 33572ece | Jan Kiszka | @item info usernet |
1450 | 33572ece | Jan Kiszka | show user network stack connection states |
1451 | 33572ece | Jan Kiszka | @item info migrate |
1452 | 33572ece | Jan Kiszka | show migration status |
1453 | bbf6da32 | Orit Wasserman | @item info migrate_capabilities |
1454 | bbf6da32 | Orit Wasserman | show current migration capabilities |
1455 | 9e1ba4cc | Orit Wasserman | @item info migrate_cache_size |
1456 | 9e1ba4cc | Orit Wasserman | show current migration XBZRLE cache size |
1457 | 33572ece | Jan Kiszka | @item info balloon |
1458 | 33572ece | Jan Kiszka | show balloon information |
1459 | 33572ece | Jan Kiszka | @item info qtree |
1460 | 33572ece | Jan Kiszka | show device tree |
1461 | 33572ece | Jan Kiszka | @item info qdm |
1462 | 33572ece | Jan Kiszka | show qdev device model list |
1463 | 33572ece | Jan Kiszka | @item info roms |
1464 | 33572ece | Jan Kiszka | show roms |
1465 | 33572ece | Jan Kiszka | @end table |
1466 | 33572ece | Jan Kiszka | ETEXI |
1467 | 33572ece | Jan Kiszka | |
1468 | 6d8a764e | Lluís | #ifdef CONFIG_TRACE_SIMPLE |
1469 | 22890ab5 | Prerna Saxena | STEXI |
1470 | 22890ab5 | Prerna Saxena | @item info trace |
1471 | 22890ab5 | Prerna Saxena | show contents of trace buffer |
1472 | 31965ae2 | Lluís | ETEXI |
1473 | 31965ae2 | Lluís | #endif |
1474 | 31965ae2 | Lluís | |
1475 | 31965ae2 | Lluís | STEXI |
1476 | 22890ab5 | Prerna Saxena | @item info trace-events |
1477 | 22890ab5 | Prerna Saxena | show available trace events and their state |
1478 | 22890ab5 | Prerna Saxena | ETEXI |
1479 | 22890ab5 | Prerna Saxena | |
1480 | 2313086a | Blue Swirl | STEXI |
1481 | 2313086a | Blue Swirl | @end table |
1482 | 2313086a | Blue Swirl | ETEXI |