qmp-commands.hx

   1 HXCOMM QMP dispatch table and documentation
   2 HXCOMM Text between SQMP and EQMP is copied to the QMP documention file and
   3 HXCOMM does not show up in the other formats.
   4
   5 SQMP
   6                         QMP Supported Commands
   7                         ----------------------
   8
   9 This document describes all commands currently supported by QMP.
  10
  11 Most of the time their usage is exactly the same as in the user Monitor, this
  12 means that any other document which also describe commands (the manpage,
  13 QEMU's manual, etc) can and should be consulted.
  14
  15 QMP has two types of commands: regular and query commands. Regular commands
  16 usually change the Virtual Machine's state someway, while query commands just
  17 return information. The sections below are divided accordingly.
  18
  19 It's important to observe that all communication examples are formatted in
  20 a reader-friendly way, so that they're easier to understand. However, in real
  21 protocol usage, they're emitted as a single line.
  22
  23 Also, the following notation is used to denote data flow:
  24
  25 -> data issued by the Client
  26 <- Server data response
  27
  28 Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
  29 information on the Server command and response formats.
  30
  31 NOTE: This document is temporary and will be replaced soon.
  32
  33 1. Stability Considerations
  34 ===========================
  35
  36 The current QMP command set (described in this file) may be useful for a
  37 number of use cases, however it's limited and several commands have bad
  38 defined semantics, specially with regard to command completion.
  39
  40 These problems are going to be solved incrementally in the next QEMU releases
  41 and we're going to establish a deprecation policy for badly defined commands.
  42
  43 If you're planning to adopt QMP, please observe the following:
  44
  45     1. The deprecation policy will take effect and be documented soon, please
  46        check the documentation of each used command as soon as a new release of
  47        QEMU is available
  48
  49     2. DO NOT rely on anything which is not explicit documented
  50
  51     3. Errors, in special, are not documented. Applications should NOT check
  52        for specific errors classes or data (it's strongly recommended to only
  53        check for the "error" key)
  54
  55 2. Regular Commands
  56 ===================
  57
  58 Server's responses in the examples below are always a success response, please
  59 refer to the QMP specification for more details on error responses.
  60
  61 EQMP
  62
  63     {
  64         .name       = "quit",
  65         .args_type  = "",
  66         .mhandler.cmd_new = qmp_marshal_input_quit,
  67     },
  68
  69 SQMP
  70 quit
  71 ----
  72
  73 Quit the emulator.
  74
  75 Arguments: None.
  76
  77 Example:
  78
  79 -> { "execute": "quit" }
  80 <- { "return": {} }
  81
  82 EQMP
  83
  84     {
  85         .name       = "eject",
  86         .args_type  = "force:-f,device:B",
  87         .mhandler.cmd_new = qmp_marshal_input_eject,
  88     },
  89
  90 SQMP
  91 eject
  92 -----
  93
  94 Eject a removable medium.
  95
  96 Arguments:
  97
  98 - force: force ejection (json-bool, optional)
  99 - device: device name (json-string)
 100
 101 Example:
 102
 103 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
 104 <- { "return": {} }
 105
 106 Note: The "force" argument defaults to false.
 107
 108 EQMP
 109
 110     {
 111         .name       = "change",
 112         .args_type  = "device:B,target:F,arg:s?",
 113         .mhandler.cmd_new = qmp_marshal_input_change,
 114     },
 115
 116 SQMP
 117 change
 118 ------
 119
 120 Change a removable medium or VNC configuration.
 121
 122 Arguments:
 123
 124 - "device": device name (json-string)
 125 - "target": filename or item (json-string)
 126 - "arg": additional argument (json-string, optional)
 127
 128 Examples:
 129
 130 1. Change a removable medium
 131
 132 -> { "execute": "change",
 133              "arguments": { "device": "ide1-cd0",
 134                             "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
 135 <- { "return": {} }
 136
 137 2. Change VNC password
 138
 139 -> { "execute": "change",
 140              "arguments": { "device": "vnc", "target": "password",
 141                             "arg": "foobar1" } }
 142 <- { "return": {} }
 143
 144 EQMP
 145
 146     {
 147         .name       = "screendump",
 148         .args_type  = "filename:F",
 149         .mhandler.cmd_new = qmp_marshal_input_screendump,
 150     },
 151
 152 SQMP
 153 screendump
 154 ----------
 155
 156 Save screen into PPM image.
 157
 158 Arguments:
 159
 160 - "filename": file path (json-string)
 161
 162 Example:
 163
 164 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
 165 <- { "return": {} }
 166
 167 EQMP
 168
 169     {
 170         .name       = "stop",
 171         .args_type  = "",
 172         .mhandler.cmd_new = qmp_marshal_input_stop,
 173     },
 174
 175 SQMP
 176 stop
 177 ----
 178
 179 Stop the emulator.
 180
 181 Arguments: None.
 182
 183 Example:
 184
 185 -> { "execute": "stop" }
 186 <- { "return": {} }
 187
 188 EQMP
 189
 190     {
 191         .name       = "cont",
 192         .args_type  = "",
 193         .mhandler.cmd_new = qmp_marshal_input_cont,
 194     },
 195
 196 SQMP
 197 cont
 198 ----
 199
 200 Resume emulation.
 201
 202 Arguments: None.
 203
 204 Example:
 205
 206 -> { "execute": "cont" }
 207 <- { "return": {} }
 208
 209 EQMP
 210
 211     {
 212         .name       = "system_wakeup",
 213         .args_type  = "",
 214         .mhandler.cmd_new = qmp_marshal_input_system_wakeup,
 215     },
 216
 217 SQMP
 218 system_wakeup
 219 -------------
 220
 221 Wakeup guest from suspend.
 222
 223 Arguments: None.
 224
 225 Example:
 226
 227 -> { "execute": "system_wakeup" }
 228 <- { "return": {} }
 229
 230 EQMP
 231
 232     {
 233         .name       = "system_reset",
 234         .args_type  = "",
 235         .mhandler.cmd_new = qmp_marshal_input_system_reset,
 236     },
 237
 238 SQMP
 239 system_reset
 240 ------------
 241
 242 Reset the system.
 243
 244 Arguments: None.
 245
 246 Example:
 247
 248 -> { "execute": "system_reset" }
 249 <- { "return": {} }
 250
 251 EQMP
 252
 253     {
 254         .name       = "system_powerdown",
 255         .args_type  = "",
 256         .mhandler.cmd_new = qmp_marshal_input_system_powerdown,
 257     },
 258
 259 SQMP
 260 system_powerdown
 261 ----------------
 262
 263 Send system power down event.
 264
 265 Arguments: None.
 266
 267 Example:
 268
 269 -> { "execute": "system_powerdown" }
 270 <- { "return": {} }
 271
 272 EQMP
 273
 274     {
 275         .name       = "device_add",
 276         .args_type  = "device:O",
 277         .params     = "driver[,prop=value][,...]",
 278         .help       = "add device, like -device on the command line",
 279         .user_print = monitor_user_noop,
 280         .mhandler.cmd_new = do_device_add,
 281     },
 282
 283 SQMP
 284 device_add
 285 ----------
 286
 287 Add a device.
 288
 289 Arguments:
 290
 291 - "driver": the name of the new device's driver (json-string)
 292 - "bus": the device's parent bus (device tree path, json-string, optional)
 293 - "id": the device's ID, must be unique (json-string)
 294 - device properties
 295
 296 Example:
 297
 298 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
 299 <- { "return": {} }
 300
 301 Notes:
 302
 303 (1) For detailed information about this command, please refer to the
 304     'docs/qdev-device-use.txt' file.
 305
 306 (2) It's possible to list device properties by running QEMU with the
 307     "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
 308
 309 EQMP
 310
 311     {
 312         .name       = "device_del",
 313         .args_type  = "id:s",
 314         .mhandler.cmd_new = qmp_marshal_input_device_del,
 315     },
 316
 317 SQMP
 318 device_del
 319 ----------
 320
 321 Remove a device.
 322
 323 Arguments:
 324
 325 - "id": the device's ID (json-string)
 326
 327 Example:
 328
 329 -> { "execute": "device_del", "arguments": { "id": "net1" } }
 330 <- { "return": {} }
 331
 332 EQMP
 333
 334     {
 335         .name       = "send-key",
 336         .args_type  = "keys:O,hold-time:i?",
 337         .mhandler.cmd_new = qmp_marshal_input_send_key,
 338     },
 339
 340 SQMP
 341 send-key
 342 ----------
 343
 344 Send keys to VM.
 345
 346 Arguments:
 347
 348 keys array:
 349     - "key": key sequence (a json-array of key union values,
 350              union can be number or qcode enum)
 351
 352 - hold-time: time to delay key up events, milliseconds. Defaults to 100
 353              (json-int, optional)
 354
 355 Example:
 356
 357 -> { "execute": "send-key",
 358      "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
 359                               { "type": "qcode", "data": "alt" },
 360                               { "type": "qcode", "data": "delete" } ] } }
 361 <- { "return": {} }
 362
 363 EQMP
 364
 365     {
 366         .name       = "cpu",
 367         .args_type  = "index:i",
 368         .mhandler.cmd_new = qmp_marshal_input_cpu,
 369     },
 370
 371 SQMP
 372 cpu
 373 ---
 374
 375 Set the default CPU.
 376
 377 Arguments:
 378
 379 - "index": the CPU's index (json-int)
 380
 381 Example:
 382
 383 -> { "execute": "cpu", "arguments": { "index": 0 } }
 384 <- { "return": {} }
 385
 386 Note: CPUs' indexes are obtained with the 'query-cpus' command.
 387
 388 EQMP
 389
 390     {
 391         .name       = "cpu-add",
 392         .args_type  = "id:i",
 393         .mhandler.cmd_new = qmp_marshal_input_cpu_add,
 394     },
 395
 396 SQMP
 397 cpu-add
 398 -------
 399
 400 Adds virtual cpu
 401
 402 Arguments:
 403
 404 - "id": cpu id (json-int)
 405
 406 Example:
 407
 408 -> { "execute": "cpu-add", "arguments": { "id": 2 } }
 409 <- { "return": {} }
 410
 411 EQMP
 412
 413     {
 414         .name       = "memsave",
 415         .args_type  = "val:l,size:i,filename:s,cpu:i?",
 416         .mhandler.cmd_new = qmp_marshal_input_memsave,
 417     },
 418
 419 SQMP
 420 memsave
 421 -------
 422
 423 Save to disk virtual memory dump starting at 'val' of size 'size'.
 424
 425 Arguments:
 426
 427 - "val": the starting address (json-int)
 428 - "size": the memory size, in bytes (json-int)
 429 - "filename": file path (json-string)
 430 - "cpu": virtual CPU index (json-int, optional)
 431
 432 Example:
 433
 434 -> { "execute": "memsave",
 435              "arguments": { "val": 10,
 436                             "size": 100,
 437                             "filename": "/tmp/virtual-mem-dump" } }
 438 <- { "return": {} }
 439
 440 EQMP
 441
 442     {
 443         .name       = "pmemsave",
 444         .args_type  = "val:l,size:i,filename:s",
 445         .mhandler.cmd_new = qmp_marshal_input_pmemsave,
 446     },
 447
 448 SQMP
 449 pmemsave
 450 --------
 451
 452 Save to disk physical memory dump starting at 'val' of size 'size'.
 453
 454 Arguments:
 455
 456 - "val": the starting address (json-int)
 457 - "size": the memory size, in bytes (json-int)
 458 - "filename": file path (json-string)
 459
 460 Example:
 461
 462 -> { "execute": "pmemsave",
 463              "arguments": { "val": 10,
 464                             "size": 100,
 465                             "filename": "/tmp/physical-mem-dump" } }
 466 <- { "return": {} }
 467
 468 EQMP
 469
 470     {
 471         .name       = "inject-nmi",
 472         .args_type  = "",
 473         .mhandler.cmd_new = qmp_marshal_input_inject_nmi,
 474     },
 475
 476 SQMP
 477 inject-nmi
 478 ----------
 479
 480 Inject an NMI on guest's CPUs.
 481
 482 Arguments: None.
 483
 484 Example:
 485
 486 -> { "execute": "inject-nmi" }
 487 <- { "return": {} }
 488
 489 Note: inject-nmi fails when the guest doesn't support injecting.
 490       Currently, only x86 (NMI) and s390x (RESTART) guests do.
 491
 492 EQMP
 493
 494     {
 495         .name       = "ringbuf-write",
 496         .args_type  = "device:s,data:s,format:s?",
 497         .mhandler.cmd_new = qmp_marshal_input_ringbuf_write,
 498     },
 499
 500 SQMP
 501 ringbuf-write
 502 -------------
 503
 504 Write to a ring buffer character device.
 505
 506 Arguments:
 507
 508 - "device": ring buffer character device name (json-string)
 509 - "data": data to write (json-string)
 510 - "format": data format (json-string, optional)
 511           - Possible values: "utf8" (default), "base64"
 512             Bug: invalid base64 is currently not rejected.
 513             Whitespace *is* invalid.
 514
 515 Example:
 516
 517 -> { "execute": "ringbuf-write",
 518                 "arguments": { "device": "foo",
 519                                "data": "abcdefgh",
 520                                "format": "utf8" } }
 521 <- { "return": {} }
 522
 523 EQMP
 524
 525     {
 526         .name       = "ringbuf-read",
 527         .args_type  = "device:s,size:i,format:s?",
 528         .mhandler.cmd_new = qmp_marshal_input_ringbuf_read,
 529     },
 530
 531 SQMP
 532 ringbuf-read
 533 -------------
 534
 535 Read from a ring buffer character device.
 536
 537 Arguments:
 538
 539 - "device": ring buffer character device name (json-string)
 540 - "size": how many bytes to read at most (json-int)
 541           - Number of data bytes, not number of characters in encoded data
 542 - "format": data format (json-string, optional)
 543           - Possible values: "utf8" (default), "base64"
 544           - Naturally, format "utf8" works only when the ring buffer
 545             contains valid UTF-8 text.  Invalid UTF-8 sequences get
 546             replaced.  Bug: replacement doesn't work.  Bug: can screw
 547             up on encountering NUL characters, after the ring buffer
 548             lost data, and when reading stops because the size limit
 549             is reached.
 550
 551 Example:
 552
 553 -> { "execute": "ringbuf-read",
 554                 "arguments": { "device": "foo",
 555                                "size": 1000,
 556                                "format": "utf8" } }
 557 <- {"return": "abcdefgh"}
 558
 559 EQMP
 560
 561     {
 562         .name       = "xen-save-devices-state",
 563         .args_type  = "filename:F",
 564     .mhandler.cmd_new = qmp_marshal_input_xen_save_devices_state,
 565     },
 566
 567 SQMP
 568 xen-save-devices-state
 569 -------
 570
 571 Save the state of all devices to file. The RAM and the block devices
 572 of the VM are not saved by this command.
 573
 574 Arguments:
 575
 576 - "filename": the file to save the state of the devices to as binary
 577 data. See xen-save-devices-state.txt for a description of the binary
 578 format.
 579
 580 Example:
 581
 582 -> { "execute": "xen-save-devices-state",
 583      "arguments": { "filename": "/tmp/save" } }
 584 <- { "return": {} }
 585
 586 EQMP
 587
 588     {
 589         .name       = "xen-set-global-dirty-log",
 590         .args_type  = "enable:b",
 591         .mhandler.cmd_new = qmp_marshal_input_xen_set_global_dirty_log,
 592     },
 593
 594 SQMP
 595 xen-set-global-dirty-log
 596 -------
 597
 598 Enable or disable the global dirty log mode.
 599
 600 Arguments:
 601
 602 - "enable": Enable it or disable it.
 603
 604 Example:
 605
 606 -> { "execute": "xen-set-global-dirty-log",
 607      "arguments": { "enable": true } }
 608 <- { "return": {} }
 609
 610 EQMP
 611
 612     {
 613         .name       = "migrate",
 614         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 615         .mhandler.cmd_new = qmp_marshal_input_migrate,
 616     },
 617
 618 SQMP
 619 migrate
 620 -------
 621
 622 Migrate to URI.
 623
 624 Arguments:
 625
 626 - "blk": block migration, full disk copy (json-bool, optional)
 627 - "inc": incremental disk copy (json-bool, optional)
 628 - "uri": Destination URI (json-string)
 629
 630 Example:
 631
 632 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
 633 <- { "return": {} }
 634
 635 Notes:
 636
 637 (1) The 'query-migrate' command should be used to check migration's progress
 638     and final result (this information is provided by the 'status' member)
 639 (2) All boolean arguments default to false
 640 (3) The user Monitor's "detach" argument is invalid in QMP and should not
 641     be used
 642
 643 EQMP
 644
 645     {
 646         .name       = "migrate_cancel",
 647         .args_type  = "",
 648         .mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
 649     },
 650
 651 SQMP
 652 migrate_cancel
 653 --------------
 654
 655 Cancel the current migration.
 656
 657 Arguments: None.
 658
 659 Example:
 660
 661 -> { "execute": "migrate_cancel" }
 662 <- { "return": {} }
 663
 664 EQMP
 665 {
 666         .name       = "migrate-set-cache-size",
 667         .args_type  = "value:o",
 668         .mhandler.cmd_new = qmp_marshal_input_migrate_set_cache_size,
 669     },
 670
 671 SQMP
 672 migrate-set-cache-size
 673 ----------------------
 674
 675 Set cache size to be used by XBZRLE migration, the cache size will be rounded
 676 down to the nearest power of 2
 677
 678 Arguments:
 679
 680 - "value": cache size in bytes (json-int)
 681
 682 Example:
 683
 684 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
 685 <- { "return": {} }
 686
 687 EQMP
 688     {
 689         .name       = "query-migrate-cache-size",
 690         .args_type  = "",
 691         .mhandler.cmd_new = qmp_marshal_input_query_migrate_cache_size,
 692     },
 693
 694 SQMP
 695 query-migrate-cache-size
 696 ------------------------
 697
 698 Show cache size to be used by XBZRLE migration
 699
 700 returns a json-object with the following information:
 701 - "size" : json-int
 702
 703 Example:
 704
 705 -> { "execute": "query-migrate-cache-size" }
 706 <- { "return": 67108864 }
 707
 708 EQMP
 709
 710     {
 711         .name       = "migrate_set_speed",
 712         .args_type  = "value:o",
 713         .mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
 714     },
 715
 716 SQMP
 717 migrate_set_speed
 718 -----------------
 719
 720 Set maximum speed for migrations.
 721
 722 Arguments:
 723
 724 - "value": maximum speed, in bytes per second (json-int)
 725
 726 Example:
 727
 728 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
 729 <- { "return": {} }
 730
 731 EQMP
 732
 733     {
 734         .name       = "migrate_set_downtime",
 735         .args_type  = "value:T",
 736         .mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
 737     },
 738
 739 SQMP
 740 migrate_set_downtime
 741 --------------------
 742
 743 Set maximum tolerated downtime (in seconds) for migrations.
 744
 745 Arguments:
 746
 747 - "value": maximum downtime (json-number)
 748
 749 Example:
 750
 751 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
 752 <- { "return": {} }
 753
 754 EQMP
 755
 756     {
 757         .name       = "client_migrate_info",
 758         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
 759         .params     = "protocol hostname port tls-port cert-subject",
 760         .help       = "send migration info to spice/vnc client",
 761         .user_print = monitor_user_noop,
 762         .mhandler.cmd_async = client_migrate_info,
 763         .flags      = MONITOR_CMD_ASYNC,
 764     },
 765
 766 SQMP
 767 client_migrate_info
 768 ------------------
 769
 770 Set the spice/vnc connection info for the migration target.  The spice/vnc
 771 server will ask the spice/vnc client to automatically reconnect using the
 772 new parameters (if specified) once the vm migration finished successfully.
 773
 774 Arguments:
 775
 776 - "protocol":     protocol: "spice" or "vnc" (json-string)
 777 - "hostname":     migration target hostname (json-string)
 778 - "port":         spice/vnc tcp port for plaintext channels (json-int, optional)
 779 - "tls-port":     spice tcp port for tls-secured channels (json-int, optional)
 780 - "cert-subject": server certificate subject (json-string, optional)
 781
 782 Example:
 783
 784 -> { "execute": "client_migrate_info",
 785      "arguments": { "protocol": "spice",
 786                     "hostname": "virt42.lab.kraxel.org",
 787                     "port": 1234 } }
 788 <- { "return": {} }
 789
 790 EQMP
 791
 792     {
 793         .name       = "dump-guest-memory",
 794         .args_type  = "paging:b,protocol:s,begin:i?,end:i?",
 795         .params     = "-p protocol [begin] [length]",
 796         .help       = "dump guest memory to file",
 797         .user_print = monitor_user_noop,
 798         .mhandler.cmd_new = qmp_marshal_input_dump_guest_memory,
 799     },
 800
 801 SQMP
 802 dump
 803
 804
 805 Dump guest memory to file. The file can be processed with crash or gdb.
 806
 807 Arguments:
 808
 809 - "paging": do paging to get guest's memory mapping (json-bool)
 810 - "protocol": destination file(started with "file:") or destination file
 811               descriptor (started with "fd:") (json-string)
 812 - "begin": the starting physical address. It's optional, and should be specified
 813            with length together (json-int)
 814 - "length": the memory size, in bytes. It's optional, and should be specified
 815             with begin together (json-int)
 816
 817 Example:
 818
 819 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
 820 <- { "return": {} }
 821
 822 Notes:
 823
 824 (1) All boolean arguments default to false
 825
 826 EQMP
 827
 828     {
 829         .name       = "netdev_add",
 830         .args_type  = "netdev:O",
 831         .mhandler.cmd_new = qmp_netdev_add,
 832     },
 833
 834 SQMP
 835 netdev_add
 836 ----------
 837
 838 Add host network device.
 839
 840 Arguments:
 841
 842 - "type": the device type, "tap", "user", ... (json-string)
 843 - "id": the device's ID, must be unique (json-string)
 844 - device options
 845
 846 Example:
 847
 848 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
 849 <- { "return": {} }
 850
 851 Note: The supported device options are the same ones supported by the '-netdev'
 852       command-line argument, which are listed in the '-help' output or QEMU's
 853       manual
 854
 855 EQMP
 856
 857     {
 858         .name       = "netdev_del",
 859         .args_type  = "id:s",
 860         .mhandler.cmd_new = qmp_marshal_input_netdev_del,
 861     },
 862
 863 SQMP
 864 netdev_del
 865 ----------
 866
 867 Remove host network device.
 868
 869 Arguments:
 870
 871 - "id": the device's ID, must be unique (json-string)
 872
 873 Example:
 874
 875 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
 876 <- { "return": {} }
 877
 878
 879 EQMP
 880
 881     {
 882         .name       = "object-del",
 883         .args_type  = "id:s",
 884         .mhandler.cmd_new = qmp_marshal_input_object_del,
 885     },
 886
 887 SQMP
 888 object-del
 889 ----------
 890
 891 Remove QOM object.
 892
 893 Arguments:
 894
 895 - "id": the object's ID (json-string)
 896
 897 Example:
 898
 899 -> { "execute": "object-del", "arguments": { "id": "rng1" } }
 900 <- { "return": {} }
 901
 902
 903 EQMP
 904
 905
 906     {
 907         .name       = "block_resize",
 908         .args_type  = "device:B,size:o",
 909         .mhandler.cmd_new = qmp_marshal_input_block_resize,
 910     },
 911
 912 SQMP
 913 block_resize
 914 ------------
 915
 916 Resize a block image while a guest is running.
 917
 918 Arguments:
 919
 920 - "device": the device's ID, must be unique (json-string)
 921 - "size": new size
 922
 923 Example:
 924
 925 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
 926 <- { "return": {} }
 927
 928 EQMP
 929
 930     {
 931         .name       = "block-stream",
 932         .args_type  = "device:B,base:s?,speed:o?,on-error:s?",
 933         .mhandler.cmd_new = qmp_marshal_input_block_stream,
 934     },
 935
 936     {
 937         .name       = "block-commit",
 938         .args_type  = "device:B,base:s?,top:s,speed:o?",
 939         .mhandler.cmd_new = qmp_marshal_input_block_commit,
 940     },
 941
 942     {
 943         .name       = "drive-backup",
 944         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
 945                       "on-source-error:s?,on-target-error:s?",
 946         .mhandler.cmd_new = qmp_marshal_input_drive_backup,
 947     },
 948
 949 SQMP
 950 drive-backup
 951 ------------
 952
 953 Start a point-in-time copy of a block device to a new destination.  The
 954 status of ongoing drive-backup operations can be checked with
 955 query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
 956 The operation can be stopped before it has completed using the
 957 block-job-cancel command.
 958
 959 Arguments:
 960
 961 - "device": the name of the device which should be copied.
 962             (json-string)
 963 - "target": the target of the new image. If the file exists, or if it is a
 964             device, the existing file/device will be used as the new
 965             destination.  If it does not exist, a new file will be created.
 966             (json-string)
 967 - "format": the format of the new destination, default is to probe if 'mode' is
 968             'existing', else the format of the source
 969             (json-string, optional)
 970 - "sync": what parts of the disk image should be copied to the destination;
 971   possibilities include "full" for all the disk, "top" for only the sectors
 972   allocated in the topmost image, or "none" to only replicate new I/O
 973   (MirrorSyncMode).
 974 - "mode": whether and how QEMU should create a new image
 975           (NewImageMode, optional, default 'absolute-paths')
 976 - "speed": the maximum speed, in bytes per second (json-int, optional)
 977 - "on-source-error": the action to take on an error on the source, default
 978                      'report'.  'stop' and 'enospc' can only be used
 979                      if the block device supports io-status.
 980                      (BlockdevOnError, optional)
 981 - "on-target-error": the action to take on an error on the target, default
 982                      'report' (no limitations, since this applies to
 983                      a different block device than device).
 984                      (BlockdevOnError, optional)
 985
 986 Example:
 987 -> { "execute": "drive-backup", "arguments": { "device": "drive0",
 988                                                "sync": "full",
 989                                                "target": "backup.img" } }
 990 <- { "return": {} }
 991 EQMP
 992
 993     {
 994         .name       = "block-job-set-speed",
 995         .args_type  = "device:B,speed:o",
 996         .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
 997     },
 998
 999     {
1000         .name       = "block-job-cancel",
1001         .args_type  = "device:B,force:b?",
1002         .mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
1003     },
1004     {
1005         .name       = "block-job-pause",
1006         .args_type  = "device:B",
1007         .mhandler.cmd_new = qmp_marshal_input_block_job_pause,
1008     },
1009     {
1010         .name       = "block-job-resume",
1011         .args_type  = "device:B",
1012         .mhandler.cmd_new = qmp_marshal_input_block_job_resume,
1013     },
1014     {
1015         .name       = "block-job-complete",
1016         .args_type  = "device:B",
1017         .mhandler.cmd_new = qmp_marshal_input_block_job_complete,
1018     },
1019     {
1020         .name       = "transaction",
1021         .args_type  = "actions:q",
1022         .mhandler.cmd_new = qmp_marshal_input_transaction,
1023     },
1024
1025 SQMP
1026 transaction
1027 -----------
1028
1029 Atomically operate on one or more block devices.  The only supported operations
1030 for now are drive-backup, internal and external snapshotting.  A list of
1031 dictionaries is accepted, that contains the actions to be performed.
1032 If there is any failure performing any of the operations, all operations
1033 for the group are abandoned.
1034
1035 For external snapshots, the dictionary contains the device, the file to use for
1036 the new snapshot, and the format.  The default format, if not specified, is
1037 qcow2.
1038
1039 Each new snapshot defaults to being created by QEMU (wiping any
1040 contents if the file already exists), but it is also possible to reuse
1041 an externally-created file.  In the latter case, you should ensure that
1042 the new image file has the same contents as the current one; QEMU cannot
1043 perform any meaningful check.  Typically this is achieved by using the
1044 current image file as the backing file for the new image.
1045
1046 On failure, the original disks pre-snapshot attempt will be used.
1047
1048 For internal snapshots, the dictionary contains the device and the snapshot's
1049 name.  If an internal snapshot matching name already exists, the request will
1050 be rejected.  Only some image formats support it, for example, qcow2, rbd,
1051 and sheepdog.
1052
1053 On failure, qemu will try delete the newly created internal snapshot in the
1054 transaction.  When an I/O error occurs during deletion, the user needs to fix
1055 it later with qemu-img or other command.
1056
1057 Arguments:
1058
1059 actions array:
1060     - "type": the operation to perform.  The only supported
1061       value is "blockdev-snapshot-sync". (json-string)
1062     - "data": a dictionary.  The contents depend on the value
1063       of "type".  When "type" is "blockdev-snapshot-sync":
1064       - "device": device name to snapshot (json-string)
1065       - "snapshot-file": name of new image file (json-string)
1066       - "format": format of new image (json-string, optional)
1067       - "mode": whether and how QEMU should create the snapshot file
1068         (NewImageMode, optional, default "absolute-paths")
1069       When "type" is "blockdev-snapshot-internal-sync":
1070       - "device": device name to snapshot (json-string)
1071       - "name": name of the new snapshot (json-string)
1072
1073 Example:
1074
1075 -> { "execute": "transaction",
1076      "arguments": { "actions": [
1077          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd0",
1078                                          "snapshot-file": "/some/place/my-image",
1079                                          "format": "qcow2" } },
1080          { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd1",
1081                                          "snapshot-file": "/some/place/my-image2",
1082                                          "mode": "existing",
1083                                          "format": "qcow2" } },
1084          { 'type': 'blockdev-snapshot-internal-sync', 'data' : {
1085                                          "device": "ide-hd2",
1086                                          "name": "snapshot0" } } ] } }
1087 <- { "return": {} }
1088
1089 EQMP
1090
1091     {
1092         .name       = "blockdev-snapshot-sync",
1093         .args_type  = "device:B,snapshot-file:s,format:s?,mode:s?",
1094         .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
1095     },
1096
1097 SQMP
1098 blockdev-snapshot-sync
1099 ----------------------
1100
1101 Synchronous snapshot of a block device. snapshot-file specifies the
1102 target of the new image. If the file exists, or if it is a device, the
1103 snapshot will be created in the existing file/device. If does not
1104 exist, a new file will be created. format specifies the format of the
1105 snapshot image, default is qcow2.
1106
1107 Arguments:
1108
1109 - "device": device name to snapshot (json-string)
1110 - "snapshot-file": name of new image file (json-string)
1111 - "mode": whether and how QEMU should create the snapshot file
1112   (NewImageMode, optional, default "absolute-paths")
1113 - "format": format of new image (json-string, optional)
1114
1115 Example:
1116
1117 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1118                                                          "snapshot-file":
1119                                                         "/some/place/my-image",
1120                                                         "format": "qcow2" } }
1121 <- { "return": {} }
1122
1123 EQMP
1124
1125     {
1126         .name       = "blockdev-snapshot-internal-sync",
1127         .args_type  = "device:B,name:s",
1128         .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_internal_sync,
1129     },
1130
1131 SQMP
1132 blockdev-snapshot-internal-sync
1133 -------------------------------
1134
1135 Synchronously take an internal snapshot of a block device when the format of
1136 image used supports it.  If the name is an empty string, or a snapshot with
1137 name already exists, the operation will fail.
1138
1139 Arguments:
1140
1141 - "device": device name to snapshot (json-string)
1142 - "name": name of the new snapshot (json-string)
1143
1144 Example:
1145
1146 -> { "execute": "blockdev-snapshot-internal-sync",
1147                 "arguments": { "device": "ide-hd0",
1148                                "name": "snapshot0" }
1149    }
1150 <- { "return": {} }
1151
1152 EQMP
1153
1154     {
1155         .name       = "blockdev-snapshot-delete-internal-sync",
1156         .args_type  = "device:B,id:s?,name:s?",
1157         .mhandler.cmd_new =
1158                       qmp_marshal_input_blockdev_snapshot_delete_internal_sync,
1159     },
1160
1161 SQMP
1162 blockdev-snapshot-delete-internal-sync
1163 --------------------------------------
1164
1165 Synchronously delete an internal snapshot of a block device when the format of
1166 image used supports it.  The snapshot is identified by name or id or both.  One
1167 of name or id is required.  If the snapshot is not found, the operation will
1168 fail.
1169
1170 Arguments:
1171
1172 - "device": device name (json-string)
1173 - "id": ID of the snapshot (json-string, optional)
1174 - "name": name of the snapshot (json-string, optional)
1175
1176 Example:
1177
1178 -> { "execute": "blockdev-snapshot-delete-internal-sync",
1179                 "arguments": { "device": "ide-hd0",
1180                                "name": "snapshot0" }
1181    }
1182 <- { "return": {
1183                    "id": "1",
1184                    "name": "snapshot0",
1185                    "vm-state-size": 0,
1186                    "date-sec": 1000012,
1187                    "date-nsec": 10,
1188                    "vm-clock-sec": 100,
1189                    "vm-clock-nsec": 20
1190      }
1191    }
1192
1193 EQMP
1194
1195     {
1196         .name       = "drive-mirror",
1197         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1198                       "on-source-error:s?,on-target-error:s?,"
1199                       "granularity:i?,buf-size:i?",
1200         .mhandler.cmd_new = qmp_marshal_input_drive_mirror,
1201     },
1202
1203 SQMP
1204 drive-mirror
1205 ------------
1206
1207 Start mirroring a block device's writes to a new destination. target
1208 specifies the target of the new image. If the file exists, or if it is
1209 a device, it will be used as the new destination for writes. If it does not
1210 exist, a new file will be created. format specifies the format of the
1211 mirror image, default is to probe if mode='existing', else the format
1212 of the source.
1213
1214 Arguments:
1215
1216 - "device": device name to operate on (json-string)
1217 - "target": name of new image file (json-string)
1218 - "format": format of new image (json-string, optional)
1219 - "mode": how an image file should be created into the target
1220   file/device (NewImageMode, optional, default 'absolute-paths')
1221 - "speed": maximum speed of the streaming job, in bytes per second
1222   (json-int)
1223 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1224 - "buf_size": maximum amount of data in flight from source to target, in bytes
1225   (json-int, default 10M)
1226 - "sync": what parts of the disk image should be copied to the destination;
1227   possibilities include "full" for all the disk, "top" for only the sectors
1228   allocated in the topmost image, or "none" to only replicate new I/O
1229   (MirrorSyncMode).
1230 - "on-source-error": the action to take on an error on the source
1231   (BlockdevOnError, default 'report')
1232 - "on-target-error": the action to take on an error on the target
1233   (BlockdevOnError, default 'report')
1234
1235 The default value of the granularity is the image cluster size clamped
1236 between 4096 and 65536, if the image format defines one.  If the format
1237 does not define a cluster size, the default value of the granularity
1238 is 65536.
1239
1240
1241 Example:
1242
1243 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1244                                                "target": "/some/place/my-image",
1245                                                "sync": "full",
1246                                                "format": "qcow2" } }
1247 <- { "return": {} }
1248
1249 EQMP
1250
1251     {
1252         .name       = "balloon",
1253         .args_type  = "value:M",
1254         .mhandler.cmd_new = qmp_marshal_input_balloon,
1255     },
1256
1257 SQMP
1258 balloon
1259 -------
1260
1261 Request VM to change its memory allocation (in bytes).
1262
1263 Arguments:
1264
1265 - "value": New memory allocation (json-int)
1266
1267 Example:
1268
1269 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1270 <- { "return": {} }
1271
1272 EQMP
1273
1274     {
1275         .name       = "set_link",
1276         .args_type  = "name:s,up:b",
1277         .mhandler.cmd_new = qmp_marshal_input_set_link,
1278     },
1279
1280 SQMP
1281 set_link
1282 --------
1283
1284 Change the link status of a network adapter.
1285
1286 Arguments:
1287
1288 - "name": network device name (json-string)
1289 - "up": status is up (json-bool)
1290
1291 Example:
1292
1293 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1294 <- { "return": {} }
1295
1296 EQMP
1297
1298     {
1299         .name       = "getfd",
1300         .args_type  = "fdname:s",
1301         .params     = "getfd name",
1302         .help       = "receive a file descriptor via SCM rights and assign it a name",
1303         .mhandler.cmd_new = qmp_marshal_input_getfd,
1304     },
1305
1306 SQMP
1307 getfd
1308 -----
1309
1310 Receive a file descriptor via SCM rights and assign it a name.
1311
1312 Arguments:
1313
1314 - "fdname": file descriptor name (json-string)
1315
1316 Example:
1317
1318 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1319 <- { "return": {} }
1320
1321 Notes:
1322
1323 (1) If the name specified by the "fdname" argument already exists,
1324     the file descriptor assigned to it will be closed and replaced
1325     by the received file descriptor.
1326 (2) The 'closefd' command can be used to explicitly close the file
1327     descriptor when it is no longer needed.
1328
1329 EQMP
1330
1331     {
1332         .name       = "closefd",
1333         .args_type  = "fdname:s",
1334         .params     = "closefd name",
1335         .help       = "close a file descriptor previously passed via SCM rights",
1336         .mhandler.cmd_new = qmp_marshal_input_closefd,
1337     },
1338
1339 SQMP
1340 closefd
1341 -------
1342
1343 Close a file descriptor previously passed via SCM rights.
1344
1345 Arguments:
1346
1347 - "fdname": file descriptor name (json-string)
1348
1349 Example:
1350
1351 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1352 <- { "return": {} }
1353
1354 EQMP
1355
1356      {
1357         .name       = "add-fd",
1358         .args_type  = "fdset-id:i?,opaque:s?",
1359         .params     = "add-fd fdset-id opaque",
1360         .help       = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1361         .mhandler.cmd_new = qmp_marshal_input_add_fd,
1362     },
1363
1364 SQMP
1365 add-fd
1366 -------
1367
1368 Add a file descriptor, that was passed via SCM rights, to an fd set.
1369
1370 Arguments:
1371
1372 - "fdset-id": The ID of the fd set to add the file descriptor to.
1373               (json-int, optional)
1374 - "opaque": A free-form string that can be used to describe the fd.
1375             (json-string, optional)
1376
1377 Return a json-object with the following information:
1378
1379 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1380 - "fd": The file descriptor that was received via SCM rights and added to the
1381         fd set. (json-int)
1382
1383 Example:
1384
1385 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1386 <- { "return": { "fdset-id": 1, "fd": 3 } }
1387
1388 Notes:
1389
1390 (1) The list of fd sets is shared by all monitor connections.
1391 (2) If "fdset-id" is not specified, a new fd set will be created.
1392
1393 EQMP
1394
1395      {
1396         .name       = "remove-fd",
1397         .args_type  = "fdset-id:i,fd:i?",
1398         .params     = "remove-fd fdset-id fd",
1399         .help       = "Remove a file descriptor from an fd set",
1400         .mhandler.cmd_new = qmp_marshal_input_remove_fd,
1401     },
1402
1403 SQMP
1404 remove-fd
1405 ---------
1406
1407 Remove a file descriptor from an fd set.
1408
1409 Arguments:
1410
1411 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1412               (json-int)
1413 - "fd": The file descriptor that is to be removed. (json-int, optional)
1414
1415 Example:
1416
1417 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1418 <- { "return": {} }
1419
1420 Notes:
1421
1422 (1) The list of fd sets is shared by all monitor connections.
1423 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1424     removed.
1425
1426 EQMP
1427
1428     {
1429         .name       = "query-fdsets",
1430         .args_type  = "",
1431         .help       = "Return information describing all fd sets",
1432         .mhandler.cmd_new = qmp_marshal_input_query_fdsets,
1433     },
1434
1435 SQMP
1436 query-fdsets
1437 -------------
1438
1439 Return information describing all fd sets.
1440
1441 Arguments: None
1442
1443 Example:
1444
1445 -> { "execute": "query-fdsets" }
1446 <- { "return": [
1447        {
1448          "fds": [
1449            {
1450              "fd": 30,
1451              "opaque": "rdonly:/path/to/file"
1452            },
1453            {
1454              "fd": 24,
1455              "opaque": "rdwr:/path/to/file"
1456            }
1457          ],
1458          "fdset-id": 1
1459        },
1460        {
1461          "fds": [
1462            {
1463              "fd": 28
1464            },
1465            {
1466              "fd": 29
1467            }
1468          ],
1469          "fdset-id": 0
1470        }
1471      ]
1472    }
1473
1474 Note: The list of fd sets is shared by all monitor connections.
1475
1476 EQMP
1477
1478     {
1479         .name       = "block_passwd",
1480         .args_type  = "device:B,password:s",
1481         .mhandler.cmd_new = qmp_marshal_input_block_passwd,
1482     },
1483
1484 SQMP
1485 block_passwd
1486 ------------
1487
1488 Set the password of encrypted block devices.
1489
1490 Arguments:
1491
1492 - "device": device name (json-string)
1493 - "password": password (json-string)
1494
1495 Example:
1496
1497 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1498                                                "password": "12345" } }
1499 <- { "return": {} }
1500
1501 EQMP
1502
1503     {
1504         .name       = "block_set_io_throttle",
1505         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l,bps_max:l?,bps_rd_max:l?,bps_wr_max:l?,iops_max:l?,iops_rd_max:l?,iops_wr_max:l?,iops_size:l?",
1506         .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
1507     },
1508
1509 SQMP
1510 block_set_io_throttle
1511 ------------
1512
1513 Change I/O throttle limits for a block drive.
1514
1515 Arguments:
1516
1517 - "device": device name (json-string)
1518 - "bps": total throughput limit in bytes per second (json-int)
1519 - "bps_rd": read throughput limit in bytes per second (json-int)
1520 - "bps_wr": write throughput limit in bytes per second (json-int)
1521 - "iops": total I/O operations per second (json-int)
1522 - "iops_rd": read I/O operations per second (json-int)
1523 - "iops_wr": write I/O operations per second (json-int)
1524 - "bps_max":  total max in bytes (json-int)
1525 - "bps_rd_max":  read max in bytes (json-int)
1526 - "bps_wr_max":  write max in bytes (json-int)
1527 - "iops_max":  total I/O operations max (json-int)
1528 - "iops_rd_max":  read I/O operations max (json-int)
1529 - "iops_wr_max":  write I/O operations max (json-int)
1530 - "iops_size":  I/O size in bytes when limiting (json-int)
1531
1532 Example:
1533
1534 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
1535                                                "bps": 1000000,
1536                                                "bps_rd": 0,
1537                                                "bps_wr": 0,
1538                                                "iops": 0,
1539                                                "iops_rd": 0,
1540                                                "iops_wr": 0,
1541                                                "bps_max": 8000000,
1542                                                "bps_rd_max": 0,
1543                                                "bps_wr_max": 0,
1544                                                "iops_max": 0,
1545                                                "iops_rd_max": 0,
1546                                                "iops_wr_max": 0,
1547                                                "iops_size": 0 } }
1548 <- { "return": {} }
1549
1550 EQMP
1551
1552     {
1553         .name       = "set_password",
1554         .args_type  = "protocol:s,password:s,connected:s?",
1555         .mhandler.cmd_new = qmp_marshal_input_set_password,
1556     },
1557
1558 SQMP
1559 set_password
1560 ------------
1561
1562 Set the password for vnc/spice protocols.
1563
1564 Arguments:
1565
1566 - "protocol": protocol name (json-string)
1567 - "password": password (json-string)
1568 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
1569
1570 Example:
1571
1572 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
1573                                                "password": "secret" } }
1574 <- { "return": {} }
1575
1576 EQMP
1577
1578     {
1579         .name       = "expire_password",
1580         .args_type  = "protocol:s,time:s",
1581         .mhandler.cmd_new = qmp_marshal_input_expire_password,
1582     },
1583
1584 SQMP
1585 expire_password
1586 ---------------
1587
1588 Set the password expire time for vnc/spice protocols.
1589
1590 Arguments:
1591
1592 - "protocol": protocol name (json-string)
1593 - "time": [ now | never | +secs | secs ] (json-string)
1594
1595 Example:
1596
1597 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1598                                                   "time": "+60" } }
1599 <- { "return": {} }
1600
1601 EQMP
1602
1603     {
1604         .name       = "add_client",
1605         .args_type  = "protocol:s,fdname:s,skipauth:b?,tls:b?",
1606         .mhandler.cmd_new = qmp_marshal_input_add_client,
1607     },
1608
1609 SQMP
1610 add_client
1611 ----------
1612
1613 Add a graphics client
1614
1615 Arguments:
1616
1617 - "protocol": protocol name (json-string)
1618 - "fdname": file descriptor name (json-string)
1619 - "skipauth": whether to skip authentication (json-bool, optional)
1620 - "tls": whether to perform TLS (json-bool, optional)
1621
1622 Example:
1623
1624 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
1625                                              "fdname": "myclient" } }
1626 <- { "return": {} }
1627
1628 EQMP
1629     {
1630         .name       = "qmp_capabilities",
1631         .args_type  = "",
1632         .params     = "",
1633         .help       = "enable QMP capabilities",
1634         .user_print = monitor_user_noop,
1635         .mhandler.cmd_new = do_qmp_capabilities,
1636     },
1637
1638 SQMP
1639 qmp_capabilities
1640 ----------------
1641
1642 Enable QMP capabilities.
1643
1644 Arguments: None.
1645
1646 Example:
1647
1648 -> { "execute": "qmp_capabilities" }
1649 <- { "return": {} }
1650
1651 Note: This command must be issued before issuing any other command.
1652
1653 EQMP
1654
1655     {
1656         .name       = "human-monitor-command",
1657         .args_type  = "command-line:s,cpu-index:i?",
1658         .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
1659     },
1660
1661 SQMP
1662 human-monitor-command
1663 ---------------------
1664
1665 Execute a Human Monitor command.
1666
1667 Arguments:
1668
1669 - command-line: the command name and its arguments, just like the
1670                 Human Monitor's shell (json-string)
1671 - cpu-index: select the CPU number to be used by commands which access CPU
1672              data, like 'info registers'. The Monitor selects CPU 0 if this
1673              argument is not provided (json-int, optional)
1674
1675 Example:
1676
1677 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1678 <- { "return": "kvm support: enabled\r\n" }
1679
1680 Notes:
1681
1682 (1) The Human Monitor is NOT an stable interface, this means that command
1683     names, arguments and responses can change or be removed at ANY time.
1684     Applications that rely on long term stability guarantees should NOT
1685     use this command
1686
1687 (2) Limitations:
1688
1689     o This command is stateless, this means that commands that depend
1690       on state information (such as getfd) might not work
1691
1692     o Commands that prompt the user for data (eg. 'cont' when the block
1693       device is encrypted) don't currently work
1694
1695 3. Query Commands
1696 =================
1697
1698 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1699 HXCOMM this! We will possibly move query commands definitions inside those
1700 HXCOMM sections, just like regular commands.
1701
1702 EQMP
1703
1704 SQMP
1705 query-version
1706 -------------
1707
1708 Show QEMU version.
1709
1710 Return a json-object with the following information:
1711
1712 - "qemu": A json-object containing three integer values:
1713     - "major": QEMU's major version (json-int)
1714     - "minor": QEMU's minor version (json-int)
1715     - "micro": QEMU's micro version (json-int)
1716 - "package": package's version (json-string)
1717
1718 Example:
1719
1720 -> { "execute": "query-version" }
1721 <- {
1722       "return":{
1723          "qemu":{
1724             "major":0,
1725             "minor":11,
1726             "micro":5
1727          },
1728          "package":""
1729       }
1730    }
1731
1732 EQMP
1733
1734     {
1735         .name       = "query-version",
1736         .args_type  = "",
1737         .mhandler.cmd_new = qmp_marshal_input_query_version,
1738     },
1739
1740 SQMP
1741 query-commands
1742 --------------
1743
1744 List QMP available commands.
1745
1746 Each command is represented by a json-object, the returned value is a json-array
1747 of all commands.
1748
1749 Each json-object contain:
1750
1751 - "name": command's name (json-string)
1752
1753 Example:
1754
1755 -> { "execute": "query-commands" }
1756 <- {
1757       "return":[
1758          {
1759             "name":"query-balloon"
1760          },
1761          {
1762             "name":"system_powerdown"
1763          }
1764       ]
1765    }
1766
1767 Note: This example has been shortened as the real response is too long.
1768
1769 EQMP
1770
1771     {
1772         .name       = "query-commands",
1773         .args_type  = "",
1774         .mhandler.cmd_new = qmp_marshal_input_query_commands,
1775     },
1776
1777 SQMP
1778 query-events
1779 --------------
1780
1781 List QMP available events.
1782
1783 Each event is represented by a json-object, the returned value is a json-array
1784 of all events.
1785
1786 Each json-object contains:
1787
1788 - "name": event's name (json-string)
1789
1790 Example:
1791
1792 -> { "execute": "query-events" }
1793 <- {
1794       "return":[
1795          {
1796             "name":"SHUTDOWN"
1797          },
1798          {
1799             "name":"RESET"
1800          }
1801       ]
1802    }
1803
1804 Note: This example has been shortened as the real response is too long.
1805
1806 EQMP
1807
1808     {
1809         .name       = "query-events",
1810         .args_type  = "",
1811         .mhandler.cmd_new = qmp_marshal_input_query_events,
1812     },
1813
1814 SQMP
1815 query-chardev
1816 -------------
1817
1818 Each device is represented by a json-object. The returned value is a json-array
1819 of all devices.
1820
1821 Each json-object contain the following:
1822
1823 - "label": device's label (json-string)
1824 - "filename": device's file (json-string)
1825
1826 Example:
1827
1828 -> { "execute": "query-chardev" }
1829 <- {
1830       "return":[
1831          {
1832             "label":"monitor",
1833             "filename":"stdio"
1834          },
1835          {
1836             "label":"serial0",
1837             "filename":"vc"
1838          }
1839       ]
1840    }
1841
1842 EQMP
1843
1844     {
1845         .name       = "query-chardev",
1846         .args_type  = "",
1847         .mhandler.cmd_new = qmp_marshal_input_query_chardev,
1848     },
1849
1850 SQMP
1851 query-block
1852 -----------
1853
1854 Show the block devices.
1855
1856 Each block device information is stored in a json-object and the returned value
1857 is a json-array of all devices.
1858
1859 Each json-object contain the following:
1860
1861 - "device": device name (json-string)
1862 - "type": device type (json-string)
1863          - deprecated, retained for backward compatibility
1864          - Possible values: "unknown"
1865 - "removable": true if the device is removable, false otherwise (json-bool)
1866 - "locked": true if the device is locked, false otherwise (json-bool)
1867 - "tray_open": only present if removable, true if the device has a tray,
1868                and it is open (json-bool)
1869 - "inserted": only present if the device is inserted, it is a json-object
1870    containing the following:
1871          - "file": device file name (json-string)
1872          - "ro": true if read-only, false otherwise (json-bool)
1873          - "drv": driver format name (json-string)
1874              - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1875                                 "file", "file", "ftp", "ftps", "host_cdrom",
1876                                 "host_device", "host_floppy", "http", "https",
1877                                 "nbd", "parallels", "qcow", "qcow2", "raw",
1878                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1879          - "backing_file": backing file name (json-string, optional)
1880          - "backing_file_depth": number of files in the backing file chain (json-int)
1881          - "encrypted": true if encrypted, false otherwise (json-bool)
1882          - "bps": limit total bytes per second (json-int)
1883          - "bps_rd": limit read bytes per second (json-int)
1884          - "bps_wr": limit write bytes per second (json-int)
1885          - "iops": limit total I/O operations per second (json-int)
1886          - "iops_rd": limit read operations per second (json-int)
1887          - "iops_wr": limit write operations per second (json-int)
1888          - "bps_max":  total max in bytes (json-int)
1889          - "bps_rd_max":  read max in bytes (json-int)
1890          - "bps_wr_max":  write max in bytes (json-int)
1891          - "iops_max":  total I/O operations max (json-int)
1892          - "iops_rd_max":  read I/O operations max (json-int)
1893          - "iops_wr_max":  write I/O operations max (json-int)
1894          - "iops_size": I/O size when limiting by iops (json-int)
1895          - "image": the detail of the image, it is a json-object containing
1896             the following:
1897              - "filename": image file name (json-string)
1898              - "format": image format (json-string)
1899              - "virtual-size": image capacity in bytes (json-int)
1900              - "dirty-flag": true if image is not cleanly closed, not present
1901                              means clean (json-bool, optional)
1902              - "actual-size": actual size on disk in bytes of the image, not
1903                               present when image does not support thin
1904                               provision (json-int, optional)
1905              - "cluster-size": size of a cluster in bytes, not present if image
1906                                format does not support it (json-int, optional)
1907              - "encrypted": true if the image is encrypted, not present means
1908                             false or the image format does not support
1909                             encryption (json-bool, optional)
1910              - "backing_file": backing file name, not present means no backing
1911                                file is used or the image format does not
1912                                support backing file chain
1913                                (json-string, optional)
1914              - "full-backing-filename": full path of the backing file, not
1915                                         present if it equals backing_file or no
1916                                         backing file is used
1917                                         (json-string, optional)
1918              - "backing-filename-format": the format of the backing file, not
1919                                           present means unknown or no backing
1920                                           file (json-string, optional)
1921              - "snapshots": the internal snapshot info, it is an optional list
1922                 of json-object containing the following:
1923                  - "id": unique snapshot id (json-string)
1924                  - "name": snapshot name (json-string)
1925                  - "vm-state-size": size of the VM state in bytes (json-int)
1926                  - "date-sec": UTC date of the snapshot in seconds (json-int)
1927                  - "date-nsec": fractional part in nanoseconds to be used with
1928                                 date-sec (json-int)
1929                  - "vm-clock-sec": VM clock relative to boot in seconds
1930                                    (json-int)
1931                  - "vm-clock-nsec": fractional part in nanoseconds to be used
1932                                     with vm-clock-sec (json-int)
1933              - "backing-image": the detail of the backing image, it is an
1934                                 optional json-object only present when a
1935                                 backing image present for this image
1936
1937 - "io-status": I/O operation status, only present if the device supports it
1938                and the VM is configured to stop on errors. It's always reset
1939                to "ok" when the "cont" command is issued (json_string, optional)
1940              - Possible values: "ok", "failed", "nospace"
1941
1942 Example:
1943
1944 -> { "execute": "query-block" }
1945 <- {
1946       "return":[
1947          {
1948             "io-status": "ok",
1949             "device":"ide0-hd0",
1950             "locked":false,
1951             "removable":false,
1952             "inserted":{
1953                "ro":false,
1954                "drv":"qcow2",
1955                "encrypted":false,
1956                "file":"disks/test.qcow2",
1957                "backing_file_depth":1,
1958                "bps":1000000,
1959                "bps_rd":0,
1960                "bps_wr":0,
1961                "iops":1000000,
1962                "iops_rd":0,
1963                "iops_wr":0,
1964                "bps_max": 8000000,
1965                "bps_rd_max": 0,
1966                "bps_wr_max": 0,
1967                "iops_max": 0,
1968                "iops_rd_max": 0,
1969                "iops_wr_max": 0,
1970                "iops_size": 0,
1971                "image":{
1972                   "filename":"disks/test.qcow2",
1973                   "format":"qcow2",
1974                   "virtual-size":2048000,
1975                   "backing_file":"base.qcow2",
1976                   "full-backing-filename":"disks/base.qcow2",
1977                   "backing-filename-format:"qcow2",
1978                   "snapshots":[
1979                      {
1980                         "id": "1",
1981                         "name": "snapshot1",
1982                         "vm-state-size": 0,
1983                         "date-sec": 10000200,
1984                         "date-nsec": 12,
1985                         "vm-clock-sec": 206,
1986                         "vm-clock-nsec": 30
1987                      }
1988                   ],
1989                   "backing-image":{
1990                       "filename":"disks/base.qcow2",
1991                       "format":"qcow2",
1992                       "virtual-size":2048000
1993                   }
1994                }
1995             },
1996             "type":"unknown"
1997          },
1998          {
1999             "io-status": "ok",
2000             "device":"ide1-cd0",
2001             "locked":false,
2002             "removable":true,
2003             "type":"unknown"
2004          },
2005          {
2006             "device":"floppy0",
2007             "locked":false,
2008             "removable":true,
2009             "type":"unknown"
2010          },
2011          {
2012             "device":"sd0",
2013             "locked":false,
2014             "removable":true,
2015             "type":"unknown"
2016          }
2017       ]
2018    }
2019
2020 EQMP
2021
2022     {
2023         .name       = "query-block",
2024         .args_type  = "",
2025         .mhandler.cmd_new = qmp_marshal_input_query_block,
2026     },
2027
2028 SQMP
2029 query-blockstats
2030 ----------------
2031
2032 Show block device statistics.
2033
2034 Each device statistic information is stored in a json-object and the returned
2035 value is a json-array of all devices.
2036
2037 Each json-object contain the following:
2038
2039 - "device": device name (json-string)
2040 - "stats": A json-object with the statistics information, it contains:
2041     - "rd_bytes": bytes read (json-int)
2042     - "wr_bytes": bytes written (json-int)
2043     - "rd_operations": read operations (json-int)
2044     - "wr_operations": write operations (json-int)
2045     - "flush_operations": cache flush operations (json-int)
2046     - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
2047     - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
2048     - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
2049     - "wr_highest_offset": Highest offset of a sector written since the
2050                            BlockDriverState has been opened (json-int)
2051 - "parent": Contains recursively the statistics of the underlying
2052             protocol (e.g. the host file for a qcow2 image). If there is
2053             no underlying protocol, this field is omitted
2054             (json-object, optional)
2055
2056 Example:
2057
2058 -> { "execute": "query-blockstats" }
2059 <- {
2060       "return":[
2061          {
2062             "device":"ide0-hd0",
2063             "parent":{
2064                "stats":{
2065                   "wr_highest_offset":3686448128,
2066                   "wr_bytes":9786368,
2067                   "wr_operations":751,
2068                   "rd_bytes":122567168,
2069                   "rd_operations":36772
2070                   "wr_total_times_ns":313253456
2071                   "rd_total_times_ns":3465673657
2072                   "flush_total_times_ns":49653
2073                   "flush_operations":61,
2074                }
2075             },
2076             "stats":{
2077                "wr_highest_offset":2821110784,
2078                "wr_bytes":9786368,
2079                "wr_operations":692,
2080                "rd_bytes":122739200,
2081                "rd_operations":36604
2082                "flush_operations":51,
2083                "wr_total_times_ns":313253456
2084                "rd_total_times_ns":3465673657
2085                "flush_total_times_ns":49653
2086             }
2087          },
2088          {
2089             "device":"ide1-cd0",
2090             "stats":{
2091                "wr_highest_offset":0,
2092                "wr_bytes":0,
2093                "wr_operations":0,
2094                "rd_bytes":0,
2095                "rd_operations":0
2096                "flush_operations":0,
2097                "wr_total_times_ns":0
2098                "rd_total_times_ns":0
2099                "flush_total_times_ns":0
2100             }
2101          },
2102          {
2103             "device":"floppy0",
2104             "stats":{
2105                "wr_highest_offset":0,
2106                "wr_bytes":0,
2107                "wr_operations":0,
2108                "rd_bytes":0,
2109                "rd_operations":0
2110                "flush_operations":0,
2111                "wr_total_times_ns":0
2112                "rd_total_times_ns":0
2113                "flush_total_times_ns":0
2114             }
2115          },
2116          {
2117             "device":"sd0",
2118             "stats":{
2119                "wr_highest_offset":0,
2120                "wr_bytes":0,
2121                "wr_operations":0,
2122                "rd_bytes":0,
2123                "rd_operations":0
2124                "flush_operations":0,
2125                "wr_total_times_ns":0
2126                "rd_total_times_ns":0
2127                "flush_total_times_ns":0
2128             }
2129          }
2130       ]
2131    }
2132
2133 EQMP
2134
2135     {
2136         .name       = "query-blockstats",
2137         .args_type  = "",
2138         .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
2139     },
2140
2141 SQMP
2142 query-cpus
2143 ----------
2144
2145 Show CPU information.
2146
2147 Return a json-array. Each CPU is represented by a json-object, which contains:
2148
2149 - "CPU": CPU index (json-int)
2150 - "current": true if this is the current CPU, false otherwise (json-bool)
2151 - "halted": true if the cpu is halted, false otherwise (json-bool)
2152 - Current program counter. The key's name depends on the architecture:
2153      "pc": i386/x86_64 (json-int)
2154      "nip": PPC (json-int)
2155      "pc" and "npc": sparc (json-int)
2156      "PC": mips (json-int)
2157 - "thread_id": ID of the underlying host thread (json-int)
2158
2159 Example:
2160
2161 -> { "execute": "query-cpus" }
2162 <- {
2163       "return":[
2164          {
2165             "CPU":0,
2166             "current":true,
2167             "halted":false,
2168             "pc":3227107138
2169             "thread_id":3134
2170          },
2171          {
2172             "CPU":1,
2173             "current":false,
2174             "halted":true,
2175             "pc":7108165
2176             "thread_id":3135
2177          }
2178       ]
2179    }
2180
2181 EQMP
2182
2183     {
2184         .name       = "query-cpus",
2185         .args_type  = "",
2186         .mhandler.cmd_new = qmp_marshal_input_query_cpus,
2187     },
2188
2189 SQMP
2190 query-pci
2191 ---------
2192
2193 PCI buses and devices information.
2194
2195 The returned value is a json-array of all buses. Each bus is represented by
2196 a json-object, which has a key with a json-array of all PCI devices attached
2197 to it. Each device is represented by a json-object.
2198
2199 The bus json-object contains the following:
2200
2201 - "bus": bus number (json-int)
2202 - "devices": a json-array of json-objects, each json-object represents a
2203              PCI device
2204
2205 The PCI device json-object contains the following:
2206
2207 - "bus": identical to the parent's bus number (json-int)
2208 - "slot": slot number (json-int)
2209 - "function": function number (json-int)
2210 - "class_info": a json-object containing:
2211      - "desc": device class description (json-string, optional)
2212      - "class": device class number (json-int)
2213 - "id": a json-object containing:
2214      - "device": device ID (json-int)
2215      - "vendor": vendor ID (json-int)
2216 - "irq": device's IRQ if assigned (json-int, optional)
2217 - "qdev_id": qdev id string (json-string)
2218 - "pci_bridge": It's a json-object, only present if this device is a
2219                 PCI bridge, contains:
2220      - "bus": bus number (json-int)
2221      - "secondary": secondary bus number (json-int)
2222      - "subordinate": subordinate bus number (json-int)
2223      - "io_range": I/O memory range information, a json-object with the
2224                    following members:
2225                  - "base": base address, in bytes (json-int)
2226                  - "limit": limit address, in bytes (json-int)
2227      - "memory_range": memory range information, a json-object with the
2228                        following members:
2229                  - "base": base address, in bytes (json-int)
2230                  - "limit": limit address, in bytes (json-int)
2231      - "prefetchable_range": Prefetchable memory range information, a
2232                              json-object with the following members:
2233                  - "base": base address, in bytes (json-int)
2234                  - "limit": limit address, in bytes (json-int)
2235      - "devices": a json-array of PCI devices if there's any attached, each
2236                   each element is represented by a json-object, which contains
2237                   the same members of the 'PCI device json-object' described
2238                   above (optional)
2239 - "regions": a json-array of json-objects, each json-object represents a
2240              memory region of this device
2241
2242 The memory range json-object contains the following:
2243
2244 - "base": base memory address (json-int)
2245 - "limit": limit value (json-int)
2246
2247 The region json-object can be an I/O region or a memory region, an I/O region
2248 json-object contains the following:
2249
2250 - "type": "io" (json-string, fixed)
2251 - "bar": BAR number (json-int)
2252 - "address": memory address (json-int)
2253 - "size": memory size (json-int)
2254
2255 A memory region json-object contains the following:
2256
2257 - "type": "memory" (json-string, fixed)
2258 - "bar": BAR number (json-int)
2259 - "address": memory address (json-int)
2260 - "size": memory size (json-int)
2261 - "mem_type_64": true or false (json-bool)
2262 - "prefetch": true or false (json-bool)
2263
2264 Example:
2265
2266 -> { "execute": "query-pci" }
2267 <- {
2268       "return":[
2269          {
2270             "bus":0,
2271             "devices":[
2272                {
2273                   "bus":0,
2274                   "qdev_id":"",
2275                   "slot":0,
2276                   "class_info":{
2277                      "class":1536,
2278                      "desc":"Host bridge"
2279                   },
2280                   "id":{
2281                      "device":32902,
2282                      "vendor":4663
2283                   },
2284                   "function":0,
2285                   "regions":[
2286
2287                   ]
2288                },
2289                {
2290                   "bus":0,
2291                   "qdev_id":"",
2292                   "slot":1,
2293                   "class_info":{
2294                      "class":1537,
2295                      "desc":"ISA bridge"
2296                   },
2297                   "id":{
2298                      "device":32902,
2299                      "vendor":28672
2300                   },
2301                   "function":0,
2302                   "regions":[
2303
2304                   ]
2305                },
2306                {
2307                   "bus":0,
2308                   "qdev_id":"",
2309                   "slot":1,
2310                   "class_info":{
2311                      "class":257,
2312                      "desc":"IDE controller"
2313                   },
2314                   "id":{
2315                      "device":32902,
2316                      "vendor":28688
2317                   },
2318                   "function":1,
2319                   "regions":[
2320                      {
2321                         "bar":4,
2322                         "size":16,
2323                         "address":49152,
2324                         "type":"io"
2325                      }
2326                   ]
2327                },
2328                {
2329                   "bus":0,
2330                   "qdev_id":"",
2331                   "slot":2,
2332                   "class_info":{
2333                      "class":768,
2334                      "desc":"VGA controller"
2335                   },
2336                   "id":{
2337                      "device":4115,
2338                      "vendor":184
2339                   },
2340                   "function":0,
2341                   "regions":[
2342                      {
2343                         "prefetch":true,
2344                         "mem_type_64":false,
2345                         "bar":0,
2346                         "size":33554432,
2347                         "address":4026531840,
2348                         "type":"memory"
2349                      },
2350                      {
2351                         "prefetch":false,
2352                         "mem_type_64":false,
2353                         "bar":1,
2354                         "size":4096,
2355                         "address":4060086272,
2356                         "type":"memory"
2357                      },
2358                      {
2359                         "prefetch":false,
2360                         "mem_type_64":false,
2361                         "bar":6,
2362                         "size":65536,
2363                         "address":-1,
2364                         "type":"memory"
2365                      }
2366                   ]
2367                },
2368                {
2369                   "bus":0,
2370                   "qdev_id":"",
2371                   "irq":11,
2372                   "slot":4,
2373                   "class_info":{
2374                      "class":1280,
2375                      "desc":"RAM controller"
2376                   },
2377                   "id":{
2378                      "device":6900,
2379                      "vendor":4098
2380                   },
2381                   "function":0,
2382                   "regions":[
2383                      {
2384                         "bar":0,
2385                         "size":32,
2386                         "address":49280,
2387                         "type":"io"
2388                      }
2389                   ]
2390                }
2391             ]
2392          }
2393       ]
2394    }
2395
2396 Note: This example has been shortened as the real response is too long.
2397
2398 EQMP
2399
2400     {
2401         .name       = "query-pci",
2402         .args_type  = "",
2403         .mhandler.cmd_new = qmp_marshal_input_query_pci,
2404     },
2405
2406 SQMP
2407 query-kvm
2408 ---------
2409
2410 Show KVM information.
2411
2412 Return a json-object with the following information:
2413
2414 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
2415 - "present": true if QEMU has KVM support, false otherwise (json-bool)
2416
2417 Example:
2418
2419 -> { "execute": "query-kvm" }
2420 <- { "return": { "enabled": true, "present": true } }
2421
2422 EQMP
2423
2424     {
2425         .name       = "query-kvm",
2426         .args_type  = "",
2427         .mhandler.cmd_new = qmp_marshal_input_query_kvm,
2428     },
2429
2430 SQMP
2431 query-status
2432 ------------
2433
2434 Return a json-object with the following information:
2435
2436 - "running": true if the VM is running, or false if it is paused (json-bool)
2437 - "singlestep": true if the VM is in single step mode,
2438                 false otherwise (json-bool)
2439 - "status": one of the following values (json-string)
2440     "debug" - QEMU is running on a debugger
2441     "inmigrate" - guest is paused waiting for an incoming migration
2442     "internal-error" - An internal error that prevents further guest
2443     execution has occurred
2444     "io-error" - the last IOP has failed and the device is configured
2445     to pause on I/O errors
2446     "paused" - guest has been paused via the 'stop' command
2447     "postmigrate" - guest is paused following a successful 'migrate'
2448     "prelaunch" - QEMU was started with -S and guest has not started
2449     "finish-migrate" - guest is paused to finish the migration process
2450     "restore-vm" - guest is paused to restore VM state
2451     "running" - guest is actively running
2452     "save-vm" - guest is paused to save the VM state
2453     "shutdown" - guest is shut down (and -no-shutdown is in use)
2454     "watchdog" - the watchdog action is configured to pause and
2455      has been triggered
2456
2457 Example:
2458
2459 -> { "execute": "query-status" }
2460 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
2461
2462 EQMP
2463
2464     {
2465         .name       = "query-status",
2466         .args_type  = "",
2467         .mhandler.cmd_new = qmp_marshal_input_query_status,
2468     },
2469
2470 SQMP
2471 query-mice
2472 ----------
2473
2474 Show VM mice information.
2475
2476 Each mouse is represented by a json-object, the returned value is a json-array
2477 of all mice.
2478
2479 The mouse json-object contains the following:
2480
2481 - "name": mouse's name (json-string)
2482 - "index": mouse's index (json-int)
2483 - "current": true if this mouse is receiving events, false otherwise (json-bool)
2484 - "absolute": true if the mouse generates absolute input events (json-bool)
2485
2486 Example:
2487
2488 -> { "execute": "query-mice" }
2489 <- {
2490       "return":[
2491          {
2492             "name":"QEMU Microsoft Mouse",
2493             "index":0,
2494             "current":false,
2495             "absolute":false
2496          },
2497          {
2498             "name":"QEMU PS/2 Mouse",
2499             "index":1,
2500             "current":true,
2501             "absolute":true
2502          }
2503       ]
2504    }
2505
2506 EQMP
2507
2508     {
2509         .name       = "query-mice",
2510         .args_type  = "",
2511         .mhandler.cmd_new = qmp_marshal_input_query_mice,
2512     },
2513
2514 SQMP
2515 query-vnc
2516 ---------
2517
2518 Show VNC server information.
2519
2520 Return a json-object with server information. Connected clients are returned
2521 as a json-array of json-objects.
2522
2523 The main json-object contains the following:
2524
2525 - "enabled": true or false (json-bool)
2526 - "host": server's IP address (json-string)
2527 - "family": address family (json-string)
2528          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2529 - "service": server's port number (json-string)
2530 - "auth": authentication method (json-string)
2531          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
2532                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
2533                             "vencrypt+plain", "vencrypt+tls+none",
2534                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
2535                             "vencrypt+tls+vnc", "vencrypt+x509+none",
2536                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
2537                             "vencrypt+x509+vnc", "vnc"
2538 - "clients": a json-array of all connected clients
2539
2540 Clients are described by a json-object, each one contain the following:
2541
2542 - "host": client's IP address (json-string)
2543 - "family": address family (json-string)
2544          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2545 - "service": client's port number (json-string)
2546 - "x509_dname": TLS dname (json-string, optional)
2547 - "sasl_username": SASL username (json-string, optional)
2548
2549 Example:
2550
2551 -> { "execute": "query-vnc" }
2552 <- {
2553       "return":{
2554          "enabled":true,
2555          "host":"0.0.0.0",
2556          "service":"50402",
2557          "auth":"vnc",
2558          "family":"ipv4",
2559          "clients":[
2560             {
2561                "host":"127.0.0.1",
2562                "service":"50401",
2563                "family":"ipv4"
2564             }
2565          ]
2566       }
2567    }
2568
2569 EQMP
2570
2571     {
2572         .name       = "query-vnc",
2573         .args_type  = "",
2574         .mhandler.cmd_new = qmp_marshal_input_query_vnc,
2575     },
2576
2577 SQMP
2578 query-spice
2579 -----------
2580
2581 Show SPICE server information.
2582
2583 Return a json-object with server information. Connected clients are returned
2584 as a json-array of json-objects.
2585
2586 The main json-object contains the following:
2587
2588 - "enabled": true or false (json-bool)
2589 - "host": server's IP address (json-string)
2590 - "port": server's port number (json-int, optional)
2591 - "tls-port": server's port number (json-int, optional)
2592 - "auth": authentication method (json-string)
2593          - Possible values: "none", "spice"
2594 - "channels": a json-array of all active channels clients
2595
2596 Channels are described by a json-object, each one contain the following:
2597
2598 - "host": client's IP address (json-string)
2599 - "family": address family (json-string)
2600          - Possible values: "ipv4", "ipv6", "unix", "unknown"
2601 - "port": client's port number (json-string)
2602 - "connection-id": spice connection id.  All channels with the same id
2603                    belong to the same spice session (json-int)
2604 - "channel-type": channel type.  "1" is the main control channel, filter for
2605                   this one if you want track spice sessions only (json-int)
2606 - "channel-id": channel id.  Usually "0", might be different needed when
2607                 multiple channels of the same type exist, such as multiple
2608                 display channels in a multihead setup (json-int)
2609 - "tls": whevener the channel is encrypted (json-bool)
2610
2611 Example:
2612
2613 -> { "execute": "query-spice" }
2614 <- {
2615       "return": {
2616          "enabled": true,
2617          "auth": "spice",
2618          "port": 5920,
2619          "tls-port": 5921,
2620          "host": "0.0.0.0",
2621          "channels": [
2622             {
2623                "port": "54924",
2624                "family": "ipv4",
2625                "channel-type": 1,
2626                "connection-id": 1804289383,
2627                "host": "127.0.0.1",
2628                "channel-id": 0,
2629                "tls": true
2630             },
2631             {
2632                "port": "36710",
2633                "family": "ipv4",
2634                "channel-type": 4,
2635                "connection-id": 1804289383,
2636                "host": "127.0.0.1",
2637                "channel-id": 0,
2638                "tls": false
2639             },
2640             [ ... more channels follow ... ]
2641          ]
2642       }
2643    }
2644
2645 EQMP
2646
2647 #if defined(CONFIG_SPICE)
2648     {
2649         .name       = "query-spice",
2650         .args_type  = "",
2651         .mhandler.cmd_new = qmp_marshal_input_query_spice,
2652     },
2653 #endif
2654
2655 SQMP
2656 query-name
2657 ----------
2658
2659 Show VM name.
2660
2661 Return a json-object with the following information:
2662
2663 - "name": VM's name (json-string, optional)
2664
2665 Example:
2666
2667 -> { "execute": "query-name" }
2668 <- { "return": { "name": "qemu-name" } }
2669
2670 EQMP
2671
2672     {
2673         .name       = "query-name",
2674         .args_type  = "",
2675         .mhandler.cmd_new = qmp_marshal_input_query_name,
2676     },
2677
2678 SQMP
2679 query-uuid
2680 ----------
2681
2682 Show VM UUID.
2683
2684 Return a json-object with the following information:
2685
2686 - "UUID": Universally Unique Identifier (json-string)
2687
2688 Example:
2689
2690 -> { "execute": "query-uuid" }
2691 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
2692
2693 EQMP
2694
2695     {
2696         .name       = "query-uuid",
2697         .args_type  = "",
2698         .mhandler.cmd_new = qmp_marshal_input_query_uuid,
2699     },
2700
2701 SQMP
2702 query-command-line-options
2703 --------------------------
2704
2705 Show command line option schema.
2706
2707 Return a json-array of command line option schema for all options (or for
2708 the given option), returning an error if the given option doesn't exist.
2709
2710 Each array entry contains the following:
2711
2712 - "option": option name (json-string)
2713 - "parameters": a json-array describes all parameters of the option:
2714     - "name": parameter name (json-string)
2715     - "type": parameter type (one of 'string', 'boolean', 'number',
2716               or 'size')
2717     - "help": human readable description of the parameter
2718               (json-string, optional)
2719
2720 Example:
2721
2722 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
2723 <- { "return": [
2724         {
2725             "parameters": [
2726                 {
2727                     "name": "romfile",
2728                     "type": "string"
2729                 },
2730                 {
2731                     "name": "bootindex",
2732                     "type": "number"
2733                 }
2734             ],
2735             "option": "option-rom"
2736         }
2737      ]
2738    }
2739
2740 EQMP
2741
2742     {
2743         .name       = "query-command-line-options",
2744         .args_type  = "option:s?",
2745         .mhandler.cmd_new = qmp_marshal_input_query_command_line_options,
2746     },
2747
2748 SQMP
2749 query-migrate
2750 -------------
2751
2752 Migration status.
2753
2754 Return a json-object. If migration is active there will be another json-object
2755 with RAM migration status and if block migration is active another one with
2756 block migration status.
2757
2758 The main json-object contains the following:
2759
2760 - "status": migration status (json-string)
2761      - Possible values: "active", "completed", "failed", "cancelled"
2762 - "total-time": total amount of ms since migration started.  If
2763                 migration has ended, it returns the total migration
2764                 time (json-int)
2765 - "setup-time" amount of setup time in milliseconds _before_ the
2766                iterations begin but _after_ the QMP command is issued.
2767                This is designed to provide an accounting of any activities
2768                (such as RDMA pinning) which may be expensive, but do not
2769                actually occur during the iterative migration rounds
2770                themselves. (json-int)
2771 - "downtime": only present when migration has finished correctly
2772               total amount in ms for downtime that happened (json-int)
2773 - "expected-downtime": only present while migration is active
2774                 total amount in ms for downtime that was calculated on
2775                 the last bitmap round (json-int)
2776 - "ram": only present if "status" is "active", it is a json-object with the
2777   following RAM information:
2778          - "transferred": amount transferred in bytes (json-int)
2779          - "remaining": amount remaining to transfer in bytes (json-int)
2780          - "total": total amount of memory in bytes (json-int)
2781          - "duplicate": number of pages filled entirely with the same
2782             byte (json-int)
2783             These are sent over the wire much more efficiently.
2784          - "skipped": number of skipped zero pages (json-int)
2785          - "normal" : number of whole pages transferred.  I.e. they
2786             were not sent as duplicate or xbzrle pages (json-int)
2787          - "normal-bytes" : number of bytes transferred in whole
2788             pages. This is just normal pages times size of one page,
2789             but this way upper levels don't need to care about page
2790             size (json-int)
2791 - "disk": only present if "status" is "active" and it is a block migration,
2792   it is a json-object with the following disk information:
2793          - "transferred": amount transferred in bytes (json-int)
2794          - "remaining": amount remaining to transfer in bytes json-int)
2795          - "total": total disk size in bytes (json-int)
2796 - "xbzrle-cache": only present if XBZRLE is active.
2797   It is a json-object with the following XBZRLE information:
2798          - "cache-size": XBZRLE cache size in bytes
2799          - "bytes": number of bytes transferred for XBZRLE compressed pages
2800          - "pages": number of XBZRLE compressed pages
2801          - "cache-miss": number of XBRZRLE page cache misses
2802          - "overflow": number of times XBZRLE overflows.  This means
2803            that the XBZRLE encoding was bigger than just sent the
2804            whole page, and then we sent the whole page instead (as as
2805            normal page).
2806
2807 Examples:
2808
2809 1. Before the first migration
2810
2811 -> { "execute": "query-migrate" }
2812 <- { "return": {} }
2813
2814 2. Migration is done and has succeeded
2815
2816 -> { "execute": "query-migrate" }
2817 <- { "return": {
2818         "status": "completed",
2819         "ram":{
2820           "transferred":123,
2821           "remaining":123,
2822           "total":246,
2823           "total-time":12345,
2824           "setup-time":12345,
2825           "downtime":12345,
2826           "duplicate":123,
2827           "normal":123,
2828           "normal-bytes":123456
2829         }
2830      }
2831    }
2832
2833 3. Migration is done and has failed
2834
2835 -> { "execute": "query-migrate" }
2836 <- { "return": { "status": "failed" } }
2837
2838 4. Migration is being performed and is not a block migration:
2839
2840 -> { "execute": "query-migrate" }
2841 <- {
2842       "return":{
2843          "status":"active",
2844          "ram":{
2845             "transferred":123,
2846             "remaining":123,
2847             "total":246,
2848             "total-time":12345,
2849             "setup-time":12345,
2850             "expected-downtime":12345,
2851             "duplicate":123,
2852             "normal":123,
2853             "normal-bytes":123456
2854          }
2855       }
2856    }
2857
2858 5. Migration is being performed and is a block migration:
2859
2860 -> { "execute": "query-migrate" }
2861 <- {
2862       "return":{
2863          "status":"active",
2864          "ram":{
2865             "total":1057024,
2866             "remaining":1053304,
2867             "transferred":3720,
2868             "total-time":12345,
2869             "setup-time":12345,
2870             "expected-downtime":12345,
2871             "duplicate":123,
2872             "normal":123,
2873             "normal-bytes":123456
2874          },
2875          "disk":{
2876             "total":20971520,
2877             "remaining":20880384,
2878             "transferred":91136
2879          }
2880       }
2881    }
2882
2883 6. Migration is being performed and XBZRLE is active:
2884
2885 -> { "execute": "query-migrate" }
2886 <- {
2887       "return":{
2888          "status":"active",
2889          "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
2890          "ram":{
2891             "total":1057024,
2892             "remaining":1053304,
2893             "transferred":3720,
2894             "total-time":12345,
2895             "setup-time":12345,
2896             "expected-downtime":12345,
2897             "duplicate":10,
2898             "normal":3333,
2899             "normal-bytes":3412992
2900          },
2901          "xbzrle-cache":{
2902             "cache-size":67108864,
2903             "bytes":20971520,
2904             "pages":2444343,
2905             "cache-miss":2244,
2906             "overflow":34434
2907          }
2908       }
2909    }
2910
2911 EQMP
2912
2913     {
2914         .name       = "query-migrate",
2915         .args_type  = "",
2916         .mhandler.cmd_new = qmp_marshal_input_query_migrate,
2917     },
2918
2919 SQMP
2920 migrate-set-capabilities
2921 ------------------------
2922
2923 Enable/Disable migration capabilities
2924
2925 - "xbzrle": XBZRLE support
2926
2927 Arguments:
2928
2929 Example:
2930
2931 -> { "execute": "migrate-set-capabilities" , "arguments":
2932      { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
2933
2934 EQMP
2935
2936     {
2937         .name       = "migrate-set-capabilities",
2938         .args_type  = "capabilities:O",
2939         .params     = "capability:s,state:b",
2940         .mhandler.cmd_new = qmp_marshal_input_migrate_set_capabilities,
2941     },
2942 SQMP
2943 query-migrate-capabilities
2944 --------------------------
2945
2946 Query current migration capabilities
2947
2948 - "capabilities": migration capabilities state
2949          - "xbzrle" : XBZRLE state (json-bool)
2950
2951 Arguments:
2952
2953 Example:
2954
2955 -> { "execute": "query-migrate-capabilities" }
2956 <- { "return": [ { "state": false, "capability": "xbzrle" } ] }
2957
2958 EQMP
2959
2960     {
2961         .name       = "query-migrate-capabilities",
2962         .args_type  = "",
2963         .mhandler.cmd_new = qmp_marshal_input_query_migrate_capabilities,
2964     },
2965
2966 SQMP
2967 query-balloon
2968 -------------
2969
2970 Show balloon information.
2971
2972 Make an asynchronous request for balloon info. When the request completes a
2973 json-object will be returned containing the following data:
2974
2975 - "actual": current balloon value in bytes (json-int)
2976
2977 Example:
2978
2979 -> { "execute": "query-balloon" }
2980 <- {
2981       "return":{
2982          "actual":1073741824,
2983       }
2984    }
2985
2986 EQMP
2987
2988     {
2989         .name       = "query-balloon",
2990         .args_type  = "",
2991         .mhandler.cmd_new = qmp_marshal_input_query_balloon,
2992     },
2993
2994     {
2995         .name       = "query-block-jobs",
2996         .args_type  = "",
2997         .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
2998     },
2999
3000     {
3001         .name       = "qom-list",
3002         .args_type  = "path:s",
3003         .mhandler.cmd_new = qmp_marshal_input_qom_list,
3004     },
3005
3006     {
3007         .name       = "qom-set",
3008         .args_type  = "path:s,property:s,value:q",
3009         .mhandler.cmd_new = qmp_qom_set,
3010     },
3011
3012     {
3013         .name       = "qom-get",
3014         .args_type  = "path:s,property:s",
3015         .mhandler.cmd_new = qmp_qom_get,
3016     },
3017
3018     {
3019         .name       = "nbd-server-start",
3020         .args_type  = "addr:q",
3021         .mhandler.cmd_new = qmp_marshal_input_nbd_server_start,
3022     },
3023     {
3024         .name       = "nbd-server-add",
3025         .args_type  = "device:B,writable:b?",
3026         .mhandler.cmd_new = qmp_marshal_input_nbd_server_add,
3027     },
3028     {
3029         .name       = "nbd-server-stop",
3030         .args_type  = "",
3031         .mhandler.cmd_new = qmp_marshal_input_nbd_server_stop,
3032     },
3033
3034     {
3035         .name       = "change-vnc-password",
3036         .args_type  = "password:s",
3037         .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
3038     },
3039     {
3040         .name       = "qom-list-types",
3041         .args_type  = "implements:s?,abstract:b?",
3042         .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
3043     },
3044
3045     {
3046         .name       = "device-list-properties",
3047         .args_type  = "typename:s",
3048         .mhandler.cmd_new = qmp_marshal_input_device_list_properties,
3049     },
3050
3051     {
3052         .name       = "query-machines",
3053         .args_type  = "",
3054         .mhandler.cmd_new = qmp_marshal_input_query_machines,
3055     },
3056
3057     {
3058         .name       = "query-cpu-definitions",
3059         .args_type  = "",
3060         .mhandler.cmd_new = qmp_marshal_input_query_cpu_definitions,
3061     },
3062
3063     {
3064         .name       = "query-target",
3065         .args_type  = "",
3066         .mhandler.cmd_new = qmp_marshal_input_query_target,
3067     },
3068
3069     {
3070         .name       = "query-tpm",
3071         .args_type  = "",
3072         .mhandler.cmd_new = qmp_marshal_input_query_tpm,
3073     },
3074
3075 SQMP
3076 query-tpm
3077 ---------
3078
3079 Return information about the TPM device.
3080
3081 Arguments: None
3082
3083 Example:
3084
3085 -> { "execute": "query-tpm" }
3086 <- { "return":
3087      [
3088        { "model": "tpm-tis",
3089          "options":
3090            { "type": "passthrough",
3091              "data":
3092                { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
3093                  "path": "/dev/tpm0"
3094                }
3095            },
3096          "id": "tpm0"
3097        }
3098      ]
3099    }
3100
3101 EQMP
3102
3103     {
3104         .name       = "query-tpm-models",
3105         .args_type  = "",
3106         .mhandler.cmd_new = qmp_marshal_input_query_tpm_models,
3107     },
3108
3109 SQMP
3110 query-tpm-models
3111 ----------------
3112
3113 Return a list of supported TPM models.
3114
3115 Arguments: None
3116
3117 Example:
3118
3119 -> { "execute": "query-tpm-models" }
3120 <- { "return": [ "tpm-tis" ] }
3121
3122 EQMP
3123
3124     {
3125         .name       = "query-tpm-types",
3126         .args_type  = "",
3127         .mhandler.cmd_new = qmp_marshal_input_query_tpm_types,
3128     },
3129
3130 SQMP
3131 query-tpm-types
3132 ---------------
3133
3134 Return a list of supported TPM types.
3135
3136 Arguments: None
3137
3138 Example:
3139
3140 -> { "execute": "query-tpm-types" }
3141 <- { "return": [ "passthrough" ] }
3142
3143 EQMP
3144
3145     {
3146         .name       = "chardev-add",
3147         .args_type  = "id:s,backend:q",
3148         .mhandler.cmd_new = qmp_marshal_input_chardev_add,
3149     },
3150
3151 SQMP
3152 chardev-add
3153 ----------------
3154
3155 Add a chardev.
3156
3157 Arguments:
3158
3159 - "id": the chardev's ID, must be unique (json-string)
3160 - "backend": chardev backend type + parameters
3161
3162 Examples:
3163
3164 -> { "execute" : "chardev-add",
3165      "arguments" : { "id" : "foo",
3166                      "backend" : { "type" : "null", "data" : {} } } }
3167 <- { "return": {} }
3168
3169 -> { "execute" : "chardev-add",
3170      "arguments" : { "id" : "bar",
3171                      "backend" : { "type" : "file",
3172                                    "data" : { "out" : "/tmp/bar.log" } } } }
3173 <- { "return": {} }
3174
3175 -> { "execute" : "chardev-add",
3176      "arguments" : { "id" : "baz",
3177                      "backend" : { "type" : "pty", "data" : {} } } }
3178 <- { "return": { "pty" : "/dev/pty/42" } }
3179
3180 EQMP
3181
3182     {
3183         .name       = "chardev-remove",
3184         .args_type  = "id:s",
3185         .mhandler.cmd_new = qmp_marshal_input_chardev_remove,
3186     },
3187
3188
3189 SQMP
3190 chardev-remove
3191 --------------
3192
3193 Remove a chardev.
3194
3195 Arguments:
3196
3197 - "id": the chardev's ID, must exist and not be in use (json-string)
3198
3199 Example:
3200
3201 -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
3202 <- { "return": {} }
3203
3204 EQMP
3205     {
3206         .name       = "query-rx-filter",
3207         .args_type  = "name:s?",
3208         .mhandler.cmd_new = qmp_marshal_input_query_rx_filter,
3209     },
3210
3211 SQMP
3212 query-rx-filter
3213 ---------------
3214
3215 Show rx-filter information.
3216
3217 Returns a json-array of rx-filter information for all NICs (or for the
3218 given NIC), returning an error if the given NIC doesn't exist, or
3219 given NIC doesn't support rx-filter querying, or given net client
3220 isn't a NIC.
3221
3222 The query will clear the event notification flag of each NIC, then qemu
3223 will start to emit event to QMP monitor.
3224
3225 Each array entry contains the following:
3226
3227 - "name": net client name (json-string)
3228 - "promiscuous": promiscuous mode is enabled (json-bool)
3229 - "multicast": multicast receive state (one of 'normal', 'none', 'all')
3230 - "unicast": unicast receive state  (one of 'normal', 'none', 'all')
3231 - "broadcast-allowed": allow to receive broadcast (json-bool)
3232 - "multicast-overflow": multicast table is overflowed (json-bool)
3233 - "unicast-overflow": unicast table is overflowed (json-bool)
3234 - "main-mac": main macaddr string (json-string)
3235 - "vlan-table": a json-array of active vlan id
3236 - "unicast-table": a json-array of unicast macaddr string
3237 - "multicast-table": a json-array of multicast macaddr string
3238
3239 Example:
3240
3241 -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
3242 <- { "return": [
3243         {
3244             "promiscuous": true,
3245             "name": "vnet0",
3246             "main-mac": "52:54:00:12:34:56",
3247             "unicast": "normal",
3248             "vlan-table": [
3249                 4,
3250                 0
3251             ],
3252             "unicast-table": [
3253             ],
3254             "multicast": "normal",
3255             "multicast-overflow": false,
3256             "unicast-overflow": false,
3257             "multicast-table": [
3258                 "01:00:5e:00:00:01",
3259                 "33:33:00:00:00:01",
3260                 "33:33:ff:12:34:56"
3261             ],
3262             "broadcast-allowed": false
3263         }
3264       ]
3265    }
3266
3267 EQMP
3268
3269     {
3270         .name       = "blockdev-add",
3271         .args_type  = "options:q",
3272         .mhandler.cmd_new = qmp_marshal_input_blockdev_add,
3273     },
3274
3275 SQMP
3276 blockdev-add
3277 ------------
3278
3279 Add a block device.
3280
3281 Arguments:
3282
3283 - "options": block driver options
3284
3285 Example (1):
3286
3287 -> { "execute": "blockdev-add",
3288     "arguments": { "options" : { "driver": "qcow2",
3289                                  "file": { "driver": "file",
3290                                            "filename": "test.qcow2" } } } }
3291 <- { "return": {} }
3292
3293 Example (2):
3294
3295 -> { "execute": "blockdev-add",
3296      "arguments": {
3297          "options": {
3298            "driver": "qcow2",
3299            "id": "my_disk",
3300            "discard": "unmap",
3301            "cache": {
3302                "direct": true,
3303                "writeback": true
3304            },
3305            "file": {
3306                "driver": "file",
3307                "filename": "/tmp/test.qcow2"
3308            },
3309            "backing": {
3310                "driver": "raw",
3311                "file": {
3312                    "driver": "file",
3313                    "filename": "/dev/fdset/4"
3314                }
3315            }
3316          }
3317        }
3318      }
3319
3320 <- { "return": {} }
3321
3322 EQMP