root / qemu-monitor.hx @ c05c7a73
History | View | Annotate | Download (29.1 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 = "info", |
42 | d7f9b689 | Luiz Capitulino | .args_type = "item:s?", |
43 | d7f9b689 | Luiz Capitulino | .params = "[subcommand]", |
44 | d7f9b689 | Luiz Capitulino | .help = "show various information about the system state", |
45 | 13c7425e | Luiz Capitulino | .user_print = monitor_user_noop, |
46 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_info, |
47 | d7f9b689 | Luiz Capitulino | }, |
48 | d7f9b689 | Luiz Capitulino | |
49 | 2313086a | Blue Swirl | STEXI |
50 | 2313086a | Blue Swirl | @item info @var{subcommand} |
51 | 70fcbbe7 | Stefan Weil | @findex info |
52 | 2313086a | Blue Swirl | Show various information about the system state. |
53 | 2313086a | Blue Swirl | |
54 | 2313086a | Blue Swirl | @table @option |
55 | 2313086a | Blue Swirl | @item info version |
56 | 2313086a | Blue Swirl | show the version of QEMU |
57 | 2313086a | Blue Swirl | @item info network |
58 | 2313086a | Blue Swirl | show the various VLANs and the associated devices |
59 | 2313086a | Blue Swirl | @item info chardev |
60 | 2313086a | Blue Swirl | show the character devices |
61 | 2313086a | Blue Swirl | @item info block |
62 | 2313086a | Blue Swirl | show the block devices |
63 | 2313086a | Blue Swirl | @item info block |
64 | 2313086a | Blue Swirl | show block device statistics |
65 | 2313086a | Blue Swirl | @item info registers |
66 | 2313086a | Blue Swirl | show the cpu registers |
67 | 2313086a | Blue Swirl | @item info cpus |
68 | 2313086a | Blue Swirl | show infos for each CPU |
69 | 2313086a | Blue Swirl | @item info history |
70 | 2313086a | Blue Swirl | show the command line history |
71 | 2313086a | Blue Swirl | @item info irq |
72 | 2313086a | Blue Swirl | show the interrupts statistics (if available) |
73 | 2313086a | Blue Swirl | @item info pic |
74 | 2313086a | Blue Swirl | show i8259 (PIC) state |
75 | 2313086a | Blue Swirl | @item info pci |
76 | 2313086a | Blue Swirl | show emulated PCI device info |
77 | 2313086a | Blue Swirl | @item info tlb |
78 | 2313086a | Blue Swirl | show virtual to physical memory mappings (i386 only) |
79 | 2313086a | Blue Swirl | @item info mem |
80 | 2313086a | Blue Swirl | show the active virtual memory mappings (i386 only) |
81 | 2313086a | Blue Swirl | @item info hpet |
82 | 2313086a | Blue Swirl | show state of HPET (i386 only) |
83 | 2313086a | Blue Swirl | @item info kvm |
84 | 2313086a | Blue Swirl | show KVM information |
85 | 2313086a | Blue Swirl | @item info usb |
86 | 2313086a | Blue Swirl | show USB devices plugged on the virtual USB hub |
87 | 2313086a | Blue Swirl | @item info usbhost |
88 | 2313086a | Blue Swirl | show all USB host devices |
89 | 2313086a | Blue Swirl | @item info profile |
90 | 2313086a | Blue Swirl | show profiling information |
91 | 2313086a | Blue Swirl | @item info capture |
92 | 2313086a | Blue Swirl | show information about active capturing |
93 | 2313086a | Blue Swirl | @item info snapshots |
94 | 2313086a | Blue Swirl | show list of VM snapshots |
95 | 2313086a | Blue Swirl | @item info status |
96 | 2313086a | Blue Swirl | show the current VM status (running|paused) |
97 | 2313086a | Blue Swirl | @item info pcmcia |
98 | 2313086a | Blue Swirl | show guest PCMCIA status |
99 | 2313086a | Blue Swirl | @item info mice |
100 | 2313086a | Blue Swirl | show which guest mouse is receiving events |
101 | 2313086a | Blue Swirl | @item info vnc |
102 | 2313086a | Blue Swirl | show the vnc server status |
103 | 2313086a | Blue Swirl | @item info name |
104 | 2313086a | Blue Swirl | show the current VM name |
105 | 2313086a | Blue Swirl | @item info uuid |
106 | 2313086a | Blue Swirl | show the current VM UUID |
107 | 2313086a | Blue Swirl | @item info cpustats |
108 | 2313086a | Blue Swirl | show CPU statistics |
109 | 6dbe553f | Jan Kiszka | @item info usernet |
110 | 6dbe553f | Jan Kiszka | show user network stack connection states |
111 | 2313086a | Blue Swirl | @item info migrate |
112 | 2313086a | Blue Swirl | show migration status |
113 | 2313086a | Blue Swirl | @item info balloon |
114 | 2313086a | Blue Swirl | show balloon information |
115 | 2313086a | Blue Swirl | @item info qtree |
116 | 2313086a | Blue Swirl | show device tree |
117 | 2313086a | Blue Swirl | @end table |
118 | 2313086a | Blue Swirl | ETEXI |
119 | 2313086a | Blue Swirl | |
120 | d7f9b689 | Luiz Capitulino | { |
121 | d7f9b689 | Luiz Capitulino | .name = "q|quit", |
122 | d7f9b689 | Luiz Capitulino | .args_type = "", |
123 | d7f9b689 | Luiz Capitulino | .params = "", |
124 | d7f9b689 | Luiz Capitulino | .help = "quit the emulator", |
125 | b223f35f | Luiz Capitulino | .user_print = monitor_user_noop, |
126 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_quit, |
127 | d7f9b689 | Luiz Capitulino | }, |
128 | d7f9b689 | Luiz Capitulino | |
129 | 2313086a | Blue Swirl | STEXI |
130 | 2313086a | Blue Swirl | @item q or quit |
131 | 70fcbbe7 | Stefan Weil | @findex quit |
132 | 2313086a | Blue Swirl | Quit the emulator. |
133 | 2313086a | Blue Swirl | ETEXI |
134 | 2313086a | Blue Swirl | |
135 | d7f9b689 | Luiz Capitulino | { |
136 | d7f9b689 | Luiz Capitulino | .name = "eject", |
137 | 78d714e0 | Luiz Capitulino | .args_type = "force:-f,device:B", |
138 | d7f9b689 | Luiz Capitulino | .params = "[-f] device", |
139 | d7f9b689 | Luiz Capitulino | .help = "eject a removable medium (use -f to force it)", |
140 | e1c923a6 | Luiz Capitulino | .user_print = monitor_user_noop, |
141 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_eject, |
142 | d7f9b689 | Luiz Capitulino | }, |
143 | d7f9b689 | Luiz Capitulino | |
144 | 2313086a | Blue Swirl | STEXI |
145 | 2313086a | Blue Swirl | @item eject [-f] @var{device} |
146 | 70fcbbe7 | Stefan Weil | @findex eject |
147 | 2313086a | Blue Swirl | Eject a removable medium (use -f to force it). |
148 | 2313086a | Blue Swirl | ETEXI |
149 | 2313086a | Blue Swirl | |
150 | d7f9b689 | Luiz Capitulino | { |
151 | d7f9b689 | Luiz Capitulino | .name = "change", |
152 | d7f9b689 | Luiz Capitulino | .args_type = "device:B,target:F,arg:s?", |
153 | d7f9b689 | Luiz Capitulino | .params = "device filename [format]", |
154 | d7f9b689 | Luiz Capitulino | .help = "change a removable medium, optional format", |
155 | ec3b82af | Markus Armbruster | .user_print = monitor_user_noop, |
156 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_change, |
157 | d7f9b689 | Luiz Capitulino | }, |
158 | d7f9b689 | Luiz Capitulino | |
159 | 2313086a | Blue Swirl | STEXI |
160 | 2313086a | Blue Swirl | @item change @var{device} @var{setting} |
161 | 70fcbbe7 | Stefan Weil | @findex change |
162 | 2313086a | Blue Swirl | |
163 | 2313086a | Blue Swirl | Change the configuration of a device. |
164 | 2313086a | Blue Swirl | |
165 | 2313086a | Blue Swirl | @table @option |
166 | 2313086a | Blue Swirl | @item change @var{diskdevice} @var{filename} [@var{format}] |
167 | 2313086a | Blue Swirl | Change the medium for a removable disk device to point to @var{filename}. eg |
168 | 2313086a | Blue Swirl | |
169 | 2313086a | Blue Swirl | @example |
170 | 2313086a | Blue Swirl | (qemu) change ide1-cd0 /path/to/some.iso |
171 | 2313086a | Blue Swirl | @end example |
172 | 2313086a | Blue Swirl | |
173 | 2313086a | Blue Swirl | @var{format} is optional. |
174 | 2313086a | Blue Swirl | |
175 | 2313086a | Blue Swirl | @item change vnc @var{display},@var{options} |
176 | 2313086a | Blue Swirl | Change the configuration of the VNC server. The valid syntax for @var{display} |
177 | 2313086a | Blue Swirl | and @var{options} are described at @ref{sec_invocation}. eg |
178 | 2313086a | Blue Swirl | |
179 | 2313086a | Blue Swirl | @example |
180 | 2313086a | Blue Swirl | (qemu) change vnc localhost:1 |
181 | 2313086a | Blue Swirl | @end example |
182 | 2313086a | Blue Swirl | |
183 | 2313086a | Blue Swirl | @item change vnc password [@var{password}] |
184 | 2313086a | Blue Swirl | |
185 | 2313086a | Blue Swirl | Change the password associated with the VNC server. If the new password is not |
186 | 2313086a | Blue Swirl | supplied, the monitor will prompt for it to be entered. VNC passwords are only |
187 | 2313086a | Blue Swirl | significant up to 8 letters. eg |
188 | 2313086a | Blue Swirl | |
189 | 2313086a | Blue Swirl | @example |
190 | 2313086a | Blue Swirl | (qemu) change vnc password |
191 | 2313086a | Blue Swirl | Password: ******** |
192 | 2313086a | Blue Swirl | @end example |
193 | 2313086a | Blue Swirl | |
194 | 2313086a | Blue Swirl | @end table |
195 | 2313086a | Blue Swirl | ETEXI |
196 | 2313086a | Blue Swirl | |
197 | d7f9b689 | Luiz Capitulino | { |
198 | d7f9b689 | Luiz Capitulino | .name = "screendump", |
199 | d7f9b689 | Luiz Capitulino | .args_type = "filename:F", |
200 | d7f9b689 | Luiz Capitulino | .params = "filename", |
201 | d7f9b689 | Luiz Capitulino | .help = "save screen into PPM image 'filename'", |
202 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_screen_dump, |
203 | d7f9b689 | Luiz Capitulino | }, |
204 | d7f9b689 | Luiz Capitulino | |
205 | 2313086a | Blue Swirl | STEXI |
206 | 2313086a | Blue Swirl | @item screendump @var{filename} |
207 | 70fcbbe7 | Stefan Weil | @findex screendump |
208 | 2313086a | Blue Swirl | Save screen into PPM image @var{filename}. |
209 | 2313086a | Blue Swirl | ETEXI |
210 | 2313086a | Blue Swirl | |
211 | d7f9b689 | Luiz Capitulino | { |
212 | d7f9b689 | Luiz Capitulino | .name = "logfile", |
213 | d7f9b689 | Luiz Capitulino | .args_type = "filename:F", |
214 | d7f9b689 | Luiz Capitulino | .params = "filename", |
215 | d7f9b689 | Luiz Capitulino | .help = "output logs to 'filename'", |
216 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_logfile, |
217 | d7f9b689 | Luiz Capitulino | }, |
218 | d7f9b689 | Luiz Capitulino | |
219 | 2313086a | Blue Swirl | STEXI |
220 | 2313086a | Blue Swirl | @item logfile @var{filename} |
221 | 70fcbbe7 | Stefan Weil | @findex logfile |
222 | 2313086a | Blue Swirl | Output logs to @var{filename}. |
223 | 2313086a | Blue Swirl | ETEXI |
224 | 2313086a | Blue Swirl | |
225 | d7f9b689 | Luiz Capitulino | { |
226 | d7f9b689 | Luiz Capitulino | .name = "log", |
227 | d7f9b689 | Luiz Capitulino | .args_type = "items:s", |
228 | d7f9b689 | Luiz Capitulino | .params = "item1[,...]", |
229 | d7f9b689 | Luiz Capitulino | .help = "activate logging of the specified items to '/tmp/qemu.log'", |
230 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_log, |
231 | d7f9b689 | Luiz Capitulino | }, |
232 | d7f9b689 | Luiz Capitulino | |
233 | 2313086a | Blue Swirl | STEXI |
234 | 2313086a | Blue Swirl | @item log @var{item1}[,...] |
235 | 70fcbbe7 | Stefan Weil | @findex log |
236 | 2313086a | Blue Swirl | Activate logging of the specified items to @file{/tmp/qemu.log}. |
237 | 2313086a | Blue Swirl | ETEXI |
238 | 2313086a | Blue Swirl | |
239 | d7f9b689 | Luiz Capitulino | { |
240 | d7f9b689 | Luiz Capitulino | .name = "savevm", |
241 | d7f9b689 | Luiz Capitulino | .args_type = "name:s?", |
242 | d7f9b689 | Luiz Capitulino | .params = "[tag|id]", |
243 | d7f9b689 | Luiz Capitulino | .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created", |
244 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_savevm, |
245 | d7f9b689 | Luiz Capitulino | }, |
246 | d7f9b689 | Luiz Capitulino | |
247 | 2313086a | Blue Swirl | STEXI |
248 | 2313086a | Blue Swirl | @item savevm [@var{tag}|@var{id}] |
249 | 70fcbbe7 | Stefan Weil | @findex savevm |
250 | 2313086a | Blue Swirl | Create a snapshot of the whole virtual machine. If @var{tag} is |
251 | 2313086a | Blue Swirl | provided, it is used as human readable identifier. If there is already |
252 | 2313086a | Blue Swirl | a snapshot with the same tag or ID, it is replaced. More info at |
253 | 2313086a | Blue Swirl | @ref{vm_snapshots}. |
254 | 2313086a | Blue Swirl | ETEXI |
255 | 2313086a | Blue Swirl | |
256 | d7f9b689 | Luiz Capitulino | { |
257 | d7f9b689 | Luiz Capitulino | .name = "loadvm", |
258 | d7f9b689 | Luiz Capitulino | .args_type = "name:s", |
259 | d7f9b689 | Luiz Capitulino | .params = "tag|id", |
260 | d7f9b689 | Luiz Capitulino | .help = "restore a VM snapshot from its tag or id", |
261 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_loadvm, |
262 | d7f9b689 | Luiz Capitulino | }, |
263 | d7f9b689 | Luiz Capitulino | |
264 | 2313086a | Blue Swirl | STEXI |
265 | 2313086a | Blue Swirl | @item loadvm @var{tag}|@var{id} |
266 | 70fcbbe7 | Stefan Weil | @findex loadvm |
267 | 2313086a | Blue Swirl | Set the whole virtual machine to the snapshot identified by the tag |
268 | 2313086a | Blue Swirl | @var{tag} or the unique snapshot ID @var{id}. |
269 | 2313086a | Blue Swirl | ETEXI |
270 | 2313086a | Blue Swirl | |
271 | d7f9b689 | Luiz Capitulino | { |
272 | d7f9b689 | Luiz Capitulino | .name = "delvm", |
273 | d7f9b689 | Luiz Capitulino | .args_type = "name:s", |
274 | d7f9b689 | Luiz Capitulino | .params = "tag|id", |
275 | d7f9b689 | Luiz Capitulino | .help = "delete a VM snapshot from its tag or id", |
276 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_delvm, |
277 | d7f9b689 | Luiz Capitulino | }, |
278 | d7f9b689 | Luiz Capitulino | |
279 | 2313086a | Blue Swirl | STEXI |
280 | 2313086a | Blue Swirl | @item delvm @var{tag}|@var{id} |
281 | 70fcbbe7 | Stefan Weil | @findex delvm |
282 | 2313086a | Blue Swirl | Delete the snapshot identified by @var{tag} or @var{id}. |
283 | 2313086a | Blue Swirl | ETEXI |
284 | 2313086a | Blue Swirl | |
285 | d7f9b689 | Luiz Capitulino | { |
286 | d7f9b689 | Luiz Capitulino | .name = "singlestep", |
287 | d7f9b689 | Luiz Capitulino | .args_type = "option:s?", |
288 | d7f9b689 | Luiz Capitulino | .params = "[on|off]", |
289 | d7f9b689 | Luiz Capitulino | .help = "run emulation in singlestep mode or switch to normal mode", |
290 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_singlestep, |
291 | d7f9b689 | Luiz Capitulino | }, |
292 | d7f9b689 | Luiz Capitulino | |
293 | 2313086a | Blue Swirl | STEXI |
294 | 2313086a | Blue Swirl | @item singlestep [off] |
295 | 70fcbbe7 | Stefan Weil | @findex singlestep |
296 | 2313086a | Blue Swirl | Run the emulation in single step mode. |
297 | 2313086a | Blue Swirl | If called with option off, the emulation returns to normal mode. |
298 | 2313086a | Blue Swirl | ETEXI |
299 | 2313086a | Blue Swirl | |
300 | d7f9b689 | Luiz Capitulino | { |
301 | d7f9b689 | Luiz Capitulino | .name = "stop", |
302 | d7f9b689 | Luiz Capitulino | .args_type = "", |
303 | d7f9b689 | Luiz Capitulino | .params = "", |
304 | d7f9b689 | Luiz Capitulino | .help = "stop emulation", |
305 | e0c97bde | Luiz Capitulino | .user_print = monitor_user_noop, |
306 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_stop, |
307 | d7f9b689 | Luiz Capitulino | }, |
308 | d7f9b689 | Luiz Capitulino | |
309 | 2313086a | Blue Swirl | STEXI |
310 | 2313086a | Blue Swirl | @item stop |
311 | 70fcbbe7 | Stefan Weil | @findex stop |
312 | 2313086a | Blue Swirl | Stop emulation. |
313 | 2313086a | Blue Swirl | ETEXI |
314 | 2313086a | Blue Swirl | |
315 | d7f9b689 | Luiz Capitulino | { |
316 | d7f9b689 | Luiz Capitulino | .name = "c|cont", |
317 | d7f9b689 | Luiz Capitulino | .args_type = "", |
318 | d7f9b689 | Luiz Capitulino | .params = "", |
319 | d7f9b689 | Luiz Capitulino | .help = "resume emulation", |
320 | a1f896a0 | Luiz Capitulino | .user_print = monitor_user_noop, |
321 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_cont, |
322 | d7f9b689 | Luiz Capitulino | }, |
323 | d7f9b689 | Luiz Capitulino | |
324 | 2313086a | Blue Swirl | STEXI |
325 | 2313086a | Blue Swirl | @item c or cont |
326 | 70fcbbe7 | Stefan Weil | @findex cont |
327 | 2313086a | Blue Swirl | Resume emulation. |
328 | 2313086a | Blue Swirl | ETEXI |
329 | 2313086a | Blue Swirl | |
330 | d7f9b689 | Luiz Capitulino | { |
331 | d7f9b689 | Luiz Capitulino | .name = "gdbserver", |
332 | d7f9b689 | Luiz Capitulino | .args_type = "device:s?", |
333 | d7f9b689 | Luiz Capitulino | .params = "[device]", |
334 | d7f9b689 | Luiz Capitulino | .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'", |
335 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_gdbserver, |
336 | d7f9b689 | Luiz Capitulino | }, |
337 | d7f9b689 | Luiz Capitulino | |
338 | 2313086a | Blue Swirl | STEXI |
339 | 2313086a | Blue Swirl | @item gdbserver [@var{port}] |
340 | 70fcbbe7 | Stefan Weil | @findex gdbserver |
341 | 2313086a | Blue Swirl | Start gdbserver session (default @var{port}=1234) |
342 | 2313086a | Blue Swirl | ETEXI |
343 | 2313086a | Blue Swirl | |
344 | d7f9b689 | Luiz Capitulino | { |
345 | d7f9b689 | Luiz Capitulino | .name = "x", |
346 | d7f9b689 | Luiz Capitulino | .args_type = "fmt:/,addr:l", |
347 | d7f9b689 | Luiz Capitulino | .params = "/fmt addr", |
348 | d7f9b689 | Luiz Capitulino | .help = "virtual memory dump starting at 'addr'", |
349 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_memory_dump, |
350 | d7f9b689 | Luiz Capitulino | }, |
351 | d7f9b689 | Luiz Capitulino | |
352 | 2313086a | Blue Swirl | STEXI |
353 | 2313086a | Blue Swirl | @item x/fmt @var{addr} |
354 | 70fcbbe7 | Stefan Weil | @findex x |
355 | 2313086a | Blue Swirl | Virtual memory dump starting at @var{addr}. |
356 | 2313086a | Blue Swirl | ETEXI |
357 | 2313086a | Blue Swirl | |
358 | d7f9b689 | Luiz Capitulino | { |
359 | d7f9b689 | Luiz Capitulino | .name = "xp", |
360 | d7f9b689 | Luiz Capitulino | .args_type = "fmt:/,addr:l", |
361 | d7f9b689 | Luiz Capitulino | .params = "/fmt addr", |
362 | d7f9b689 | Luiz Capitulino | .help = "physical memory dump starting at 'addr'", |
363 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_physical_memory_dump, |
364 | d7f9b689 | Luiz Capitulino | }, |
365 | d7f9b689 | Luiz Capitulino | |
366 | 2313086a | Blue Swirl | STEXI |
367 | 2313086a | Blue Swirl | @item xp /@var{fmt} @var{addr} |
368 | 70fcbbe7 | Stefan Weil | @findex xp |
369 | 2313086a | Blue Swirl | Physical memory dump starting at @var{addr}. |
370 | 2313086a | Blue Swirl | |
371 | 2313086a | Blue Swirl | @var{fmt} is a format which tells the command how to format the |
372 | 2313086a | Blue Swirl | data. Its syntax is: @option{/@{count@}@{format@}@{size@}} |
373 | 2313086a | Blue Swirl | |
374 | 2313086a | Blue Swirl | @table @var |
375 | 2313086a | Blue Swirl | @item count |
376 | 70fcbbe7 | Stefan Weil | @findex count |
377 | 2313086a | Blue Swirl | is the number of items to be dumped. |
378 | 2313086a | Blue Swirl | |
379 | 2313086a | Blue Swirl | @item format |
380 | 70fcbbe7 | Stefan Weil | @findex format |
381 | 2313086a | Blue Swirl | can be x (hex), d (signed decimal), u (unsigned decimal), o (octal), |
382 | 2313086a | Blue Swirl | c (char) or i (asm instruction). |
383 | 2313086a | Blue Swirl | |
384 | 2313086a | Blue Swirl | @item size |
385 | 70fcbbe7 | Stefan Weil | @findex size |
386 | 2313086a | Blue Swirl | can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86, |
387 | 2313086a | Blue Swirl | @code{h} or @code{w} can be specified with the @code{i} format to |
388 | 2313086a | Blue Swirl | respectively select 16 or 32 bit code instruction size. |
389 | 2313086a | Blue Swirl | |
390 | 2313086a | Blue Swirl | @end table |
391 | 2313086a | Blue Swirl | |
392 | 2313086a | Blue Swirl | Examples: |
393 | 2313086a | Blue Swirl | @itemize |
394 | 2313086a | Blue Swirl | @item |
395 | 2313086a | Blue Swirl | Dump 10 instructions at the current instruction pointer: |
396 | 2313086a | Blue Swirl | @example |
397 | 2313086a | Blue Swirl | (qemu) x/10i $eip |
398 | 2313086a | Blue Swirl | 0x90107063: ret |
399 | 2313086a | Blue Swirl | 0x90107064: sti |
400 | 2313086a | Blue Swirl | 0x90107065: lea 0x0(%esi,1),%esi |
401 | 2313086a | Blue Swirl | 0x90107069: lea 0x0(%edi,1),%edi |
402 | 2313086a | Blue Swirl | 0x90107070: ret |
403 | 2313086a | Blue Swirl | 0x90107071: jmp 0x90107080 |
404 | 2313086a | Blue Swirl | 0x90107073: nop |
405 | 2313086a | Blue Swirl | 0x90107074: nop |
406 | 2313086a | Blue Swirl | 0x90107075: nop |
407 | 2313086a | Blue Swirl | 0x90107076: nop |
408 | 2313086a | Blue Swirl | @end example |
409 | 2313086a | Blue Swirl | |
410 | 2313086a | Blue Swirl | @item |
411 | 2313086a | Blue Swirl | Dump 80 16 bit values at the start of the video memory. |
412 | 2313086a | Blue Swirl | @smallexample |
413 | 2313086a | Blue Swirl | (qemu) xp/80hx 0xb8000 |
414 | 2313086a | Blue Swirl | 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42 |
415 | 2313086a | Blue Swirl | 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41 |
416 | 2313086a | Blue Swirl | 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72 |
417 | 2313086a | Blue Swirl | 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73 |
418 | 2313086a | Blue Swirl | 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20 |
419 | 2313086a | Blue Swirl | 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720 |
420 | 2313086a | Blue Swirl | 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
421 | 2313086a | Blue Swirl | 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
422 | 2313086a | Blue Swirl | 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
423 | 2313086a | Blue Swirl | 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
424 | 2313086a | Blue Swirl | @end smallexample |
425 | 2313086a | Blue Swirl | @end itemize |
426 | 2313086a | Blue Swirl | ETEXI |
427 | 2313086a | Blue Swirl | |
428 | d7f9b689 | Luiz Capitulino | { |
429 | d7f9b689 | Luiz Capitulino | .name = "p|print", |
430 | d7f9b689 | Luiz Capitulino | .args_type = "fmt:/,val:l", |
431 | d7f9b689 | Luiz Capitulino | .params = "/fmt expr", |
432 | d7f9b689 | Luiz Capitulino | .help = "print expression value (use $reg for CPU register access)", |
433 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_print, |
434 | d7f9b689 | Luiz Capitulino | }, |
435 | d7f9b689 | Luiz Capitulino | |
436 | 2313086a | Blue Swirl | STEXI |
437 | 2313086a | Blue Swirl | @item p or print/@var{fmt} @var{expr} |
438 | 70fcbbe7 | Stefan Weil | @findex print |
439 | 2313086a | Blue Swirl | |
440 | 2313086a | Blue Swirl | Print expression value. Only the @var{format} part of @var{fmt} is |
441 | 2313086a | Blue Swirl | used. |
442 | 2313086a | Blue Swirl | ETEXI |
443 | 2313086a | Blue Swirl | |
444 | d7f9b689 | Luiz Capitulino | { |
445 | d7f9b689 | Luiz Capitulino | .name = "i", |
446 | d7f9b689 | Luiz Capitulino | .args_type = "fmt:/,addr:i,index:i.", |
447 | d7f9b689 | Luiz Capitulino | .params = "/fmt addr", |
448 | d7f9b689 | Luiz Capitulino | .help = "I/O port read", |
449 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_ioport_read, |
450 | d7f9b689 | Luiz Capitulino | }, |
451 | d7f9b689 | Luiz Capitulino | |
452 | 2313086a | Blue Swirl | STEXI |
453 | 2313086a | Blue Swirl | Read I/O port. |
454 | 2313086a | Blue Swirl | ETEXI |
455 | 2313086a | Blue Swirl | |
456 | d7f9b689 | Luiz Capitulino | { |
457 | d7f9b689 | Luiz Capitulino | .name = "o", |
458 | d7f9b689 | Luiz Capitulino | .args_type = "fmt:/,addr:i,val:i", |
459 | d7f9b689 | Luiz Capitulino | .params = "/fmt addr value", |
460 | d7f9b689 | Luiz Capitulino | .help = "I/O port write", |
461 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_ioport_write, |
462 | d7f9b689 | Luiz Capitulino | }, |
463 | d7f9b689 | Luiz Capitulino | |
464 | f114784f | Jan Kiszka | STEXI |
465 | f114784f | Jan Kiszka | Write to I/O port. |
466 | f114784f | Jan Kiszka | ETEXI |
467 | 2313086a | Blue Swirl | |
468 | d7f9b689 | Luiz Capitulino | { |
469 | d7f9b689 | Luiz Capitulino | .name = "sendkey", |
470 | d7f9b689 | Luiz Capitulino | .args_type = "string:s,hold_time:i?", |
471 | d7f9b689 | Luiz Capitulino | .params = "keys [hold_ms]", |
472 | d7f9b689 | Luiz Capitulino | .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)", |
473 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_sendkey, |
474 | d7f9b689 | Luiz Capitulino | }, |
475 | d7f9b689 | Luiz Capitulino | |
476 | 2313086a | Blue Swirl | STEXI |
477 | 2313086a | Blue Swirl | @item sendkey @var{keys} |
478 | 70fcbbe7 | Stefan Weil | @findex sendkey |
479 | 2313086a | Blue Swirl | |
480 | 2313086a | Blue Swirl | Send @var{keys} to the emulator. @var{keys} could be the name of the |
481 | 2313086a | Blue Swirl | key or @code{#} followed by the raw value in either decimal or hexadecimal |
482 | 2313086a | Blue Swirl | format. Use @code{-} to press several keys simultaneously. Example: |
483 | 2313086a | Blue Swirl | @example |
484 | 2313086a | Blue Swirl | sendkey ctrl-alt-f1 |
485 | 2313086a | Blue Swirl | @end example |
486 | 2313086a | Blue Swirl | |
487 | 2313086a | Blue Swirl | This command is useful to send keys that your graphical user interface |
488 | 2313086a | Blue Swirl | intercepts at low level, such as @code{ctrl-alt-f1} in X Window. |
489 | 2313086a | Blue Swirl | ETEXI |
490 | 2313086a | Blue Swirl | |
491 | d7f9b689 | Luiz Capitulino | { |
492 | d7f9b689 | Luiz Capitulino | .name = "system_reset", |
493 | d7f9b689 | Luiz Capitulino | .args_type = "", |
494 | d7f9b689 | Luiz Capitulino | .params = "", |
495 | d7f9b689 | Luiz Capitulino | .help = "reset the system", |
496 | c80d259e | Luiz Capitulino | .user_print = monitor_user_noop, |
497 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_system_reset, |
498 | d7f9b689 | Luiz Capitulino | }, |
499 | d7f9b689 | Luiz Capitulino | |
500 | 2313086a | Blue Swirl | STEXI |
501 | 2313086a | Blue Swirl | @item system_reset |
502 | 70fcbbe7 | Stefan Weil | @findex system_reset |
503 | 2313086a | Blue Swirl | |
504 | 2313086a | Blue Swirl | Reset the system. |
505 | 2313086a | Blue Swirl | ETEXI |
506 | 2313086a | Blue Swirl | |
507 | d7f9b689 | Luiz Capitulino | { |
508 | d7f9b689 | Luiz Capitulino | .name = "system_powerdown", |
509 | d7f9b689 | Luiz Capitulino | .args_type = "", |
510 | d7f9b689 | Luiz Capitulino | .params = "", |
511 | d7f9b689 | Luiz Capitulino | .help = "send system power down event", |
512 | 43076664 | Luiz Capitulino | .user_print = monitor_user_noop, |
513 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_system_powerdown, |
514 | d7f9b689 | Luiz Capitulino | }, |
515 | d7f9b689 | Luiz Capitulino | |
516 | 2313086a | Blue Swirl | STEXI |
517 | 2313086a | Blue Swirl | @item system_powerdown |
518 | 70fcbbe7 | Stefan Weil | @findex system_powerdown |
519 | 2313086a | Blue Swirl | |
520 | 2313086a | Blue Swirl | Power down the system (if supported). |
521 | 2313086a | Blue Swirl | ETEXI |
522 | 2313086a | Blue Swirl | |
523 | d7f9b689 | Luiz Capitulino | { |
524 | d7f9b689 | Luiz Capitulino | .name = "sum", |
525 | d7f9b689 | Luiz Capitulino | .args_type = "start:i,size:i", |
526 | d7f9b689 | Luiz Capitulino | .params = "addr size", |
527 | d7f9b689 | Luiz Capitulino | .help = "compute the checksum of a memory region", |
528 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_sum, |
529 | d7f9b689 | Luiz Capitulino | }, |
530 | d7f9b689 | Luiz Capitulino | |
531 | 2313086a | Blue Swirl | STEXI |
532 | 2313086a | Blue Swirl | @item sum @var{addr} @var{size} |
533 | 70fcbbe7 | Stefan Weil | @findex sum |
534 | 2313086a | Blue Swirl | |
535 | 2313086a | Blue Swirl | Compute the checksum of a memory region. |
536 | 2313086a | Blue Swirl | ETEXI |
537 | 2313086a | Blue Swirl | |
538 | d7f9b689 | Luiz Capitulino | { |
539 | d7f9b689 | Luiz Capitulino | .name = "usb_add", |
540 | d7f9b689 | Luiz Capitulino | .args_type = "devname:s", |
541 | d7f9b689 | Luiz Capitulino | .params = "device", |
542 | d7f9b689 | Luiz Capitulino | .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')", |
543 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_usb_add, |
544 | d7f9b689 | Luiz Capitulino | }, |
545 | d7f9b689 | Luiz Capitulino | |
546 | 2313086a | Blue Swirl | STEXI |
547 | 2313086a | Blue Swirl | @item usb_add @var{devname} |
548 | 70fcbbe7 | Stefan Weil | @findex usb_add |
549 | 2313086a | Blue Swirl | |
550 | 2313086a | Blue Swirl | Add the USB device @var{devname}. For details of available devices see |
551 | 2313086a | Blue Swirl | @ref{usb_devices} |
552 | 2313086a | Blue Swirl | ETEXI |
553 | 2313086a | Blue Swirl | |
554 | d7f9b689 | Luiz Capitulino | { |
555 | d7f9b689 | Luiz Capitulino | .name = "usb_del", |
556 | d7f9b689 | Luiz Capitulino | .args_type = "devname:s", |
557 | d7f9b689 | Luiz Capitulino | .params = "device", |
558 | d7f9b689 | Luiz Capitulino | .help = "remove USB device 'bus.addr'", |
559 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_usb_del, |
560 | d7f9b689 | Luiz Capitulino | }, |
561 | d7f9b689 | Luiz Capitulino | |
562 | 2313086a | Blue Swirl | STEXI |
563 | 2313086a | Blue Swirl | @item usb_del @var{devname} |
564 | 70fcbbe7 | Stefan Weil | @findex usb_del |
565 | 2313086a | Blue Swirl | |
566 | 2313086a | Blue Swirl | Remove the USB device @var{devname} from the QEMU virtual USB |
567 | 2313086a | Blue Swirl | hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor |
568 | 2313086a | Blue Swirl | command @code{info usb} to see the devices you can remove. |
569 | 2313086a | Blue Swirl | ETEXI |
570 | 2313086a | Blue Swirl | |
571 | d7f9b689 | Luiz Capitulino | { |
572 | d7f9b689 | Luiz Capitulino | .name = "device_add", |
573 | c7e4e8ce | Markus Armbruster | .args_type = "device:O", |
574 | c7e4e8ce | Markus Armbruster | .params = "driver[,prop=value][,...]", |
575 | d7f9b689 | Luiz Capitulino | .help = "add device, like -device on the command line", |
576 | 8bc27249 | Markus Armbruster | .user_print = monitor_user_noop, |
577 | 8bc27249 | Markus Armbruster | .mhandler.cmd_new = do_device_add, |
578 | d7f9b689 | Luiz Capitulino | }, |
579 | d7f9b689 | Luiz Capitulino | |
580 | 3418bd25 | Gerd Hoffmann | STEXI |
581 | 3418bd25 | Gerd Hoffmann | @item device_add @var{config} |
582 | 70fcbbe7 | Stefan Weil | @findex device_add |
583 | 3418bd25 | Gerd Hoffmann | |
584 | 3418bd25 | Gerd Hoffmann | Add device. |
585 | 3418bd25 | Gerd Hoffmann | ETEXI |
586 | 3418bd25 | Gerd Hoffmann | |
587 | d7f9b689 | Luiz Capitulino | { |
588 | d7f9b689 | Luiz Capitulino | .name = "device_del", |
589 | d7f9b689 | Luiz Capitulino | .args_type = "id:s", |
590 | d7f9b689 | Luiz Capitulino | .params = "device", |
591 | d7f9b689 | Luiz Capitulino | .help = "remove device", |
592 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_device_del, |
593 | d7f9b689 | Luiz Capitulino | }, |
594 | d7f9b689 | Luiz Capitulino | |
595 | 3418bd25 | Gerd Hoffmann | STEXI |
596 | 3418bd25 | Gerd Hoffmann | @item device_del @var{id} |
597 | 70fcbbe7 | Stefan Weil | @findex device_del |
598 | 3418bd25 | Gerd Hoffmann | |
599 | 3418bd25 | Gerd Hoffmann | Remove device @var{id}. |
600 | 3418bd25 | Gerd Hoffmann | ETEXI |
601 | 3418bd25 | Gerd Hoffmann | |
602 | d7f9b689 | Luiz Capitulino | { |
603 | d7f9b689 | Luiz Capitulino | .name = "cpu", |
604 | d7f9b689 | Luiz Capitulino | .args_type = "index:i", |
605 | d7f9b689 | Luiz Capitulino | .params = "index", |
606 | d7f9b689 | Luiz Capitulino | .help = "set the default CPU", |
607 | 81a1b45a | Markus Armbruster | .user_print = monitor_user_noop, |
608 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_cpu_set, |
609 | d7f9b689 | Luiz Capitulino | }, |
610 | 3418bd25 | Gerd Hoffmann | |
611 | 2313086a | Blue Swirl | STEXI |
612 | 2313086a | Blue Swirl | Set the default CPU. |
613 | 2313086a | Blue Swirl | ETEXI |
614 | 2313086a | Blue Swirl | |
615 | d7f9b689 | Luiz Capitulino | { |
616 | d7f9b689 | Luiz Capitulino | .name = "mouse_move", |
617 | d7f9b689 | Luiz Capitulino | .args_type = "dx_str:s,dy_str:s,dz_str:s?", |
618 | d7f9b689 | Luiz Capitulino | .params = "dx dy [dz]", |
619 | d7f9b689 | Luiz Capitulino | .help = "send mouse move events", |
620 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_mouse_move, |
621 | d7f9b689 | Luiz Capitulino | }, |
622 | d7f9b689 | Luiz Capitulino | |
623 | 2313086a | Blue Swirl | STEXI |
624 | 2313086a | Blue Swirl | @item mouse_move @var{dx} @var{dy} [@var{dz}] |
625 | 70fcbbe7 | Stefan Weil | @findex mouse_move |
626 | 2313086a | Blue Swirl | Move the active mouse to the specified coordinates @var{dx} @var{dy} |
627 | 2313086a | Blue Swirl | with optional scroll axis @var{dz}. |
628 | 2313086a | Blue Swirl | ETEXI |
629 | 2313086a | Blue Swirl | |
630 | d7f9b689 | Luiz Capitulino | { |
631 | d7f9b689 | Luiz Capitulino | .name = "mouse_button", |
632 | d7f9b689 | Luiz Capitulino | .args_type = "button_state:i", |
633 | d7f9b689 | Luiz Capitulino | .params = "state", |
634 | d7f9b689 | Luiz Capitulino | .help = "change mouse button state (1=L, 2=M, 4=R)", |
635 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_mouse_button, |
636 | d7f9b689 | Luiz Capitulino | }, |
637 | d7f9b689 | Luiz Capitulino | |
638 | 2313086a | Blue Swirl | STEXI |
639 | 2313086a | Blue Swirl | @item mouse_button @var{val} |
640 | 70fcbbe7 | Stefan Weil | @findex mouse_button |
641 | 2313086a | Blue Swirl | Change the active mouse button state @var{val} (1=L, 2=M, 4=R). |
642 | 2313086a | Blue Swirl | ETEXI |
643 | 2313086a | Blue Swirl | |
644 | d7f9b689 | Luiz Capitulino | { |
645 | d7f9b689 | Luiz Capitulino | .name = "mouse_set", |
646 | d7f9b689 | Luiz Capitulino | .args_type = "index:i", |
647 | d7f9b689 | Luiz Capitulino | .params = "index", |
648 | d7f9b689 | Luiz Capitulino | .help = "set which mouse device receives events", |
649 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_mouse_set, |
650 | d7f9b689 | Luiz Capitulino | }, |
651 | d7f9b689 | Luiz Capitulino | |
652 | 2313086a | Blue Swirl | STEXI |
653 | 2313086a | Blue Swirl | @item mouse_set @var{index} |
654 | 70fcbbe7 | Stefan Weil | @findex mouse_set |
655 | 2313086a | Blue Swirl | Set which mouse device receives events at given @var{index}, index |
656 | 2313086a | Blue Swirl | can be obtained with |
657 | 2313086a | Blue Swirl | @example |
658 | 2313086a | Blue Swirl | info mice |
659 | 2313086a | Blue Swirl | @end example |
660 | 2313086a | Blue Swirl | ETEXI |
661 | 2313086a | Blue Swirl | |
662 | 2313086a | Blue Swirl | #ifdef HAS_AUDIO |
663 | d7f9b689 | Luiz Capitulino | { |
664 | d7f9b689 | Luiz Capitulino | .name = "wavcapture", |
665 | d7f9b689 | Luiz Capitulino | .args_type = "path:F,freq:i?,bits:i?,nchannels:i?", |
666 | d7f9b689 | Luiz Capitulino | .params = "path [frequency [bits [channels]]]", |
667 | d7f9b689 | Luiz Capitulino | .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)", |
668 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_wav_capture, |
669 | d7f9b689 | Luiz Capitulino | }, |
670 | 2313086a | Blue Swirl | #endif |
671 | 2313086a | Blue Swirl | STEXI |
672 | 2313086a | Blue Swirl | @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]] |
673 | 70fcbbe7 | Stefan Weil | @findex wavcapture |
674 | 2313086a | Blue Swirl | Capture audio into @var{filename}. Using sample rate @var{frequency} |
675 | 2313086a | Blue Swirl | bits per sample @var{bits} and number of channels @var{channels}. |
676 | 2313086a | Blue Swirl | |
677 | 2313086a | Blue Swirl | Defaults: |
678 | 2313086a | Blue Swirl | @itemize @minus |
679 | 2313086a | Blue Swirl | @item Sample rate = 44100 Hz - CD quality |
680 | 2313086a | Blue Swirl | @item Bits = 16 |
681 | 2313086a | Blue Swirl | @item Number of channels = 2 - Stereo |
682 | 2313086a | Blue Swirl | @end itemize |
683 | 2313086a | Blue Swirl | ETEXI |
684 | 2313086a | Blue Swirl | |
685 | 2313086a | Blue Swirl | #ifdef HAS_AUDIO |
686 | d7f9b689 | Luiz Capitulino | { |
687 | d7f9b689 | Luiz Capitulino | .name = "stopcapture", |
688 | d7f9b689 | Luiz Capitulino | .args_type = "n:i", |
689 | d7f9b689 | Luiz Capitulino | .params = "capture index", |
690 | d7f9b689 | Luiz Capitulino | .help = "stop capture", |
691 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_stop_capture, |
692 | d7f9b689 | Luiz Capitulino | }, |
693 | 2313086a | Blue Swirl | #endif |
694 | 2313086a | Blue Swirl | STEXI |
695 | 2313086a | Blue Swirl | @item stopcapture @var{index} |
696 | 70fcbbe7 | Stefan Weil | @findex stopcapture |
697 | 2313086a | Blue Swirl | Stop capture with a given @var{index}, index can be obtained with |
698 | 2313086a | Blue Swirl | @example |
699 | 2313086a | Blue Swirl | info capture |
700 | 2313086a | Blue Swirl | @end example |
701 | 2313086a | Blue Swirl | ETEXI |
702 | 2313086a | Blue Swirl | |
703 | d7f9b689 | Luiz Capitulino | { |
704 | d7f9b689 | Luiz Capitulino | .name = "memsave", |
705 | d7f9b689 | Luiz Capitulino | .args_type = "val:l,size:i,filename:s", |
706 | d7f9b689 | Luiz Capitulino | .params = "addr size file", |
707 | d7f9b689 | Luiz Capitulino | .help = "save to disk virtual memory dump starting at 'addr' of size 'size'", |
708 | 57e09454 | Luiz Capitulino | .user_print = monitor_user_noop, |
709 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_memory_save, |
710 | d7f9b689 | Luiz Capitulino | }, |
711 | d7f9b689 | Luiz Capitulino | |
712 | 2313086a | Blue Swirl | STEXI |
713 | 2313086a | Blue Swirl | @item memsave @var{addr} @var{size} @var{file} |
714 | 70fcbbe7 | Stefan Weil | @findex memsave |
715 | 2313086a | Blue Swirl | save to disk virtual memory dump starting at @var{addr} of size @var{size}. |
716 | 2313086a | Blue Swirl | ETEXI |
717 | 2313086a | Blue Swirl | |
718 | d7f9b689 | Luiz Capitulino | { |
719 | d7f9b689 | Luiz Capitulino | .name = "pmemsave", |
720 | d7f9b689 | Luiz Capitulino | .args_type = "val:l,size:i,filename:s", |
721 | d7f9b689 | Luiz Capitulino | .params = "addr size file", |
722 | d7f9b689 | Luiz Capitulino | .help = "save to disk physical memory dump starting at 'addr' of size 'size'", |
723 | 18f5a8bf | Luiz Capitulino | .user_print = monitor_user_noop, |
724 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_physical_memory_save, |
725 | d7f9b689 | Luiz Capitulino | }, |
726 | d7f9b689 | Luiz Capitulino | |
727 | 2313086a | Blue Swirl | STEXI |
728 | 2313086a | Blue Swirl | @item pmemsave @var{addr} @var{size} @var{file} |
729 | 70fcbbe7 | Stefan Weil | @findex pmemsave |
730 | 2313086a | Blue Swirl | save to disk physical memory dump starting at @var{addr} of size @var{size}. |
731 | 2313086a | Blue Swirl | ETEXI |
732 | 2313086a | Blue Swirl | |
733 | d7f9b689 | Luiz Capitulino | { |
734 | d7f9b689 | Luiz Capitulino | .name = "boot_set", |
735 | d7f9b689 | Luiz Capitulino | .args_type = "bootdevice:s", |
736 | d7f9b689 | Luiz Capitulino | .params = "bootdevice", |
737 | d7f9b689 | Luiz Capitulino | .help = "define new values for the boot device list", |
738 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_boot_set, |
739 | d7f9b689 | Luiz Capitulino | }, |
740 | d7f9b689 | Luiz Capitulino | |
741 | 2313086a | Blue Swirl | STEXI |
742 | 2313086a | Blue Swirl | @item boot_set @var{bootdevicelist} |
743 | 70fcbbe7 | Stefan Weil | @findex boot_set |
744 | 2313086a | Blue Swirl | |
745 | 2313086a | Blue Swirl | Define new values for the boot device list. Those values will override |
746 | 2313086a | Blue Swirl | the values specified on the command line through the @code{-boot} option. |
747 | 2313086a | Blue Swirl | |
748 | 2313086a | Blue Swirl | The values that can be specified here depend on the machine type, but are |
749 | 2313086a | Blue Swirl | the same that can be specified in the @code{-boot} command line option. |
750 | 2313086a | Blue Swirl | ETEXI |
751 | 2313086a | Blue Swirl | |
752 | 2313086a | Blue Swirl | #if defined(TARGET_I386) |
753 | d7f9b689 | Luiz Capitulino | { |
754 | d7f9b689 | Luiz Capitulino | .name = "nmi", |
755 | d7f9b689 | Luiz Capitulino | .args_type = "cpu_index:i", |
756 | d7f9b689 | Luiz Capitulino | .params = "cpu", |
757 | d7f9b689 | Luiz Capitulino | .help = "inject an NMI on the given CPU", |
758 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_inject_nmi, |
759 | d7f9b689 | Luiz Capitulino | }, |
760 | 2313086a | Blue Swirl | #endif |
761 | 2313086a | Blue Swirl | STEXI |
762 | 2313086a | Blue Swirl | @item nmi @var{cpu} |
763 | 70fcbbe7 | Stefan Weil | @findex nmi |
764 | 2313086a | Blue Swirl | Inject an NMI on the given CPU (x86 only). |
765 | 2313086a | Blue Swirl | ETEXI |
766 | 2313086a | Blue Swirl | |
767 | d7f9b689 | Luiz Capitulino | { |
768 | d7f9b689 | Luiz Capitulino | .name = "migrate", |
769 | fbc3d96c | lirans@il.ibm.com | .args_type = "detach:-d,blk:-b,inc:-i,uri:s", |
770 | fbc3d96c | lirans@il.ibm.com | .params = "[-d] [-b] [-i] uri", |
771 | fbc3d96c | lirans@il.ibm.com | .help = "migrate to URI (using -d to not wait for completion)" |
772 | fbc3d96c | lirans@il.ibm.com | "\n\t\t\t -b for migration without shared storage with" |
773 | fbc3d96c | lirans@il.ibm.com | " full copy of disk\n\t\t\t -i for migration without " |
774 | fbc3d96c | lirans@il.ibm.com | "shared storage with incremental copy of disk " |
775 | fbc3d96c | lirans@il.ibm.com | "(base image shared between src and destination)", |
776 | fbc3d96c | lirans@il.ibm.com | .user_print = monitor_user_noop, |
777 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_migrate, |
778 | d7f9b689 | Luiz Capitulino | }, |
779 | d7f9b689 | Luiz Capitulino | |
780 | fbc3d96c | lirans@il.ibm.com | |
781 | 2313086a | Blue Swirl | STEXI |
782 | fbc3d96c | lirans@il.ibm.com | @item migrate [-d] [-b] [-i] @var{uri} |
783 | 70fcbbe7 | Stefan Weil | @findex migrate |
784 | 2313086a | Blue Swirl | Migrate to @var{uri} (using -d to not wait for completion). |
785 | fbc3d96c | lirans@il.ibm.com | -b for migration with full copy of disk |
786 | fbc3d96c | lirans@il.ibm.com | -i for migration with incremental copy of disk (base image is shared) |
787 | 2313086a | Blue Swirl | ETEXI |
788 | 2313086a | Blue Swirl | |
789 | d7f9b689 | Luiz Capitulino | { |
790 | d7f9b689 | Luiz Capitulino | .name = "migrate_cancel", |
791 | d7f9b689 | Luiz Capitulino | .args_type = "", |
792 | d7f9b689 | Luiz Capitulino | .params = "", |
793 | d7f9b689 | Luiz Capitulino | .help = "cancel the current VM migration", |
794 | 911d2963 | Luiz Capitulino | .user_print = monitor_user_noop, |
795 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_migrate_cancel, |
796 | d7f9b689 | Luiz Capitulino | }, |
797 | d7f9b689 | Luiz Capitulino | |
798 | 2313086a | Blue Swirl | STEXI |
799 | 2313086a | Blue Swirl | @item migrate_cancel |
800 | 70fcbbe7 | Stefan Weil | @findex migrate_cancel |
801 | 2313086a | Blue Swirl | Cancel the current VM migration. |
802 | 2313086a | Blue Swirl | ETEXI |
803 | 2313086a | Blue Swirl | |
804 | d7f9b689 | Luiz Capitulino | { |
805 | d7f9b689 | Luiz Capitulino | .name = "migrate_set_speed", |
806 | 5667c493 | Markus Armbruster | .args_type = "value:b", |
807 | d7f9b689 | Luiz Capitulino | .params = "value", |
808 | d7f9b689 | Luiz Capitulino | .help = "set maximum speed (in bytes) for migrations", |
809 | 5fd9083c | Markus Armbruster | .user_print = monitor_user_noop, |
810 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_migrate_set_speed, |
811 | d7f9b689 | Luiz Capitulino | }, |
812 | d7f9b689 | Luiz Capitulino | |
813 | 2313086a | Blue Swirl | STEXI |
814 | 2313086a | Blue Swirl | @item migrate_set_speed @var{value} |
815 | 70fcbbe7 | Stefan Weil | @findex migrate_set_speed |
816 | 2313086a | Blue Swirl | Set maximum speed to @var{value} (in bytes) for migrations. |
817 | 2313086a | Blue Swirl | ETEXI |
818 | 2313086a | Blue Swirl | |
819 | d7f9b689 | Luiz Capitulino | { |
820 | d7f9b689 | Luiz Capitulino | .name = "migrate_set_downtime", |
821 | b0fbf7d3 | Markus Armbruster | .args_type = "value:T", |
822 | d7f9b689 | Luiz Capitulino | .params = "value", |
823 | d7f9b689 | Luiz Capitulino | .help = "set maximum tolerated downtime (in seconds) for migrations", |
824 | c6027f56 | Markus Armbruster | .user_print = monitor_user_noop, |
825 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_migrate_set_downtime, |
826 | d7f9b689 | Luiz Capitulino | }, |
827 | 2ea42952 | Glauber Costa | |
828 | 2ea42952 | Glauber Costa | STEXI |
829 | 2ea42952 | Glauber Costa | @item migrate_set_downtime @var{second} |
830 | 70fcbbe7 | Stefan Weil | @findex migrate_set_downtime |
831 | 2ea42952 | Glauber Costa | Set maximum tolerated downtime (in seconds) for migration. |
832 | 2ea42952 | Glauber Costa | ETEXI |
833 | 2ea42952 | Glauber Costa | |
834 | 2313086a | Blue Swirl | #if defined(TARGET_I386) |
835 | d7f9b689 | Luiz Capitulino | { |
836 | d7f9b689 | Luiz Capitulino | .name = "drive_add", |
837 | d7f9b689 | Luiz Capitulino | .args_type = "pci_addr:s,opts:s", |
838 | d7f9b689 | Luiz Capitulino | .params = "[[<domain>:]<bus>:]<slot>\n" |
839 | d7f9b689 | Luiz Capitulino | "[file=file][,if=type][,bus=n]\n" |
840 | d7f9b689 | Luiz Capitulino | "[,unit=m][,media=d][index=i]\n" |
841 | d7f9b689 | Luiz Capitulino | "[,cyls=c,heads=h,secs=s[,trans=t]]\n" |
842 | d7f9b689 | Luiz Capitulino | "[snapshot=on|off][,cache=on|off]", |
843 | d7f9b689 | Luiz Capitulino | .help = "add drive to PCI storage controller", |
844 | af4ce882 | Luiz Capitulino | .mhandler.cmd = drive_hot_add, |
845 | d7f9b689 | Luiz Capitulino | }, |
846 | 2313086a | Blue Swirl | #endif |
847 | d7f9b689 | Luiz Capitulino | |
848 | 2313086a | Blue Swirl | STEXI |
849 | 2313086a | Blue Swirl | @item drive_add |
850 | 70fcbbe7 | Stefan Weil | @findex drive_add |
851 | 2313086a | Blue Swirl | Add drive to PCI storage controller. |
852 | 2313086a | Blue Swirl | ETEXI |
853 | 2313086a | Blue Swirl | |
854 | 2313086a | Blue Swirl | #if defined(TARGET_I386) |
855 | d7f9b689 | Luiz Capitulino | { |
856 | d7f9b689 | Luiz Capitulino | .name = "pci_add", |
857 | d7f9b689 | Luiz Capitulino | .args_type = "pci_addr:s,type:s,opts:s?", |
858 | d7f9b689 | Luiz Capitulino | .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...", |
859 | d7f9b689 | Luiz Capitulino | .help = "hot-add PCI device", |
860 | 7a344f7a | Luiz Capitulino | .user_print = pci_device_hot_add_print, |
861 | 261394db | Luiz Capitulino | .mhandler.cmd_new = pci_device_hot_add, |
862 | d7f9b689 | Luiz Capitulino | }, |
863 | 2313086a | Blue Swirl | #endif |
864 | d7f9b689 | Luiz Capitulino | |
865 | 2313086a | Blue Swirl | STEXI |
866 | 2313086a | Blue Swirl | @item pci_add |
867 | 70fcbbe7 | Stefan Weil | @findex pci_add |
868 | 2313086a | Blue Swirl | Hot-add PCI device. |
869 | 2313086a | Blue Swirl | ETEXI |
870 | 2313086a | Blue Swirl | |
871 | 2313086a | Blue Swirl | #if defined(TARGET_I386) |
872 | d7f9b689 | Luiz Capitulino | { |
873 | d7f9b689 | Luiz Capitulino | .name = "pci_del", |
874 | d7f9b689 | Luiz Capitulino | .args_type = "pci_addr:s", |
875 | d7f9b689 | Luiz Capitulino | .params = "[[<domain>:]<bus>:]<slot>", |
876 | d7f9b689 | Luiz Capitulino | .help = "hot remove PCI device", |
877 | 6848d827 | Luiz Capitulino | .user_print = monitor_user_noop, |
878 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_pci_device_hot_remove, |
879 | d7f9b689 | Luiz Capitulino | }, |
880 | 2313086a | Blue Swirl | #endif |
881 | d7f9b689 | Luiz Capitulino | |
882 | 2313086a | Blue Swirl | STEXI |
883 | 2313086a | Blue Swirl | @item pci_del |
884 | 70fcbbe7 | Stefan Weil | @findex pci_del |
885 | 2313086a | Blue Swirl | Hot remove PCI device. |
886 | 2313086a | Blue Swirl | ETEXI |
887 | 2313086a | Blue Swirl | |
888 | d7f9b689 | Luiz Capitulino | { |
889 | d7f9b689 | Luiz Capitulino | .name = "host_net_add", |
890 | d7f9b689 | Luiz Capitulino | .args_type = "device:s,opts:s?", |
891 | d7f9b689 | Luiz Capitulino | .params = "tap|user|socket|vde|dump [options]", |
892 | d7f9b689 | Luiz Capitulino | .help = "add host VLAN client", |
893 | af4ce882 | Luiz Capitulino | .mhandler.cmd = net_host_device_add, |
894 | d7f9b689 | Luiz Capitulino | }, |
895 | d7f9b689 | Luiz Capitulino | |
896 | 2313086a | Blue Swirl | STEXI |
897 | 2313086a | Blue Swirl | @item host_net_add |
898 | 70fcbbe7 | Stefan Weil | @findex host_net_add |
899 | 2313086a | Blue Swirl | Add host VLAN client. |
900 | 2313086a | Blue Swirl | ETEXI |
901 | 2313086a | Blue Swirl | |
902 | d7f9b689 | Luiz Capitulino | { |
903 | d7f9b689 | Luiz Capitulino | .name = "host_net_remove", |
904 | d7f9b689 | Luiz Capitulino | .args_type = "vlan_id:i,device:s", |
905 | d7f9b689 | Luiz Capitulino | .params = "vlan_id name", |
906 | d7f9b689 | Luiz Capitulino | .help = "remove host VLAN client", |
907 | af4ce882 | Luiz Capitulino | .mhandler.cmd = net_host_device_remove, |
908 | d7f9b689 | Luiz Capitulino | }, |
909 | d7f9b689 | Luiz Capitulino | |
910 | 2313086a | Blue Swirl | STEXI |
911 | 2313086a | Blue Swirl | @item host_net_remove |
912 | 70fcbbe7 | Stefan Weil | @findex host_net_remove |
913 | 2313086a | Blue Swirl | Remove host VLAN client. |
914 | 2313086a | Blue Swirl | ETEXI |
915 | 2313086a | Blue Swirl | |
916 | 2313086a | Blue Swirl | #ifdef CONFIG_SLIRP |
917 | d7f9b689 | Luiz Capitulino | { |
918 | d7f9b689 | Luiz Capitulino | .name = "hostfwd_add", |
919 | d7f9b689 | Luiz Capitulino | .args_type = "arg1:s,arg2:s?,arg3:s?", |
920 | d7f9b689 | Luiz Capitulino | .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport", |
921 | d7f9b689 | Luiz Capitulino | .help = "redirect TCP or UDP connections from host to guest (requires -net user)", |
922 | af4ce882 | Luiz Capitulino | .mhandler.cmd = net_slirp_hostfwd_add, |
923 | d7f9b689 | Luiz Capitulino | }, |
924 | d7f9b689 | Luiz Capitulino | |
925 | d7f9b689 | Luiz Capitulino | { |
926 | d7f9b689 | Luiz Capitulino | .name = "hostfwd_remove", |
927 | d7f9b689 | Luiz Capitulino | .args_type = "arg1:s,arg2:s?,arg3:s?", |
928 | d7f9b689 | Luiz Capitulino | .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport", |
929 | d7f9b689 | Luiz Capitulino | .help = "remove host-to-guest TCP or UDP redirection", |
930 | af4ce882 | Luiz Capitulino | .mhandler.cmd = net_slirp_hostfwd_remove, |
931 | d7f9b689 | Luiz Capitulino | }, |
932 | d7f9b689 | Luiz Capitulino | |
933 | 2313086a | Blue Swirl | #endif |
934 | 2313086a | Blue Swirl | STEXI |
935 | 2313086a | Blue Swirl | @item host_net_redir |
936 | 70fcbbe7 | Stefan Weil | @findex host_net_redir |
937 | 2313086a | Blue Swirl | Redirect TCP or UDP connections from host to guest (requires -net user). |
938 | 2313086a | Blue Swirl | ETEXI |
939 | 2313086a | Blue Swirl | |
940 | d7f9b689 | Luiz Capitulino | { |
941 | d7f9b689 | Luiz Capitulino | .name = "balloon", |
942 | 3b0bd6ec | Luiz Capitulino | .args_type = "value:M", |
943 | d7f9b689 | Luiz Capitulino | .params = "target", |
944 | d7f9b689 | Luiz Capitulino | .help = "request VM to change it's memory allocation (in MB)", |
945 | 83fb1de2 | Luiz Capitulino | .user_print = monitor_user_noop, |
946 | 625a5bef | Adam Litke | .mhandler.cmd_async = do_balloon, |
947 | 625a5bef | Adam Litke | .async = 1, |
948 | d7f9b689 | Luiz Capitulino | }, |
949 | d7f9b689 | Luiz Capitulino | |
950 | 2313086a | Blue Swirl | STEXI |
951 | 2313086a | Blue Swirl | @item balloon @var{value} |
952 | 70fcbbe7 | Stefan Weil | @findex balloon |
953 | 2313086a | Blue Swirl | Request VM to change its memory allocation to @var{value} (in MB). |
954 | 2313086a | Blue Swirl | ETEXI |
955 | 2313086a | Blue Swirl | |
956 | d7f9b689 | Luiz Capitulino | { |
957 | d7f9b689 | Luiz Capitulino | .name = "set_link", |
958 | d7f9b689 | Luiz Capitulino | .args_type = "name:s,up_or_down:s", |
959 | d7f9b689 | Luiz Capitulino | .params = "name up|down", |
960 | d7f9b689 | Luiz Capitulino | .help = "change the link status of a network adapter", |
961 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_set_link, |
962 | d7f9b689 | Luiz Capitulino | }, |
963 | d7f9b689 | Luiz Capitulino | |
964 | 2313086a | Blue Swirl | STEXI |
965 | 2313086a | Blue Swirl | @item set_link @var{name} [up|down] |
966 | 70fcbbe7 | Stefan Weil | @findex set_link |
967 | 2313086a | Blue Swirl | Set link @var{name} up or down. |
968 | 2313086a | Blue Swirl | ETEXI |
969 | 2313086a | Blue Swirl | |
970 | d7f9b689 | Luiz Capitulino | { |
971 | d7f9b689 | Luiz Capitulino | .name = "watchdog_action", |
972 | d7f9b689 | Luiz Capitulino | .args_type = "action:s", |
973 | d7f9b689 | Luiz Capitulino | .params = "[reset|shutdown|poweroff|pause|debug|none]", |
974 | d7f9b689 | Luiz Capitulino | .help = "change watchdog action", |
975 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_watchdog_action, |
976 | d7f9b689 | Luiz Capitulino | }, |
977 | d7f9b689 | Luiz Capitulino | |
978 | 2313086a | Blue Swirl | STEXI |
979 | 2313086a | Blue Swirl | @item watchdog_action |
980 | 70fcbbe7 | Stefan Weil | @findex watchdog_action |
981 | 2313086a | Blue Swirl | Change watchdog action. |
982 | 2313086a | Blue Swirl | ETEXI |
983 | 2313086a | Blue Swirl | |
984 | d7f9b689 | Luiz Capitulino | { |
985 | d7f9b689 | Luiz Capitulino | .name = "acl_show", |
986 | d7f9b689 | Luiz Capitulino | .args_type = "aclname:s", |
987 | d7f9b689 | Luiz Capitulino | .params = "aclname", |
988 | d7f9b689 | Luiz Capitulino | .help = "list rules in the access control list", |
989 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_acl_show, |
990 | d7f9b689 | Luiz Capitulino | }, |
991 | d7f9b689 | Luiz Capitulino | |
992 | 2313086a | Blue Swirl | STEXI |
993 | 15dfcd45 | Jan Kiszka | @item acl_show @var{aclname} |
994 | 70fcbbe7 | Stefan Weil | @findex acl_show |
995 | 15dfcd45 | Jan Kiszka | List all the matching rules in the access control list, and the default |
996 | 15dfcd45 | Jan Kiszka | policy. There are currently two named access control lists, |
997 | 15dfcd45 | Jan Kiszka | @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client |
998 | 15dfcd45 | Jan Kiszka | certificate distinguished name, and SASL username respectively. |
999 | 15dfcd45 | Jan Kiszka | ETEXI |
1000 | 2313086a | Blue Swirl | |
1001 | d7f9b689 | Luiz Capitulino | { |
1002 | d7f9b689 | Luiz Capitulino | .name = "acl_policy", |
1003 | d7f9b689 | Luiz Capitulino | .args_type = "aclname:s,policy:s", |
1004 | d7f9b689 | Luiz Capitulino | .params = "aclname allow|deny", |
1005 | d7f9b689 | Luiz Capitulino | .help = "set default access control list policy", |
1006 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_acl_policy, |
1007 | d7f9b689 | Luiz Capitulino | }, |
1008 | d7f9b689 | Luiz Capitulino | |
1009 | 15dfcd45 | Jan Kiszka | STEXI |
1010 | cbbfacc6 | Jan Kiszka | @item acl_policy @var{aclname} @code{allow|deny} |
1011 | 70fcbbe7 | Stefan Weil | @findex acl_policy |
1012 | 15dfcd45 | Jan Kiszka | Set the default access control list policy, used in the event that |
1013 | 2313086a | Blue Swirl | none of the explicit rules match. The default policy at startup is |
1014 | 15dfcd45 | Jan Kiszka | always @code{deny}. |
1015 | 15dfcd45 | Jan Kiszka | ETEXI |
1016 | 15dfcd45 | Jan Kiszka | |
1017 | d7f9b689 | Luiz Capitulino | { |
1018 | d7f9b689 | Luiz Capitulino | .name = "acl_add", |
1019 | d7f9b689 | Luiz Capitulino | .args_type = "aclname:s,match:s,policy:s,index:i?", |
1020 | d7f9b689 | Luiz Capitulino | .params = "aclname match allow|deny [index]", |
1021 | d7f9b689 | Luiz Capitulino | .help = "add a match rule to the access control list", |
1022 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_acl_add, |
1023 | d7f9b689 | Luiz Capitulino | }, |
1024 | d7f9b689 | Luiz Capitulino | |
1025 | 15dfcd45 | Jan Kiszka | STEXI |
1026 | 15dfcd45 | Jan Kiszka | @item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}] |
1027 | 70fcbbe7 | Stefan Weil | @findex acl_allow |
1028 | 15dfcd45 | Jan Kiszka | Add a match rule to the access control list, allowing or denying access. |
1029 | 15dfcd45 | Jan Kiszka | The match will normally be an exact username or x509 distinguished name, |
1030 | 15dfcd45 | Jan Kiszka | but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to |
1031 | 15dfcd45 | Jan Kiszka | allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will |
1032 | 2313086a | Blue Swirl | normally be appended to the end of the ACL, but can be inserted |
1033 | 15dfcd45 | Jan Kiszka | earlier in the list if the optional @var{index} parameter is supplied. |
1034 | 15dfcd45 | Jan Kiszka | ETEXI |
1035 | 15dfcd45 | Jan Kiszka | |
1036 | d7f9b689 | Luiz Capitulino | { |
1037 | d7f9b689 | Luiz Capitulino | .name = "acl_remove", |
1038 | d7f9b689 | Luiz Capitulino | .args_type = "aclname:s,match:s", |
1039 | d7f9b689 | Luiz Capitulino | .params = "aclname match", |
1040 | d7f9b689 | Luiz Capitulino | .help = "remove a match rule from the access control list", |
1041 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_acl_remove, |
1042 | d7f9b689 | Luiz Capitulino | }, |
1043 | d7f9b689 | Luiz Capitulino | |
1044 | 15dfcd45 | Jan Kiszka | STEXI |
1045 | 15dfcd45 | Jan Kiszka | @item acl_remove @var{aclname} @var{match} |
1046 | 70fcbbe7 | Stefan Weil | @findex acl_remove |
1047 | 15dfcd45 | Jan Kiszka | Remove the specified match rule from the access control list. |
1048 | 15dfcd45 | Jan Kiszka | ETEXI |
1049 | 15dfcd45 | Jan Kiszka | |
1050 | d7f9b689 | Luiz Capitulino | { |
1051 | d7f9b689 | Luiz Capitulino | .name = "acl_reset", |
1052 | d7f9b689 | Luiz Capitulino | .args_type = "aclname:s", |
1053 | d7f9b689 | Luiz Capitulino | .params = "aclname", |
1054 | d7f9b689 | Luiz Capitulino | .help = "reset the access control list", |
1055 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_acl_reset, |
1056 | d7f9b689 | Luiz Capitulino | }, |
1057 | d7f9b689 | Luiz Capitulino | |
1058 | 15dfcd45 | Jan Kiszka | STEXI |
1059 | 70fcbbe7 | Stefan Weil | @item acl_remove @var{aclname} |
1060 | 15dfcd45 | Jan Kiszka | Remove all matches from the access control list, and set the default |
1061 | 2313086a | Blue Swirl | policy back to @code{deny}. |
1062 | 2313086a | Blue Swirl | ETEXI |
1063 | 2313086a | Blue Swirl | |
1064 | 79c4f6b0 | Huang Ying | #if defined(TARGET_I386) |
1065 | d7f9b689 | Luiz Capitulino | |
1066 | d7f9b689 | Luiz Capitulino | { |
1067 | d7f9b689 | Luiz Capitulino | .name = "mce", |
1068 | d7f9b689 | Luiz Capitulino | .args_type = "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l", |
1069 | d7f9b689 | Luiz Capitulino | .params = "cpu bank status mcgstatus addr misc", |
1070 | d7f9b689 | Luiz Capitulino | .help = "inject a MCE on the given CPU", |
1071 | af4ce882 | Luiz Capitulino | .mhandler.cmd = do_inject_mce, |
1072 | d7f9b689 | Luiz Capitulino | }, |
1073 | d7f9b689 | Luiz Capitulino | |
1074 | 79c4f6b0 | Huang Ying | #endif |
1075 | 79c4f6b0 | Huang Ying | STEXI |
1076 | 79c4f6b0 | Huang Ying | @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc} |
1077 | 70fcbbe7 | Stefan Weil | @findex mce (x86) |
1078 | 79c4f6b0 | Huang Ying | Inject an MCE on the given CPU (x86 only). |
1079 | 79c4f6b0 | Huang Ying | ETEXI |
1080 | 79c4f6b0 | Huang Ying | |
1081 | d7f9b689 | Luiz Capitulino | { |
1082 | d7f9b689 | Luiz Capitulino | .name = "getfd", |
1083 | d7f9b689 | Luiz Capitulino | .args_type = "fdname:s", |
1084 | d7f9b689 | Luiz Capitulino | .params = "getfd name", |
1085 | d7f9b689 | Luiz Capitulino | .help = "receive a file descriptor via SCM rights and assign it a name", |
1086 | f0d6000a | Luiz Capitulino | .user_print = monitor_user_noop, |
1087 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_getfd, |
1088 | d7f9b689 | Luiz Capitulino | }, |
1089 | d7f9b689 | Luiz Capitulino | |
1090 | f07918fd | Mark McLoughlin | STEXI |
1091 | f07918fd | Mark McLoughlin | @item getfd @var{fdname} |
1092 | 70fcbbe7 | Stefan Weil | @findex getfd |
1093 | f07918fd | Mark McLoughlin | If a file descriptor is passed alongside this command using the SCM_RIGHTS |
1094 | f07918fd | Mark McLoughlin | mechanism on unix sockets, it is stored using the name @var{fdname} for |
1095 | f07918fd | Mark McLoughlin | later use by other monitor commands. |
1096 | f07918fd | Mark McLoughlin | ETEXI |
1097 | f07918fd | Mark McLoughlin | |
1098 | d7f9b689 | Luiz Capitulino | { |
1099 | d7f9b689 | Luiz Capitulino | .name = "closefd", |
1100 | d7f9b689 | Luiz Capitulino | .args_type = "fdname:s", |
1101 | d7f9b689 | Luiz Capitulino | .params = "closefd name", |
1102 | d7f9b689 | Luiz Capitulino | .help = "close a file descriptor previously passed via SCM rights", |
1103 | 18f3a515 | Luiz Capitulino | .user_print = monitor_user_noop, |
1104 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_closefd, |
1105 | d7f9b689 | Luiz Capitulino | }, |
1106 | d7f9b689 | Luiz Capitulino | |
1107 | f07918fd | Mark McLoughlin | STEXI |
1108 | f07918fd | Mark McLoughlin | @item closefd @var{fdname} |
1109 | 70fcbbe7 | Stefan Weil | @findex closefd |
1110 | f07918fd | Mark McLoughlin | Close the file descriptor previously assigned to @var{fdname} using the |
1111 | f07918fd | Mark McLoughlin | @code{getfd} command. This is only needed if the file descriptor was never |
1112 | f07918fd | Mark McLoughlin | used by another monitor command. |
1113 | f07918fd | Mark McLoughlin | ETEXI |
1114 | f07918fd | Mark McLoughlin | |
1115 | a3a55a2e | Luiz Capitulino | { |
1116 | a3a55a2e | Luiz Capitulino | .name = "block_passwd", |
1117 | a3a55a2e | Luiz Capitulino | .args_type = "device:B,password:s", |
1118 | a3a55a2e | Luiz Capitulino | .params = "block_passwd device password", |
1119 | a3a55a2e | Luiz Capitulino | .help = "set the password of encrypted block devices", |
1120 | a3a55a2e | Luiz Capitulino | .user_print = monitor_user_noop, |
1121 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_block_set_passwd, |
1122 | a3a55a2e | Luiz Capitulino | }, |
1123 | a3a55a2e | Luiz Capitulino | |
1124 | a3a55a2e | Luiz Capitulino | STEXI |
1125 | a3a55a2e | Luiz Capitulino | @item block_passwd @var{device} @var{password} |
1126 | 70fcbbe7 | Stefan Weil | @findex block_passwd |
1127 | a3a55a2e | Luiz Capitulino | Set the encrypted device @var{device} password to @var{password} |
1128 | a3a55a2e | Luiz Capitulino | ETEXI |
1129 | a3a55a2e | Luiz Capitulino | |
1130 | 4a7e1190 | Luiz Capitulino | { |
1131 | 4a7e1190 | Luiz Capitulino | .name = "qmp_capabilities", |
1132 | 4a7e1190 | Luiz Capitulino | .args_type = "", |
1133 | 4a7e1190 | Luiz Capitulino | .params = "", |
1134 | 4a7e1190 | Luiz Capitulino | .help = "enable QMP capabilities", |
1135 | 4a7e1190 | Luiz Capitulino | .user_print = monitor_user_noop, |
1136 | 261394db | Luiz Capitulino | .mhandler.cmd_new = do_qmp_capabilities, |
1137 | 4a7e1190 | Luiz Capitulino | }, |
1138 | 4a7e1190 | Luiz Capitulino | |
1139 | 4a7e1190 | Luiz Capitulino | STEXI |
1140 | 4a7e1190 | Luiz Capitulino | @item qmp_capabilities |
1141 | 4a7e1190 | Luiz Capitulino | Enable the specified QMP capabilities |
1142 | 4a7e1190 | Luiz Capitulino | ETEXI |
1143 | 4a7e1190 | Luiz Capitulino | |
1144 | 2313086a | Blue Swirl | STEXI |
1145 | 2313086a | Blue Swirl | @end table |
1146 | 2313086a | Blue Swirl | ETEXI |