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