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