qmp-commands.hx

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