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 efect 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         .params     = "",
  67         .help       = "quit the emulator",
  68         .user_print = monitor_user_noop,
  69         .mhandler.cmd_new = do_quit,
  70     },
  71
  72 SQMP
  73 quit
  74 ----
  75
  76 Quit the emulator.
  77
  78 Arguments: None.
  79
  80 Example:
  81
  82 -> { "execute": "quit" }
  83 <- { "return": {} }
  84
  85 EQMP
  86
  87     {
  88         .name       = "eject",
  89         .args_type  = "force:-f,device:B",
  90         .params     = "[-f] device",
  91         .help       = "eject a removable medium (use -f to force it)",
  92         .user_print = monitor_user_noop,
  93         .mhandler.cmd_new = do_eject,
  94     },
  95
  96 SQMP
  97 eject
  98 -----
  99
 100 Eject a removable medium.
 101
 102 Arguments:
 103
 104 - force: force ejection (json-bool, optional)
 105 - device: device name (json-string)
 106
 107 Example:
 108
 109 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
 110 <- { "return": {} }
 111
 112 Note: The "force" argument defaults to false.
 113
 114 EQMP
 115
 116     {
 117         .name       = "change",
 118         .args_type  = "device:B,target:F,arg:s?",
 119         .params     = "device filename [format]",
 120         .help       = "change a removable medium, optional format",
 121         .user_print = monitor_user_noop,
 122         .mhandler.cmd_new = do_change,
 123     },
 124
 125 SQMP
 126 change
 127 ------
 128
 129 Change a removable medium or VNC configuration.
 130
 131 Arguments:
 132
 133 - "device": device name (json-string)
 134 - "target": filename or item (json-string)
 135 - "arg": additional argument (json-string, optional)
 136
 137 Examples:
 138
 139 1. Change a removable medium
 140
 141 -> { "execute": "change",
 142              "arguments": { "device": "ide1-cd0",
 143                             "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
 144 <- { "return": {} }
 145
 146 2. Change VNC password
 147
 148 -> { "execute": "change",
 149              "arguments": { "device": "vnc", "target": "password",
 150                             "arg": "foobar1" } }
 151 <- { "return": {} }
 152
 153 EQMP
 154
 155     {
 156         .name       = "screendump",
 157         .args_type  = "filename:F",
 158         .params     = "filename",
 159         .help       = "save screen into PPM image 'filename'",
 160         .user_print = monitor_user_noop,
 161         .mhandler.cmd_new = do_screen_dump,
 162     },
 163
 164 SQMP
 165 screendump
 166 ----------
 167
 168 Save screen into PPM image.
 169
 170 Arguments:
 171
 172 - "filename": file path (json-string)
 173
 174 Example:
 175
 176 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
 177 <- { "return": {} }
 178
 179 EQMP
 180
 181     {
 182         .name       = "stop",
 183         .args_type  = "",
 184         .params     = "",
 185         .help       = "stop emulation",
 186         .user_print = monitor_user_noop,
 187         .mhandler.cmd_new = do_stop,
 188     },
 189
 190 SQMP
 191 stop
 192 ----
 193
 194 Stop the emulator.
 195
 196 Arguments: None.
 197
 198 Example:
 199
 200 -> { "execute": "stop" }
 201 <- { "return": {} }
 202
 203 EQMP
 204
 205     {
 206         .name       = "cont",
 207         .args_type  = "",
 208         .params     = "",
 209         .help       = "resume emulation",
 210         .user_print = monitor_user_noop,
 211         .mhandler.cmd_new = do_cont,
 212     },
 213
 214 SQMP
 215 cont
 216 ----
 217
 218 Resume emulation.
 219
 220 Arguments: None.
 221
 222 Example:
 223
 224 -> { "execute": "cont" }
 225 <- { "return": {} }
 226
 227 EQMP
 228
 229     {
 230         .name       = "system_reset",
 231         .args_type  = "",
 232         .params     = "",
 233         .help       = "reset the system",
 234         .user_print = monitor_user_noop,
 235         .mhandler.cmd_new = do_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         .params     = "",
 257         .help       = "send system power down event",
 258         .user_print = monitor_user_noop,
 259         .mhandler.cmd_new = do_system_powerdown,
 260     },
 261
 262 SQMP
 263 system_powerdown
 264 ----------------
 265
 266 Send system power down event.
 267
 268 Arguments: None.
 269
 270 Example:
 271
 272 -> { "execute": "system_powerdown" }
 273 <- { "return": {} }
 274
 275 EQMP
 276
 277     {
 278         .name       = "device_add",
 279         .args_type  = "device:O",
 280         .params     = "driver[,prop=value][,...]",
 281         .help       = "add device, like -device on the command line",
 282         .user_print = monitor_user_noop,
 283         .mhandler.cmd_new = do_device_add,
 284     },
 285
 286 SQMP
 287 device_add
 288 ----------
 289
 290 Add a device.
 291
 292 Arguments:
 293
 294 - "driver": the name of the new device's driver (json-string)
 295 - "bus": the device's parent bus (device tree path, json-string, optional)
 296 - "id": the device's ID, must be unique (json-string)
 297 - device properties
 298
 299 Example:
 300
 301 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
 302 <- { "return": {} }
 303
 304 Notes:
 305
 306 (1) For detailed information about this command, please refer to the
 307     'docs/qdev-device-use.txt' file.
 308
 309 (2) It's possible to list device properties by running QEMU with the
 310     "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
 311
 312 EQMP
 313
 314     {
 315         .name       = "device_del",
 316         .args_type  = "id:s",
 317         .params     = "device",
 318         .help       = "remove device",
 319         .user_print = monitor_user_noop,
 320         .mhandler.cmd_new = do_device_del,
 321     },
 322
 323 SQMP
 324 device_del
 325 ----------
 326
 327 Remove a device.
 328
 329 Arguments:
 330
 331 - "id": the device's ID (json-string)
 332
 333 Example:
 334
 335 -> { "execute": "device_del", "arguments": { "id": "net1" } }
 336 <- { "return": {} }
 337
 338 EQMP
 339
 340     {
 341         .name       = "cpu",
 342         .args_type  = "index:i",
 343         .params     = "index",
 344         .help       = "set the default CPU",
 345         .user_print = monitor_user_noop,
 346         .mhandler.cmd_new = do_cpu_set,
 347     },
 348
 349 SQMP
 350 cpu
 351 ---
 352
 353 Set the default CPU.
 354
 355 Arguments:
 356
 357 - "index": the CPU's index (json-int)
 358
 359 Example:
 360
 361 -> { "execute": "cpu", "arguments": { "index": 0 } }
 362 <- { "return": {} }
 363
 364 Note: CPUs' indexes are obtained with the 'query-cpus' command.
 365
 366 EQMP
 367
 368     {
 369         .name       = "memsave",
 370         .args_type  = "val:l,size:i,filename:s",
 371         .params     = "addr size file",
 372         .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
 373         .user_print = monitor_user_noop,
 374         .mhandler.cmd_new = do_memory_save,
 375     },
 376
 377 SQMP
 378 memsave
 379 -------
 380
 381 Save to disk virtual memory dump starting at 'val' of size 'size'.
 382
 383 Arguments:
 384
 385 - "val": the starting address (json-int)
 386 - "size": the memory size, in bytes (json-int)
 387 - "filename": file path (json-string)
 388
 389 Example:
 390
 391 -> { "execute": "memsave",
 392              "arguments": { "val": 10,
 393                             "size": 100,
 394                             "filename": "/tmp/virtual-mem-dump" } }
 395 <- { "return": {} }
 396
 397 Note: Depends on the current CPU.
 398
 399 EQMP
 400
 401     {
 402         .name       = "pmemsave",
 403         .args_type  = "val:l,size:i,filename:s",
 404         .params     = "addr size file",
 405         .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
 406         .user_print = monitor_user_noop,
 407         .mhandler.cmd_new = do_physical_memory_save,
 408     },
 409
 410 SQMP
 411 pmemsave
 412 --------
 413
 414 Save to disk physical memory dump starting at 'val' of size 'size'.
 415
 416 Arguments:
 417
 418 - "val": the starting address (json-int)
 419 - "size": the memory size, in bytes (json-int)
 420 - "filename": file path (json-string)
 421
 422 Example:
 423
 424 -> { "execute": "pmemsave",
 425              "arguments": { "val": 10,
 426                             "size": 100,
 427                             "filename": "/tmp/physical-mem-dump" } }
 428 <- { "return": {} }
 429
 430 EQMP
 431
 432     {
 433         .name       = "migrate",
 434         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 435         .params     = "[-d] [-b] [-i] uri",
 436         .help       = "migrate to URI (using -d to not wait for completion)"
 437                       "\n\t\t\t -b for migration without shared storage with"
 438                       " full copy of disk\n\t\t\t -i for migration without "
 439                       "shared storage with incremental copy of disk "
 440                       "(base image shared between src and destination)",
 441         .user_print = monitor_user_noop,
 442         .mhandler.cmd_new = do_migrate,
 443     },
 444
 445 SQMP
 446 migrate
 447 -------
 448
 449 Migrate to URI.
 450
 451 Arguments:
 452
 453 - "blk": block migration, full disk copy (json-bool, optional)
 454 - "inc": incremental disk copy (json-bool, optional)
 455 - "uri": Destination URI (json-string)
 456
 457 Example:
 458
 459 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
 460 <- { "return": {} }
 461
 462 Notes:
 463
 464 (1) The 'query-migrate' command should be used to check migration's progress
 465     and final result (this information is provided by the 'status' member)
 466 (2) All boolean arguments default to false
 467 (3) The user Monitor's "detach" argument is invalid in QMP and should not
 468     be used
 469
 470 EQMP
 471
 472     {
 473         .name       = "migrate_cancel",
 474         .args_type  = "",
 475         .params     = "",
 476         .help       = "cancel the current VM migration",
 477         .user_print = monitor_user_noop,
 478         .mhandler.cmd_new = do_migrate_cancel,
 479     },
 480
 481 SQMP
 482 migrate_cancel
 483 --------------
 484
 485 Cancel the current migration.
 486
 487 Arguments: None.
 488
 489 Example:
 490
 491 -> { "execute": "migrate_cancel" }
 492 <- { "return": {} }
 493
 494 EQMP
 495
 496     {
 497         .name       = "migrate_set_speed",
 498         .args_type  = "value:o",
 499         .params     = "value",
 500         .help       = "set maximum speed (in bytes) for migrations",
 501         .user_print = monitor_user_noop,
 502         .mhandler.cmd_new = do_migrate_set_speed,
 503     },
 504
 505 SQMP
 506 client_migrate_info
 507 ------------------
 508
 509 Set the spice/vnc connection info for the migration target.  The spice/vnc
 510 server will ask the spice/vnc client to automatically reconnect using the
 511 new parameters (if specified) once the vm migration finished successfully.
 512
 513 Arguments:
 514
 515 - "protocol":     protocol: "spice" or "vnc" (json-string)
 516 - "hostname":     migration target hostname (json-string)
 517 - "port":         spice/vnc tcp port for plaintext channels (json-int, optional)
 518 - "tls-port":     spice tcp port for tls-secured channels (json-int, optional)
 519 - "cert-subject": server certificate subject (json-string, optional)
 520
 521 Example:
 522
 523 -> { "execute": "client_migrate_info",
 524      "arguments": { "protocol": "spice",
 525                     "hostname": "virt42.lab.kraxel.org",
 526                     "port": 1234 } }
 527 <- { "return": {} }
 528
 529 EQMP
 530
 531     {
 532         .name       = "client_migrate_info",
 533         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
 534         .params     = "protocol hostname port tls-port cert-subject",
 535         .help       = "send migration info to spice/vnc client",
 536         .user_print = monitor_user_noop,
 537         .mhandler.cmd_new = client_migrate_info,
 538     },
 539
 540 SQMP
 541 migrate_set_speed
 542 -----------------
 543
 544 Set maximum speed for migrations.
 545
 546 Arguments:
 547
 548 - "value": maximum speed, in bytes per second (json-int)
 549
 550 Example:
 551
 552 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
 553 <- { "return": {} }
 554
 555 EQMP
 556
 557     {
 558         .name       = "migrate_set_downtime",
 559         .args_type  = "value:T",
 560         .params     = "value",
 561         .help       = "set maximum tolerated downtime (in seconds) for migrations",
 562         .user_print = monitor_user_noop,
 563         .mhandler.cmd_new = do_migrate_set_downtime,
 564     },
 565
 566 SQMP
 567 migrate_set_downtime
 568 --------------------
 569
 570 Set maximum tolerated downtime (in seconds) for migrations.
 571
 572 Arguments:
 573
 574 - "value": maximum downtime (json-number)
 575
 576 Example:
 577
 578 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
 579 <- { "return": {} }
 580
 581 EQMP
 582
 583     {
 584         .name       = "netdev_add",
 585         .args_type  = "netdev:O",
 586         .params     = "[user|tap|socket],id=str[,prop=value][,...]",
 587         .help       = "add host network device",
 588         .user_print = monitor_user_noop,
 589         .mhandler.cmd_new = do_netdev_add,
 590     },
 591
 592 SQMP
 593 netdev_add
 594 ----------
 595
 596 Add host network device.
 597
 598 Arguments:
 599
 600 - "type": the device type, "tap", "user", ... (json-string)
 601 - "id": the device's ID, must be unique (json-string)
 602 - device options
 603
 604 Example:
 605
 606 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
 607 <- { "return": {} }
 608
 609 Note: The supported device options are the same ones supported by the '-net'
 610       command-line argument, which are listed in the '-help' output or QEMU's
 611       manual
 612
 613 EQMP
 614
 615     {
 616         .name       = "netdev_del",
 617         .args_type  = "id:s",
 618         .params     = "id",
 619         .help       = "remove host network device",
 620         .user_print = monitor_user_noop,
 621         .mhandler.cmd_new = do_netdev_del,
 622     },
 623
 624 SQMP
 625 netdev_del
 626 ----------
 627
 628 Remove host network device.
 629
 630 Arguments:
 631
 632 - "id": the device's ID, must be unique (json-string)
 633
 634 Example:
 635
 636 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
 637 <- { "return": {} }
 638
 639 EQMP
 640
 641     {
 642         .name       = "balloon",
 643         .args_type  = "value:M",
 644         .params     = "target",
 645         .help       = "request VM to change its memory allocation (in MB)",
 646         .user_print = monitor_user_noop,
 647         .mhandler.cmd_async = do_balloon,
 648         .flags      = MONITOR_CMD_ASYNC,
 649     },
 650
 651 SQMP
 652 balloon
 653 -------
 654
 655 Request VM to change its memory allocation (in bytes).
 656
 657 Arguments:
 658
 659 - "value": New memory allocation (json-int)
 660
 661 Example:
 662
 663 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
 664 <- { "return": {} }
 665
 666 EQMP
 667
 668     {
 669         .name       = "set_link",
 670         .args_type  = "name:s,up:b",
 671         .params     = "name on|off",
 672         .help       = "change the link status of a network adapter",
 673         .user_print = monitor_user_noop,
 674         .mhandler.cmd_new = do_set_link,
 675     },
 676
 677 SQMP
 678 set_link
 679 --------
 680
 681 Change the link status of a network adapter.
 682
 683 Arguments:
 684
 685 - "name": network device name (json-string)
 686 - "up": status is up (json-bool)
 687
 688 Example:
 689
 690 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
 691 <- { "return": {} }
 692
 693 EQMP
 694
 695     {
 696         .name       = "getfd",
 697         .args_type  = "fdname:s",
 698         .params     = "getfd name",
 699         .help       = "receive a file descriptor via SCM rights and assign it a name",
 700         .user_print = monitor_user_noop,
 701         .mhandler.cmd_new = do_getfd,
 702     },
 703
 704 SQMP
 705 getfd
 706 -----
 707
 708 Receive a file descriptor via SCM rights and assign it a name.
 709
 710 Arguments:
 711
 712 - "fdname": file descriptor name (json-string)
 713
 714 Example:
 715
 716 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
 717 <- { "return": {} }
 718
 719 EQMP
 720
 721     {
 722         .name       = "closefd",
 723         .args_type  = "fdname:s",
 724         .params     = "closefd name",
 725         .help       = "close a file descriptor previously passed via SCM rights",
 726         .user_print = monitor_user_noop,
 727         .mhandler.cmd_new = do_closefd,
 728     },
 729
 730 SQMP
 731 closefd
 732 -------
 733
 734 Close a file descriptor previously passed via SCM rights.
 735
 736 Arguments:
 737
 738 - "fdname": file descriptor name (json-string)
 739
 740 Example:
 741
 742 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
 743 <- { "return": {} }
 744
 745 EQMP
 746
 747     {
 748         .name       = "block_passwd",
 749         .args_type  = "device:B,password:s",
 750         .params     = "block_passwd device password",
 751         .help       = "set the password of encrypted block devices",
 752         .user_print = monitor_user_noop,
 753         .mhandler.cmd_new = do_block_set_passwd,
 754     },
 755
 756 SQMP
 757 block_passwd
 758 ------------
 759
 760 Set the password of encrypted block devices.
 761
 762 Arguments:
 763
 764 - "device": device name (json-string)
 765 - "password": password (json-string)
 766
 767 Example:
 768
 769 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
 770                                                "password": "12345" } }
 771 <- { "return": {} }
 772
 773 EQMP
 774
 775     {
 776         .name       = "set_password",
 777         .args_type  = "protocol:s,password:s,connected:s?",
 778         .params     = "protocol password action-if-connected",
 779         .help       = "set spice/vnc password",
 780         .user_print = monitor_user_noop,
 781         .mhandler.cmd_new = set_password,
 782     },
 783
 784 SQMP
 785 set_password
 786 ------------
 787
 788 Set the password for vnc/spice protocols.
 789
 790 Arguments:
 791
 792 - "protocol": protocol name (json-string)
 793 - "password": password (json-string)
 794 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
 795
 796 Example:
 797
 798 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
 799                                                "password": "secret" } }
 800 <- { "return": {} }
 801
 802 EQMP
 803
 804     {
 805         .name       = "expire_password",
 806         .args_type  = "protocol:s,time:s",
 807         .params     = "protocol time",
 808         .help       = "set spice/vnc password expire-time",
 809         .user_print = monitor_user_noop,
 810         .mhandler.cmd_new = expire_password,
 811     },
 812
 813 SQMP
 814 expire_password
 815 ---------------
 816
 817 Set the password expire time for vnc/spice protocols.
 818
 819 Arguments:
 820
 821 - "protocol": protocol name (json-string)
 822 - "time": [ now | never | +secs | secs ] (json-string)
 823
 824 Example:
 825
 826 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
 827                                                   "time": "+60" } }
 828 <- { "return": {} }
 829
 830 EQMP
 831
 832     {
 833         .name       = "qmp_capabilities",
 834         .args_type  = "",
 835         .params     = "",
 836         .help       = "enable QMP capabilities",
 837         .user_print = monitor_user_noop,
 838         .mhandler.cmd_new = do_qmp_capabilities,
 839     },
 840
 841 SQMP
 842 qmp_capabilities
 843 ----------------
 844
 845 Enable QMP capabilities.
 846
 847 Arguments: None.
 848
 849 Example:
 850
 851 -> { "execute": "qmp_capabilities" }
 852 <- { "return": {} }
 853
 854 Note: This command must be issued before issuing any other command.
 855
 856 EQMP
 857
 858     {
 859         .name       = "human-monitor-command",
 860         .args_type  = "command-line:s,cpu-index:i?",
 861         .params     = "",
 862         .help       = "",
 863         .user_print = monitor_user_noop,
 864         .mhandler.cmd_new = do_hmp_passthrough,
 865     },
 866
 867 SQMP
 868 human-monitor-command
 869 ---------------------
 870
 871 Execute a Human Monitor command.
 872
 873 Arguments:
 874
 875 - command-line: the command name and its arguments, just like the
 876                 Human Monitor's shell (json-string)
 877 - cpu-index: select the CPU number to be used by commands which access CPU
 878              data, like 'info registers'. The Monitor selects CPU 0 if this
 879              argument is not provided (json-int, optional)
 880
 881 Example:
 882
 883 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
 884 <- { "return": "kvm support: enabled\r\n" }
 885
 886 Notes:
 887
 888 (1) The Human Monitor is NOT an stable interface, this means that command
 889     names, arguments and responses can change or be removed at ANY time.
 890     Applications that rely on long term stability guarantees should NOT
 891     use this command
 892
 893 (2) Limitations:
 894
 895     o This command is stateless, this means that commands that depend
 896       on state information (such as getfd) might not work
 897
 898     o Commands that prompt the user for data (eg. 'cont' when the block
 899       device is encrypted) don't currently work
 900
 901 3. Query Commands
 902 =================
 903
 904 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
 905 HXCOMM this! We will possibly move query commands definitions inside those
 906 HXCOMM sections, just like regular commands.
 907
 908 EQMP
 909
 910 SQMP
 911 query-version
 912 -------------
 913
 914 Show QEMU version.
 915
 916 Return a json-object with the following information:
 917
 918 - "qemu": A json-object containing three integer values:
 919     - "major": QEMU's major version (json-int)
 920     - "minor": QEMU's minor version (json-int)
 921     - "micro": QEMU's micro version (json-int)
 922 - "package": package's version (json-string)
 923
 924 Example:
 925
 926 -> { "execute": "query-version" }
 927 <- {
 928       "return":{
 929          "qemu":{
 930             "major":0,
 931             "minor":11,
 932             "micro":5
 933          },
 934          "package":""
 935       }
 936    }
 937
 938 EQMP
 939
 940 SQMP
 941 query-commands
 942 --------------
 943
 944 List QMP available commands.
 945
 946 Each command is represented by a json-object, the returned value is a json-array
 947 of all commands.
 948
 949 Each json-object contain:
 950
 951 - "name": command's name (json-string)
 952
 953 Example:
 954
 955 -> { "execute": "query-commands" }
 956 <- {
 957       "return":[
 958          {
 959             "name":"query-balloon"
 960          },
 961          {
 962             "name":"system_powerdown"
 963          }
 964       ]
 965    }
 966
 967 Note: This example has been shortened as the real response is too long.
 968
 969 EQMP
 970
 971 SQMP
 972 query-chardev
 973 -------------
 974
 975 Each device is represented by a json-object. The returned value is a json-array
 976 of all devices.
 977
 978 Each json-object contain the following:
 979
 980 - "label": device's label (json-string)
 981 - "filename": device's file (json-string)
 982
 983 Example:
 984
 985 -> { "execute": "query-chardev" }
 986 <- {
 987       "return":[
 988          {
 989             "label":"monitor",
 990             "filename":"stdio"
 991          },
 992          {
 993             "label":"serial0",
 994             "filename":"vc"
 995          }
 996       ]
 997    }
 998
 999 EQMP
