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