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