blob: 6d47d49f13dcf33d1706c749b7f30bb37a6d0a75 [file] [log] [blame]
Blue Swirl23130862009-06-06 08:22:04 +00001HXCOMM Use DEFHEADING() to define headings in both help text and texi
2HXCOMM Text between STEXI and ETEXI are copied to texi version and
3HXCOMM discarded from C version
4HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5HXCOMM monitor commands
6HXCOMM HXCOMM can be used for comments, discarded from both texi and C
7
8STEXI
9@table @option
10ETEXI
11
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030012 {
13 .name = "help|?",
14 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030015 .params = "[cmd]",
16 .help = "show the help",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -030017 .mhandler.cmd = do_help_cmd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030018 },
19
Blue Swirl23130862009-06-06 08:22:04 +000020STEXI
21@item help or ? [@var{cmd}]
22Show the help for all commands or just for command @var{cmd}.
23ETEXI
24
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030025 {
26 .name = "commit",
27 .args_type = "device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030028 .params = "device|all",
29 .help = "commit changes to the disk images (if -snapshot is used) or backing files",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -030030 .mhandler.cmd = do_commit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030031 },
32
Blue Swirl23130862009-06-06 08:22:04 +000033STEXI
34@item commit
35Commit changes to the disk images (if -snapshot is used) or backing files.
36ETEXI
37
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030038 {
39 .name = "info",
40 .args_type = "item:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030041 .params = "[subcommand]",
42 .help = "show various information about the system state",
Luiz Capitulino13c74252009-10-07 13:41:55 -030043 .user_print = monitor_user_noop,
44 .mhandler.cmd_new = do_info,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030045 },
46
Blue Swirl23130862009-06-06 08:22:04 +000047STEXI
48@item info @var{subcommand}
49Show various information about the system state.
50
51@table @option
52@item info version
53show the version of QEMU
54@item info network
55show the various VLANs and the associated devices
56@item info chardev
57show the character devices
58@item info block
59show the block devices
60@item info block
61show block device statistics
62@item info registers
63show the cpu registers
64@item info cpus
65show infos for each CPU
66@item info history
67show the command line history
68@item info irq
69show the interrupts statistics (if available)
70@item info pic
71show i8259 (PIC) state
72@item info pci
73show emulated PCI device info
74@item info tlb
75show virtual to physical memory mappings (i386 only)
76@item info mem
77show the active virtual memory mappings (i386 only)
78@item info hpet
79show state of HPET (i386 only)
Blue Swirl23130862009-06-06 08:22:04 +000080@item info kvm
81show KVM information
82@item info usb
83show USB devices plugged on the virtual USB hub
84@item info usbhost
85show all USB host devices
86@item info profile
87show profiling information
88@item info capture
89show information about active capturing
90@item info snapshots
91show list of VM snapshots
92@item info status
93show the current VM status (running|paused)
94@item info pcmcia
95show guest PCMCIA status
96@item info mice
97show which guest mouse is receiving events
98@item info vnc
99show the vnc server status
100@item info name
101show the current VM name
102@item info uuid
103show the current VM UUID
104@item info cpustats
105show CPU statistics
Jan Kiszka6dbe5532009-06-24 14:42:29 +0200106@item info usernet
107show user network stack connection states
Blue Swirl23130862009-06-06 08:22:04 +0000108@item info migrate
109show migration status
110@item info balloon
111show balloon information
112@item info qtree
113show device tree
114@end table
115ETEXI
116
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300117 {
118 .name = "q|quit",
119 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300120 .params = "",
121 .help = "quit the emulator",
Luiz Capitulinob223f352009-10-07 13:41:56 -0300122 .user_print = monitor_user_noop,
123 .mhandler.cmd_new = do_quit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300124 },
125
Blue Swirl23130862009-06-06 08:22:04 +0000126STEXI
127@item q or quit
128Quit the emulator.
129ETEXI
130
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300131 {
132 .name = "eject",
Luiz Capitulino78d714e2009-12-14 18:53:21 -0200133 .args_type = "force:-f,device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300134 .params = "[-f] device",
135 .help = "eject a removable medium (use -f to force it)",
Luiz Capitulinoe1c923a2009-10-16 12:23:49 -0300136 .user_print = monitor_user_noop,
137 .mhandler.cmd_new = do_eject,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300138 },
139
Blue Swirl23130862009-06-06 08:22:04 +0000140STEXI
141@item eject [-f] @var{device}
142Eject a removable medium (use -f to force it).
143ETEXI
144
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300145 {
146 .name = "change",
147 .args_type = "device:B,target:F,arg:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300148 .params = "device filename [format]",
149 .help = "change a removable medium, optional format",
Markus Armbrusterec3b82a2009-12-07 21:37:09 +0100150 .user_print = monitor_user_noop,
151 .mhandler.cmd_new = do_change,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300152 },
153
Blue Swirl23130862009-06-06 08:22:04 +0000154STEXI
155@item change @var{device} @var{setting}
156
157Change the configuration of a device.
158
159@table @option
160@item change @var{diskdevice} @var{filename} [@var{format}]
161Change the medium for a removable disk device to point to @var{filename}. eg
162
163@example
164(qemu) change ide1-cd0 /path/to/some.iso
165@end example
166
167@var{format} is optional.
168
169@item change vnc @var{display},@var{options}
170Change the configuration of the VNC server. The valid syntax for @var{display}
171and @var{options} are described at @ref{sec_invocation}. eg
172
173@example
174(qemu) change vnc localhost:1
175@end example
176
177@item change vnc password [@var{password}]
178
179Change the password associated with the VNC server. If the new password is not
180supplied, the monitor will prompt for it to be entered. VNC passwords are only
181significant up to 8 letters. eg
182
183@example
184(qemu) change vnc password
185Password: ********
186@end example
187
188@end table
189ETEXI
190
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300191 {
192 .name = "screendump",
193 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300194 .params = "filename",
195 .help = "save screen into PPM image 'filename'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300196 .mhandler.cmd = do_screen_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300197 },
198
Blue Swirl23130862009-06-06 08:22:04 +0000199STEXI
200@item screendump @var{filename}
201Save screen into PPM image @var{filename}.
202ETEXI
203
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300204 {
205 .name = "logfile",
206 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300207 .params = "filename",
208 .help = "output logs to 'filename'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300209 .mhandler.cmd = do_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300210 },
211
Blue Swirl23130862009-06-06 08:22:04 +0000212STEXI
213@item logfile @var{filename}
214Output logs to @var{filename}.
215ETEXI
216
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300217 {
218 .name = "log",
219 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300220 .params = "item1[,...]",
221 .help = "activate logging of the specified items to '/tmp/qemu.log'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300222 .mhandler.cmd = do_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300223 },
224
Blue Swirl23130862009-06-06 08:22:04 +0000225STEXI
226@item log @var{item1}[,...]
227Activate logging of the specified items to @file{/tmp/qemu.log}.
228ETEXI
229
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300230 {
231 .name = "savevm",
232 .args_type = "name:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300233 .params = "[tag|id]",
234 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300235 .mhandler.cmd = do_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300236 },
237
Blue Swirl23130862009-06-06 08:22:04 +0000238STEXI
239@item savevm [@var{tag}|@var{id}]
240Create a snapshot of the whole virtual machine. If @var{tag} is
241provided, it is used as human readable identifier. If there is already
242a snapshot with the same tag or ID, it is replaced. More info at
243@ref{vm_snapshots}.
244ETEXI
245
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300246 {
247 .name = "loadvm",
248 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300249 .params = "tag|id",
250 .help = "restore a VM snapshot from its tag or id",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300251 .mhandler.cmd = do_loadvm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300252 },
253
Blue Swirl23130862009-06-06 08:22:04 +0000254STEXI
255@item loadvm @var{tag}|@var{id}
256Set the whole virtual machine to the snapshot identified by the tag
257@var{tag} or the unique snapshot ID @var{id}.
258ETEXI
259
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300260 {
261 .name = "delvm",
262 .args_type = "name:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300263 .params = "tag|id",
264 .help = "delete a VM snapshot from its tag or id",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300265 .mhandler.cmd = do_delvm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300266 },
267
Blue Swirl23130862009-06-06 08:22:04 +0000268STEXI
269@item delvm @var{tag}|@var{id}
270Delete the snapshot identified by @var{tag} or @var{id}.
271ETEXI
272
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300273 {
274 .name = "singlestep",
275 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300276 .params = "[on|off]",
277 .help = "run emulation in singlestep mode or switch to normal mode",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300278 .mhandler.cmd = do_singlestep,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300279 },
280
Blue Swirl23130862009-06-06 08:22:04 +0000281STEXI
282@item singlestep [off]
283Run the emulation in single step mode.
284If called with option off, the emulation returns to normal mode.
285ETEXI
286
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300287 {
288 .name = "stop",
289 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300290 .params = "",
291 .help = "stop emulation",
Luiz Capitulinoe0c97bd2009-10-07 13:41:57 -0300292 .user_print = monitor_user_noop,
293 .mhandler.cmd_new = do_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300294 },
295
Blue Swirl23130862009-06-06 08:22:04 +0000296STEXI
297@item stop
298Stop emulation.
299ETEXI
300
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300301 {
302 .name = "c|cont",
303 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300304 .params = "",
305 .help = "resume emulation",
Luiz Capitulinoa1f896a2009-10-07 13:42:00 -0300306 .user_print = monitor_user_noop,
307 .mhandler.cmd_new = do_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300308 },
309
Blue Swirl23130862009-06-06 08:22:04 +0000310STEXI
311@item c or cont
312Resume emulation.
313ETEXI
314
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300315 {
316 .name = "gdbserver",
317 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300318 .params = "[device]",
319 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300320 .mhandler.cmd = do_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300321 },
322
Blue Swirl23130862009-06-06 08:22:04 +0000323STEXI
324@item gdbserver [@var{port}]
325Start gdbserver session (default @var{port}=1234)
326ETEXI
327
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300328 {
329 .name = "x",
330 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300331 .params = "/fmt addr",
332 .help = "virtual memory dump starting at 'addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300333 .mhandler.cmd = do_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300334 },
335
Blue Swirl23130862009-06-06 08:22:04 +0000336STEXI
337@item x/fmt @var{addr}
338Virtual memory dump starting at @var{addr}.
339ETEXI
340
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300341 {
342 .name = "xp",
343 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300344 .params = "/fmt addr",
345 .help = "physical memory dump starting at 'addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300346 .mhandler.cmd = do_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300347 },
348
Blue Swirl23130862009-06-06 08:22:04 +0000349STEXI
350@item xp /@var{fmt} @var{addr}
351Physical memory dump starting at @var{addr}.
352
353@var{fmt} is a format which tells the command how to format the
354data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
355
356@table @var
357@item count
358is the number of items to be dumped.
359
360@item format
361can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
362c (char) or i (asm instruction).
363
364@item size
365can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
366@code{h} or @code{w} can be specified with the @code{i} format to
367respectively select 16 or 32 bit code instruction size.
368
369@end table
370
371Examples:
372@itemize
373@item
374Dump 10 instructions at the current instruction pointer:
375@example
376(qemu) x/10i $eip
3770x90107063: ret
3780x90107064: sti
3790x90107065: lea 0x0(%esi,1),%esi
3800x90107069: lea 0x0(%edi,1),%edi
3810x90107070: ret
3820x90107071: jmp 0x90107080
3830x90107073: nop
3840x90107074: nop
3850x90107075: nop
3860x90107076: nop
387@end example
388
389@item
390Dump 80 16 bit values at the start of the video memory.
391@smallexample
392(qemu) xp/80hx 0xb8000
3930x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
3940x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
3950x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
3960x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
3970x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
3980x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
3990x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
4000x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
4010x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
4020x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
403@end smallexample
404@end itemize
405ETEXI
406
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300407 {
408 .name = "p|print",
409 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300410 .params = "/fmt expr",
411 .help = "print expression value (use $reg for CPU register access)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300412 .mhandler.cmd = do_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300413 },
414
Blue Swirl23130862009-06-06 08:22:04 +0000415STEXI
416@item p or print/@var{fmt} @var{expr}
417
418Print expression value. Only the @var{format} part of @var{fmt} is
419used.
420ETEXI
421
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300422 {
423 .name = "i",
424 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300425 .params = "/fmt addr",
426 .help = "I/O port read",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300427 .mhandler.cmd = do_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300428 },
429
Blue Swirl23130862009-06-06 08:22:04 +0000430STEXI
431Read I/O port.
432ETEXI
433
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300434 {
435 .name = "o",
436 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300437 .params = "/fmt addr value",
438 .help = "I/O port write",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300439 .mhandler.cmd = do_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300440 },
441
Jan Kiszkaf1147842009-07-14 10:20:11 +0200442STEXI
443Write to I/O port.
444ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000445
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300446 {
447 .name = "sendkey",
448 .args_type = "string:s,hold_time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300449 .params = "keys [hold_ms]",
450 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300451 .mhandler.cmd = do_sendkey,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300452 },
453
Blue Swirl23130862009-06-06 08:22:04 +0000454STEXI
455@item sendkey @var{keys}
456
457Send @var{keys} to the emulator. @var{keys} could be the name of the
458key or @code{#} followed by the raw value in either decimal or hexadecimal
459format. Use @code{-} to press several keys simultaneously. Example:
460@example
461sendkey ctrl-alt-f1
462@end example
463
464This command is useful to send keys that your graphical user interface
465intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
466ETEXI
467
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300468 {
469 .name = "system_reset",
470 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300471 .params = "",
472 .help = "reset the system",
Luiz Capitulinoc80d2592009-10-07 13:41:58 -0300473 .user_print = monitor_user_noop,
474 .mhandler.cmd_new = do_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300475 },
476
Blue Swirl23130862009-06-06 08:22:04 +0000477STEXI
478@item system_reset
479
480Reset the system.
481ETEXI
482
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300483 {
484 .name = "system_powerdown",
485 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300486 .params = "",
487 .help = "send system power down event",
Luiz Capitulino43076662009-10-07 13:41:59 -0300488 .user_print = monitor_user_noop,
489 .mhandler.cmd_new = do_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300490 },
491
Blue Swirl23130862009-06-06 08:22:04 +0000492STEXI
493@item system_powerdown
494
495Power down the system (if supported).
496ETEXI
497
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300498 {
499 .name = "sum",
500 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300501 .params = "addr size",
502 .help = "compute the checksum of a memory region",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300503 .mhandler.cmd = do_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300504 },
505
Blue Swirl23130862009-06-06 08:22:04 +0000506STEXI
507@item sum @var{addr} @var{size}
508
509Compute the checksum of a memory region.
510ETEXI
511
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300512 {
513 .name = "usb_add",
514 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300515 .params = "device",
516 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300517 .mhandler.cmd = do_usb_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300518 },
519
Blue Swirl23130862009-06-06 08:22:04 +0000520STEXI
521@item usb_add @var{devname}
522
523Add the USB device @var{devname}. For details of available devices see
524@ref{usb_devices}
525ETEXI
526
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300527 {
528 .name = "usb_del",
529 .args_type = "devname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300530 .params = "device",
531 .help = "remove USB device 'bus.addr'",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300532 .mhandler.cmd = do_usb_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300533 },
534
Blue Swirl23130862009-06-06 08:22:04 +0000535STEXI
536@item usb_del @var{devname}
537
538Remove the USB device @var{devname} from the QEMU virtual USB
539hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
540command @code{info usb} to see the devices you can remove.
541ETEXI
542
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300543 {
544 .name = "device_add",
545 .args_type = "config:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300546 .params = "device",
547 .help = "add device, like -device on the command line",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300548 .mhandler.cmd = do_device_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300549 },
550
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200551STEXI
552@item device_add @var{config}
553
554Add device.
555ETEXI
556
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300557 {
558 .name = "device_del",
559 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300560 .params = "device",
561 .help = "remove device",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300562 .mhandler.cmd = do_device_del,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300563 },
564
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200565STEXI
566@item device_del @var{id}
567
568Remove device @var{id}.
569ETEXI
570
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300571 {
572 .name = "cpu",
573 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300574 .params = "index",
575 .help = "set the default CPU",
Markus Armbruster81a1b452010-01-20 13:07:35 +0100576 .user_print = monitor_user_noop,
577 .mhandler.cmd_new = do_cpu_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300578 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200579
Blue Swirl23130862009-06-06 08:22:04 +0000580STEXI
581Set the default CPU.
582ETEXI
583
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300584 {
585 .name = "mouse_move",
586 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300587 .params = "dx dy [dz]",
588 .help = "send mouse move events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300589 .mhandler.cmd = do_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300590 },
591
Blue Swirl23130862009-06-06 08:22:04 +0000592STEXI
593@item mouse_move @var{dx} @var{dy} [@var{dz}]
594Move the active mouse to the specified coordinates @var{dx} @var{dy}
595with optional scroll axis @var{dz}.
596ETEXI
597
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300598 {
599 .name = "mouse_button",
600 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300601 .params = "state",
602 .help = "change mouse button state (1=L, 2=M, 4=R)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300603 .mhandler.cmd = do_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300604 },
605
Blue Swirl23130862009-06-06 08:22:04 +0000606STEXI
607@item mouse_button @var{val}
608Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
609ETEXI
610
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300611 {
612 .name = "mouse_set",
613 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300614 .params = "index",
615 .help = "set which mouse device receives events",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300616 .mhandler.cmd = do_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300617 },
618
Blue Swirl23130862009-06-06 08:22:04 +0000619STEXI
620@item mouse_set @var{index}
621Set which mouse device receives events at given @var{index}, index
622can be obtained with
623@example
624info mice
625@end example
626ETEXI
627
628#ifdef HAS_AUDIO
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300629 {
630 .name = "wavcapture",
631 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300632 .params = "path [frequency [bits [channels]]]",
633 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300634 .mhandler.cmd = do_wav_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300635 },
Blue Swirl23130862009-06-06 08:22:04 +0000636#endif
637STEXI
638@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
639Capture audio into @var{filename}. Using sample rate @var{frequency}
640bits per sample @var{bits} and number of channels @var{channels}.
641
642Defaults:
643@itemize @minus
644@item Sample rate = 44100 Hz - CD quality
645@item Bits = 16
646@item Number of channels = 2 - Stereo
647@end itemize
648ETEXI
649
650#ifdef HAS_AUDIO
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300651 {
652 .name = "stopcapture",
653 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300654 .params = "capture index",
655 .help = "stop capture",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300656 .mhandler.cmd = do_stop_capture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300657 },
Blue Swirl23130862009-06-06 08:22:04 +0000658#endif
659STEXI
660@item stopcapture @var{index}
661Stop capture with a given @var{index}, index can be obtained with
662@example
663info capture
664@end example
665ETEXI
666
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300667 {
668 .name = "memsave",
669 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300670 .params = "addr size file",
671 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Luiz Capitulino57e09452009-10-16 12:23:43 -0300672 .user_print = monitor_user_noop,
673 .mhandler.cmd_new = do_memory_save,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300674 },
675
Blue Swirl23130862009-06-06 08:22:04 +0000676STEXI
677@item memsave @var{addr} @var{size} @var{file}
678save to disk virtual memory dump starting at @var{addr} of size @var{size}.
679ETEXI
680
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300681 {
682 .name = "pmemsave",
683 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300684 .params = "addr size file",
685 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Luiz Capitulino18f5a8b2009-10-16 12:23:44 -0300686 .user_print = monitor_user_noop,
687 .mhandler.cmd_new = do_physical_memory_save,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300688 },
689
Blue Swirl23130862009-06-06 08:22:04 +0000690STEXI
691@item pmemsave @var{addr} @var{size} @var{file}
692save to disk physical memory dump starting at @var{addr} of size @var{size}.
693ETEXI
694
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300695 {
696 .name = "boot_set",
697 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300698 .params = "bootdevice",
699 .help = "define new values for the boot device list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300700 .mhandler.cmd = do_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300701 },
702
Blue Swirl23130862009-06-06 08:22:04 +0000703STEXI
704@item boot_set @var{bootdevicelist}
705
706Define new values for the boot device list. Those values will override
707the values specified on the command line through the @code{-boot} option.
708
709The values that can be specified here depend on the machine type, but are
710the same that can be specified in the @code{-boot} command line option.
711ETEXI
712
713#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300714 {
715 .name = "nmi",
716 .args_type = "cpu_index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300717 .params = "cpu",
718 .help = "inject an NMI on the given CPU",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300719 .mhandler.cmd = do_inject_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300720 },
Blue Swirl23130862009-06-06 08:22:04 +0000721#endif
722STEXI
723@item nmi @var{cpu}
724Inject an NMI on the given CPU (x86 only).
725ETEXI
726
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300727 {
728 .name = "migrate",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200729 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
730 .params = "[-d] [-b] [-i] uri",
731 .help = "migrate to URI (using -d to not wait for completion)"
732 "\n\t\t\t -b for migration without shared storage with"
733 " full copy of disk\n\t\t\t -i for migration without "
734 "shared storage with incremental copy of disk "
735 "(base image shared between src and destination)",
736 .user_print = monitor_user_noop,
737 .mhandler.cmd_new = do_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300738 },
739
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200740
Blue Swirl23130862009-06-06 08:22:04 +0000741STEXI
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200742@item migrate [-d] [-b] [-i] @var{uri}
Blue Swirl23130862009-06-06 08:22:04 +0000743Migrate to @var{uri} (using -d to not wait for completion).
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200744 -b for migration with full copy of disk
745 -i for migration with incremental copy of disk (base image is shared)
Blue Swirl23130862009-06-06 08:22:04 +0000746ETEXI
747
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300748 {
749 .name = "migrate_cancel",
750 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300751 .params = "",
752 .help = "cancel the current VM migration",
Luiz Capitulino911d2962009-10-16 12:23:47 -0300753 .user_print = monitor_user_noop,
754 .mhandler.cmd_new = do_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300755 },
756
Blue Swirl23130862009-06-06 08:22:04 +0000757STEXI
758@item migrate_cancel
759Cancel the current VM migration.
760ETEXI
761
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300762 {
763 .name = "migrate_set_speed",
Markus Armbruster5667c492010-01-25 14:23:04 +0100764 .args_type = "value:b",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300765 .params = "value",
766 .help = "set maximum speed (in bytes) for migrations",
Markus Armbruster5fd90832010-01-25 14:23:05 +0100767 .user_print = monitor_user_noop,
768 .mhandler.cmd_new = do_migrate_set_speed,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300769 },
770
Blue Swirl23130862009-06-06 08:22:04 +0000771STEXI
772@item migrate_set_speed @var{value}
773Set maximum speed to @var{value} (in bytes) for migrations.
774ETEXI
775
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300776 {
777 .name = "migrate_set_downtime",
778 .args_type = "value:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300779 .params = "value",
780 .help = "set maximum tolerated downtime (in seconds) for migrations",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300781 .mhandler.cmd = do_migrate_set_downtime,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300782 },
Glauber Costa2ea42952009-05-28 15:22:58 -0400783
784STEXI
785@item migrate_set_downtime @var{second}
786Set maximum tolerated downtime (in seconds) for migration.
787ETEXI
788
Blue Swirl23130862009-06-06 08:22:04 +0000789#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300790 {
791 .name = "drive_add",
792 .args_type = "pci_addr:s,opts:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300793 .params = "[[<domain>:]<bus>:]<slot>\n"
794 "[file=file][,if=type][,bus=n]\n"
795 "[,unit=m][,media=d][index=i]\n"
796 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
797 "[snapshot=on|off][,cache=on|off]",
798 .help = "add drive to PCI storage controller",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300799 .mhandler.cmd = drive_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300800 },
Blue Swirl23130862009-06-06 08:22:04 +0000801#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300802
Blue Swirl23130862009-06-06 08:22:04 +0000803STEXI
804@item drive_add
805Add drive to PCI storage controller.
806ETEXI
807
808#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300809 {
810 .name = "pci_add",
811 .args_type = "pci_addr:s,type:s,opts:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300812 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
813 .help = "hot-add PCI device",
Luiz Capitulino7a344f72009-12-10 17:16:09 -0200814 .user_print = pci_device_hot_add_print,
815 .mhandler.cmd_new = pci_device_hot_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300816 },
Blue Swirl23130862009-06-06 08:22:04 +0000817#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300818
Blue Swirl23130862009-06-06 08:22:04 +0000819STEXI
820@item pci_add
821Hot-add PCI device.
822ETEXI
823
824#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300825 {
826 .name = "pci_del",
827 .args_type = "pci_addr:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300828 .params = "[[<domain>:]<bus>:]<slot>",
829 .help = "hot remove PCI device",
Luiz Capitulino6848d822009-10-16 12:23:48 -0300830 .user_print = monitor_user_noop,
831 .mhandler.cmd_new = do_pci_device_hot_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300832 },
Blue Swirl23130862009-06-06 08:22:04 +0000833#endif
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300834
Blue Swirl23130862009-06-06 08:22:04 +0000835STEXI
836@item pci_del
837Hot remove PCI device.
838ETEXI
839
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300840 {
841 .name = "host_net_add",
842 .args_type = "device:s,opts:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300843 .params = "tap|user|socket|vde|dump [options]",
844 .help = "add host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300845 .mhandler.cmd = net_host_device_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300846 },
847
Blue Swirl23130862009-06-06 08:22:04 +0000848STEXI
849@item host_net_add
850Add host VLAN client.
851ETEXI
852
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300853 {
854 .name = "host_net_remove",
855 .args_type = "vlan_id:i,device:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300856 .params = "vlan_id name",
857 .help = "remove host VLAN client",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300858 .mhandler.cmd = net_host_device_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300859 },
860
Blue Swirl23130862009-06-06 08:22:04 +0000861STEXI
862@item host_net_remove
863Remove host VLAN client.
864ETEXI
865
866#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300867 {
868 .name = "hostfwd_add",
869 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300870 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
871 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300872 .mhandler.cmd = net_slirp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300873 },
874
875 {
876 .name = "hostfwd_remove",
877 .args_type = "arg1:s,arg2:s?,arg3:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300878 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
879 .help = "remove host-to-guest TCP or UDP redirection",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300880 .mhandler.cmd = net_slirp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300881 },
882
Blue Swirl23130862009-06-06 08:22:04 +0000883#endif
884STEXI
885@item host_net_redir
886Redirect TCP or UDP connections from host to guest (requires -net user).
887ETEXI
888
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300889 {
890 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -0200891 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300892 .params = "target",
893 .help = "request VM to change it's memory allocation (in MB)",
Luiz Capitulino83fb1de2009-10-07 13:42:01 -0300894 .user_print = monitor_user_noop,
Adam Litke625a5be2010-01-26 14:17:35 -0600895 .mhandler.cmd_async = do_balloon,
896 .async = 1,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300897 },
898
Blue Swirl23130862009-06-06 08:22:04 +0000899STEXI
900@item balloon @var{value}
901Request VM to change its memory allocation to @var{value} (in MB).
902ETEXI
903
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300904 {
905 .name = "set_link",
906 .args_type = "name:s,up_or_down:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300907 .params = "name up|down",
908 .help = "change the link status of a network adapter",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300909 .mhandler.cmd = do_set_link,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300910 },
911
Blue Swirl23130862009-06-06 08:22:04 +0000912STEXI
913@item set_link @var{name} [up|down]
914Set link @var{name} up or down.
915ETEXI
916
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300917 {
918 .name = "watchdog_action",
919 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300920 .params = "[reset|shutdown|poweroff|pause|debug|none]",
921 .help = "change watchdog action",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300922 .mhandler.cmd = do_watchdog_action,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300923 },
924
Blue Swirl23130862009-06-06 08:22:04 +0000925STEXI
926@item watchdog_action
927Change watchdog action.
928ETEXI
929
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300930 {
931 .name = "acl_show",
932 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300933 .params = "aclname",
934 .help = "list rules in the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300935 .mhandler.cmd = do_acl_show,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300936 },
937
Blue Swirl23130862009-06-06 08:22:04 +0000938STEXI
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200939@item acl_show @var{aclname}
940List all the matching rules in the access control list, and the default
941policy. There are currently two named access control lists,
942@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
943certificate distinguished name, and SASL username respectively.
944ETEXI
Blue Swirl23130862009-06-06 08:22:04 +0000945
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300946 {
947 .name = "acl_policy",
948 .args_type = "aclname:s,policy:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300949 .params = "aclname allow|deny",
950 .help = "set default access control list policy",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300951 .mhandler.cmd = do_acl_policy,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300952 },
953
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200954STEXI
Jan Kiszkacbbfacc2009-07-03 08:46:05 +0200955@item acl_policy @var{aclname} @code{allow|deny}
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200956Set the default access control list policy, used in the event that
Blue Swirl23130862009-06-06 08:22:04 +0000957none of the explicit rules match. The default policy at startup is
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200958always @code{deny}.
959ETEXI
960
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300961 {
962 .name = "acl_add",
963 .args_type = "aclname:s,match:s,policy:s,index:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300964 .params = "aclname match allow|deny [index]",
965 .help = "add a match rule to the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300966 .mhandler.cmd = do_acl_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300967 },
968
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200969STEXI
970@item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}]
971Add a match rule to the access control list, allowing or denying access.
972The match will normally be an exact username or x509 distinguished name,
973but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
974allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
Blue Swirl23130862009-06-06 08:22:04 +0000975normally be appended to the end of the ACL, but can be inserted
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200976earlier in the list if the optional @var{index} parameter is supplied.
977ETEXI
978
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300979 {
980 .name = "acl_remove",
981 .args_type = "aclname:s,match:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300982 .params = "aclname match",
983 .help = "remove a match rule from the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300984 .mhandler.cmd = do_acl_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300985 },
986
Jan Kiszka15dfcd42009-06-25 08:22:08 +0200987STEXI
988@item acl_remove @var{aclname} @var{match}
989Remove the specified match rule from the access control list.
990ETEXI
991
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300992 {
993 .name = "acl_reset",
994 .args_type = "aclname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300995 .params = "aclname",
996 .help = "reset the access control list",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -0300997 .mhandler.cmd = do_acl_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300998 },
999
Jan Kiszka15dfcd42009-06-25 08:22:08 +02001000STEXI
1001@item acl_remove @var{aclname} @var{match}
1002Remove all matches from the access control list, and set the default
Blue Swirl23130862009-06-06 08:22:04 +00001003policy back to @code{deny}.
Blue Swirl23130862009-06-06 08:22:04 +00001004ETEXI
1005
Huang Ying79c4f6b2009-06-23 10:05:14 +08001006#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001007
1008 {
1009 .name = "mce",
1010 .args_type = "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001011 .params = "cpu bank status mcgstatus addr misc",
1012 .help = "inject a MCE on the given CPU",
Luiz Capitulinoaf4ce882009-10-07 13:41:52 -03001013 .mhandler.cmd = do_inject_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001014 },
1015
Huang Ying79c4f6b2009-06-23 10:05:14 +08001016#endif
1017STEXI
1018@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1019Inject an MCE on the given CPU (x86 only).
1020ETEXI
1021
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001022 {
1023 .name = "getfd",
1024 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001025 .params = "getfd name",
1026 .help = "receive a file descriptor via SCM rights and assign it a name",
Luiz Capitulinof0d60002009-10-16 12:23:50 -03001027 .user_print = monitor_user_noop,
1028 .mhandler.cmd_new = do_getfd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001029 },
1030
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001031STEXI
1032@item getfd @var{fdname}
1033If a file descriptor is passed alongside this command using the SCM_RIGHTS
1034mechanism on unix sockets, it is stored using the name @var{fdname} for
1035later use by other monitor commands.
1036ETEXI
1037
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001038 {
1039 .name = "closefd",
1040 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001041 .params = "closefd name",
1042 .help = "close a file descriptor previously passed via SCM rights",
Luiz Capitulino18f3a512009-10-16 12:23:51 -03001043 .user_print = monitor_user_noop,
1044 .mhandler.cmd_new = do_closefd,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001045 },
1046
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001047STEXI
1048@item closefd @var{fdname}
1049Close the file descriptor previously assigned to @var{fdname} using the
1050@code{getfd} command. This is only needed if the file descriptor was never
1051used by another monitor command.
1052ETEXI
1053
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001054 {
1055 .name = "block_passwd",
1056 .args_type = "device:B,password:s",
1057 .params = "block_passwd device password",
1058 .help = "set the password of encrypted block devices",
1059 .user_print = monitor_user_noop,
1060 .mhandler.cmd_new = do_block_set_passwd,
1061 },
1062
1063STEXI
1064@item block_passwd @var{device} @var{password}
1065Set the encrypted device @var{device} password to @var{password}
1066ETEXI
1067
Blue Swirl23130862009-06-06 08:22:04 +00001068STEXI
1069@end table
1070ETEXI