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