1000
1001 SQMP
1002 query-block
1003 -----------
1004
1005 Show the block devices.
1006
1007 Each block device information is stored in a json-object and the returned value
1008 is a json-array of all devices.
1009
1010 Each json-object contain the following:
1011
1012 - "device": device name (json-string)
1013 - "type": device type (json-string)
1014          - Possible values: "hd", "cdrom", "floppy", "unknown"
1015 - "removable": true if the device is removable, false otherwise (json-bool)
1016 - "locked": true if the device is locked, false otherwise (json-bool)
1017 - "inserted": only present if the device is inserted, it is a json-object
1018    containing the following:
1019          - "file": device file name (json-string)
1020          - "ro": true if read-only, false otherwise (json-bool)
1021          - "drv": driver format name (json-string)
1022              - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1023                                 "file", "file", "ftp", "ftps", "host_cdrom",
1024                                 "host_device", "host_floppy", "http", "https",
1025                                 "nbd", "parallels", "qcow", "qcow2", "raw",
1026                                 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1027          - "backing_file": backing file name (json-string, optional)
1028          - "encrypted": true if encrypted, false otherwise (json-bool)
1029
1030 Example:
1031
1032 -> { "execute": "query-block" }
1033 <- {
1034       "return":[
1035          {
1036             "device":"ide0-hd0",
1037             "locked":false,
1038             "removable":false,
1039             "inserted":{
1040                "ro":false,
1041                "drv":"qcow2",
1042                "encrypted":false,
1043                "file":"disks/test.img"
1044             },
1045             "type":"hd"
1046          },
1047          {
1048             "device":"ide1-cd0",
1049             "locked":false,
1050             "removable":true,
1051             "type":"cdrom"
1052          },
1053          {
1054             "device":"floppy0",
1055             "locked":false,
1056             "removable":true,
1057             "type": "floppy"
1058          },
1059          {
1060             "device":"sd0",
1061             "locked":false,
1062             "removable":true,
1063             "type":"floppy"
1064          }
1065       ]
1066    }
1067
1068 EQMP
1069
1070 SQMP
1071 query-blockstats
1072 ----------------
1073
1074 Show block device statistics.
1075
1076 Each device statistic information is stored in a json-object and the returned
1077 value is a json-array of all devices.
1078
1079 Each json-object contain the following:
1080
1081 - "device": device name (json-string)
1082 - "stats": A json-object with the statistics information, it contains:
1083     - "rd_bytes": bytes read (json-int)
1084     - "wr_bytes": bytes written (json-int)
1085     - "rd_operations": read operations (json-int)
1086     - "wr_operations": write operations (json-int)
1087     - "wr_highest_offset": Highest offset of a sector written since the
1088                            BlockDriverState has been opened (json-int)
1089 - "parent": Contains recursively the statistics of the underlying
1090             protocol (e.g. the host file for a qcow2 image). If there is
1091             no underlying protocol, this field is omitted
1092             (json-object, optional)
1093
1094 Example:
1095
1096 -> { "execute": "query-blockstats" }
1097 <- {
1098       "return":[
1099          {
1100             "device":"ide0-hd0",
1101             "parent":{
1102                "stats":{
1103                   "wr_highest_offset":3686448128,
1104                   "wr_bytes":9786368,
1105                   "wr_operations":751,
1106                   "rd_bytes":122567168,
1107                   "rd_operations":36772
1108                }
1109             },
1110             "stats":{
1111                "wr_highest_offset":2821110784,
1112                "wr_bytes":9786368,
1113                "wr_operations":692,
1114                "rd_bytes":122739200,
1115                "rd_operations":36604
1116             }
1117          },
1118          {
1119             "device":"ide1-cd0",
1120             "stats":{
1121                "wr_highest_offset":0,
1122                "wr_bytes":0,
1123                "wr_operations":0,
1124                "rd_bytes":0,
1125                "rd_operations":0
1126             }
1127          },
1128          {
1129             "device":"floppy0",
1130             "stats":{
1131                "wr_highest_offset":0,
1132                "wr_bytes":0,
1133                "wr_operations":0,
1134                "rd_bytes":0,
1135                "rd_operations":0
1136             }
1137          },
1138          {
1139             "device":"sd0",
1140             "stats":{
1141                "wr_highest_offset":0,
1142                "wr_bytes":0,
1143                "wr_operations":0,
1144                "rd_bytes":0,
1145                "rd_operations":0
1146             }
1147          }
1148       ]
1149    }
1150
1151 EQMP
1152
1153 SQMP
1154 query-cpus
1155 ----------
1156
1157 Show CPU information.
1158
1159 Return a json-array. Each CPU is represented by a json-object, which contains:
1160
1161 - "CPU": CPU index (json-int)
1162 - "current": true if this is the current CPU, false otherwise (json-bool)
1163 - "halted": true if the cpu is halted, false otherwise (json-bool)
1164 - Current program counter. The key's name depends on the architecture:
1165      "pc": i386/x86_64 (json-int)
1166      "nip": PPC (json-int)
1167      "pc" and "npc": sparc (json-int)
1168      "PC": mips (json-int)
1169
1170 Example:
1171
1172 -> { "execute": "query-cpus" }
1173 <- {
1174       "return":[
1175          {
1176             "CPU":0,
1177             "current":true,
1178             "halted":false,
1179             "pc":3227107138
1180          },
1181          {
1182             "CPU":1,
1183             "current":false,
1184             "halted":true,
1185             "pc":7108165
1186          }
1187       ]
1188    }
1189
1190 EQMP
1191
1192 SQMP
1193 query-pci
1194 ---------
1195
1196 PCI buses and devices information.
1197
1198 The returned value is a json-array of all buses. Each bus is represented by
1199 a json-object, which has a key with a json-array of all PCI devices attached
1200 to it. Each device is represented by a json-object.
1201
1202 The bus json-object contains the following:
1203
1204 - "bus": bus number (json-int)
1205 - "devices": a json-array of json-objects, each json-object represents a
1206              PCI device
1207
1208 The PCI device json-object contains the following:
1209
1210 - "bus": identical to the parent's bus number (json-int)
1211 - "slot": slot number (json-int)
1212 - "function": function number (json-int)
1213 - "class_info": a json-object containing:
1214      - "desc": device class description (json-string, optional)
1215      - "class": device class number (json-int)
1216 - "id": a json-object containing:
1217      - "device": device ID (json-int)
1218      - "vendor": vendor ID (json-int)
1219 - "irq": device's IRQ if assigned (json-int, optional)
1220 - "qdev_id": qdev id string (json-string)
1221 - "pci_bridge": It's a json-object, only present if this device is a
1222                 PCI bridge, contains:
1223      - "bus": bus number (json-int)
1224      - "secondary": secondary bus number (json-int)
1225      - "subordinate": subordinate bus number (json-int)
1226      - "io_range": I/O memory range information, a json-object with the
1227                    following members:
1228                  - "base": base address, in bytes (json-int)
1229                  - "limit": limit address, in bytes (json-int)
1230      - "memory_range": memory range information, a json-object with the
1231                        following members:
1232                  - "base": base address, in bytes (json-int)
1233                  - "limit": limit address, in bytes (json-int)
1234      - "prefetchable_range": Prefetchable memory range information, a
1235                              json-object with the following members:
1236                  - "base": base address, in bytes (json-int)
1237                  - "limit": limit address, in bytes (json-int)
1238      - "devices": a json-array of PCI devices if there's any attached, each
1239                   each element is represented by a json-object, which contains
1240                   the same members of the 'PCI device json-object' described
1241                   above (optional)
1242 - "regions": a json-array of json-objects, each json-object represents a
1243              memory region of this device
1244
1245 The memory range json-object contains the following:
1246
1247 - "base": base memory address (json-int)
1248 - "limit": limit value (json-int)
1249
1250 The region json-object can be an I/O region or a memory region, an I/O region
1251 json-object contains the following:
1252
1253 - "type": "io" (json-string, fixed)
1254 - "bar": BAR number (json-int)
1255 - "address": memory address (json-int)
1256 - "size": memory size (json-int)
1257
1258 A memory region json-object contains the following:
1259
1260 - "type": "memory" (json-string, fixed)
1261 - "bar": BAR number (json-int)
1262 - "address": memory address (json-int)
1263 - "size": memory size (json-int)
1264 - "mem_type_64": true or false (json-bool)
1265 - "prefetch": true or false (json-bool)
1266
1267 Example:
1268
1269 -> { "execute": "query-pci" }
1270 <- {
1271       "return":[
1272          {
1273             "bus":0,
1274             "devices":[
1275                {
1276                   "bus":0,
1277                   "qdev_id":"",
1278                   "slot":0,
1279                   "class_info":{
1280                      "class":1536,
1281                      "desc":"Host bridge"
1282                   },
1283                   "id":{
1284                      "device":32902,
1285                      "vendor":4663
1286                   },
1287                   "function":0,
1288                   "regions":[
1289
1290                   ]
1291                },
1292                {
1293                   "bus":0,
1294                   "qdev_id":"",
1295                   "slot":1,
1296                   "class_info":{
1297                      "class":1537,
1298                      "desc":"ISA bridge"
1299                   },
1300                   "id":{
1301                      "device":32902,
1302                      "vendor":28672
1303                   },
1304                   "function":0,
1305                   "regions":[
1306
1307                   ]
1308                },
1309                {
1310                   "bus":0,
1311                   "qdev_id":"",
1312                   "slot":1,
1313                   "class_info":{
1314                      "class":257,
1315                      "desc":"IDE controller"
1316                   },
1317                   "id":{
1318                      "device":32902,
1319                      "vendor":28688
1320                   },
1321                   "function":1,
1322                   "regions":[
1323                      {
1324                         "bar":4,
1325                         "size":16,
1326                         "address":49152,
1327                         "type":"io"
1328                      }
1329                   ]
1330                },
1331                {
1332                   "bus":0,
1333                   "qdev_id":"",
1334                   "slot":2,
1335                   "class_info":{
1336                      "class":768,
1337                      "desc":"VGA controller"
1338                   },
1339                   "id":{
1340                      "device":4115,
1341                      "vendor":184
1342                   },
1343                   "function":0,
1344                   "regions":[
1345                      {
1346                         "prefetch":true,
1347                         "mem_type_64":false,
1348                         "bar":0,
1349                         "size":33554432,
1350                         "address":4026531840,
1351                         "type":"memory"
1352                      },
1353                      {
1354                         "prefetch":false,
1355                         "mem_type_64":false,
1356                         "bar":1,
1357                         "size":4096,
1358                         "address":4060086272,
1359                         "type":"memory"
1360                      },
1361                      {
1362                         "prefetch":false,
1363                         "mem_type_64":false,
1364                         "bar":6,
1365                         "size":65536,
1366                         "address":-1,
1367                         "type":"memory"
1368                      }
1369                   ]
1370                },
1371                {
1372                   "bus":0,
1373                   "qdev_id":"",
1374                   "irq":11,
1375                   "slot":4,
1376                   "class_info":{
1377                      "class":1280,
1378                      "desc":"RAM controller"
1379                   },
1380                   "id":{
1381                      "device":6900,
1382                      "vendor":4098
1383                   },
1384                   "function":0,
1385                   "regions":[
1386                      {
1387                         "bar":0,
1388                         "size":32,
1389                         "address":49280,
1390                         "type":"io"
1391                      }
1392                   ]
1393                }
1394             ]
1395          }
1396       ]
1397    }
1398
1399 Note: This example has been shortened as the real response is too long.
1400
1401 EQMP
1402
1403 SQMP
1404 query-kvm
1405 ---------
1406
1407 Show KVM information.
1408
1409 Return a json-object with the following information:
1410
1411 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
1412 - "present": true if QEMU has KVM support, false otherwise (json-bool)
1413
1414 Example:
1415
1416 -> { "execute": "query-kvm" }
1417 <- { "return": { "enabled": true, "present": true } }
1418
1419 EQMP
1420
1421 SQMP
1422 query-status
1423 ------------
1424
1425 Return a json-object with the following information:
1426
1427 - "running": true if the VM is running, or false if it is paused (json-bool)
1428 - "singlestep": true if the VM is in single step mode,
1429                 false otherwise (json-bool)
1430
1431 Example:
1432
1433 -> { "execute": "query-status" }
1434 <- { "return": { "running": true, "singlestep": false } }
1435
1436 EQMP
1437
1438 SQMP
1439 query-mice
1440 ----------
1441
1442 Show VM mice information.
1443
1444 Each mouse is represented by a json-object, the returned value is a json-array
1445 of all mice.
1446
1447 The mouse json-object contains the following:
1448
1449 - "name": mouse's name (json-string)
1450 - "index": mouse's index (json-int)
1451 - "current": true if this mouse is receiving events, false otherwise (json-bool)
1452 - "absolute": true if the mouse generates absolute input events (json-bool)
1453
1454 Example:
1455
1456 -> { "execute": "query-mice" }
1457 <- {
1458       "return":[
1459          {
1460             "name":"QEMU Microsoft Mouse",
1461             "index":0,
1462             "current":false,
1463             "absolute":false
1464          },
1465          {
1466             "name":"QEMU PS/2 Mouse",
1467             "index":1,
1468             "current":true,
1469             "absolute":true
1470          }
1471       ]
1472    }
1473
1474 EQMP
1475
1476 SQMP
1477 query-vnc
1478 ---------
1479
1480 Show VNC server information.
1481
1482 Return a json-object with server information. Connected clients are returned
1483 as a json-array of json-objects.
1484
1485 The main json-object contains the following:
1486
1487 - "enabled": true or false (json-bool)
1488 - "host": server's IP address (json-string)
1489 - "family": address family (json-string)
1490          - Possible values: "ipv4", "ipv6", "unix", "unknown"
1491 - "service": server's port number (json-string)
1492 - "auth": authentication method (json-string)
1493          - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
1494                             "tls", "ultra", "unknown", "vencrypt", "vencrypt",
1495                             "vencrypt+plain", "vencrypt+tls+none",
1496                             "vencrypt+tls+plain", "vencrypt+tls+sasl",
1497                             "vencrypt+tls+vnc", "vencrypt+x509+none",
1498                             "vencrypt+x509+plain", "vencrypt+x509+sasl",
1499                             "vencrypt+x509+vnc", "vnc"
1500 - "clients": a json-array of all connected clients
1501
1502 Clients are described by a json-object, each one contain the following:
1503
1504 - "host": client's IP address (json-string)
1505 - "family": address family (json-string)
1506          - Possible values: "ipv4", "ipv6", "unix", "unknown"
1507 - "service": client's port number (json-string)
1508 - "x509_dname": TLS dname (json-string, optional)
1509 - "sasl_username": SASL username (json-string, optional)
1510
1511 Example:
1512
1513 -> { "execute": "query-vnc" }
1514 <- {
1515       "return":{
1516          "enabled":true,
1517          "host":"0.0.0.0",
1518          "service":"50402",
1519          "auth":"vnc",
1520          "family":"ipv4",
1521          "clients":[
1522             {
1523                "host":"127.0.0.1",
1524                "service":"50401",
1525                "family":"ipv4"
1526             }
1527          ]
1528       }
1529    }
1530
1531 EQMP
1532
1533 SQMP
1534 query-spice
1535 -----------
1536
1537 Show SPICE server information.
1538
1539 Return a json-object with server information. Connected clients are returned
1540 as a json-array of json-objects.
1541
1542 The main json-object contains the following:
1543
1544 - "enabled": true or false (json-bool)
1545 - "host": server's IP address (json-string)
1546 - "port": server's port number (json-int, optional)
1547 - "tls-port": server's port number (json-int, optional)
1548 - "auth": authentication method (json-string)
1549          - Possible values: "none", "spice"
1550 - "channels": a json-array of all active channels clients
1551
1552 Channels are described by a json-object, each one contain the following:
1553
1554 - "host": client's IP address (json-string)
1555 - "family": address family (json-string)
1556          - Possible values: "ipv4", "ipv6", "unix", "unknown"
1557 - "port": client's port number (json-string)
1558 - "connection-id": spice connection id.  All channels with the same id
1559                    belong to the same spice session (json-int)
1560 - "channel-type": channel type.  "1" is the main control channel, filter for
1561                   this one if you want track spice sessions only (json-int)
1562 - "channel-id": channel id.  Usually "0", might be different needed when
1563                 multiple channels of the same type exist, such as multiple
1564                 display channels in a multihead setup (json-int)
1565 - "tls": whevener the channel is encrypted (json-bool)
1566
1567 Example:
1568
1569 -> { "execute": "query-spice" }
1570 <- {
1571       "return": {
1572          "enabled": true,
1573          "auth": "spice",
1574          "port": 5920,
1575          "tls-port": 5921,
1576          "host": "0.0.0.0",
1577          "channels": [
1578             {
1579                "port": "54924",
1580                "family": "ipv4",
1581                "channel-type": 1,
1582                "connection-id": 1804289383,
1583                "host": "127.0.0.1",
1584                "channel-id": 0,
1585                "tls": true
1586             },
1587             {
1588                "port": "36710",
1589                "family": "ipv4",
1590                "channel-type": 4,
1591                "connection-id": 1804289383,
1592                "host": "127.0.0.1",
1593                "channel-id": 0,
1594                "tls": false
1595             },
1596             [ ... more channels follow ... ]
1597          ]
1598       }
1599    }
1600
1601 EQMP
1602
1603 SQMP
1604 query-name
1605 ----------
1606
1607 Show VM name.
1608
1609 Return a json-object with the following information:
1610
1611 - "name": VM's name (json-string, optional)
1612
1613 Example:
1614
1615 -> { "execute": "query-name" }
1616 <- { "return": { "name": "qemu-name" } }
1617
1618 EQMP
1619
1620 SQMP
1621 query-uuid
1622 ----------
1623
1624 Show VM UUID.
1625
1626 Return a json-object with the following information:
1627
1628 - "UUID": Universally Unique Identifier (json-string)
1629
1630 Example:
1631
1632 -> { "execute": "query-uuid" }
1633 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
1634
1635 EQMP
1636
1637 SQMP
1638 query-migrate
1639 -------------
1640
1641 Migration status.
1642
1643 Return a json-object. If migration is active there will be another json-object
1644 with RAM migration status and if block migration is active another one with
1645 block migration status.
1646
1647 The main json-object contains the following:
1648
1649 - "status": migration status (json-string)
1650      - Possible values: "active", "completed", "failed", "cancelled"
1651 - "ram": only present if "status" is "active", it is a json-object with the
1652   following RAM information (in bytes):
1653          - "transferred": amount transferred (json-int)
1654          - "remaining": amount remaining (json-int)
1655          - "total": total (json-int)
1656 - "disk": only present if "status" is "active" and it is a block migration,
1657   it is a json-object with the following disk information (in bytes):
1658          - "transferred": amount transferred (json-int)
1659          - "remaining": amount remaining (json-int)
1660          - "total": total (json-int)
1661
1662 Examples:
1663
1664 1. Before the first migration
1665
1666 -> { "execute": "query-migrate" }
1667 <- { "return": {} }
1668
1669 2. Migration is done and has succeeded
1670
1671 -> { "execute": "query-migrate" }
1672 <- { "return": { "status": "completed" } }
1673
1674 3. Migration is done and has failed
1675
1676 -> { "execute": "query-migrate" }
1677 <- { "return": { "status": "failed" } }
1678
1679 4. Migration is being performed and is not a block migration:
1680
1681 -> { "execute": "query-migrate" }
1682 <- {
1683       "return":{
1684          "status":"active",
1685          "ram":{
1686             "transferred":123,
1687             "remaining":123,
1688             "total":246
1689          }
1690       }
1691    }
1692
1693 5. Migration is being performed and is a block migration:
1694
1695 -> { "execute": "query-migrate" }
1696 <- {
1697       "return":{
1698          "status":"active",
1699          "ram":{
1700             "total":1057024,
1701             "remaining":1053304,
1702             "transferred":3720
1703          },
1704          "disk":{
1705             "total":20971520,
1706             "remaining":20880384,
1707             "transferred":91136
1708          }
1709       }
1710    }
1711
1712 EQMP
1713
1714 SQMP
1715 query-balloon
1716 -------------
1717
1718 Show balloon information.
1719
1720 Make an asynchronous request for balloon info. When the request completes a
1721 json-object will be returned containing the following data:
1722
1723 - "actual": current balloon value in bytes (json-int)
1724 - "mem_swapped_in": Amount of memory swapped in bytes (json-int, optional)
1725 - "mem_swapped_out": Amount of memory swapped out in bytes (json-int, optional)
1726 - "major_page_faults": Number of major faults (json-int, optional)
1727 - "minor_page_faults": Number of minor faults (json-int, optional)
1728 - "free_mem": Total amount of free and unused memory in
1729               bytes (json-int, optional)
1730 - "total_mem": Total amount of available memory in bytes (json-int, optional)
1731
1732 Example:
1733
1734 -> { "execute": "query-balloon" }
1735 <- {
1736       "return":{
1737          "actual":1073741824,
1738          "mem_swapped_in":0,
1739          "mem_swapped_out":0,
1740          "major_page_faults":142,
1741          "minor_page_faults":239245,
1742          "free_mem":1014185984,
1743          "total_mem":1044668416
1744       }
1745    }
1746
1747 EQMP
1748