docs/qmp-events.txt

   1                    QEMU Machine Protocol Events
   2                    ============================
   3
   4 ACPI_DEVICE_OST
   5 ---------------
   6
   7 Emitted when guest executes ACPI _OST method.
   8
   9  - data: ACPIOSTInfo type as described in qapi-schema.json
  10
  11 { "event": "ACPI_DEVICE_OST",
  12      "data": { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0 } }
  13
  14 BALLOON_CHANGE
  15 --------------
  16
  17 Emitted when the guest changes the actual BALLOON level. This
  18 value is equivalent to the 'actual' field return by the
  19 'query-balloon' command
  20
  21 Data:
  22
  23 - "actual": actual level of the guest memory balloon in bytes (json-number)
  24
  25 Example:
  26
  27 { "event": "BALLOON_CHANGE",
  28     "data": { "actual": 944766976 },
  29     "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
  30
  31 Note: this event is rate-limited.
  32
  33 BLOCK_IMAGE_CORRUPTED
  34 ---------------------
  35
  36 Emitted when a disk image is being marked corrupt. The image can be
  37 identified by its device or node name. The 'device' field is always
  38 present for compatibility reasons, but it can be empty ("") if the
  39 image does not have a device name associated.
  40
  41 Data:
  42
  43 - "device":    Device name (json-string)
  44 - "node-name": Node name (json-string, optional)
  45 - "msg":       Informative message (e.g., reason for the corruption)
  46                (json-string)
  47 - "offset":    If the corruption resulted from an image access, this
  48                is the host's access offset into the image
  49                (json-int, optional)
  50 - "size":      If the corruption resulted from an image access, this
  51                is the access size (json-int, optional)
  52
  53 Example:
  54
  55 { "event": "BLOCK_IMAGE_CORRUPTED",
  56     "data": { "device": "ide0-hd0", "node-name": "node0",
  57         "msg": "Prevented active L1 table overwrite", "offset": 196608,
  58         "size": 65536 },
  59     "timestamp": { "seconds": 1378126126, "microseconds": 966463 } }
  60
  61 BLOCK_IO_ERROR
  62 --------------
  63
  64 Emitted when a disk I/O error occurs.
  65
  66 Data:
  67
  68 - "device": device name (json-string)
  69 - "operation": I/O operation (json-string, "read" or "write")
  70 - "action": action that has been taken, it's one of the following (json-string):
  71     "ignore": error has been ignored
  72     "report": error has been reported to the device
  73     "stop": the VM is going to stop because of the error
  74
  75 Example:
  76
  77 { "event": "BLOCK_IO_ERROR",
  78     "data": { "device": "ide0-hd1",
  79               "operation": "write",
  80               "action": "stop" },
  81     "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
  82
  83 Note: If action is "stop", a STOP event will eventually follow the
  84 BLOCK_IO_ERROR event.
  85
  86 BLOCK_JOB_CANCELLED
  87 -------------------
  88
  89 Emitted when a block job has been cancelled.
  90
  91 Data:
  92
  93 - "type":     Job type (json-string; "stream" for image streaming
  94                                      "commit" for block commit)
  95 - "device":   Device name (json-string)
  96 - "len":      Maximum progress value (json-int)
  97 - "offset":   Current progress value (json-int)
  98               On success this is equal to len.
  99               On failure this is less than len.
 100 - "speed":    Rate limit, bytes per second (json-int)
 101
 102 Example:
 103
 104 { "event": "BLOCK_JOB_CANCELLED",
 105      "data": { "type": "stream", "device": "virtio-disk0",
 106                "len": 10737418240, "offset": 134217728,
 107                "speed": 0 },
 108      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
 109
 110 BLOCK_JOB_COMPLETED
 111 -------------------
 112
 113 Emitted when a block job has completed.
 114
 115 Data:
 116
 117 - "type":     Job type (json-string; "stream" for image streaming
 118                                      "commit" for block commit)
 119 - "device":   Device name (json-string)
 120 - "len":      Maximum progress value (json-int)
 121 - "offset":   Current progress value (json-int)
 122               On success this is equal to len.
 123               On failure this is less than len.
 124 - "speed":    Rate limit, bytes per second (json-int)
 125 - "error":    Error message (json-string, optional)
 126               Only present on failure.  This field contains a human-readable
 127               error message.  There are no semantics other than that streaming
 128               has failed and clients should not try to interpret the error
 129               string.
 130
 131 Example:
 132
 133 { "event": "BLOCK_JOB_COMPLETED",
 134      "data": { "type": "stream", "device": "virtio-disk0",
 135                "len": 10737418240, "offset": 10737418240,
 136                "speed": 0 },
 137      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
 138
 139 BLOCK_JOB_ERROR
 140 ---------------
 141
 142 Emitted when a block job encounters an error.
 143
 144 Data:
 145
 146 - "device": device name (json-string)
 147 - "operation": I/O operation (json-string, "read" or "write")
 148 - "action": action that has been taken, it's one of the following (json-string):
 149     "ignore": error has been ignored, the job may fail later
 150     "report": error will be reported and the job canceled
 151     "stop": error caused job to be paused
 152
 153 Example:
 154
 155 { "event": "BLOCK_JOB_ERROR",
 156     "data": { "device": "ide0-hd1",
 157               "operation": "write",
 158               "action": "stop" },
 159     "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
 160
 161 BLOCK_JOB_READY
 162 ---------------
 163
 164 Emitted when a block job is ready to complete.
 165
 166 Data:
 167
 168 - "type":     Job type (json-string; "stream" for image streaming
 169                                      "commit" for block commit)
 170 - "device":   Device name (json-string)
 171 - "len":      Maximum progress value (json-int)
 172 - "offset":   Current progress value (json-int)
 173               On success this is equal to len.
 174               On failure this is less than len.
 175 - "speed":    Rate limit, bytes per second (json-int)
 176
 177 Example:
 178
 179 { "event": "BLOCK_JOB_READY",
 180     "data": { "device": "drive0", "type": "mirror", "speed": 0,
 181               "len": 2097152, "offset": 2097152 }
 182     "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
 183
 184 Note: The "ready to complete" status is always reset by a BLOCK_JOB_ERROR
 185 event.
 186
 187 DEVICE_DELETED
 188 --------------
 189
 190 Emitted whenever the device removal completion is acknowledged
 191 by the guest.
 192 At this point, it's safe to reuse the specified device ID.
 193 Device removal can be initiated by the guest or by HMP/QMP commands.
 194
 195 Data:
 196
 197 - "device": device name (json-string, optional)
 198 - "path": device path (json-string)
 199
 200 { "event": "DEVICE_DELETED",
 201   "data": { "device": "virtio-net-pci-0",
 202             "path": "/machine/peripheral/virtio-net-pci-0" },
 203   "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
 204
 205 DEVICE_TRAY_MOVED
 206 -----------------
 207
 208 It's emitted whenever the tray of a removable device is moved by the guest
 209 or by HMP/QMP commands.
 210
 211 Data:
 212
 213 - "device": device name (json-string)
 214 - "tray-open": true if the tray has been opened or false if it has been closed
 215                (json-bool)
 216
 217 { "event": "DEVICE_TRAY_MOVED",
 218   "data": { "device": "ide1-cd0",
 219             "tray-open": true
 220   },
 221   "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
 222
 223 GUEST_PANICKED
 224 --------------
 225
 226 Emitted when guest OS panic is detected.
 227
 228 Data:
 229
 230 - "action": Action that has been taken (json-string, currently always "pause").
 231
 232 Example:
 233
 234 { "event": "GUEST_PANICKED",
 235      "data": { "action": "pause" } }
 236
 237 MEM_UNPLUG_ERROR
 238 --------------------
 239 Emitted when memory hot unplug error occurs.
 240
 241 Data:
 242
 243 - "device": device name (json-string)
 244 - "msg": Informative message (e.g., reason for the error) (json-string)
 245
 246 Example:
 247
 248 { "event": "MEM_UNPLUG_ERROR"
 249   "data": { "device": "dimm1",
 250             "msg": "acpi: device unplug for unsupported device"
 251   },
 252   "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
 253
 254 NIC_RX_FILTER_CHANGED
 255 ---------------------
 256
 257 The event is emitted once until the query command is executed,
 258 the first event will always be emitted.
 259
 260 Data:
 261
 262 - "name": net client name (json-string)
 263 - "path": device path (json-string)
 264
 265 { "event": "NIC_RX_FILTER_CHANGED",
 266   "data": { "name": "vnet0",
 267             "path": "/machine/peripheral/vnet0/virtio-backend" },
 268   "timestamp": { "seconds": 1368697518, "microseconds": 326866 } }
 269 }
 270
 271 POWERDOWN
 272 ---------
 273
 274 Emitted when the Virtual Machine is powered down through the power
 275 control system, such as via ACPI.
 276
 277 Data: None.
 278
 279 Example:
 280
 281 { "event": "POWERDOWN",
 282     "timestamp": { "seconds": 1267040730, "microseconds": 682951 } }
 283
 284 QUORUM_FAILURE
 285 --------------
 286
 287 Emitted by the Quorum block driver if it fails to establish a quorum.
 288
 289 Data:
 290
 291 - "reference":     device name if defined else node name.
 292 - "sector-num":    Number of the first sector of the failed read operation.
 293 - "sectors-count": Failed read operation sector count.
 294
 295 Example:
 296
 297 { "event": "QUORUM_FAILURE",
 298      "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 },
 299      "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
 300
 301 Note: this event is rate-limited.
 302
 303 QUORUM_REPORT_BAD
 304 -----------------
 305
 306 Emitted to report a corruption of a Quorum file.
 307
 308 Data:
 309
 310 - "error":         Error message (json-string, optional)
 311                    Only present on failure.  This field contains a human-readable
 312                    error message.  There are no semantics other than that the
 313                    block layer reported an error and clients should not try to
 314                    interpret the error string.
 315 - "node-name":     The graph node name of the block driver state.
 316 - "sector-num":    Number of the first sector of the failed read operation.
 317 - "sectors-count": Failed read operation sector count.
 318
 319 Example:
 320
 321 { "event": "QUORUM_REPORT_BAD",
 322      "data": { "node-name": "1.raw", "sector-num": 345435, "sectors-count": 5 },
 323      "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
 324
 325 Note: this event is rate-limited.
 326
 327 RESET
 328 -----
 329
 330 Emitted when the Virtual Machine is reset.
 331
 332 Data: None.
 333
 334 Example:
 335
 336 { "event": "RESET",
 337     "timestamp": { "seconds": 1267041653, "microseconds": 9518 } }
 338
 339 RESUME
 340 ------
 341
 342 Emitted when the Virtual Machine resumes execution.
 343
 344 Data: None.
 345
 346 Example:
 347
 348 { "event": "RESUME",
 349     "timestamp": { "seconds": 1271770767, "microseconds": 582542 } }
 350
 351 RTC_CHANGE
 352 ----------
 353
 354 Emitted when the guest changes the RTC time.
 355
 356 Data:
 357
 358 - "offset": Offset between base RTC clock (as specified by -rtc base), and
 359 new RTC clock value (json-number)
 360
 361 Example:
 362
 363 { "event": "RTC_CHANGE",
 364     "data": { "offset": 78 },
 365     "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
 366
 367 Note: this event is rate-limited.
 368
 369 SHUTDOWN
 370 --------
 371
 372 Emitted when the Virtual Machine has shut down, indicating that qemu
 373 is about to exit.
 374
 375 Data: None.
 376
 377 Example:
 378
 379 { "event": "SHUTDOWN",
 380     "timestamp": { "seconds": 1267040730, "microseconds": 682951 } }
 381
 382 Note: If the command-line option "-no-shutdown" has been specified, a STOP
 383 event will eventually follow the SHUTDOWN event.
 384
 385 SPICE_CONNECTED
 386 ---------------
 387
 388 Emitted when a SPICE client connects.
 389
 390 Data:
 391
 392 - "server": Server information (json-object)
 393   - "host": IP address (json-string)
 394   - "port": port number (json-string)
 395   - "family": address family (json-string, "ipv4" or "ipv6")
 396 - "client": Client information (json-object)
 397   - "host": IP address (json-string)
 398   - "port": port number (json-string)
 399   - "family": address family (json-string, "ipv4" or "ipv6")
 400
 401 Example:
 402
 403 { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
 404   "event": "SPICE_CONNECTED",
 405   "data": {
 406     "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
 407     "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
 408 }}
 409
 410 SPICE_DISCONNECTED
 411 ------------------
 412
 413 Emitted when a SPICE client disconnects.
 414
 415 Data:
 416
 417 - "server": Server information (json-object)
 418   - "host": IP address (json-string)
 419   - "port": port number (json-string)
 420   - "family": address family (json-string, "ipv4" or "ipv6")
 421 - "client": Client information (json-object)
 422   - "host": IP address (json-string)
 423   - "port": port number (json-string)
 424   - "family": address family (json-string, "ipv4" or "ipv6")
 425
 426 Example:
 427
 428 { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
 429   "event": "SPICE_DISCONNECTED",
 430   "data": {
 431     "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
 432     "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
 433 }}
 434
 435 SPICE_INITIALIZED
 436 -----------------
 437
 438 Emitted after initial handshake and authentication takes place (if any)
 439 and the SPICE channel is up and running
 440
 441 Data:
 442
 443 - "server": Server information (json-object)
 444   - "host": IP address (json-string)
 445   - "port": port number (json-string)
 446   - "family": address family (json-string, "ipv4" or "ipv6")
 447   - "auth": authentication method (json-string, optional)
 448 - "client": Client information (json-object)
 449   - "host": IP address (json-string)
 450   - "port": port number (json-string)
 451   - "family": address family (json-string, "ipv4" or "ipv6")
 452   - "connection-id": spice connection id.  All channels with the same id
 453                      belong to the same spice session (json-int)
 454   - "channel-type": channel type.  "1" is the main control channel, filter for
 455                     this one if you want track spice sessions only (json-int)
 456   - "channel-id": channel id.  Usually "0", might be different needed when
 457                   multiple channels of the same type exist, such as multiple
 458                   display channels in a multihead setup (json-int)
 459   - "tls": whevener the channel is encrypted (json-bool)
 460
 461 Example:
 462
 463 { "timestamp": {"seconds": 1290688046, "microseconds": 417172},
 464   "event": "SPICE_INITIALIZED",
 465   "data": {"server": {"auth": "spice", "port": "5921",
 466                       "family": "ipv4", "host": "127.0.0.1"},
 467            "client": {"port": "49004", "family": "ipv4", "channel-type": 3,
 468                       "connection-id": 1804289383, "host": "127.0.0.1",
 469                       "channel-id": 0, "tls": true}
 470 }}
 471
 472 SPICE_MIGRATE_COMPLETED
 473 -----------------------
 474
 475 Emitted when SPICE migration has completed
 476
 477 Data: None.
 478
 479 Example:
 480
 481 { "timestamp": {"seconds": 1290688046, "microseconds": 417172},
 482   "event": "SPICE_MIGRATE_COMPLETED" }
 483
 484 MIGRATION
 485 ---------
 486
 487 Emitted when a migration event happens
 488
 489 Data: None.
 490
 491  - "status": migration status
 492      See MigrationStatus in ~/qapi-schema.json for possible values
 493
 494 Example:
 495
 496 {"timestamp": {"seconds": 1432121972, "microseconds": 744001},
 497  "event": "MIGRATION", "data": {"status": "completed"}}
 498
 499 MIGRATION_PASS
 500 --------------
 501
 502 Emitted from the source side of a migration at the start of each pass
 503 (when it syncs the dirty bitmap)
 504
 505 Data: None.
 506
 507   - "pass": An incrementing count (starting at 1 on the first pass)
 508
 509 Example:
 510 {"timestamp": {"seconds": 1449669631, "microseconds": 239225},
 511  "event": "MIGRATION_PASS", "data": {"pass": 2}}
 512
 513 STOP
 514 ----
 515
 516 Emitted when the Virtual Machine is stopped.
 517
 518 Data: None.
 519
 520 Example:
 521
 522 { "event": "STOP",
 523     "timestamp": { "seconds": 1267041730, "microseconds": 281295 } }
 524
 525 SUSPEND
 526 -------
 527
 528 Emitted when guest enters S3 state.
 529
 530 Data: None.
 531
 532 Example:
 533
 534 { "event": "SUSPEND",
 535      "timestamp": { "seconds": 1344456160, "microseconds": 309119 } }
 536
 537 SUSPEND_DISK
 538 ------------
 539
 540 Emitted when the guest makes a request to enter S4 state.
 541
 542 Data: None.
 543
 544 Example:
 545
 546 { "event": "SUSPEND_DISK",
 547      "timestamp": { "seconds": 1344456160, "microseconds": 309119 } }
 548
 549 Note: QEMU shuts down when entering S4 state.
 550
 551 VNC_CONNECTED
 552 -------------
 553
 554 Emitted when a VNC client establishes a connection.
 555
 556 Data:
 557
 558 - "server": Server information (json-object)
 559   - "host": IP address (json-string)
 560   - "service": port number (json-string)
 561   - "family": address family (json-string, "ipv4" or "ipv6")
 562   - "auth": authentication method (json-string, optional)
 563 - "client": Client information (json-object)
 564   - "host": IP address (json-string)
 565   - "service": port number (json-string)
 566   - "family": address family (json-string, "ipv4" or "ipv6")
 567
 568 Example:
 569
 570 { "event": "VNC_CONNECTED",
 571     "data": {
 572         "server": { "auth": "sasl", "family": "ipv4",
 573                     "service": "5901", "host": "0.0.0.0" },
 574         "client": { "family": "ipv4", "service": "58425",
 575                     "host": "127.0.0.1" } },
 576     "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
 577
 578
 579 Note: This event is emitted before any authentication takes place, thus
 580 the authentication ID is not provided.
 581
 582 VNC_DISCONNECTED
 583 ----------------
 584
 585 Emitted when the connection is closed.
 586
 587 Data:
 588
 589 - "server": Server information (json-object)
 590   - "host": IP address (json-string)
 591   - "service": port number (json-string)
 592   - "family": address family (json-string, "ipv4" or "ipv6")
 593   - "auth": authentication method (json-string, optional)
 594 - "client": Client information (json-object)
 595   - "host": IP address (json-string)
 596   - "service": port number (json-string)
 597   - "family": address family (json-string, "ipv4" or "ipv6")
 598   - "x509_dname": TLS dname (json-string, optional)
 599   - "sasl_username": SASL username (json-string, optional)
 600
 601 Example:
 602
 603 { "event": "VNC_DISCONNECTED",
 604     "data": {
 605         "server": { "auth": "sasl", "family": "ipv4",
 606                     "service": "5901", "host": "0.0.0.0" },
 607         "client": { "family": "ipv4", "service": "58425",
 608                     "host": "127.0.0.1", "sasl_username": "luiz" } },
 609     "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
 610
 611 VNC_INITIALIZED
 612 ---------------
 613
 614 Emitted after authentication takes place (if any) and the VNC session is
 615 made active.
 616
 617 Data:
 618
 619 - "server": Server information (json-object)
 620   - "host": IP address (json-string)
 621   - "service": port number (json-string)
 622   - "family": address family (json-string, "ipv4" or "ipv6")
 623   - "auth": authentication method (json-string, optional)
 624 - "client": Client information (json-object)
 625   - "host": IP address (json-string)
 626   - "service": port number (json-string)
 627   - "family": address family (json-string, "ipv4" or "ipv6")
 628   - "x509_dname": TLS dname (json-string, optional)
 629   - "sasl_username": SASL username (json-string, optional)
 630
 631 Example:
 632
 633 { "event": "VNC_INITIALIZED",
 634     "data": {
 635         "server": { "auth": "sasl", "family": "ipv4",
 636                     "service": "5901", "host": "0.0.0.0"},
 637         "client": { "family": "ipv4", "service": "46089",
 638                     "host": "127.0.0.1", "sasl_username": "luiz" } },
 639         "timestamp": { "seconds": 1263475302, "microseconds": 150772 } }
 640
 641 VSERPORT_CHANGE
 642 ---------------
 643
 644 Emitted when the guest opens or closes a virtio-serial port.
 645
 646 Data:
 647
 648 - "id": device identifier of the virtio-serial port (json-string)
 649 - "open": true if the guest has opened the virtio-serial port (json-bool)
 650
 651 Example:
 652
 653 { "event": "VSERPORT_CHANGE",
 654     "data": { "id": "channel0", "open": true },
 655     "timestamp": { "seconds": 1401385907, "microseconds": 422329 } }
 656
 657 Note: this event is rate-limited separately for each "id".
 658
 659 WAKEUP
 660 ------
 661
 662 Emitted when the guest has woken up from S3 and is running.
 663
 664 Data: None.
 665
 666 Example:
 667
 668 { "event": "WAKEUP",
 669      "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
 670
 671 WATCHDOG
 672 --------
 673
 674 Emitted when the watchdog device's timer is expired.
 675
 676 Data:
 677
 678 - "action": Action that has been taken, it's one of the following (json-string):
 679             "reset", "shutdown", "poweroff", "pause", "debug", or "none"
 680
 681 Example:
 682
 683 { "event": "WATCHDOG",
 684      "data": { "action": "reset" },
 685      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
 686
 687 Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is
 688 followed respectively by the RESET, SHUTDOWN, or STOP events.
 689
 690 Note: this event is rate-limited.