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