qmp-commands.hx

   1 HXCOMM QMP dispatch table and documentation
   2 HXCOMM Text between SQMP and EQMP is copied to the QMP documentation 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_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_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_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_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_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_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_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_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_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         .mhandler.cmd_new = qmp_device_add,
 280     },
 281
 282 SQMP
 283 device_add
 284 ----------
 285
 286 Add a device.
 287
 288 Arguments:
 289
 290 - "driver": the name of the new device's driver (json-string)
 291 - "bus": the device's parent bus (device tree path, json-string, optional)
 292 - "id": the device's ID, must be unique (json-string)
 293 - device properties
 294
 295 Example:
 296
 297 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
 298 <- { "return": {} }
 299
 300 Notes:
 301
 302 (1) For detailed information about this command, please refer to the
 303     'docs/qdev-device-use.txt' file.
 304
 305 (2) It's possible to list device properties by running QEMU with the
 306     "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
 307
 308 EQMP
 309
 310     {
 311         .name       = "device_del",
 312         .args_type  = "id:s",
 313         .mhandler.cmd_new = qmp_marshal_device_del,
 314     },
 315
 316 SQMP
 317 device_del
 318 ----------
 319
 320 Remove a device.
 321
 322 Arguments:
 323
 324 - "id": the device's ID or QOM path (json-string)
 325
 326 Example:
 327
 328 -> { "execute": "device_del", "arguments": { "id": "net1" } }
 329 <- { "return": {} }
 330
 331 Example:
 332
 333 -> { "execute": "device_del", "arguments": { "id": "/machine/peripheral-anon/device[0]" } }
 334 <- { "return": {} }
 335
 336 EQMP
 337
 338     {
 339         .name       = "send-key",
 340         .args_type  = "keys:q,hold-time:i?",
 341         .mhandler.cmd_new = qmp_marshal_send_key,
 342     },
 343
 344 SQMP
 345 send-key
 346 ----------
 347
 348 Send keys to VM.
 349
 350 Arguments:
 351
 352 keys array:
 353     - "key": key sequence (a json-array of key union values,
 354              union can be number or qcode enum)
 355
 356 - hold-time: time to delay key up events, milliseconds. Defaults to 100
 357              (json-int, optional)
 358
 359 Example:
 360
 361 -> { "execute": "send-key",
 362      "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
 363                               { "type": "qcode", "data": "alt" },
 364                               { "type": "qcode", "data": "delete" } ] } }
 365 <- { "return": {} }
 366
 367 EQMP
 368
 369     {
 370         .name       = "cpu",
 371         .args_type  = "index:i",
 372         .mhandler.cmd_new = qmp_marshal_cpu,
 373     },
 374
 375 SQMP
 376 cpu
 377 ---
 378
 379 Set the default CPU.
 380
 381 Arguments:
 382
 383 - "index": the CPU's index (json-int)
 384
 385 Example:
 386
 387 -> { "execute": "cpu", "arguments": { "index": 0 } }
 388 <- { "return": {} }
 389
 390 Note: CPUs' indexes are obtained with the 'query-cpus' command.
 391
 392 EQMP
 393
 394     {
 395         .name       = "cpu-add",
 396         .args_type  = "id:i",
 397         .mhandler.cmd_new = qmp_marshal_cpu_add,
 398     },
 399
 400 SQMP
 401 cpu-add
 402 -------
 403
 404 Adds virtual cpu
 405
 406 Arguments:
 407
 408 - "id": cpu id (json-int)
 409
 410 Example:
 411
 412 -> { "execute": "cpu-add", "arguments": { "id": 2 } }
 413 <- { "return": {} }
 414
 415 EQMP
 416
 417     {
 418         .name       = "memsave",
 419         .args_type  = "val:l,size:i,filename:s,cpu:i?",
 420         .mhandler.cmd_new = qmp_marshal_memsave,
 421     },
 422
 423 SQMP
 424 memsave
 425 -------
 426
 427 Save to disk virtual memory dump starting at 'val' of size 'size'.
 428
 429 Arguments:
 430
 431 - "val": the starting address (json-int)
 432 - "size": the memory size, in bytes (json-int)
 433 - "filename": file path (json-string)
 434 - "cpu": virtual CPU index (json-int, optional)
 435
 436 Example:
 437
 438 -> { "execute": "memsave",
 439              "arguments": { "val": 10,
 440                             "size": 100,
 441                             "filename": "/tmp/virtual-mem-dump" } }
 442 <- { "return": {} }
 443
 444 EQMP
 445
 446     {
 447         .name       = "pmemsave",
 448         .args_type  = "val:l,size:i,filename:s",
 449         .mhandler.cmd_new = qmp_marshal_pmemsave,
 450     },
 451
 452 SQMP
 453 pmemsave
 454 --------
 455
 456 Save to disk physical memory dump starting at 'val' of size 'size'.
 457
 458 Arguments:
 459
 460 - "val": the starting address (json-int)
 461 - "size": the memory size, in bytes (json-int)
 462 - "filename": file path (json-string)
 463
 464 Example:
 465
 466 -> { "execute": "pmemsave",
 467              "arguments": { "val": 10,
 468                             "size": 100,
 469                             "filename": "/tmp/physical-mem-dump" } }
 470 <- { "return": {} }
 471
 472 EQMP
 473
 474     {
 475         .name       = "inject-nmi",
 476         .args_type  = "",
 477         .mhandler.cmd_new = qmp_marshal_inject_nmi,
 478     },
 479
 480 SQMP
 481 inject-nmi
 482 ----------
 483
 484 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
 485
 486 Arguments: None.
 487
 488 Example:
 489
 490 -> { "execute": "inject-nmi" }
 491 <- { "return": {} }
 492
 493 Note: inject-nmi fails when the guest doesn't support injecting.
 494
 495 EQMP
 496
 497     {
 498         .name       = "ringbuf-write",
 499         .args_type  = "device:s,data:s,format:s?",
 500         .mhandler.cmd_new = qmp_marshal_ringbuf_write,
 501     },
 502
 503 SQMP
 504 ringbuf-write
 505 -------------
 506
 507 Write to a ring buffer character device.
 508
 509 Arguments:
 510
 511 - "device": ring buffer character device name (json-string)
 512 - "data": data to write (json-string)
 513 - "format": data format (json-string, optional)
 514           - Possible values: "utf8" (default), "base64"
 515             Bug: invalid base64 is currently not rejected.
 516             Whitespace *is* invalid.
 517
 518 Example:
 519
 520 -> { "execute": "ringbuf-write",
 521                 "arguments": { "device": "foo",
 522                                "data": "abcdefgh",
 523                                "format": "utf8" } }
 524 <- { "return": {} }
 525
 526 EQMP
 527
 528     {
 529         .name       = "ringbuf-read",
 530         .args_type  = "device:s,size:i,format:s?",
 531         .mhandler.cmd_new = qmp_marshal_ringbuf_read,
 532     },
 533
 534 SQMP
 535 ringbuf-read
 536 -------------
 537
 538 Read from a ring buffer character device.
 539
 540 Arguments:
 541
 542 - "device": ring buffer character device name (json-string)
 543 - "size": how many bytes to read at most (json-int)
 544           - Number of data bytes, not number of characters in encoded data
 545 - "format": data format (json-string, optional)
 546           - Possible values: "utf8" (default), "base64"
 547           - Naturally, format "utf8" works only when the ring buffer
 548             contains valid UTF-8 text.  Invalid UTF-8 sequences get
 549             replaced.  Bug: replacement doesn't work.  Bug: can screw
 550             up on encountering NUL characters, after the ring buffer
 551             lost data, and when reading stops because the size limit
 552             is reached.
 553
 554 Example:
 555
 556 -> { "execute": "ringbuf-read",
 557                 "arguments": { "device": "foo",
 558                                "size": 1000,
 559                                "format": "utf8" } }
 560 <- {"return": "abcdefgh"}
 561
 562 EQMP
 563
 564     {
 565         .name       = "xen-save-devices-state",
 566         .args_type  = "filename:F",
 567     .mhandler.cmd_new = qmp_marshal_xen_save_devices_state,
 568     },
 569
 570 SQMP
 571 xen-save-devices-state
 572 -------
 573
 574 Save the state of all devices to file. The RAM and the block devices
 575 of the VM are not saved by this command.
 576
 577 Arguments:
 578
 579 - "filename": the file to save the state of the devices to as binary
 580 data. See xen-save-devices-state.txt for a description of the binary
 581 format.
 582
 583 Example:
 584
 585 -> { "execute": "xen-save-devices-state",
 586      "arguments": { "filename": "/tmp/save" } }
 587 <- { "return": {} }
 588
 589 EQMP
 590
 591     {
 592         .name       = "xen-set-global-dirty-log",
 593         .args_type  = "enable:b",
 594         .mhandler.cmd_new = qmp_marshal_xen_set_global_dirty_log,
 595     },
 596
 597 SQMP
 598 xen-set-global-dirty-log
 599 -------
 600
 601 Enable or disable the global dirty log mode.
 602
 603 Arguments:
 604
 605 - "enable": Enable it or disable it.
 606
 607 Example:
 608
 609 -> { "execute": "xen-set-global-dirty-log",
 610      "arguments": { "enable": true } }
 611 <- { "return": {} }
 612
 613 EQMP
 614
 615     {
 616         .name       = "migrate",
 617         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 618         .mhandler.cmd_new = qmp_marshal_migrate,
 619     },
 620
 621 SQMP
 622 migrate
 623 -------
 624
 625 Migrate to URI.
 626
 627 Arguments:
 628
 629 - "blk": block migration, full disk copy (json-bool, optional)
 630 - "inc": incremental disk copy (json-bool, optional)
 631 - "uri": Destination URI (json-string)
 632
 633 Example:
 634
 635 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
 636 <- { "return": {} }
 637
 638 Notes:
 639
 640 (1) The 'query-migrate' command should be used to check migration's progress
 641     and final result (this information is provided by the 'status' member)
 642 (2) All boolean arguments default to false
 643 (3) The user Monitor's "detach" argument is invalid in QMP and should not
 644     be used
 645
 646 EQMP
 647
 648     {
 649         .name       = "migrate_cancel",
 650         .args_type  = "",
 651         .mhandler.cmd_new = qmp_marshal_migrate_cancel,
 652     },
 653
 654 SQMP
 655 migrate_cancel
 656 --------------
 657
 658 Cancel the current migration.
 659
 660 Arguments: None.
 661
 662 Example:
 663
 664 -> { "execute": "migrate_cancel" }
 665 <- { "return": {} }
 666
 667 EQMP
 668
 669     {
 670         .name       = "migrate-incoming",
 671         .args_type  = "uri:s",
 672         .mhandler.cmd_new = qmp_marshal_migrate_incoming,
 673     },
 674
 675 SQMP
 676 migrate-incoming
 677 ----------------
 678
 679 Continue an incoming migration
 680
 681 Arguments:
 682
 683 - "uri": Source/listening URI (json-string)
 684
 685 Example:
 686
 687 -> { "execute": "migrate-incoming", "arguments": { "uri": "tcp::4446" } }
 688 <- { "return": {} }
 689
 690 Notes:
 691
 692 (1) QEMU must be started with -incoming defer to allow migrate-incoming to
 693     be used
 694 (2) The uri format is the same as for -incoming
 695
 696 EQMP
 697     {
 698         .name       = "migrate-set-cache-size",
 699         .args_type  = "value:o",
 700         .mhandler.cmd_new = qmp_marshal_migrate_set_cache_size,
 701     },
 702
 703 SQMP
 704 migrate-set-cache-size
 705 ----------------------
 706
 707 Set cache size to be used by XBZRLE migration, the cache size will be rounded
 708 down to the nearest power of 2
 709
 710 Arguments:
 711
 712 - "value": cache size in bytes (json-int)
 713
 714 Example:
 715
 716 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
 717 <- { "return": {} }
 718
 719 EQMP
 720     {
 721         .name       = "migrate-start-postcopy",
 722         .args_type  = "",
 723         .mhandler.cmd_new = qmp_marshal_migrate_start_postcopy,
 724     },
 725
 726 SQMP
 727 migrate-start-postcopy
 728 ----------------------
 729
 730 Switch an in-progress migration to postcopy mode. Ignored after the end of
 731 migration (or once already in postcopy).
 732
 733 Example:
 734 -> { "execute": "migrate-start-postcopy" }
 735 <- { "return": {} }
 736
 737 EQMP
 738
 739     {
 740         .name       = "query-migrate-cache-size",
 741         .args_type  = "",
 742         .mhandler.cmd_new = qmp_marshal_query_migrate_cache_size,
 743     },
 744
 745 SQMP
 746 query-migrate-cache-size
 747 ------------------------
 748
 749 Show cache size to be used by XBZRLE migration
 750
 751 returns a json-object with the following information:
 752 - "size" : json-int
 753
 754 Example:
 755
 756 -> { "execute": "query-migrate-cache-size" }
 757 <- { "return": 67108864 }
 758
 759 EQMP
 760
 761     {
 762         .name       = "migrate_set_speed",
 763         .args_type  = "value:o",
 764         .mhandler.cmd_new = qmp_marshal_migrate_set_speed,
 765     },
 766
 767 SQMP
 768 migrate_set_speed
 769 -----------------
 770
 771 Set maximum speed for migrations.
 772
 773 Arguments:
 774
 775 - "value": maximum speed, in bytes per second (json-int)
 776
 777 Example:
 778
 779 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
 780 <- { "return": {} }
 781
 782 EQMP
 783
 784     {
 785         .name       = "migrate_set_downtime",
 786         .args_type  = "value:T",
 787         .mhandler.cmd_new = qmp_marshal_migrate_set_downtime,
 788     },
 789
 790 SQMP
 791 migrate_set_downtime
 792 --------------------
 793
 794 Set maximum tolerated downtime (in seconds) for migrations.
 795
 796 Arguments:
 797
 798 - "value": maximum downtime (json-number)
 799
 800 Example:
 801
 802 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
 803 <- { "return": {} }
 804
 805 EQMP
 806
 807     {
 808         .name       = "client_migrate_info",
 809         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
 810         .params     = "protocol hostname port tls-port cert-subject",
 811         .help       = "set migration information for remote display",
 812         .mhandler.cmd_new = qmp_marshal_client_migrate_info,
 813     },
 814
 815 SQMP
 816 client_migrate_info
 817 -------------------
 818
 819 Set migration information for remote display.  This makes the server
 820 ask the client to automatically reconnect using the new parameters
 821 once migration finished successfully.  Only implemented for SPICE.
 822
 823 Arguments:
 824
 825 - "protocol":     must be "spice" (json-string)
 826 - "hostname":     migration target hostname (json-string)
 827 - "port":         spice tcp port for plaintext channels (json-int, optional)
 828 - "tls-port":     spice tcp port for tls-secured channels (json-int, optional)
 829 - "cert-subject": server certificate subject (json-string, optional)
 830
 831 Example:
 832
 833 -> { "execute": "client_migrate_info",
 834      "arguments": { "protocol": "spice",
 835                     "hostname": "virt42.lab.kraxel.org",
 836                     "port": 1234 } }
 837 <- { "return": {} }
 838
 839 EQMP
 840
 841     {
 842         .name       = "dump-guest-memory",
 843         .args_type  = "paging:b,protocol:s,begin:i?,end:i?,format:s?",
 844         .params     = "-p protocol [begin] [length] [format]",
 845         .help       = "dump guest memory to file",
 846         .mhandler.cmd_new = qmp_marshal_dump_guest_memory,
 847     },
 848
 849 SQMP
 850 dump
 851
 852
 853 Dump guest memory to file. The file can be processed with crash or gdb.
 854
 855 Arguments:
 856
 857 - "paging": do paging to get guest's memory mapping (json-bool)
 858 - "protocol": destination file(started with "file:") or destination file
 859               descriptor (started with "fd:") (json-string)
 860 - "begin": the starting physical address. It's optional, and should be specified
 861            with length together (json-int)
 862 - "length": the memory size, in bytes. It's optional, and should be specified
 863             with begin together (json-int)
 864 - "format": the format of guest memory dump. It's optional, and can be
 865             elf|kdump-zlib|kdump-lzo|kdump-snappy, but non-elf formats will
 866             conflict with paging and filter, ie. begin and length (json-string)
 867
 868 Example:
 869
 870 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
 871 <- { "return": {} }
 872
 873 Notes:
 874
 875 (1) All boolean arguments default to false
 876
 877 EQMP
 878
 879     {
 880         .name       = "query-dump-guest-memory-capability",
 881         .args_type  = "",
 882     .mhandler.cmd_new = qmp_marshal_query_dump_guest_memory_capability,
 883     },
 884
 885 SQMP
 886 query-dump-guest-memory-capability
 887 ----------
 888
 889 Show available formats for 'dump-guest-memory'
 890
 891 Example:
 892
 893 -> { "execute": "query-dump-guest-memory-capability" }
 894 <- { "return": { "formats":
 895                     ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
 896
 897 EQMP
 898
 899 #if defined TARGET_S390X
 900     {
 901         .name       = "dump-skeys",
 902         .args_type  = "filename:F",
 903         .mhandler.cmd_new = qmp_marshal_dump_skeys,
 904     },
 905 #endif
 906
 907 SQMP
 908 dump-skeys
 909 ----------
 910
 911 Save guest storage keys to file.
 912
 913 Arguments:
 914
 915 - "filename": file path (json-string)
 916
 917 Example:
 918
 919 -> { "execute": "dump-skeys", "arguments": { "filename": "/tmp/skeys" } }
 920 <- { "return": {} }
 921
 922 EQMP
 923
 924     {
 925         .name       = "netdev_add",
 926         .args_type  = "netdev:O",
 927         .mhandler.cmd_new = qmp_netdev_add,
 928     },
 929
 930 SQMP
 931 netdev_add
 932 ----------
 933
 934 Add host network device.
 935
 936 Arguments:
 937
 938 - "type": the device type, "tap", "user", ... (json-string)
 939 - "id": the device's ID, must be unique (json-string)
 940 - device options
 941
 942 Example:
 943
 944 -> { "execute": "netdev_add",
 945      "arguments": { "type": "user", "id": "netdev1",
 946                     "dnssearch": "example.org" } }
 947 <- { "return": {} }
 948
 949 Note: The supported device options are the same ones supported by the '-netdev'
 950       command-line argument, which are listed in the '-help' output or QEMU's
 951       manual
 952
 953 EQMP
 954
 955     {
 956         .name       = "netdev_del",
 957         .args_type  = "id:s",
 958         .mhandler.cmd_new = qmp_marshal_netdev_del,
 959     },
 960
 961 SQMP
 962 netdev_del
 963 ----------
 964
 965 Remove host network device.
 966
 967 Arguments:
 968
 969 - "id": the device's ID, must be unique (json-string)
 970
 971 Example:
 972
 973 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
 974 <- { "return": {} }
 975
 976
 977 EQMP
 978
 979     {
 980         .name       = "object-add",
 981         .args_type  = "qom-type:s,id:s,props:q?",
 982         .mhandler.cmd_new = qmp_marshal_object_add,
 983     },
 984
 985 SQMP
 986 object-add
 987 ----------
 988
 989 Create QOM object.
 990
 991 Arguments:
 992
 993 - "qom-type": the object's QOM type, i.e. the class name (json-string)
 994 - "id": the object's ID, must be unique (json-string)
 995 - "props": a dictionary of object property values (optional, json-dict)
 996
 997 Example:
 998
 999 -> { "execute": "object-add", "arguments": { "qom-type": "rng-random", "id": "rng1",
1000      "props": { "filename": "/dev/hwrng" } } }
1001 <- { "return": {} }
1002
1003 EQMP
1004
1005     {
1006         .name       = "object-del",
1007         .args_type  = "id:s",
1008         .mhandler.cmd_new = qmp_marshal_object_del,
1009     },
1010
1011 SQMP
1012 object-del
1013 ----------
1014
1015 Remove QOM object.
1016
1017 Arguments:
1018
1019 - "id": the object's ID (json-string)
1020
1021 Example:
1022
1023 -> { "execute": "object-del", "arguments": { "id": "rng1" } }
1024 <- { "return": {} }
1025
1026
1027 EQMP
1028
1029
1030     {
1031         .name       = "block_resize",
1032         .args_type  = "device:s?,node-name:s?,size:o",
1033         .mhandler.cmd_new = qmp_marshal_block_resize,
1034     },
1035
1036 SQMP
1037 block_resize
1038 ------------
1039
1040 Resize a block image while a guest is running.
1041
1042 Arguments:
1043
1044 - "device": the device's ID, must be unique (json-string)
1045 - "node-name": the node name in the block driver state graph (json-string)
1046 - "size": new size
1047
1048 Example:
1049
1050 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
1051 <- { "return": {} }
1052
1053 EQMP
1054
1055     {
1056         .name       = "block-stream",
1057         .args_type  = "device:B,base:s?,speed:o?,backing-file:s?,on-error:s?",
1058         .mhandler.cmd_new = qmp_marshal_block_stream,
1059     },
1060
1061 SQMP
1062 block-stream
1063 ------------
1064
1065 Copy data from a backing file into a block device.
1066
1067 Arguments:
1068
1069 - "device": The device's ID, must be unique (json-string)
1070 - "base": The file name of the backing image above which copying starts
1071           (json-string, optional)
1072 - "backing-file": The backing file string to write into the active layer. This
1073                   filename is not validated.
1074
1075                   If a pathname string is such that it cannot be resolved by
1076                   QEMU, that means that subsequent QMP or HMP commands must use
1077                   node-names for the image in question, as filename lookup
1078                   methods will fail.
1079
1080                   If not specified, QEMU will automatically determine the
1081                   backing file string to use, or error out if there is no
1082                   obvious choice.  Care should be taken when specifying the
1083                   string, to specify a valid filename or protocol.
1084                   (json-string, optional) (Since 2.1)
1085 - "speed":  the maximum speed, in bytes per second (json-int, optional)
1086 - "on-error": the action to take on an error (default 'report').  'stop' and
1087               'enospc' can only be used if the block device supports io-status.
1088               (json-string, optional) (Since 2.1)
1089
1090 Example:
1091
1092 -> { "execute": "block-stream", "arguments": { "device": "virtio0",
1093                                                "base": "/tmp/master.qcow2" } }
1094 <- { "return": {} }
1095
1096 EQMP
1097
1098     {
1099         .name       = "block-commit",
1100         .args_type  = "device:B,base:s?,top:s?,backing-file:s?,speed:o?",
1101         .mhandler.cmd_new = qmp_marshal_block_commit,
1102     },
1103
1104 SQMP
1105 block-commit
1106 ------------
1107
1108 Live commit of data from overlay image nodes into backing nodes - i.e., writes
1109 data between 'top' and 'base' into 'base'.
1110
1111 Arguments:
1112
1113 - "device": The device's ID, must be unique (json-string)
1114 - "base": The file name of the backing image to write data into.
1115           If not specified, this is the deepest backing image
1116           (json-string, optional)
1117 - "top":  The file name of the backing image within the image chain,
1118           which contains the topmost data to be committed down. If
1119           not specified, this is the active layer. (json-string, optional)
1120
1121 - backing-file:     The backing file string to write into the overlay
1122                     image of 'top'.  If 'top' is the active layer,
1123                     specifying a backing file string is an error. This
1124                     filename is not validated.
1125
1126                     If a pathname string is such that it cannot be
1127                     resolved by QEMU, that means that subsequent QMP or
1128                     HMP commands must use node-names for the image in
1129                     question, as filename lookup methods will fail.
1130
1131                     If not specified, QEMU will automatically determine
1132                     the backing file string to use, or error out if
1133                     there is no obvious choice. Care should be taken
1134                     when specifying the string, to specify a valid
1135                     filename or protocol.
1136                     (json-string, optional) (Since 2.1)
1137
1138           If top == base, that is an error.
1139           If top == active, the job will not be completed by itself,
1140           user needs to complete the job with the block-job-complete
1141           command after getting the ready event. (Since 2.0)
1142
1143           If the base image is smaller than top, then the base image
1144           will be resized to be the same size as top.  If top is
1145           smaller than the base image, the base will not be
1146           truncated.  If you want the base image size to match the
1147           size of the smaller top, you can safely truncate it
1148           yourself once the commit operation successfully completes.
1149           (json-string)
1150 - "speed":  the maximum speed, in bytes per second (json-int, optional)
1151
1152
1153 Example:
1154
1155 -> { "execute": "block-commit", "arguments": { "device": "virtio0",
1156                                               "top": "/tmp/snap1.qcow2" } }
1157 <- { "return": {} }
1158
1159 EQMP
1160
1161     {
1162         .name       = "drive-backup",
1163         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1164                       "bitmap:s?,on-source-error:s?,on-target-error:s?",
1165         .mhandler.cmd_new = qmp_marshal_drive_backup,
1166     },
1167
1168 SQMP
1169 drive-backup
1170 ------------
1171
1172 Start a point-in-time copy of a block device to a new destination.  The
1173 status of ongoing drive-backup operations can be checked with
1174 query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1175 The operation can be stopped before it has completed using the
1176 block-job-cancel command.
1177
1178 Arguments:
1179
1180 - "device": the name of the device which should be copied.
1181             (json-string)
1182 - "target": the target of the new image. If the file exists, or if it is a
1183             device, the existing file/device will be used as the new
1184             destination.  If it does not exist, a new file will be created.
1185             (json-string)
1186 - "format": the format of the new destination, default is to probe if 'mode' is
1187             'existing', else the format of the source
1188             (json-string, optional)
1189 - "sync": what parts of the disk image should be copied to the destination;
1190   possibilities include "full" for all the disk, "top" for only the sectors
1191   allocated in the topmost image, "incremental" for only the dirty sectors in
1192   the bitmap, or "none" to only replicate new I/O (MirrorSyncMode).
1193 - "bitmap": dirty bitmap name for sync==incremental. Must be present if sync
1194             is "incremental", must NOT be present otherwise.
1195 - "mode": whether and how QEMU should create a new image
1196           (NewImageMode, optional, default 'absolute-paths')
1197 - "speed": the maximum speed, in bytes per second (json-int, optional)
1198 - "on-source-error": the action to take on an error on the source, default
1199                      'report'.  'stop' and 'enospc' can only be used
1200                      if the block device supports io-status.
1201                      (BlockdevOnError, optional)
1202 - "on-target-error": the action to take on an error on the target, default
1203                      'report' (no limitations, since this applies to
1204                      a different block device than device).
1205                      (BlockdevOnError, optional)
1206
1207 Example:
1208 -> { "execute": "drive-backup", "arguments": { "device": "drive0",
1209                                                "sync": "full",
1210                                                "target": "backup.img" } }
1211 <- { "return": {} }
1212
1213 EQMP
1214
1215     {
1216         .name       = "blockdev-backup",
1217         .args_type  = "sync:s,device:B,target:B,speed:i?,"
1218                       "on-source-error:s?,on-target-error:s?",
1219         .mhandler.cmd_new = qmp_marshal_blockdev_backup,
1220     },
1221
1222 SQMP
1223 blockdev-backup
1224 ---------------
1225
1226 The device version of drive-backup: this command takes an existing named device
1227 as backup target.
1228
1229 Arguments:
1230
1231 - "device": the name of the device which should be copied.
1232             (json-string)
1233 - "target": the name of the backup target device. (json-string)
1234 - "sync": what parts of the disk image should be copied to the destination;
1235           possibilities include "full" for all the disk, "top" for only the
1236           sectors allocated in the topmost image, or "none" to only replicate
1237           new I/O (MirrorSyncMode).
1238 - "speed": the maximum speed, in bytes per second (json-int, optional)
1239 - "on-source-error": the action to take on an error on the source, default
1240                      'report'.  'stop' and 'enospc' can only be used
1241                      if the block device supports io-status.
1242                      (BlockdevOnError, optional)
1243 - "on-target-error": the action to take on an error on the target, default
1244                      'report' (no limitations, since this applies to
1245                      a different block device than device).
1246                      (BlockdevOnError, optional)
1247
1248 Example:
1249 -> { "execute": "blockdev-backup", "arguments": { "device": "src-id",
1250                                                   "sync": "full",
1251                                                   "target": "tgt-id" } }
1252 <- { "return": {} }
1253
1254 EQMP
1255
1256     {
1257         .name       = "block-job-set-speed",
1258         .args_type  = "device:B,speed:o",
1259         .mhandler.cmd_new = qmp_marshal_block_job_set_speed,
1260     },
1261
1262     {
1263         .name       = "block-job-cancel",
1264         .args_type  = "device:B,force:b?",
1265         .mhandler.cmd_new = qmp_marshal_block_job_cancel,
1266     },
1267     {
1268         .name       = "block-job-pause",
1269         .args_type  = "device:B",
1270         .mhandler.cmd_new = qmp_marshal_block_job_pause,
1271     },
1272     {
1273         .name       = "block-job-resume",
1274         .args_type  = "device:B",
1275         .mhandler.cmd_new = qmp_marshal_block_job_resume,
1276     },
1277     {
1278         .name       = "block-job-complete",
1279         .args_type  = "device:B",
1280         .mhandler.cmd_new = qmp_marshal_block_job_complete,
1281     },
1282     {
1283         .name       = "transaction",
1284         .args_type  = "actions:q",
1285         .mhandler.cmd_new = qmp_marshal_transaction,
1286     },
1287
1288 SQMP
1289 transaction
1290 -----------
1291
1292 Atomically operate on one or more block devices.  Operations that are
1293 currently supported:
1294
1295     - drive-backup
1296     - blockdev-backup
1297     - blockdev-snapshot-sync
1298     - blockdev-snapshot-internal-sync
1299     - abort
1300     - block-dirty-bitmap-add
1301     - block-dirty-bitmap-clear
1302
1303 Refer to the qemu/qapi-schema.json file for minimum required QEMU
1304 versions for these operations.  A list of dictionaries is accepted,
1305 that contains the actions to be performed.  If there is any failure
1306 performing any of the operations, all operations for the group are
1307 abandoned.
1308
1309 For external snapshots, the dictionary contains the device, the file to use for
1310 the new snapshot, and the format.  The default format, if not specified, is
1311 qcow2.
1312
1313 Each new snapshot defaults to being created by QEMU (wiping any
1314 contents if the file already exists), but it is also possible to reuse
1315 an externally-created file.  In the latter case, you should ensure that
1316 the new image file has the same contents as the current one; QEMU cannot
1317 perform any meaningful check.  Typically this is achieved by using the
1318 current image file as the backing file for the new image.
1319
1320 On failure, the original disks pre-snapshot attempt will be used.
1321
1322 For internal snapshots, the dictionary contains the device and the snapshot's
1323 name.  If an internal snapshot matching name already exists, the request will
1324 be rejected.  Only some image formats support it, for example, qcow2, rbd,
1325 and sheepdog.
1326
1327 On failure, qemu will try delete the newly created internal snapshot in the
1328 transaction.  When an I/O error occurs during deletion, the user needs to fix
1329 it later with qemu-img or other command.
1330
1331 Arguments:
1332
1333 actions array:
1334     - "type": the operation to perform (json-string).  Possible
1335               values: "drive-backup", "blockdev-backup",
1336                       "blockdev-snapshot-sync",
1337                       "blockdev-snapshot-internal-sync",
1338                       "abort", "block-dirty-bitmap-add",
1339                       "block-dirty-bitmap-clear"
1340     - "data": a dictionary.  The contents depend on the value
1341       of "type".  When "type" is "blockdev-snapshot-sync":
1342       - "device": device name to snapshot (json-string)
1343       - "node-name": graph node name to snapshot (json-string)
1344       - "snapshot-file": name of new image file (json-string)
1345       - "snapshot-node-name": graph node name of the new snapshot (json-string)
1346       - "format": format of new image (json-string, optional)
1347       - "mode": whether and how QEMU should create the snapshot file
1348         (NewImageMode, optional, default "absolute-paths")
1349       When "type" is "blockdev-snapshot-internal-sync":
1350       - "device": device name to snapshot (json-string)
1351       - "name": name of the new snapshot (json-string)
1352
1353 Example:
1354
1355 -> { "execute": "transaction",
1356      "arguments": { "actions": [
1357          { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
1358                                          "snapshot-file": "/some/place/my-image",
1359                                          "format": "qcow2" } },
1360          { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
1361                                          "snapshot-file": "/some/place/my-image2",
1362                                          "snapshot-node-name": "node3432",
1363                                          "mode": "existing",
1364                                          "format": "qcow2" } },
1365          { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
1366                                          "snapshot-file": "/some/place/my-image2",
1367                                          "mode": "existing",
1368                                          "format": "qcow2" } },
1369          { "type": "blockdev-snapshot-internal-sync", "data" : {
1370                                          "device": "ide-hd2",
1371                                          "name": "snapshot0" } } ] } }
1372 <- { "return": {} }
1373
1374 EQMP
1375
1376     {
1377         .name       = "block-dirty-bitmap-add",
1378         .args_type  = "node:B,name:s,granularity:i?",
1379         .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_add,
1380     },
1381
1382 SQMP
1383
1384 block-dirty-bitmap-add
1385 ----------------------
1386 Since 2.4
1387
1388 Create a dirty bitmap with a name on the device, and start tracking the writes.
1389
1390 Arguments:
1391
1392 - "node": device/node on which to create dirty bitmap (json-string)
1393 - "name": name of the new dirty bitmap (json-string)
1394 - "granularity": granularity to track writes with (int, optional)
1395
1396 Example:
1397
1398 -> { "execute": "block-dirty-bitmap-add", "arguments": { "node": "drive0",
1399                                                    "name": "bitmap0" } }
1400 <- { "return": {} }
1401
1402 EQMP
1403
1404     {
1405         .name       = "block-dirty-bitmap-remove",
1406         .args_type  = "node:B,name:s",
1407         .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_remove,
1408     },
1409
1410 SQMP
1411
1412 block-dirty-bitmap-remove
1413 -------------------------
1414 Since 2.4
1415
1416 Stop write tracking and remove the dirty bitmap that was created with
1417 block-dirty-bitmap-add.
1418
1419 Arguments:
1420
1421 - "node": device/node on which to remove dirty bitmap (json-string)
1422 - "name": name of the dirty bitmap to remove (json-string)
1423
1424 Example:
1425
1426 -> { "execute": "block-dirty-bitmap-remove", "arguments": { "node": "drive0",
1427                                                       "name": "bitmap0" } }
1428 <- { "return": {} }
1429
1430 EQMP
1431
1432     {
1433         .name       = "block-dirty-bitmap-clear",
1434         .args_type  = "node:B,name:s",
1435         .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_clear,
1436     },
1437
1438 SQMP
1439
1440 block-dirty-bitmap-clear
1441 ------------------------
1442 Since 2.4
1443
1444 Reset the dirty bitmap associated with a node so that an incremental backup
1445 from this point in time forward will only backup clusters modified after this
1446 clear operation.
1447
1448 Arguments:
1449
1450 - "node": device/node on which to remove dirty bitmap (json-string)
1451 - "name": name of the dirty bitmap to remove (json-string)
1452
1453 Example:
1454
1455 -> { "execute": "block-dirty-bitmap-clear", "arguments": { "node": "drive0",
1456                                                            "name": "bitmap0" } }
1457 <- { "return": {} }
1458
1459 EQMP
1460
1461     {
1462         .name       = "blockdev-snapshot-sync",
1463         .args_type  = "device:s?,node-name:s?,snapshot-file:s,snapshot-node-name:s?,format:s?,mode:s?",
1464         .mhandler.cmd_new = qmp_marshal_blockdev_snapshot_sync,
1465     },
1466
1467 SQMP
1468 blockdev-snapshot-sync
1469 ----------------------
1470
1471 Synchronous snapshot of a block device. snapshot-file specifies the
1472 target of the new image. If the file exists, or if it is a device, the
1473 snapshot will be created in the existing file/device. If does not
1474 exist, a new file will be created. format specifies the format of the
1475 snapshot image, default is qcow2.
1476
1477 Arguments:
1478
1479 - "device": device name to snapshot (json-string)
1480 - "node-name": graph node name to snapshot (json-string)
1481 - "snapshot-file": name of new image file (json-string)
1482 - "snapshot-node-name": graph node name of the new snapshot (json-string)
1483 - "mode": whether and how QEMU should create the snapshot file
1484   (NewImageMode, optional, default "absolute-paths")
1485 - "format": format of new image (json-string, optional)
1486
1487 Example:
1488
1489 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1490                                                          "snapshot-file":
1491                                                         "/some/place/my-image",
1492                                                         "format": "qcow2" } }
1493 <- { "return": {} }
1494
1495 EQMP
1496
1497     {
1498         .name       = "blockdev-snapshot",
1499         .args_type  = "node:s,overlay:s",
1500         .mhandler.cmd_new = qmp_marshal_blockdev_snapshot,
1501     },
1502
1503 SQMP
1504 blockdev-snapshot
1505 -----------------
1506 Since 2.5
1507
1508 Create a snapshot, by installing 'node' as the backing image of
1509 'overlay'. Additionally, if 'node' is associated with a block
1510 device, the block device changes to using 'overlay' as its new active
1511 image.
1512
1513 Arguments:
1514
1515 - "node": device that will have a snapshot created (json-string)
1516 - "overlay": device that will have 'node' as its backing image (json-string)
1517
1518 Example:
1519
1520 -> { "execute": "blockdev-add",
1521                 "arguments": { "options": { "driver": "qcow2",
1522                                             "node-name": "node1534",
1523                                             "file": { "driver": "file",
1524                                                       "filename": "hd1.qcow2" },
1525                                             "backing": "" } } }
1526
1527 <- { "return": {} }
1528
1529 -> { "execute": "blockdev-snapshot", "arguments": { "node": "ide-hd0",
1530                                                     "overlay": "node1534" } }
1531 <- { "return": {} }
1532
1533 EQMP
1534
1535     {
1536         .name       = "blockdev-snapshot-internal-sync",
1537         .args_type  = "device:B,name:s",
1538         .mhandler.cmd_new = qmp_marshal_blockdev_snapshot_internal_sync,
1539     },
1540
1541 SQMP
1542 blockdev-snapshot-internal-sync
1543 -------------------------------
1544
1545 Synchronously take an internal snapshot of a block device when the format of
1546 image used supports it.  If the name is an empty string, or a snapshot with
1547 name already exists, the operation will fail.
1548
1549 Arguments:
1550
1551 - "device": device name to snapshot (json-string)
1552 - "name": name of the new snapshot (json-string)
1553
1554 Example:
1555
1556 -> { "execute": "blockdev-snapshot-internal-sync",
1557                 "arguments": { "device": "ide-hd0",
1558                                "name": "snapshot0" }
1559    }
1560 <- { "return": {} }
1561
1562 EQMP
1563
1564     {
1565         .name       = "blockdev-snapshot-delete-internal-sync",
1566         .args_type  = "device:B,id:s?,name:s?",
1567         .mhandler.cmd_new =
1568                       qmp_marshal_blockdev_snapshot_delete_internal_sync,
1569     },
1570
1571 SQMP
1572 blockdev-snapshot-delete-internal-sync
1573 --------------------------------------
1574
1575 Synchronously delete an internal snapshot of a block device when the format of
1576 image used supports it.  The snapshot is identified by name or id or both.  One
1577 of name or id is required.  If the snapshot is not found, the operation will
1578 fail.
1579
1580 Arguments:
1581
1582 - "device": device name (json-string)
1583 - "id": ID of the snapshot (json-string, optional)
1584 - "name": name of the snapshot (json-string, optional)
1585
1586 Example:
1587
1588 -> { "execute": "blockdev-snapshot-delete-internal-sync",
1589                 "arguments": { "device": "ide-hd0",
1590                                "name": "snapshot0" }
1591    }
1592 <- { "return": {
1593                    "id": "1",
1594                    "name": "snapshot0",
1595                    "vm-state-size": 0,
1596                    "date-sec": 1000012,
1597                    "date-nsec": 10,
1598                    "vm-clock-sec": 100,
1599                    "vm-clock-nsec": 20
1600      }
1601    }
1602
1603 EQMP
1604
1605     {
1606         .name       = "drive-mirror",
1607         .args_type  = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1608                       "node-name:s?,replaces:s?,"
1609                       "on-source-error:s?,on-target-error:s?,"
1610                       "unmap:b?,"
1611                       "granularity:i?,buf-size:i?",
1612         .mhandler.cmd_new = qmp_marshal_drive_mirror,
1613     },
1614
1615 SQMP
1616 drive-mirror
1617 ------------
1618
1619 Start mirroring a block device's writes to a new destination. target
1620 specifies the target of the new image. If the file exists, or if it is
1621 a device, it will be used as the new destination for writes. If it does not
1622 exist, a new file will be created. format specifies the format of the
1623 mirror image, default is to probe if mode='existing', else the format
1624 of the source.
1625
1626 Arguments:
1627
1628 - "device": device name to operate on (json-string)
1629 - "target": name of new image file (json-string)
1630 - "format": format of new image (json-string, optional)
1631 - "node-name": the name of the new block driver state in the node graph
1632                (json-string, optional)
1633 - "replaces": the block driver node name to replace when finished
1634               (json-string, optional)
1635 - "mode": how an image file should be created into the target
1636   file/device (NewImageMode, optional, default 'absolute-paths')
1637 - "speed": maximum speed of the streaming job, in bytes per second
1638   (json-int)
1639 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1640 - "buf_size": maximum amount of data in flight from source to target, in bytes
1641   (json-int, default 10M)
1642 - "sync": what parts of the disk image should be copied to the destination;
1643   possibilities include "full" for all the disk, "top" for only the sectors
1644   allocated in the topmost image, or "none" to only replicate new I/O
1645   (MirrorSyncMode).
1646 - "on-source-error": the action to take on an error on the source
1647   (BlockdevOnError, default 'report')
1648 - "on-target-error": the action to take on an error on the target
1649   (BlockdevOnError, default 'report')
1650 - "unmap": whether the target sectors should be discarded where source has only
1651   zeroes. (json-bool, optional, default true)
1652
1653 The default value of the granularity is the image cluster size clamped
1654 between 4096 and 65536, if the image format defines one.  If the format
1655 does not define a cluster size, the default value of the granularity
1656 is 65536.
1657
1658
1659 Example:
1660
1661 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1662                                                "target": "/some/place/my-image",
1663                                                "sync": "full",
1664                                                "format": "qcow2" } }
1665 <- { "return": {} }
1666
1667 EQMP
1668
1669     {
1670         .name       = "change-backing-file",
1671         .args_type  = "device:s,image-node-name:s,backing-file:s",
1672         .mhandler.cmd_new = qmp_marshal_change_backing_file,
1673     },
1674
1675 SQMP
1676 change-backing-file
1677 -------------------
1678 Since: 2.1
1679
1680 Change the backing file in the image file metadata.  This does not cause
1681 QEMU to reopen the image file to reparse the backing filename (it may,
1682 however, perform a reopen to change permissions from r/o -> r/w -> r/o,
1683 if needed). The new backing file string is written into the image file
1684 metadata, and the QEMU internal strings are updated.
1685
1686 Arguments:
1687
1688 - "image-node-name":    The name of the block driver state node of the
1689                         image to modify.  The "device" is argument is used to
1690                         verify "image-node-name" is in the chain described by
1691                         "device".
1692                         (json-string, optional)
1693
1694 - "device":             The name of the device.
1695                         (json-string)
1696
1697 - "backing-file":       The string to write as the backing file.  This string is
1698                         not validated, so care should be taken when specifying
1699                         the string or the image chain may not be able to be
1700                         reopened again.
1701                         (json-string)
1702
1703 Returns: Nothing on success
1704          If "device" does not exist or cannot be determined, DeviceNotFound
1705
1706 EQMP
1707
1708     {
1709         .name       = "balloon",
1710         .args_type  = "value:M",
1711         .mhandler.cmd_new = qmp_marshal_balloon,
1712     },
1713
1714 SQMP
1715 balloon
1716 -------
1717
1718 Request VM to change its memory allocation (in bytes).
1719
1720 Arguments:
1721
1722 - "value": New memory allocation (json-int)
1723
1724 Example:
1725
1726 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1727 <- { "return": {} }
1728
1729 EQMP
1730
1731     {
1732         .name       = "set_link",
1733         .args_type  = "name:s,up:b",
1734         .mhandler.cmd_new = qmp_marshal_set_link,
1735     },
1736
1737 SQMP
1738 set_link
1739 --------
1740
1741 Change the link status of a network adapter.
1742
1743 Arguments:
1744
1745 - "name": network device name (json-string)
1746 - "up": status is up (json-bool)
1747
1748 Example:
1749
1750 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1751 <- { "return": {} }
1752
1753 EQMP
1754
1755     {
1756         .name       = "getfd",
1757         .args_type  = "fdname:s",
1758         .params     = "getfd name",
1759         .help       = "receive a file descriptor via SCM rights and assign it a name",
1760         .mhandler.cmd_new = qmp_marshal_getfd,
1761     },
1762
1763 SQMP
1764 getfd
1765 -----
1766
1767 Receive a file descriptor via SCM rights and assign it a name.
1768
1769 Arguments:
1770
1771 - "fdname": file descriptor name (json-string)
1772
1773 Example:
1774
1775 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1776 <- { "return": {} }
1777
1778 Notes:
1779
1780 (1) If the name specified by the "fdname" argument already exists,
1781     the file descriptor assigned to it will be closed and replaced
1782     by the received file descriptor.
1783 (2) The 'closefd' command can be used to explicitly close the file
1784     descriptor when it is no longer needed.
1785
1786 EQMP
1787
1788     {
1789         .name       = "closefd",
1790         .args_type  = "fdname:s",
1791         .params     = "closefd name",
1792         .help       = "close a file descriptor previously passed via SCM rights",
1793         .mhandler.cmd_new = qmp_marshal_closefd,
1794     },
1795
1796 SQMP
1797 closefd
1798 -------
1799
1800 Close a file descriptor previously passed via SCM rights.
1801
1802 Arguments:
1803
1804 - "fdname": file descriptor name (json-string)
1805
1806 Example:
1807
1808 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1809 <- { "return": {} }
1810
1811 EQMP
1812
1813      {
1814         .name       = "add-fd",
1815         .args_type  = "fdset-id:i?,opaque:s?",
1816         .params     = "add-fd fdset-id opaque",
1817         .help       = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1818         .mhandler.cmd_new = qmp_marshal_add_fd,
1819     },
1820
1821 SQMP
1822 add-fd
1823 -------
1824
1825 Add a file descriptor, that was passed via SCM rights, to an fd set.
1826
1827 Arguments:
1828
1829 - "fdset-id": The ID of the fd set to add the file descriptor to.
1830               (json-int, optional)
1831 - "opaque": A free-form string that can be used to describe the fd.
1832             (json-string, optional)
1833
1834 Return a json-object with the following information:
1835
1836 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1837 - "fd": The file descriptor that was received via SCM rights and added to the
1838         fd set. (json-int)
1839
1840 Example:
1841
1842 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1843 <- { "return": { "fdset-id": 1, "fd": 3 } }
1844
1845 Notes:
1846
1847 (1) The list of fd sets is shared by all monitor connections.
1848 (2) If "fdset-id" is not specified, a new fd set will be created.
1849
1850 EQMP
1851
1852      {
1853         .name       = "remove-fd",
1854         .args_type  = "fdset-id:i,fd:i?",
1855         .params     = "remove-fd fdset-id fd",
1856         .help       = "Remove a file descriptor from an fd set",
1857         .mhandler.cmd_new = qmp_marshal_remove_fd,
1858     },
1859
1860 SQMP
1861 remove-fd
1862 ---------
1863
1864 Remove a file descriptor from an fd set.
1865
1866 Arguments:
1867
1868 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1869               (json-int)
1870 - "fd": The file descriptor that is to be removed. (json-int, optional)
1871
1872 Example:
1873
1874 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1875 <- { "return": {} }
1876
1877 Notes:
1878
1879 (1) The list of fd sets is shared by all monitor connections.
1880 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1881     removed.
1882
1883 EQMP
1884
1885     {
1886         .name       = "query-fdsets",
1887         .args_type  = "",
1888         .help       = "Return information describing all fd sets",
1889         .mhandler.cmd_new = qmp_marshal_query_fdsets,
1890     },
1891
1892 SQMP
1893 query-fdsets
1894 -------------
1895
1896 Return information describing all fd sets.
1897
1898 Arguments: None
1899
1900 Example:
1901
1902 -> { "execute": "query-fdsets" }
1903 <- { "return": [
1904        {
1905          "fds": [
1906            {
1907              "fd": 30,
1908              "opaque": "rdonly:/path/to/file"
1909            },
1910            {
1911              "fd": 24,
1912              "opaque": "rdwr:/path/to/file"
1913            }
1914          ],
1915          "fdset-id": 1
1916        },
1917        {
1918          "fds": [
1919            {
1920              "fd": 28
1921            },
1922            {
1923              "fd": 29
1924            }
1925          ],
1926          "fdset-id": 0
1927        }
1928      ]
1929    }
1930
1931 Note: The list of fd sets is shared by all monitor connections.
1932
1933 EQMP
1934
1935     {
1936         .name       = "block_passwd",
1937         .args_type  = "device:s?,node-name:s?,password:s",
1938         .mhandler.cmd_new = qmp_marshal_block_passwd,
1939     },
1940
1941 SQMP
1942 block_passwd
1943 ------------
1944
1945 Set the password of encrypted block devices.
1946
1947 Arguments:
1948
1949 - "device": device name (json-string)
1950 - "node-name": name in the block driver state graph (json-string)
1951 - "password": password (json-string)
1952
1953 Example:
1954
1955 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1956                                                "password": "12345" } }
1957 <- { "return": {} }
1958
1959 EQMP
1960
1961     {
1962         .name       = "block_set_io_throttle",
1963         .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?,group:s?",
1964         .mhandler.cmd_new = qmp_marshal_block_set_io_throttle,
1965     },
1966
1967 SQMP
1968 block_set_io_throttle
1969 ------------
1970
1971 Change I/O throttle limits for a block drive.
1972
1973 Arguments:
1974
1975 - "device": device name (json-string)
1976 - "bps": total throughput limit in bytes per second (json-int)
1977 - "bps_rd": read throughput limit in bytes per second (json-int)
1978 - "bps_wr": write throughput limit in bytes per second (json-int)
1979 - "iops": total I/O operations per second (json-int)
1980 - "iops_rd": read I/O operations per second (json-int)
1981 - "iops_wr": write I/O operations per second (json-int)
1982 - "bps_max":  total max in bytes (json-int)
1983 - "bps_rd_max":  read max in bytes (json-int)
1984 - "bps_wr_max":  write max in bytes (json-int)
1985 - "iops_max":  total I/O operations max (json-int)
1986 - "iops_rd_max":  read I/O operations max (json-int)
1987 - "iops_wr_max":  write I/O operations max (json-int)
1988 - "iops_size":  I/O size in bytes when limiting (json-int)
1989 - "group": throttle group name (json-string)
1990
1991 Example:
1992
1993 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
1994                                                "bps": 1000000,
1995                                                "bps_rd": 0,
1996                                                "bps_wr": 0,
1997                                                "iops": 0,
1998                                                "iops_rd": 0,
1999                                                "iops_wr": 0,
2000                                                "bps_max": 8000000,
2001                                                "bps_rd_max": 0,
2002                                                "bps_wr_max": 0,
2003                                                "iops_max": 0,
2004                                                "iops_rd_max": 0,
2005                                                "iops_wr_max": 0,
2006                                                "iops_size": 0 } }
2007 <- { "return": {} }
2008
2009 EQMP
2010
2011     {
2012         .name       = "set_password",
2013         .args_type  = "protocol:s,password:s,connected:s?",
2014         .mhandler.cmd_new = qmp_marshal_set_password,
2015     },
2016
2017 SQMP
2018 set_password
2019 ------------
2020
2021 Set the password for vnc/spice protocols.
2022
2023 Arguments:
2024
2025 - "protocol": protocol name (json-string)
2026 - "password": password (json-string)
2027 - "connected": [ keep | disconnect | fail ] (json-string, optional)
2028
2029 Example:
2030
2031 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
2032                                                "password": "secret" } }
2033 <- { "return": {} }
2034
2035 EQMP
2036
2037     {
2038         .name       = "expire_password",
2039         .args_type  = "protocol:s,time:s",
2040         .mhandler.cmd_new = qmp_marshal_expire_password,
2041     },
2042
2043 SQMP
2044 expire_password
2045 ---------------
2046
2047 Set the password expire time for vnc/spice protocols.
2048
2049 Arguments:
2050
2051 - "protocol": protocol name (json-string)
2052 - "time": [ now | never | +secs | secs ] (json-string)
2053
2054 Example:
2055
2056 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
2057                                                   "time": "+60" } }
2058 <- { "return": {} }
2059
2060 EQMP
2061
2062     {
2063         .name       = "add_client",
2064         .args_type  = "protocol:s,fdname:s,skipauth:b?,tls:b?",
2065         .mhandler.cmd_new = qmp_marshal_add_client,
2066     },
2067
2068 SQMP
2069 add_client
2070 ----------
2071
2072 Add a graphics client
2073
2074 Arguments:
2075
2076 - "protocol": protocol name (json-string)
2077 - "fdname": file descriptor name (json-string)
2078 - "skipauth": whether to skip authentication (json-bool, optional)
2079 - "tls": whether to perform TLS (json-bool, optional)
2080
2081 Example:
2082
2083 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
2084                                              "fdname": "myclient" } }
2085 <- { "return": {} }
2086
2087 EQMP
2088     {
2089         .name       = "qmp_capabilities",
2090         .args_type  = "",
2091         .params     = "",
2092         .help       = "enable QMP capabilities",
2093         .mhandler.cmd_new = qmp_capabilities,
2094     },
2095
2096 SQMP
2097 qmp_capabilities
2098 ----------------
2099
2100 Enable QMP capabilities.
2101
2102 Arguments: None.
2103
2104 Example:
2105
2106 -> { "execute": "qmp_capabilities" }
2107 <- { "return": {} }
2108
2109 Note: This command must be issued before issuing any other command.
2110
2111 EQMP
2112
2113     {
2114         .name       = "human-monitor-command",
2115         .args_type  = "command-line:s,cpu-index:i?",
2116         .mhandler.cmd_new = qmp_marshal_human_monitor_command,
2117     },
2118
2119 SQMP
2120 human-monitor-command
2121 ---------------------
2122
2123 Execute a Human Monitor command.
2124
2125 Arguments:
2126
2127 - command-line: the command name and its arguments, just like the
2128                 Human Monitor's shell (json-string)
2129 - cpu-index: select the CPU number to be used by commands which access CPU
2130              data, like 'info registers'. The Monitor selects CPU 0 if this
2131              argument is not provided (json-int, optional)
2132
2133 Example:
2134
2135 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
2136 <- { "return": "kvm support: enabled\r\n" }
2137
2138 Notes:
2139
2140 (1) The Human Monitor is NOT an stable interface, this means that command
2141     names, arguments and responses can change or be removed at ANY time.
2142     Applications that rely on long term stability guarantees should NOT
2143     use this command
2144
2145 (2) Limitations:
2146
2147     o This command is stateless, this means that commands that depend
2148       on state information (such as getfd) might not work
2149
2150     o Commands that prompt the user for data (eg. 'cont' when the block
2151       device is encrypted) don't currently work
2152
2153 3. Query Commands
2154 =================
2155
2156 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
2157 HXCOMM this! We will possibly move query commands definitions inside those
2158 HXCOMM sections, just like regular commands.
2159
2160 EQMP
2161
2162 SQMP
2163 query-version
2164 -------------
2165
2166 Show QEMU version.
2167
2168 Return a json-object with the following information:
2169
2170 - "qemu": A json-object containing three integer values:
2171     - "major": QEMU's major version (json-int)
2172     - "minor": QEMU's minor version (json-int)
2173     - "micro": QEMU's micro version (json-int)
2174 - "package": package's version (json-string)
2175
2176 Example:
2177
2178 -> { "execute": "query-version" }
2179 <- {
2180       "return":{
2181          "qemu":{
2182             "major":0,
2183             "minor":11,
2184             "micro":5
2185          },
2186          "package":""
2187       }
2188    }
2189
2190 EQMP
2191
2192     {
2193         .name       = "query-version",
2194         .args_type  = "",
2195         .mhandler.cmd_new = qmp_marshal_query_version,
2196     },
2197
2198 SQMP
2199 query-commands
2200 --------------
2201
2202 List QMP available commands.
2203
2204 Each command is represented by a json-object, the returned value is a json-array
2205 of all commands.
2206
2207 Each json-object contain:
2208
2209 - "name": command's name (json-string)
2210
2211 Example:
2212
2213 -> { "execute": "query-commands" }
2214 <- {
2215       "return":[
2216          {
2217             "name":"query-balloon"
2218          },
2219          {
2220             "name":"system_powerdown"
2221          }
2222       ]
2223    }
2224
2225 Note: This example has been shortened as the real response is too long.
2226
2227 EQMP
2228
2229     {
2230         .name       = "query-commands",
2231         .args_type  = "",
2232         .mhandler.cmd_new = qmp_marshal_query_commands,
2233     },
2234
2235 SQMP
2236 query-events
2237 --------------
2238
2239 List QMP available events.
2240
2241 Each event is represented by a json-object, the returned value is a json-array
2242 of all events.
2243
2244 Each json-object contains:
2245
2246 - "name": event's name (json-string)
2247
2248 Example:
2249
2250 -> { "execute": "query-events" }
2251 <- {
2252       "return":[
2253          {
2254             "name":"SHUTDOWN"
2255          },
2256          {
2257             "name":"RESET"
2258          }
2259       ]
2260    }
2261
2262 Note: This example has been shortened as the real response is too long.
2263
2264 EQMP
2265
2266     {
2267         .name       = "query-events",
2268         .args_type  = "",
2269         .mhandler.cmd_new = qmp_marshal_query_events,
2270     },
2271
2272 SQMP
2273 query-qmp-schema
2274 ----------------
2275
2276 Return the QMP wire schema.  The returned value is a json-array of
2277 named schema entities.  Entities are commands, events and various
2278 types.  See docs/qapi-code-gen.txt for information on their structure
2279 and intended use.
2280
2281 EQMP
2282
2283     {
2284         .name       = "query-qmp-schema",
2285         .args_type  = "",
2286         .mhandler.cmd_new = qmp_query_qmp_schema,
2287     },
2288
2289 SQMP
2290 query-chardev
2291 -------------
2292
2293 Each device is represented by a json-object. The returned value is a json-array
2294 of all devices.
2295
2296 Each json-object contain the following:
2297
2298 - "label": device's label (json-string)
2299 - "filename": device's file (json-string)
2300 - "frontend-open": open/closed state of the frontend device attached to this
2301                    backend (json-bool)
2302
2303 Example:
2304
2305 -> { "execute": "query-chardev" }
2306 <- {
2307       "return": [
2308          {
2309             "label": "charchannel0",
2310             "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server",
2311             "frontend-open": false
2312          },
2313          {
2314             "label": "charmonitor",
2315             "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server",
2316             "frontend-open": true
2317          },
2318          {
2319             "label": "charserial0",
2320             "filename": "pty:/dev/pts/2",
2321             "frontend-open": true
2322          }
2323       ]
2324    }
2325
2326 EQMP
2327
2328     {
2329         .name       = "query-chardev",
2330         .args_type  = "",
2331         .mhandler.cmd_new = qmp_marshal_query_chardev,
2332     },
2333
2334 SQMP
2335 query-chardev-backends
2336 -------------
2337
2338 List available character device backends.
2339
2340 Each backend is represented by a json-object, the returned value is a json-array
2341 of all backends.
2342
2343 Each json-object contains:
2344
2345 - "name": backend name (json-string)
2346
2347 Example:
2348
2349 -> { "execute": "query-chardev-backends" }
2350 <- {
2351       "return":[
2352          {
2353             "name":"udp"
2354          },
2355          {
2356             "name":"tcp"
2357          },
2358          {
2359             "name":"unix"
2360          },
2361          {
2362             "name":"spiceport"
2363          }
2364       ]
2365    }
2366
2367 EQMP
2368
2369     {
2370         .name       = "query-chardev-backends",
2371         .args_type  = "",
2372         .mhandler.cmd_new = qmp_marshal_query_chardev_backends,
2373     },
2374
2375 SQMP
2376 query-block
2377 -----------
2378
2379 Show the block devices.
2380
2381 Each block device information is stored in a json-object and the returned value
2382 is a json-array of all devices.
2383
2384 Each json-object contain the following:
2385
2386 - "device": device name (json-string)
2387 - "type": device type (json-string)
2388          - deprecated, retained for backward compatibility
2389          - Possible values: "unknown"
2390 - "removable": true if the device is removable, false otherwise (json-bool)
2391 - "locked": true if the device is locked, false otherwise (json-bool)
2392 - "tray_open": only present if removable, true if the device has a tray,
2393                and it is open (json-bool)
2394 - "inserted": only present if the device is inserted, it is a json-object
2395    containing the following:
2396          - "file": device file name (json-string)
2397          - "ro": true if read-only, false otherwise (json-bool)
2398          - "drv": driver format name (json-string)
2399              - Possible values: "blkdebug", "bochs", "cloop", "dmg",
2400                                 "file", "file", "ftp", "ftps", "host_cdrom",
2401                                 "host_device", "http", "https",
2402                                 "nbd", "parallels", "qcow", "qcow2", "raw",
2403                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
2404          - "backing_file": backing file name (json-string, optional)
2405          - "backing_file_depth": number of files in the backing file chain (json-int)
2406          - "encrypted": true if encrypted, false otherwise (json-bool)
2407          - "bps": limit total bytes per second (json-int)
2408          - "bps_rd": limit read bytes per second (json-int)
2409          - "bps_wr": limit write bytes per second (json-int)
2410          - "iops": limit total I/O operations per second (json-int)
2411          - "iops_rd": limit read operations per second (json-int)
2412          - "iops_wr": limit write operations per second (json-int)
2413          - "bps_max":  total max in bytes (json-int)
2414          - "bps_rd_max":  read max in bytes (json-int)
2415          - "bps_wr_max":  write max in bytes (json-int)
2416          - "iops_max":  total I/O operations max (json-int)
2417          - "iops_rd_max":  read I/O operations max (json-int)
2418          - "iops_wr_max":  write I/O operations max (json-int)
2419          - "iops_size": I/O size when limiting by iops (json-int)
2420          - "detect_zeroes": detect and optimize zero writing (json-string)
2421              - Possible values: "off", "on", "unmap"
2422          - "write_threshold": write offset threshold in bytes, a event will be
2423                               emitted if crossed. Zero if disabled (json-int)
2424          - "image": the detail of the image, it is a json-object containing
2425             the following:
2426              - "filename": image file name (json-string)
2427              - "format": image format (json-string)
2428              - "virtual-size": image capacity in bytes (json-int)
2429              - "dirty-flag": true if image is not cleanly closed, not present
2430                              means clean (json-bool, optional)
2431              - "actual-size": actual size on disk in bytes of the image, not
2432                               present when image does not support thin
2433                               provision (json-int, optional)
2434              - "cluster-size": size of a cluster in bytes, not present if image
2435                                format does not support it (json-int, optional)
2436              - "encrypted": true if the image is encrypted, not present means
2437                             false or the image format does not support
2438                             encryption (json-bool, optional)
2439              - "backing_file": backing file name, not present means no backing
2440                                file is used or the image format does not
2441                                support backing file chain
2442                                (json-string, optional)
2443              - "full-backing-filename": full path of the backing file, not
2444                                         present if it equals backing_file or no
2445                                         backing file is used
2446                                         (json-string, optional)
2447              - "backing-filename-format": the format of the backing file, not
2448                                           present means unknown or no backing
2449                                           file (json-string, optional)
2450              - "snapshots": the internal snapshot info, it is an optional list
2451                 of json-object containing the following:
2452                  - "id": unique snapshot id (json-string)
2453                  - "name": snapshot name (json-string)
2454                  - "vm-state-size": size of the VM state in bytes (json-int)
2455                  - "date-sec": UTC date of the snapshot in seconds (json-int)
2456                  - "date-nsec": fractional part in nanoseconds to be used with
2457                                 date-sec (json-int)
2458                  - "vm-clock-sec": VM clock relative to boot in seconds
2459                                    (json-int)
2460                  - "vm-clock-nsec": fractional part in nanoseconds to be used
2461                                     with vm-clock-sec (json-int)
2462              - "backing-image": the detail of the backing image, it is an
2463                                 optional json-object only present when a
2464                                 backing image present for this image
2465
2466 - "io-status": I/O operation status, only present if the device supports it
2467                and the VM is configured to stop on errors. It's always reset
2468                to "ok" when the "cont" command is issued (json_string, optional)
2469              - Possible values: "ok", "failed", "nospace"
2470
2471 Example:
2472
2473 -> { "execute": "query-block" }
2474 <- {
2475       "return":[
2476          {
2477             "io-status": "ok",
2478             "device":"ide0-hd0",
2479             "locked":false,
2480             "removable":false,
2481             "inserted":{
2482                "ro":false,
2483                "drv":"qcow2",
2484                "encrypted":false,
2485                "file":"disks/test.qcow2",
2486                "backing_file_depth":1,
2487                "bps":1000000,
2488                "bps_rd":0,
2489                "bps_wr":0,
2490                "iops":1000000,
2491                "iops_rd":0,
2492                "iops_wr":0,
2493                "bps_max": 8000000,
2494                "bps_rd_max": 0,
2495                "bps_wr_max": 0,
2496                "iops_max": 0,
2497                "iops_rd_max": 0,
2498                "iops_wr_max": 0,
2499                "iops_size": 0,
2500                "detect_zeroes": "on",
2501                "write_threshold": 0,
2502                "image":{
2503                   "filename":"disks/test.qcow2",
2504                   "format":"qcow2",
2505                   "virtual-size":2048000,
2506                   "backing_file":"base.qcow2",
2507                   "full-backing-filename":"disks/base.qcow2",
2508                   "backing-filename-format":"qcow2",
2509                   "snapshots":[
2510                      {
2511                         "id": "1",
2512                         "name": "snapshot1",
2513                         "vm-state-size": 0,
2514                         "date-sec": 10000200,
2515                         "date-nsec": 12,
2516                         "vm-clock-sec": 206,
2517                         "vm-clock-nsec": 30
2518                      }
2519                   ],
2520                   "backing-image":{
2521                       "filename":"disks/base.qcow2",
2522                       "format":"qcow2",
2523                       "virtual-size":2048000
2524                   }
2525                }
2526             },
2527             "type":"unknown"
2528          },
2529          {
2530             "io-status": "ok",
2531             "device":"ide1-cd0",
2532             "locked":false,
2533             "removable":true,
2534             "type":"unknown"
2535          },
2536          {
2537             "device":"floppy0",
2538             "locked":false,
2539             "removable":true,
2540             "type":"unknown"
2541          },
2542          {
2543             "device":"sd0",
2544             "locked":false,
2545             "removable":true,
2546             "type":"unknown"
2547          }
2548       ]
2549    }
2550
2551 EQMP
2552
2553     {
2554         .name       = "query-block",
2555         .args_type  = "",
2556         .mhandler.cmd_new = qmp_marshal_query_block,
2557     },
2558
2559 SQMP
2560 query-blockstats
2561 ----------------
2562
2563 Show block device statistics.
2564
2565 Each device statistic information is stored in a json-object and the returned
2566 value is a json-array of all devices.
2567
2568 Each json-object contain the following:
2569
2570 - "device": device name (json-string)
2571 - "stats": A json-object with the statistics information, it contains:
2572     - "rd_bytes": bytes read (json-int)
2573     - "wr_bytes": bytes written (json-int)
2574     - "rd_operations": read operations (json-int)
2575     - "wr_operations": write operations (json-int)
2576     - "flush_operations": cache flush operations (json-int)
2577     - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
2578     - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
2579     - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
2580     - "wr_highest_offset": The offset after the greatest byte written to the
2581                            BlockDriverState since it has been opened (json-int)
2582     - "rd_merged": number of read requests that have been merged into
2583                    another request (json-int)
2584     - "wr_merged": number of write requests that have been merged into
2585                    another request (json-int)
2586 - "parent": Contains recursively the statistics of the underlying
2587             protocol (e.g. the host file for a qcow2 image). If there is
2588             no underlying protocol, this field is omitted
2589             (json-object, optional)
2590
2591 Example:
2592
2593 -> { "execute": "query-blockstats" }
2594 <- {
2595       "return":[
2596          {
2597             "device":"ide0-hd0",
2598             "parent":{
2599                "stats":{
2600                   "wr_highest_offset":3686448128,
2601                   "wr_bytes":9786368,
2602                   "wr_operations":751,
2603                   "rd_bytes":122567168,
2604                   "rd_operations":36772
2605                   "wr_total_times_ns":313253456
2606                   "rd_total_times_ns":3465673657
2607                   "flush_total_times_ns":49653
2608                   "flush_operations":61,
2609                   "rd_merged":0,
2610                   "wr_merged":0
2611                }
2612             },
2613             "stats":{
2614                "wr_highest_offset":2821110784,
2615                "wr_bytes":9786368,
2616                "wr_operations":692,
2617                "rd_bytes":122739200,
2618                "rd_operations":36604
2619                "flush_operations":51,
2620                "wr_total_times_ns":313253456
2621                "rd_total_times_ns":3465673657
2622                "flush_total_times_ns":49653,
2623                "rd_merged":0,
2624                "wr_merged":0
2625             }
2626          },
2627          {
2628             "device":"ide1-cd0",
2629             "stats":{
2630                "wr_highest_offset":0,
2631                "wr_bytes":0,
2632                "wr_operations":0,
2633                "rd_bytes":0,
2634                "rd_operations":0
2635                "flush_operations":0,
2636                "wr_total_times_ns":0
2637                "rd_total_times_ns":0
2638                "flush_total_times_ns":0,
2639                "rd_merged":0,
2640                "wr_merged":0
2641             }
2642          },
2643          {
2644             "device":"floppy0",
2645             "stats":{
2646                "wr_highest_offset":0,
2647                "wr_bytes":0,
2648                "wr_operations":0,
2649                "rd_bytes":0,
2650                "rd_operations":0
2651                "flush_operations":0,
2652                "wr_total_times_ns":0
2653                "rd_total_times_ns":0
2654                "flush_total_times_ns":0,
2655                "rd_merged":0,
2656                "wr_merged":0
2657             }
2658          },
2659          {
2660             "device":"sd0",
2661             "stats":{
2662                "wr_highest_offset":0,
2663                "wr_bytes":0,
2664                "wr_operations":0,
2665                "rd_bytes":0,
2666                "rd_operations":0
2667                "flush_operations":0,
2668                "wr_total_times_ns":0
2669                "rd_total_times_ns":0
2670                "flush_total_times_ns":0,
2671                "rd_merged":0,
2672                "wr_merged":0
2673             }
2674          }
2675       ]
2676    }
2677
2678 EQMP
2679
2680     {
2681         .name       = "query-blockstats",
2682         .args_type  = "query-nodes:b?",
2683         .mhandler.cmd_new = qmp_marshal_query_blockstats,
2684     },
2685
2686 SQMP
2687 query-cpus
2688 ----------
2689
2690 Show CPU information.
2691
2692 Return a json-array. Each CPU is represented by a json-object, which contains:
2693
2694 - "CPU": CPU index (json-int)
2695 - "current": true if this is the current CPU, false otherwise (json-bool)
2696 - "halted": true if the cpu is halted, false otherwise (json-bool)
2697 - "qom_path": path to the CPU object in the QOM tree (json-str)
2698 - Current program counter. The key's name depends on the architecture:
2699      "pc": i386/x86_64 (json-int)
2700      "nip": PPC (json-int)
2701      "pc" and "npc": sparc (json-int)
2702      "PC": mips (json-int)
2703 - "thread_id": ID of the underlying host thread (json-int)
2704
2705 Example:
2706
2707 -> { "execute": "query-cpus" }
2708 <- {
2709       "return":[
2710          {
2711             "CPU":0,
2712             "current":true,
2713             "halted":false,
2714             "qom_path":"/machine/unattached/device[0]",
2715             "pc":3227107138,
2716             "thread_id":3134
2717          },
2718          {
2719             "CPU":1,
2720             "current":false,
2721             "halted":true,
2722             "qom_path":"/machine/unattached/device[2]",
2723             "pc":7108165,
2724             "thread_id":3135
2725          }
2726       ]
2727    }
2728
2729 EQMP
2730
2731     {
2732         .name       = "query-cpus",
2733         .args_type  = "",
2734         .mhandler.cmd_new = qmp_marshal_query_cpus,
2735     },
2736
2737 SQMP
2738 query-iothreads
2739 ---------------
2740
2741 Returns a list of information about each iothread.
2742
2743 Note this list excludes the QEMU main loop thread, which is not declared
2744 using the -object iothread command-line option.  It is always the main thread
2745 of the process.
2746
2747 Return a json-array. Each iothread is represented by a json-object, which contains:
2748
2749 - "id": name of iothread (json-str)
2750 - "thread-id": ID of the underlying host thread (json-int)
2751
2752 Example:
2753
2754 -> { "execute": "query-iothreads" }
2755 <- {
2756       "return":[
2757          {
2758             "id":"iothread0",
2759             "thread-id":3134
2760          },
2761          {
2762             "id":"iothread1",
2763             "thread-id":3135
2764          }
2765       ]
2766    }
2767
2768 EQMP
2769
2770     {
2771         .name       = "query-iothreads",
2772         .args_type  = "",
2773         .mhandler.cmd_new = qmp_marshal_query_iothreads,
2774     },
2775
2776 SQMP
2777 query-pci
2778 ---------
2779
2780 PCI buses and devices information.
2781
2782 The returned value is a json-array of all buses. Each bus is represented by
2783 a json-object, which has a key with a json-array of all PCI devices attached
2784 to it. Each device is represented by a json-object.
2785
2786 The bus json-object contains the following:
2787
2788 - "bus": bus number (json-int)
2789 - "devices": a json-array of json-objects, each json-object represents a
2790              PCI device
2791
2792 The PCI device json-object contains the following:
2793
2794 - "bus": identical to the parent's bus number (json-int)
2795 - "slot": slot number (json-int)
2796 - "function": function number (json-int)
2797 - "class_info": a json-object containing:
2798      - "desc": device class description (json-string, optional)
2799      - "class": device class number (json-int)
2800 - "id": a json-object containing:
2801      - "device": device ID (json-int)
2802      - "vendor": vendor ID (json-int)
2803 - "irq": device's IRQ if assigned (json-int, optional)
2804 - "qdev_id": qdev id string (json-string)
2805 - "pci_bridge": It's a json-object, only present if this device is a
2806                 PCI bridge, contains:
2807      - "bus": bus number (json-int)
2808      - "secondary": secondary bus number (json-int)
2809      - "subordinate": subordinate bus number (json-int)
2810      - "io_range": I/O memory range information, a json-object with the
2811                    following members:
2812                  - "base": base address, in bytes (json-int)
2813                  - "limit": limit address, in bytes (json-int)
2814      - "memory_range": memory range information, a json-object with the
2815                        following members:
2816                  - "base": base address, in bytes (json-int)
2817                  - "limit": limit address, in bytes (json-int)
2818      - "prefetchable_range": Prefetchable memory range information, a
2819                              json-object with the following members:
2820                  - "base": base address, in bytes (json-int)
2821                  - "limit": limit address, in bytes (json-int)
2822      - "devices": a json-array of PCI devices if there's any attached, each
2823                   each element is represented by a json-object, which contains
2824                   the same members of the 'PCI device json-object' described
2825                   above (optional)
2826 - "regions": a json-array of json-objects, each json-object represents a
2827              memory region of this device
2828
2829 The memory range json-object contains the following:
2830
2831 - "base": base memory address (json-int)
2832 - "limit": limit value (json-int)
2833
2834 The region json-object can be an I/O region or a memory region, an I/O region
2835 json-object contains the following:
2836
2837 - "type": "io" (json-string, fixed)
2838 - "bar": BAR number (json-int)
2839 - "address": memory address (json-int)
2840 - "size": memory size (json-int)
2841
2842 A memory region json-object contains the following:
2843
2844 - "type": "memory" (json-string, fixed)
2845 - "bar": BAR number (json-int)
2846 - "address": memory address (json-int)
2847 - "size": memory size (json-int)
2848 - "mem_type_64": true or false (json-bool)
2849 - "prefetch": true or false (json-bool)
2850
2851 Example:
2852
2853 -> { "execute": "query-pci" }
2854 <- {
2855       "return":[
2856          {
2857             "bus":0,
2858             "devices":[
2859                {
2860                   "bus":0,
2861                   "qdev_id":"",
2862                   "slot":0,
2863                   "class_info":{
2864                      "class":1536,
2865                      "desc":"Host bridge"
2866                   },
2867                   "id":{
2868                      "device":32902,
2869                      "vendor":4663
2870                   },
2871                   "function":0,
2872                   "regions":[
2873
2874                   ]
2875                },
2876                {
2877                   "bus":0,
2878                   "qdev_id":"",
2879                   "slot":1,
2880                   "class_info":{
2881                      "class":1537,
2882                      "desc":"ISA bridge"
2883                   },
2884                   "id":{
2885                      "device":32902,
2886                      "vendor":28672
2887                   },
2888                   "function":0,
2889                   "regions":[
2890
2891                   ]
2892                },
2893                {
2894                   "bus":0,
2895                   "qdev_id":"",
2896                   "slot":1,
2897                   "class_info":{
2898                      "class":257,
2899                      "desc":"IDE controller"
2900                   },
2901                   "id":{
2902                      "device":32902,
2903                      "vendor":28688
2904                   },
2905                   "function":1,
2906                   "regions":[
2907                      {
2908                         "bar":4,
2909                         "size":16,
2910                         "address":49152,
2911                         "type":"io"
2912                      }
2913                   ]
2914                },
2915                {
2916                   "bus":0,
2917                   "qdev_id":"",
2918                   "slot":2,
2919                   "class_info":{
2920                      "class":768,
2921                      "desc":"VGA controller"
2922                   },
2923                   "id":{
2924                      "device":4115,
2925                      "vendor":184
2926                   },
2927                   "function":0,
2928                   "regions":[
2929                      {
2930                         "prefetch":true,
2931                         "mem_type_64":false,
2932                         "bar":0,
2933                         "size":33554432,
2934                         "address":4026531840,
2935                         "type":"memory"
2936                      },
2937                      {
2938                         "prefetch":false,
2939                         "mem_type_64":false,
2940                         "bar":1,
2941                         "size":4096,
2942                         "address":4060086272,
2943                         "type":"memory"
2944                      },
2945                      {
2946                         "prefetch":false,
2947                         "mem_type_64":false,
2948                         "bar":6,
2949                         "size":65536,
2950                         "address":-1,
2951                         "type":"memory"
2952                      }
2953                   ]
2954                },
2955                {
2956                   "bus":0,
2957                   "qdev_id":"",
2958                   "irq":11,
2959                   "slot":4,
2960                   "class_info":{
2961                      "class":1280,
2962                      "desc":"RAM controller"
2963                   },
2964                   "id":{
2965                      "device":6900,
2966                      "vendor":4098
2967                   },
2968                   "function":0,
2969                   "regions":[
2970                      {
2971                         "bar":0,
2972                         "size":32,
2973                         "address":49280,
2974                         "type":"io"
2975                      }
2976                   ]
2977                }
2978             ]
2979          }
2980       ]
2981    }
2982
2983 Note: This example has been shortened as the real response is too long.
2984
2985 EQMP
2986
2987     {
2988         .name       = "query-pci",
2989         .args_type  = "",
2990         .mhandler.cmd_new = qmp_marshal_query_pci,
2991     },
2992
2993 SQMP
2994 query-kvm
2995 ---------
2996
2997 Show KVM information.
2998
2999 Return a json-object with the following information:
3000
3001 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
3002 - "present": true if QEMU has KVM support, false otherwise (json-bool)
3003
3004 Example:
3005
3006 -> { "execute": "query-kvm" }
3007 <- { "return": { "enabled": true, "present": true } }
3008
3009 EQMP
3010
3011     {
3012         .name       = "query-kvm",
3013         .args_type  = "",
3014         .mhandler.cmd_new = qmp_marshal_query_kvm,
3015     },
3016
3017 SQMP
3018 query-status
3019 ------------
3020
3021 Return a json-object with the following information:
3022
3023 - "running": true if the VM is running, or false if it is paused (json-bool)
3024 - "singlestep": true if the VM is in single step mode,
3025                 false otherwise (json-bool)
3026 - "status": one of the following values (json-string)
3027     "debug" - QEMU is running on a debugger
3028     "inmigrate" - guest is paused waiting for an incoming migration
3029     "internal-error" - An internal error that prevents further guest
3030     execution has occurred
3031     "io-error" - the last IOP has failed and the device is configured
3032     to pause on I/O errors
3033     "paused" - guest has been paused via the 'stop' command
3034     "postmigrate" - guest is paused following a successful 'migrate'
3035     "prelaunch" - QEMU was started with -S and guest has not started
3036     "finish-migrate" - guest is paused to finish the migration process
3037     "restore-vm" - guest is paused to restore VM state
3038     "running" - guest is actively running
3039     "save-vm" - guest is paused to save the VM state
3040     "shutdown" - guest is shut down (and -no-shutdown is in use)
3041     "watchdog" - the watchdog action is configured to pause and
3042      has been triggered
3043
3044 Example:
3045
3046 -> { "execute": "query-status" }
3047 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
3048
3049 EQMP
3050
3051     {
3052         .name       = "query-status",
3053         .args_type  = "",
3054         .mhandler.cmd_new = qmp_marshal_query_status,
3055     },
3056
3057 SQMP
3058 query-mice
3059 ----------
3060
3061 Show VM mice information.
3062
3063 Each mouse is represented by a json-object, the returned value is a json-array
3064 of all mice.
3065
3066 The mouse json-object contains the following:
3067
3068 - "name": mouse's name (json-string)
3069 - "index": mouse's index (json-int)
3070 - "current": true if this mouse is receiving events, false otherwise (json-bool)
3071 - "absolute": true if the mouse generates absolute input events (json-bool)
3072
3073 Example:
3074
3075 -> { "execute": "query-mice" }
3076 <- {
3077       "return":[
3078          {
3079             "name":"QEMU Microsoft Mouse",
3080             "index":0,
3081             "current":false,
3082             "absolute":false
3083          },
3084          {
3085             "name":"QEMU PS/2 Mouse",
3086             "index":1,
3087             "current":true,
3088             "absolute":true
3089          }
3090       ]
3091    }
3092
3093 EQMP
3094
3095     {
3096         .name       = "query-mice",
3097         .args_type  = "",
3098         .mhandler.cmd_new = qmp_marshal_query_mice,
3099     },
3100
3101 SQMP
3102 query-vnc
3103 ---------
3104
3105 Show VNC server information.
3106
3107 Return a json-object with server information. Connected clients are returned
3108 as a json-array of json-objects.
3109
3110 The main json-object contains the following:
3111
3112 - "enabled": true or false (json-bool)
3113 - "host": server's IP address (json-string)
3114 - "family": address family (json-string)
3115          - Possible values: "ipv4", "ipv6", "unix", "unknown"
3116 - "service": server's port number (json-string)
3117 - "auth": authentication method (json-string)
3118          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
3119                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
3120                             "vencrypt+plain", "vencrypt+tls+none",
3121                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
3122                             "vencrypt+tls+vnc", "vencrypt+x509+none",
3123                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
3124                             "vencrypt+x509+vnc", "vnc"
3125 - "clients": a json-array of all connected clients
3126
3127 Clients are described by a json-object, each one contain the following:
3128
3129 - "host": client's IP address (json-string)
3130 - "family": address family (json-string)
3131          - Possible values: "ipv4", "ipv6", "unix", "unknown"
3132 - "service": client's port number (json-string)
3133 - "x509_dname": TLS dname (json-string, optional)
3134 - "sasl_username": SASL username (json-string, optional)
3135
3136 Example:
3137
3138 -> { "execute": "query-vnc" }
3139 <- {
3140       "return":{
3141          "enabled":true,
3142          "host":"0.0.0.0",
3143          "service":"50402",
3144          "auth":"vnc",
3145          "family":"ipv4",
3146          "clients":[
3147             {
3148                "host":"127.0.0.1",
3149                "service":"50401",
3150                "family":"ipv4"
3151             }
3152          ]
3153       }
3154    }
3155
3156 EQMP
3157
3158     {
3159         .name       = "query-vnc",
3160         .args_type  = "",
3161         .mhandler.cmd_new = qmp_marshal_query_vnc,
3162     },
3163     {
3164         .name       = "query-vnc-servers",
3165         .args_type  = "",
3166         .mhandler.cmd_new = qmp_marshal_query_vnc_servers,
3167     },
3168
3169 SQMP
3170 query-spice
3171 -----------
3172
3173 Show SPICE server information.
3174
3175 Return a json-object with server information. Connected clients are returned
3176 as a json-array of json-objects.
3177
3178 The main json-object contains the following:
3179
3180 - "enabled": true or false (json-bool)
3181 - "host": server's IP address (json-string)
3182 - "port": server's port number (json-int, optional)
3183 - "tls-port": server's port number (json-int, optional)
3184 - "auth": authentication method (json-string)
3185          - Possible values: "none", "spice"
3186 - "channels": a json-array of all active channels clients
3187
3188 Channels are described by a json-object, each one contain the following:
3189
3190 - "host": client's IP address (json-string)
3191 - "family": address family (json-string)
3192          - Possible values: "ipv4", "ipv6", "unix", "unknown"
3193 - "port": client's port number (json-string)
3194 - "connection-id": spice connection id.  All channels with the same id
3195                    belong to the same spice session (json-int)
3196 - "channel-type": channel type.  "1" is the main control channel, filter for
3197                   this one if you want track spice sessions only (json-int)
3198 - "channel-id": channel id.  Usually "0", might be different needed when
3199                 multiple channels of the same type exist, such as multiple
3200                 display channels in a multihead setup (json-int)
3201 - "tls": whether the channel is encrypted (json-bool)
3202
3203 Example:
3204
3205 -> { "execute": "query-spice" }
3206 <- {
3207       "return": {
3208          "enabled": true,
3209          "auth": "spice",
3210          "port": 5920,
3211          "tls-port": 5921,
3212          "host": "0.0.0.0",
3213          "channels": [
3214             {
3215                "port": "54924",
3216                "family": "ipv4",
3217                "channel-type": 1,
3218                "connection-id": 1804289383,
3219                "host": "127.0.0.1",
3220                "channel-id": 0,
3221                "tls": true
3222             },
3223             {
3224                "port": "36710",
3225                "family": "ipv4",
3226                "channel-type": 4,
3227                "connection-id": 1804289383,
3228                "host": "127.0.0.1",
3229                "channel-id": 0,
3230                "tls": false
3231             },
3232             [ ... more channels follow ... ]
3233          ]
3234       }
3235    }
3236
3237 EQMP
3238
3239 #if defined(CONFIG_SPICE)
3240     {
3241         .name       = "query-spice",
3242         .args_type  = "",
3243         .mhandler.cmd_new = qmp_marshal_query_spice,
3244     },
3245 #endif
3246
3247 SQMP
3248 query-name
3249 ----------
3250
3251 Show VM name.
3252
3253 Return a json-object with the following information:
3254
3255 - "name": VM's name (json-string, optional)
3256
3257 Example:
3258
3259 -> { "execute": "query-name" }
3260 <- { "return": { "name": "qemu-name" } }
3261
3262 EQMP
3263
3264     {
3265         .name       = "query-name",
3266         .args_type  = "",
3267         .mhandler.cmd_new = qmp_marshal_query_name,
3268     },
3269
3270 SQMP
3271 query-uuid
3272 ----------
3273
3274 Show VM UUID.
3275
3276 Return a json-object with the following information:
3277
3278 - "UUID": Universally Unique Identifier (json-string)
3279
3280 Example:
3281
3282 -> { "execute": "query-uuid" }
3283 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
3284
3285 EQMP
3286
3287     {
3288         .name       = "query-uuid",
3289         .args_type  = "",
3290         .mhandler.cmd_new = qmp_marshal_query_uuid,
3291     },
3292
3293 SQMP
3294 query-command-line-options
3295 --------------------------
3296
3297 Show command line option schema.
3298
3299 Return a json-array of command line option schema for all options (or for
3300 the given option), returning an error if the given option doesn't exist.
3301
3302 Each array entry contains the following:
3303
3304 - "option": option name (json-string)
3305 - "parameters": a json-array describes all parameters of the option:
3306     - "name": parameter name (json-string)
3307     - "type": parameter type (one of 'string', 'boolean', 'number',
3308               or 'size')
3309     - "help": human readable description of the parameter
3310               (json-string, optional)
3311     - "default": default value string for the parameter
3312                  (json-string, optional)
3313
3314 Example:
3315
3316 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
3317 <- { "return": [
3318         {
3319             "parameters": [
3320                 {
3321                     "name": "romfile",
3322                     "type": "string"
3323                 },
3324                 {
3325                     "name": "bootindex",
3326                     "type": "number"
3327                 }
3328             ],
3329             "option": "option-rom"
3330         }
3331      ]
3332    }
3333
3334 EQMP
3335
3336     {
3337         .name       = "query-command-line-options",
3338         .args_type  = "option:s?",
3339         .mhandler.cmd_new = qmp_marshal_query_command_line_options,
3340     },
3341
3342 SQMP
3343 query-migrate
3344 -------------
3345
3346 Migration status.
3347
3348 Return a json-object. If migration is active there will be another json-object
3349 with RAM migration status and if block migration is active another one with
3350 block migration status.
3351
3352 The main json-object contains the following:
3353
3354 - "status": migration status (json-string)
3355      - Possible values: "setup", "active", "completed", "failed", "cancelled"
3356 - "total-time": total amount of ms since migration started.  If
3357                 migration has ended, it returns the total migration
3358                 time (json-int)
3359 - "setup-time" amount of setup time in milliseconds _before_ the
3360                iterations begin but _after_ the QMP command is issued.
3361                This is designed to provide an accounting of any activities
3362                (such as RDMA pinning) which may be expensive, but do not
3363                actually occur during the iterative migration rounds
3364                themselves. (json-int)
3365 - "downtime": only present when migration has finished correctly
3366               total amount in ms for downtime that happened (json-int)
3367 - "expected-downtime": only present while migration is active
3368                 total amount in ms for downtime that was calculated on
3369                 the last bitmap round (json-int)
3370 - "ram": only present if "status" is "active", it is a json-object with the
3371   following RAM information:
3372          - "transferred": amount transferred in bytes (json-int)
3373          - "remaining": amount remaining to transfer in bytes (json-int)
3374          - "total": total amount of memory in bytes (json-int)
3375          - "duplicate": number of pages filled entirely with the same
3376             byte (json-int)
3377             These are sent over the wire much more efficiently.
3378          - "skipped": number of skipped zero pages (json-int)
3379          - "normal" : number of whole pages transferred.  I.e. they
3380             were not sent as duplicate or xbzrle pages (json-int)
3381          - "normal-bytes" : number of bytes transferred in whole
3382             pages. This is just normal pages times size of one page,
3383             but this way upper levels don't need to care about page
3384             size (json-int)
3385          - "dirty-sync-count": times that dirty ram was synchronized (json-int)
3386 - "disk": only present if "status" is "active" and it is a block migration,
3387   it is a json-object with the following disk information:
3388          - "transferred": amount transferred in bytes (json-int)
3389          - "remaining": amount remaining to transfer in bytes json-int)
3390          - "total": total disk size in bytes (json-int)
3391 - "xbzrle-cache": only present if XBZRLE is active.
3392   It is a json-object with the following XBZRLE information:
3393          - "cache-size": XBZRLE cache size in bytes
3394          - "bytes": number of bytes transferred for XBZRLE compressed pages
3395          - "pages": number of XBZRLE compressed pages
3396          - "cache-miss": number of XBRZRLE page cache misses
3397          - "cache-miss-rate": rate of XBRZRLE page cache misses
3398          - "overflow": number of times XBZRLE overflows.  This means
3399            that the XBZRLE encoding was bigger than just sent the
3400            whole page, and then we sent the whole page instead (as as
3401            normal page).
3402
3403 Examples:
3404
3405 1. Before the first migration
3406
3407 -> { "execute": "query-migrate" }
3408 <- { "return": {} }
3409
3410 2. Migration is done and has succeeded
3411
3412 -> { "execute": "query-migrate" }
3413 <- { "return": {
3414         "status": "completed",
3415         "ram":{
3416           "transferred":123,
3417           "remaining":123,
3418           "total":246,
3419           "total-time":12345,
3420           "setup-time":12345,
3421           "downtime":12345,
3422           "duplicate":123,
3423           "normal":123,
3424           "normal-bytes":123456,
3425           "dirty-sync-count":15
3426         }
3427      }
3428    }
3429
3430 3. Migration is done and has failed
3431
3432 -> { "execute": "query-migrate" }
3433 <- { "return": { "status": "failed" } }
3434
3435 4. Migration is being performed and is not a block migration:
3436
3437 -> { "execute": "query-migrate" }
3438 <- {
3439       "return":{
3440          "status":"active",
3441          "ram":{
3442             "transferred":123,
3443             "remaining":123,
3444             "total":246,
3445             "total-time":12345,
3446             "setup-time":12345,
3447             "expected-downtime":12345,
3448             "duplicate":123,
3449             "normal":123,
3450             "normal-bytes":123456,
3451             "dirty-sync-count":15
3452          }
3453       }
3454    }
3455
3456 5. Migration is being performed and is a block migration:
3457
3458 -> { "execute": "query-migrate" }
3459 <- {
3460       "return":{
3461          "status":"active",
3462          "ram":{
3463             "total":1057024,
3464             "remaining":1053304,
3465             "transferred":3720,
3466             "total-time":12345,
3467             "setup-time":12345,
3468             "expected-downtime":12345,
3469             "duplicate":123,
3470             "normal":123,
3471             "normal-bytes":123456,
3472             "dirty-sync-count":15
3473          },
3474          "disk":{
3475             "total":20971520,
3476             "remaining":20880384,
3477             "transferred":91136
3478          }
3479       }
3480    }
3481
3482 6. Migration is being performed and XBZRLE is active:
3483
3484 -> { "execute": "query-migrate" }
3485 <- {
3486       "return":{
3487          "status":"active",
3488          "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
3489          "ram":{
3490             "total":1057024,
3491             "remaining":1053304,
3492             "transferred":3720,
3493             "total-time":12345,
3494             "setup-time":12345,
3495             "expected-downtime":12345,
3496             "duplicate":10,
3497             "normal":3333,
3498             "normal-bytes":3412992,
3499             "dirty-sync-count":15
3500          },
3501          "xbzrle-cache":{
3502             "cache-size":67108864,
3503             "bytes":20971520,
3504             "pages":2444343,
3505             "cache-miss":2244,
3506             "cache-miss-rate":0.123,
3507             "overflow":34434
3508          }
3509       }
3510    }
3511
3512 EQMP
3513
3514     {
3515         .name       = "query-migrate",
3516         .args_type  = "",
3517         .mhandler.cmd_new = qmp_marshal_query_migrate,
3518     },
3519
3520 SQMP
3521 migrate-set-capabilities
3522 ------------------------
3523
3524 Enable/Disable migration capabilities
3525
3526 - "xbzrle": XBZRLE support
3527 - "rdma-pin-all": pin all pages when using RDMA during migration
3528 - "auto-converge": throttle down guest to help convergence of migration
3529 - "zero-blocks": compress zero blocks during block migration
3530 - "events": generate events for each migration state change
3531
3532 Arguments:
3533
3534 Example:
3535
3536 -> { "execute": "migrate-set-capabilities" , "arguments":
3537      { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
3538
3539 EQMP
3540
3541     {
3542         .name       = "migrate-set-capabilities",
3543         .args_type  = "capabilities:q",
3544         .params     = "capability:s,state:b",
3545         .mhandler.cmd_new = qmp_marshal_migrate_set_capabilities,
3546     },
3547 SQMP
3548 query-migrate-capabilities
3549 --------------------------
3550
3551 Query current migration capabilities
3552
3553 - "capabilities": migration capabilities state
3554          - "xbzrle" : XBZRLE state (json-bool)
3555          - "rdma-pin-all" : RDMA Pin Page state (json-bool)
3556          - "auto-converge" : Auto Converge state (json-bool)
3557          - "zero-blocks" : Zero Blocks state (json-bool)
3558
3559 Arguments:
3560
3561 Example:
3562
3563 -> { "execute": "query-migrate-capabilities" }
3564 <- { "return": [ { "state": false, "capability": "xbzrle" } ] }
3565
3566 EQMP
3567
3568     {
3569         .name       = "query-migrate-capabilities",
3570         .args_type  = "",
3571         .mhandler.cmd_new = qmp_marshal_query_migrate_capabilities,
3572     },
3573
3574 SQMP
3575 migrate-set-parameters
3576 ----------------------
3577
3578 Set migration parameters
3579
3580 - "compress-level": set compression level during migration (json-int)
3581 - "compress-threads": set compression thread count for migration (json-int)
3582 - "decompress-threads": set decompression thread count for migration (json-int)
3583
3584 Arguments:
3585
3586 Example:
3587
3588 -> { "execute": "migrate-set-parameters" , "arguments":
3589       { "compress-level": 1 } }
3590
3591 EQMP
3592
3593     {
3594         .name       = "migrate-set-parameters",
3595         .args_type  =
3596             "compress-level:i?,compress-threads:i?,decompress-threads:i?",
3597         .mhandler.cmd_new = qmp_marshal_migrate_set_parameters,
3598     },
3599 SQMP
3600 query-migrate-parameters
3601 ------------------------
3602
3603 Query current migration parameters
3604
3605 - "parameters": migration parameters value
3606          - "compress-level" : compression level value (json-int)
3607          - "compress-threads" : compression thread count value (json-int)
3608          - "decompress-threads" : decompression thread count value (json-int)
3609
3610 Arguments:
3611
3612 Example:
3613
3614 -> { "execute": "query-migrate-parameters" }
3615 <- {
3616       "return": {
3617          "decompress-threads", 2,
3618          "compress-threads", 8,
3619          "compress-level", 1
3620       }
3621    }
3622
3623 EQMP
3624
3625     {
3626         .name       = "query-migrate-parameters",
3627         .args_type  = "",
3628         .mhandler.cmd_new = qmp_marshal_query_migrate_parameters,
3629     },
3630
3631 SQMP
3632 query-balloon
3633 -------------
3634
3635 Show balloon information.
3636
3637 Make an asynchronous request for balloon info. When the request completes a
3638 json-object will be returned containing the following data:
3639
3640 - "actual": current balloon value in bytes (json-int)
3641
3642 Example:
3643
3644 -> { "execute": "query-balloon" }
3645 <- {
3646       "return":{
3647          "actual":1073741824,
3648       }
3649    }
3650
3651 EQMP
3652
3653     {
3654         .name       = "query-balloon",
3655         .args_type  = "",
3656         .mhandler.cmd_new = qmp_marshal_query_balloon,
3657     },
3658
3659     {
3660         .name       = "query-block-jobs",
3661         .args_type  = "",
3662         .mhandler.cmd_new = qmp_marshal_query_block_jobs,
3663     },
3664
3665     {
3666         .name       = "qom-list",
3667         .args_type  = "path:s",
3668         .mhandler.cmd_new = qmp_marshal_qom_list,
3669     },
3670
3671     {
3672         .name       = "qom-set",
3673         .args_type  = "path:s,property:s,value:q",
3674         .mhandler.cmd_new = qmp_marshal_qom_set,
3675     },
3676
3677     {
3678         .name       = "qom-get",
3679         .args_type  = "path:s,property:s",
3680         .mhandler.cmd_new = qmp_marshal_qom_get,
3681     },
3682
3683     {
3684         .name       = "nbd-server-start",
3685         .args_type  = "addr:q",
3686         .mhandler.cmd_new = qmp_marshal_nbd_server_start,
3687     },
3688     {
3689         .name       = "nbd-server-add",
3690         .args_type  = "device:B,writable:b?",
3691         .mhandler.cmd_new = qmp_marshal_nbd_server_add,
3692     },
3693     {
3694         .name       = "nbd-server-stop",
3695         .args_type  = "",
3696         .mhandler.cmd_new = qmp_marshal_nbd_server_stop,
3697     },
3698
3699     {
3700         .name       = "change-vnc-password",
3701         .args_type  = "password:s",
3702         .mhandler.cmd_new = qmp_marshal_change_vnc_password,
3703     },
3704     {
3705         .name       = "qom-list-types",
3706         .args_type  = "implements:s?,abstract:b?",
3707         .mhandler.cmd_new = qmp_marshal_qom_list_types,
3708     },
3709
3710     {
3711         .name       = "device-list-properties",
3712         .args_type  = "typename:s",
3713         .mhandler.cmd_new = qmp_marshal_device_list_properties,
3714     },
3715
3716     {
3717         .name       = "query-machines",
3718         .args_type  = "",
3719         .mhandler.cmd_new = qmp_marshal_query_machines,
3720     },
3721
3722     {
3723         .name       = "query-cpu-definitions",
3724         .args_type  = "",
3725         .mhandler.cmd_new = qmp_marshal_query_cpu_definitions,
3726     },
3727
3728     {
3729         .name       = "query-target",
3730         .args_type  = "",
3731         .mhandler.cmd_new = qmp_marshal_query_target,
3732     },
3733
3734     {
3735         .name       = "query-tpm",
3736         .args_type  = "",
3737         .mhandler.cmd_new = qmp_marshal_query_tpm,
3738     },
3739
3740 SQMP
3741 query-tpm
3742 ---------
3743
3744 Return information about the TPM device.
3745
3746 Arguments: None
3747
3748 Example:
3749
3750 -> { "execute": "query-tpm" }
3751 <- { "return":
3752      [
3753        { "model": "tpm-tis",
3754          "options":
3755            { "type": "passthrough",
3756              "data":
3757                { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
3758                  "path": "/dev/tpm0"
3759                }
3760            },
3761          "id": "tpm0"
3762        }
3763      ]
3764    }
3765
3766 EQMP
3767
3768     {
3769         .name       = "query-tpm-models",
3770         .args_type  = "",
3771         .mhandler.cmd_new = qmp_marshal_query_tpm_models,
3772     },
3773
3774 SQMP
3775 query-tpm-models
3776 ----------------
3777
3778 Return a list of supported TPM models.
3779
3780 Arguments: None
3781
3782 Example:
3783
3784 -> { "execute": "query-tpm-models" }
3785 <- { "return": [ "tpm-tis" ] }
3786
3787 EQMP
3788
3789     {
3790         .name       = "query-tpm-types",
3791         .args_type  = "",
3792         .mhandler.cmd_new = qmp_marshal_query_tpm_types,
3793     },
3794
3795 SQMP
3796 query-tpm-types
3797 ---------------
3798
3799 Return a list of supported TPM types.
3800
3801 Arguments: None
3802
3803 Example:
3804
3805 -> { "execute": "query-tpm-types" }
3806 <- { "return": [ "passthrough" ] }
3807
3808 EQMP
3809
3810     {
3811         .name       = "chardev-add",
3812         .args_type  = "id:s,backend:q",
3813         .mhandler.cmd_new = qmp_marshal_chardev_add,
3814     },
3815
3816 SQMP
3817 chardev-add
3818 ----------------
3819
3820 Add a chardev.
3821
3822 Arguments:
3823
3824 - "id": the chardev's ID, must be unique (json-string)
3825 - "backend": chardev backend type + parameters
3826
3827 Examples:
3828
3829 -> { "execute" : "chardev-add",
3830      "arguments" : { "id" : "foo",
3831                      "backend" : { "type" : "null", "data" : {} } } }
3832 <- { "return": {} }
3833
3834 -> { "execute" : "chardev-add",
3835      "arguments" : { "id" : "bar",
3836                      "backend" : { "type" : "file",
3837                                    "data" : { "out" : "/tmp/bar.log" } } } }
3838 <- { "return": {} }
3839
3840 -> { "execute" : "chardev-add",
3841      "arguments" : { "id" : "baz",
3842                      "backend" : { "type" : "pty", "data" : {} } } }
3843 <- { "return": { "pty" : "/dev/pty/42" } }
3844
3845 EQMP
3846
3847     {
3848         .name       = "chardev-remove",
3849         .args_type  = "id:s",
3850         .mhandler.cmd_new = qmp_marshal_chardev_remove,
3851     },
3852
3853
3854 SQMP
3855 chardev-remove
3856 --------------
3857
3858 Remove a chardev.
3859
3860 Arguments:
3861
3862 - "id": the chardev's ID, must exist and not be in use (json-string)
3863
3864 Example:
3865
3866 -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
3867 <- { "return": {} }
3868
3869 EQMP
3870     {
3871         .name       = "query-rx-filter",
3872         .args_type  = "name:s?",
3873         .mhandler.cmd_new = qmp_marshal_query_rx_filter,
3874     },
3875
3876 SQMP
3877 query-rx-filter
3878 ---------------
3879
3880 Show rx-filter information.
3881
3882 Returns a json-array of rx-filter information for all NICs (or for the
3883 given NIC), returning an error if the given NIC doesn't exist, or
3884 given NIC doesn't support rx-filter querying, or given net client
3885 isn't a NIC.
3886
3887 The query will clear the event notification flag of each NIC, then qemu
3888 will start to emit event to QMP monitor.
3889
3890 Each array entry contains the following:
3891
3892 - "name": net client name (json-string)
3893 - "promiscuous": promiscuous mode is enabled (json-bool)
3894 - "multicast": multicast receive state (one of 'normal', 'none', 'all')
3895 - "unicast": unicast receive state  (one of 'normal', 'none', 'all')
3896 - "vlan": vlan receive state (one of 'normal', 'none', 'all') (Since 2.0)
3897 - "broadcast-allowed": allow to receive broadcast (json-bool)
3898 - "multicast-overflow": multicast table is overflowed (json-bool)
3899 - "unicast-overflow": unicast table is overflowed (json-bool)
3900 - "main-mac": main macaddr string (json-string)
3901 - "vlan-table": a json-array of active vlan id
3902 - "unicast-table": a json-array of unicast macaddr string
3903 - "multicast-table": a json-array of multicast macaddr string
3904
3905 Example:
3906
3907 -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
3908 <- { "return": [
3909         {
3910             "promiscuous": true,
3911             "name": "vnet0",
3912             "main-mac": "52:54:00:12:34:56",
3913             "unicast": "normal",
3914             "vlan": "normal",
3915             "vlan-table": [
3916                 4,
3917                 0
3918             ],
3919             "unicast-table": [
3920             ],
3921             "multicast": "normal",
3922             "multicast-overflow": false,
3923             "unicast-overflow": false,
3924             "multicast-table": [
3925                 "01:00:5e:00:00:01",
3926                 "33:33:00:00:00:01",
3927                 "33:33:ff:12:34:56"
3928             ],
3929             "broadcast-allowed": false
3930         }
3931       ]
3932    }
3933
3934 EQMP
3935
3936     {
3937         .name       = "blockdev-add",
3938         .args_type  = "options:q",
3939         .mhandler.cmd_new = qmp_marshal_blockdev_add,
3940     },
3941
3942 SQMP
3943 blockdev-add
3944 ------------
3945
3946 Add a block device.
3947
3948 This command is still a work in progress.  It doesn't support all
3949 block drivers among other things.  Stay away from it unless you want
3950 to help with its development.
3951
3952 Arguments:
3953
3954 - "options": block driver options
3955
3956 Example (1):
3957
3958 -> { "execute": "blockdev-add",
3959     "arguments": { "options" : { "driver": "qcow2",
3960                                  "file": { "driver": "file",
3961                                            "filename": "test.qcow2" } } } }
3962 <- { "return": {} }
3963
3964 Example (2):
3965
3966 -> { "execute": "blockdev-add",
3967      "arguments": {
3968          "options": {
3969            "driver": "qcow2",
3970            "id": "my_disk",
3971            "discard": "unmap",
3972            "cache": {
3973                "direct": true,
3974                "writeback": true
3975            },
3976            "file": {
3977                "driver": "file",
3978                "filename": "/tmp/test.qcow2"
3979            },
3980            "backing": {
3981                "driver": "raw",
3982                "file": {
3983                    "driver": "file",
3984                    "filename": "/dev/fdset/4"
3985                }
3986            }
3987          }
3988        }
3989      }
3990
3991 <- { "return": {} }
3992
3993 EQMP
3994
3995     {
3996         .name       = "x-blockdev-del",
3997         .args_type  = "id:s?,node-name:s?",
3998         .mhandler.cmd_new = qmp_marshal_x_blockdev_del,
3999     },
4000
4001 SQMP
4002 x-blockdev-del
4003 ------------
4004 Since 2.5
4005
4006 Deletes a block device thas has been added using blockdev-add.
4007 The selected device can be either a block backend or a graph node.
4008
4009 In the former case the backend will be destroyed, along with its
4010 inserted medium if there's any. The command will fail if the backend
4011 or its medium are in use.
4012
4013 In the latter case the node will be destroyed. The command will fail
4014 if the node is attached to a block backend or is otherwise being
4015 used.
4016
4017 One of "id" or "node-name" must be specified, but not both.
4018
4019 This command is still a work in progress and is considered
4020 experimental. Stay away from it unless you want to help with its
4021 development.
4022
4023 Arguments:
4024
4025 - "id": Name of the block backend device to delete (json-string, optional)
4026 - "node-name": Name of the graph node to delete (json-string, optional)
4027
4028 Example:
4029
4030 -> { "execute": "blockdev-add",
4031      "arguments": {
4032          "options": {
4033              "driver": "qcow2",
4034              "id": "drive0",
4035              "file": {
4036                  "driver": "file",
4037                  "filename": "test.qcow2"
4038              }
4039          }
4040      }
4041    }
4042
4043 <- { "return": {} }
4044
4045 -> { "execute": "x-blockdev-del",
4046      "arguments": { "id": "drive0" }
4047    }
4048 <- { "return": {} }
4049
4050 EQMP
4051
4052     {
4053         .name       = "blockdev-open-tray",
4054         .args_type  = "device:s,force:b?",
4055         .mhandler.cmd_new = qmp_marshal_blockdev_open_tray,
4056     },
4057
4058 SQMP
4059 blockdev-open-tray
4060 ------------------
4061
4062 Opens a block device's tray. If there is a block driver state tree inserted as a
4063 medium, it will become inaccessible to the guest (but it will remain associated
4064 to the block device, so closing the tray will make it accessible again).
4065
4066 If the tray was already open before, this will be a no-op.
4067
4068 Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
4069 which no such event will be generated, these include:
4070 - if the guest has locked the tray, @force is false and the guest does not
4071   respond to the eject request
4072 - if the BlockBackend denoted by @device does not have a guest device attached
4073   to it
4074 - if the guest device does not have an actual tray and is empty, for instance
4075   for floppy disk drives
4076
4077 Arguments:
4078
4079 - "device": block device name (json-string)
4080 - "force": if false (the default), an eject request will be sent to the guest if
4081            it has locked the tray (and the tray will not be opened immediately);
4082            if true, the tray will be opened regardless of whether it is locked
4083            (json-bool, optional)
4084
4085 Example:
4086
4087 -> { "execute": "blockdev-open-tray",
4088      "arguments": { "device": "ide1-cd0" } }
4089
4090 <- { "timestamp": { "seconds": 1418751016,
4091                     "microseconds": 716996 },
4092      "event": "DEVICE_TRAY_MOVED",
4093      "data": { "device": "ide1-cd0",
4094                "tray-open": true } }
4095
4096 <- { "return": {} }
4097
4098 EQMP
4099
4100     {
4101         .name       = "blockdev-close-tray",
4102         .args_type  = "device:s",
4103         .mhandler.cmd_new = qmp_marshal_blockdev_close_tray,
4104     },
4105
4106 SQMP
4107 blockdev-close-tray
4108 -------------------
4109
4110 Closes a block device's tray. If there is a block driver state tree associated
4111 with the block device (which is currently ejected), that tree will be loaded as
4112 the medium.
4113
4114 If the tray was already closed before, this will be a no-op.
4115
4116 Arguments:
4117
4118 - "device": block device name (json-string)
4119
4120 Example:
4121
4122 -> { "execute": "blockdev-close-tray",
4123      "arguments": { "device": "ide1-cd0" } }
4124
4125 <- { "timestamp": { "seconds": 1418751345,
4126                     "microseconds": 272147 },
4127      "event": "DEVICE_TRAY_MOVED",
4128      "data": { "device": "ide1-cd0",
4129                "tray-open": false } }
4130
4131 <- { "return": {} }
4132
4133 EQMP
4134
4135     {
4136         .name       = "blockdev-remove-medium",
4137         .args_type  = "device:s",
4138         .mhandler.cmd_new = qmp_marshal_blockdev_remove_medium,
4139     },
4140
4141 SQMP
4142 blockdev-remove-medium
4143 ----------------------
4144
4145 Removes a medium (a block driver state tree) from a block device. That block
4146 device's tray must currently be open (unless there is no attached guest device).
4147
4148 If the tray is open and there is no medium inserted, this will be a no-op.
4149
4150 Arguments:
4151
4152 - "device": block device name (json-string)
4153
4154 Example:
4155
4156 -> { "execute": "blockdev-remove-medium",
4157      "arguments": { "device": "ide1-cd0" } }
4158
4159 <- { "error": { "class": "GenericError",
4160                 "desc": "Tray of device 'ide1-cd0' is not open" } }
4161
4162 -> { "execute": "blockdev-open-tray",
4163      "arguments": { "device": "ide1-cd0" } }
4164
4165 <- { "timestamp": { "seconds": 1418751627,
4166                     "microseconds": 549958 },
4167      "event": "DEVICE_TRAY_MOVED",
4168      "data": { "device": "ide1-cd0",
4169                "tray-open": true } }
4170
4171 <- { "return": {} }
4172
4173 -> { "execute": "blockdev-remove-medium",
4174      "arguments": { "device": "ide1-cd0" } }
4175
4176 <- { "return": {} }
4177
4178 EQMP
4179
4180     {
4181         .name       = "blockdev-insert-medium",
4182         .args_type  = "device:s,node-name:s",
4183         .mhandler.cmd_new = qmp_marshal_blockdev_insert_medium,
4184     },
4185
4186 SQMP
4187 blockdev-insert-medium
4188 ----------------------
4189
4190 Inserts a medium (a block driver state tree) into a block device. That block
4191 device's tray must currently be open (unless there is no attached guest device)
4192 and there must be no medium inserted already.
4193
4194 Arguments:
4195
4196 - "device": block device name (json-string)
4197 - "node-name": root node of the BDS tree to insert into the block device
4198
4199 Example:
4200
4201 -> { "execute": "blockdev-add",
4202      "arguments": { "options": { "node-name": "node0",
4203                                  "driver": "raw",
4204                                  "file": { "driver": "file",
4205                                            "filename": "fedora.iso" } } } }
4206
4207 <- { "return": {} }
4208
4209 -> { "execute": "blockdev-insert-medium",
4210      "arguments": { "device": "ide1-cd0",
4211                     "node-name": "node0" } }
4212
4213 <- { "return": {} }
4214
4215 EQMP
4216
4217     {
4218         .name       = "query-named-block-nodes",
4219         .args_type  = "",
4220         .mhandler.cmd_new = qmp_marshal_query_named_block_nodes,
4221     },
4222
4223 SQMP
4224 @query-named-block-nodes
4225 ------------------------
4226
4227 Return a list of BlockDeviceInfo for all the named block driver nodes
4228
4229 Example:
4230
4231 -> { "execute": "query-named-block-nodes" }
4232 <- { "return": [ { "ro":false,
4233                    "drv":"qcow2",
4234                    "encrypted":false,
4235                    "file":"disks/test.qcow2",
4236                    "node-name": "my-node",
4237                    "backing_file_depth":1,
4238                    "bps":1000000,
4239                    "bps_rd":0,
4240                    "bps_wr":0,
4241                    "iops":1000000,
4242                    "iops_rd":0,
4243                    "iops_wr":0,
4244                    "bps_max": 8000000,
4245                    "bps_rd_max": 0,
4246                    "bps_wr_max": 0,
4247                    "iops_max": 0,
4248                    "iops_rd_max": 0,
4249                    "iops_wr_max": 0,
4250                    "iops_size": 0,
4251                    "write_threshold": 0,
4252                    "image":{
4253                       "filename":"disks/test.qcow2",
4254                       "format":"qcow2",
4255                       "virtual-size":2048000,
4256                       "backing_file":"base.qcow2",
4257                       "full-backing-filename":"disks/base.qcow2",
4258                       "backing-filename-format":"qcow2",
4259                       "snapshots":[
4260                          {
4261                             "id": "1",
4262                             "name": "snapshot1",
4263                             "vm-state-size": 0,
4264                             "date-sec": 10000200,
4265                             "date-nsec": 12,
4266                             "vm-clock-sec": 206,
4267                             "vm-clock-nsec": 30
4268                          }
4269                       ],
4270                       "backing-image":{
4271                           "filename":"disks/base.qcow2",
4272                           "format":"qcow2",
4273                           "virtual-size":2048000
4274                       }
4275                    } } ] }
4276
4277 EQMP
4278
4279     {
4280         .name       = "blockdev-change-medium",
4281         .args_type  = "device:B,filename:F,format:s?,read-only-mode:s?",
4282         .mhandler.cmd_new = qmp_marshal_blockdev_change_medium,
4283     },
4284
4285 SQMP
4286 blockdev-change-medium
4287 ----------------------
4288
4289 Changes the medium inserted into a block device by ejecting the current medium
4290 and loading a new image file which is inserted as the new medium.
4291
4292 Arguments:
4293
4294 - "device": device name (json-string)
4295 - "filename": filename of the new image (json-string)
4296 - "format": format of the new image (json-string, optional)
4297 - "read-only-mode": new read-only mode (json-string, optional)
4298           - Possible values: "retain" (default), "read-only", "read-write"
4299
4300 Examples:
4301
4302 1. Change a removable medium
4303
4304 -> { "execute": "blockdev-change-medium",
4305              "arguments": { "device": "ide1-cd0",
4306                             "filename": "/srv/images/Fedora-12-x86_64-DVD.iso",
4307                             "format": "raw" } }
4308 <- { "return": {} }
4309
4310 2. Load a read-only medium into a writable drive
4311
4312 -> { "execute": "blockdev-change-medium",
4313              "arguments": { "device": "isa-fd0",
4314                             "filename": "/srv/images/ro.img",
4315                             "format": "raw",
4316                             "read-only-mode": "retain" } }
4317
4318 <- { "error":
4319      { "class": "GenericError",
4320        "desc": "Could not open '/srv/images/ro.img': Permission denied" } }
4321
4322 -> { "execute": "blockdev-change-medium",
4323              "arguments": { "device": "isa-fd0",
4324                             "filename": "/srv/images/ro.img",
4325                             "format": "raw",
4326                             "read-only-mode": "read-only" } }
4327
4328 <- { "return": {} }
4329
4330 EQMP
4331
4332     {
4333         .name       = "query-memdev",
4334         .args_type  = "",
4335         .mhandler.cmd_new = qmp_marshal_query_memdev,
4336     },
4337
4338 SQMP
4339 query-memdev
4340 ------------
4341
4342 Show memory devices information.
4343
4344
4345 Example (1):
4346
4347 -> { "execute": "query-memdev" }
4348 <- { "return": [
4349        {
4350          "size": 536870912,
4351          "merge": false,
4352          "dump": true,
4353          "prealloc": false,
4354          "host-nodes": [0, 1],
4355          "policy": "bind"
4356        },
4357        {
4358          "size": 536870912,
4359          "merge": false,
4360          "dump": true,
4361          "prealloc": true,
4362          "host-nodes": [2, 3],
4363          "policy": "preferred"
4364        }
4365      ]
4366    }
4367
4368 EQMP
4369
4370     {
4371         .name       = "query-memory-devices",
4372         .args_type  = "",
4373         .mhandler.cmd_new = qmp_marshal_query_memory_devices,
4374     },
4375
4376 SQMP
4377 @query-memory-devices
4378 --------------------
4379
4380 Return a list of memory devices.
4381
4382 Example:
4383 -> { "execute": "query-memory-devices" }
4384 <- { "return": [ { "data":
4385                       { "addr": 5368709120,
4386                         "hotpluggable": true,
4387                         "hotplugged": true,
4388                         "id": "d1",
4389                         "memdev": "/objects/memX",
4390                         "node": 0,
4391                         "size": 1073741824,
4392                         "slot": 0},
4393                    "type": "dimm"
4394                  } ] }
4395 EQMP
4396
4397     {
4398         .name       = "query-acpi-ospm-status",
4399         .args_type  = "",
4400         .mhandler.cmd_new = qmp_marshal_query_acpi_ospm_status,
4401     },
4402
4403 SQMP
4404 @query-acpi-ospm-status
4405 --------------------
4406
4407 Return list of ACPIOSTInfo for devices that support status reporting
4408 via ACPI _OST method.
4409
4410 Example:
4411 -> { "execute": "query-acpi-ospm-status" }
4412 <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
4413                  { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
4414                  { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
4415                  { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
4416    ]}
4417 EQMP
4418
4419 #if defined TARGET_I386
4420     {
4421         .name       = "rtc-reset-reinjection",
4422         .args_type  = "",
4423         .mhandler.cmd_new = qmp_marshal_rtc_reset_reinjection,
4424     },
4425 #endif
4426
4427 SQMP
4428 rtc-reset-reinjection
4429 ---------------------
4430
4431 Reset the RTC interrupt reinjection backlog.
4432
4433 Arguments: None.
4434
4435 Example:
4436
4437 -> { "execute": "rtc-reset-reinjection" }
4438 <- { "return": {} }
4439 EQMP
4440
4441     {
4442         .name       = "trace-event-get-state",
4443         .args_type  = "name:s",
4444         .mhandler.cmd_new = qmp_marshal_trace_event_get_state,
4445     },
4446
4447 SQMP
4448 trace-event-get-state
4449 ---------------------
4450
4451 Query the state of events.
4452
4453 Example:
4454
4455 -> { "execute": "trace-event-get-state", "arguments": { "name": "qemu_memalign" } }
4456 <- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
4457 EQMP
4458
4459     {
4460         .name       = "trace-event-set-state",
4461         .args_type  = "name:s,enable:b,ignore-unavailable:b?",
4462         .mhandler.cmd_new = qmp_marshal_trace_event_set_state,
4463     },
4464
4465 SQMP
4466 trace-event-set-state
4467 ---------------------
4468
4469 Set the state of events.
4470
4471 Example:
4472
4473 -> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } }
4474 <- { "return": {} }
4475 EQMP
4476
4477     {
4478         .name       = "x-input-send-event",
4479         .args_type  = "console:i?,events:q",
4480         .mhandler.cmd_new = qmp_marshal_x_input_send_event,
4481     },
4482
4483 SQMP
4484 @x-input-send-event
4485 -----------------
4486
4487 Send input event to guest.
4488
4489 Arguments:
4490
4491 - "console": console index. (json-int, optional)
4492 - "events": list of input events.
4493
4494 The consoles are visible in the qom tree, under
4495 /backend/console[$index]. They have a device link and head property, so
4496 it is possible to map which console belongs to which device and display.
4497
4498 Note: this command is experimental, and not a stable API.
4499
4500 Example (1):
4501
4502 Press left mouse button.
4503
4504 -> { "execute": "x-input-send-event",
4505     "arguments": { "console": 0,
4506                    "events": [ { "type": "btn",
4507                     "data" : { "down": true, "button": "Left" } } ] } }
4508 <- { "return": {} }
4509
4510 -> { "execute": "x-input-send-event",
4511     "arguments": { "console": 0,
4512                    "events": [ { "type": "btn",
4513                     "data" : { "down": false, "button": "Left" } } ] } }
4514 <- { "return": {} }
4515
4516 Example (2):
4517
4518 Press ctrl-alt-del.
4519
4520 -> { "execute": "x-input-send-event",
4521      "arguments": { "console": 0, "events": [
4522         { "type": "key", "data" : { "down": true,
4523           "key": {"type": "qcode", "data": "ctrl" } } },
4524         { "type": "key", "data" : { "down": true,
4525           "key": {"type": "qcode", "data": "alt" } } },
4526         { "type": "key", "data" : { "down": true,
4527           "key": {"type": "qcode", "data": "delete" } } } ] } }
4528 <- { "return": {} }
4529
4530 Example (3):
4531
4532 Move mouse pointer to absolute coordinates (20000, 400).
4533
4534 -> { "execute": "x-input-send-event" ,
4535   "arguments": { "console": 0, "events": [
4536                { "type": "abs", "data" : { "axis": "X", "value" : 20000 } },
4537                { "type": "abs", "data" : { "axis": "Y", "value" : 400 } } ] } }
4538 <- { "return": {} }
4539
4540 EQMP
4541
4542     {
4543         .name       = "block-set-write-threshold",
4544         .args_type  = "node-name:s,write-threshold:l",
4545         .mhandler.cmd_new = qmp_marshal_block_set_write_threshold,
4546     },
4547
4548 SQMP
4549 block-set-write-threshold
4550 ------------
4551
4552 Change the write threshold for a block drive. The threshold is an offset,
4553 thus must be non-negative. Default is no write threshold.
4554 Setting the threshold to zero disables it.
4555
4556 Arguments:
4557
4558 - "node-name": the node name in the block driver state graph (json-string)
4559 - "write-threshold": the write threshold in bytes (json-int)
4560
4561 Example:
4562
4563 -> { "execute": "block-set-write-threshold",
4564   "arguments": { "node-name": "mydev",
4565                  "write-threshold": 17179869184 } }
4566 <- { "return": {} }
4567
4568 EQMP
4569
4570     {
4571         .name       = "query-rocker",
4572         .args_type  = "name:s",
4573         .mhandler.cmd_new = qmp_marshal_query_rocker,
4574     },
4575
4576 SQMP
4577 Show rocker switch
4578 ------------------
4579
4580 Arguments:
4581
4582 - "name": switch name
4583
4584 Example:
4585
4586 -> { "execute": "query-rocker", "arguments": { "name": "sw1" } }
4587 <- { "return": {"name": "sw1", "ports": 2, "id": 1327446905938}}
4588
4589 EQMP
4590
4591     {
4592         .name       = "query-rocker-ports",
4593         .args_type  = "name:s",
4594         .mhandler.cmd_new = qmp_marshal_query_rocker_ports,
4595     },
4596
4597 SQMP
4598 Show rocker switch ports
4599 ------------------------
4600
4601 Arguments:
4602
4603 - "name": switch name
4604
4605 Example:
4606
4607 -> { "execute": "query-rocker-ports", "arguments": { "name": "sw1" } }
4608 <- { "return": [ {"duplex": "full", "enabled": true, "name": "sw1.1",
4609                   "autoneg": "off", "link-up": true, "speed": 10000},
4610                  {"duplex": "full", "enabled": true, "name": "sw1.2",
4611                   "autoneg": "off", "link-up": true, "speed": 10000}
4612    ]}
4613
4614 EQMP
4615
4616     {
4617         .name       = "query-rocker-of-dpa-flows",
4618         .args_type  = "name:s,tbl-id:i?",
4619         .mhandler.cmd_new = qmp_marshal_query_rocker_of_dpa_flows,
4620     },
4621
4622 SQMP
4623 Show rocker switch OF-DPA flow tables
4624 -------------------------------------
4625
4626 Arguments:
4627
4628 - "name": switch name
4629 - "tbl-id": (optional) flow table ID
4630
4631 Example:
4632
4633 -> { "execute": "query-rocker-of-dpa-flows", "arguments": { "name": "sw1" } }
4634 <- { "return": [ {"key": {"in-pport": 0, "priority": 1, "tbl-id": 0},
4635                   "hits": 138,
4636                   "cookie": 0,
4637                   "action": {"goto-tbl": 10},
4638                   "mask": {"in-pport": 4294901760}
4639                  },
4640                  {...more...},
4641    ]}
4642
4643 EQMP
4644
4645     {
4646         .name       = "query-rocker-of-dpa-groups",
4647         .args_type  = "name:s,type:i?",
4648         .mhandler.cmd_new = qmp_marshal_query_rocker_of_dpa_groups,
4649     },
4650
4651 SQMP
4652 Show rocker OF-DPA group tables
4653 -------------------------------
4654
4655 Arguments:
4656
4657 - "name": switch name
4658 - "type": (optional) group type
4659
4660 Example:
4661
4662 -> { "execute": "query-rocker-of-dpa-groups", "arguments": { "name": "sw1" } }
4663 <- { "return": [ {"type": 0, "out-pport": 2, "pport": 2, "vlan-id": 3841,
4664                   "pop-vlan": 1, "id": 251723778},
4665                  {"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3841,
4666                   "pop-vlan": 1, "id": 251723776},
4667                  {"type": 0, "out-pport": 1, "pport": 1, "vlan-id": 3840,
4668                   "pop-vlan": 1, "id": 251658241},
4669                  {"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3840,
4670                   "pop-vlan": 1, "id": 251658240}
4671    ]}