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 DEVICE_DELETED
  34 --------------
  35
  36 Emitted whenever the device removal completion is acknowledged
  37 by the guest.
  38 At this point, it's safe to reuse the specified device ID.
  39 Device removal can be initiated by the guest or by HMP/QMP commands.
  40
  41 Data:
  42
  43 - "device": device name (json-string, optional)
  44 - "path": device path (json-string)
  45
  46 { "event": "DEVICE_DELETED",
  47   "data": { "device": "virtio-net-pci-0",
  48             "path": "/machine/peripheral/virtio-net-pci-0" },
  49   "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
  50
  51 DUMP_COMPLETED
  52 --------------
  53
  54 Emitted when the guest has finished one memory dump.
  55
  56 Data:
  57
  58 - "result": DumpQueryResult type described in qapi-schema.json
  59 - "error": Error message when dump failed. This is only a
  60   human-readable string provided when dump failed. It should not be
  61   parsed in any way (json-string, optional)
  62
  63 Example:
  64
  65 { "event": "DUMP_COMPLETED",
  66   "data": {"result": {"total": 1090650112, "status": "completed",
  67                       "completed": 1090650112} } }
  68
  69 GUEST_PANICKED
  70 --------------
  71
  72 Emitted when guest OS panic is detected.
  73
  74 Data:
  75
  76 - "action": Action that has been taken (json-string, currently always "pause").
  77
  78 Example:
  79
  80 { "event": "GUEST_PANICKED",
  81      "data": { "action": "pause" } }
  82
  83 MEM_UNPLUG_ERROR
  84 --------------------
  85 Emitted when memory hot unplug error occurs.
  86
  87 Data:
  88
  89 - "device": device name (json-string)
  90 - "msg": Informative message (e.g., reason for the error) (json-string)
  91
  92 Example:
  93
  94 { "event": "MEM_UNPLUG_ERROR"
  95   "data": { "device": "dimm1",
  96             "msg": "acpi: device unplug for unsupported device"
  97   },
  98   "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
  99
 100 NIC_RX_FILTER_CHANGED
 101 ---------------------
 102
 103 The event is emitted once until the query command is executed,
 104 the first event will always be emitted.
 105
 106 Data:
 107
 108 - "name": net client name (json-string)
 109 - "path": device path (json-string)
 110
 111 { "event": "NIC_RX_FILTER_CHANGED",
 112   "data": { "name": "vnet0",
 113             "path": "/machine/peripheral/vnet0/virtio-backend" },
 114   "timestamp": { "seconds": 1368697518, "microseconds": 326866 } }
 115 }
 116
 117 QUORUM_FAILURE
 118 --------------
 119
 120 Emitted by the Quorum block driver if it fails to establish a quorum.
 121
 122 Data:
 123
 124 - "reference":     device name if defined else node name.
 125 - "sector-num":    Number of the first sector of the failed read operation.
 126 - "sectors-count": Failed read operation sector count.
 127
 128 Example:
 129
 130 { "event": "QUORUM_FAILURE",
 131      "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 },
 132      "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
 133
 134 Note: this event is rate-limited.
 135
 136 QUORUM_REPORT_BAD
 137 -----------------
 138
 139 Emitted to report a corruption of a Quorum file.
 140
 141 Data:
 142
 143 - "type":          Quorum operation type
 144 - "error":         Error message (json-string, optional)
 145                    Only present on failure.  This field contains a human-readable
 146                    error message.  There are no semantics other than that the
 147                    block layer reported an error and clients should not try to
 148                    interpret the error string.
 149 - "node-name":     The graph node name of the block driver state.
 150 - "sector-num":    Number of the first sector of the failed read operation.
 151 - "sectors-count": Failed read operation sector count.
 152
 153 Example:
 154
 155 Read operation:
 156 { "event": "QUORUM_REPORT_BAD",
 157      "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5,
 158                "type": "read" },
 159      "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
 160
 161 Flush operation:
 162 { "event": "QUORUM_REPORT_BAD",
 163      "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120,
 164                "type": "flush", "error": "Broken pipe" },
 165      "timestamp": { "seconds": 1456406829, "microseconds": 291763 } }
 166
 167 Note: this event is rate-limited.
 168
 169 RTC_CHANGE
 170 ----------
 171
 172 Emitted when the guest changes the RTC time.
 173
 174 Data:
 175
 176 - "offset": Offset between base RTC clock (as specified by -rtc base), and
 177 new RTC clock value (json-number)
 178
 179 Example:
 180
 181 { "event": "RTC_CHANGE",
 182     "data": { "offset": 78 },
 183     "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
 184
 185 Note: this event is rate-limited.
 186
 187 SPICE_CONNECTED
 188 ---------------
 189
 190 Emitted when a SPICE client connects.
 191
 192 Data:
 193
 194 - "server": Server information (json-object)
 195   - "host": IP address (json-string)
 196   - "port": port number (json-string)
 197   - "family": address family (json-string, "ipv4" or "ipv6")
 198 - "client": Client information (json-object)
 199   - "host": IP address (json-string)
 200   - "port": port number (json-string)
 201   - "family": address family (json-string, "ipv4" or "ipv6")
 202
 203 Example:
 204
 205 { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
 206   "event": "SPICE_CONNECTED",
 207   "data": {
 208     "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
 209     "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
 210 }}
 211
 212 SPICE_DISCONNECTED
 213 ------------------
 214
 215 Emitted when a SPICE client disconnects.
 216
 217 Data:
 218
 219 - "server": Server information (json-object)
 220   - "host": IP address (json-string)
 221   - "port": port number (json-string)
 222   - "family": address family (json-string, "ipv4" or "ipv6")
 223 - "client": Client information (json-object)
 224   - "host": IP address (json-string)
 225   - "port": port number (json-string)
 226   - "family": address family (json-string, "ipv4" or "ipv6")
 227
 228 Example:
 229
 230 { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
 231   "event": "SPICE_DISCONNECTED",
 232   "data": {
 233     "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
 234     "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
 235 }}
 236
 237 SPICE_INITIALIZED
 238 -----------------
 239
 240 Emitted after initial handshake and authentication takes place (if any)
 241 and the SPICE channel is up and running
 242
 243 Data:
 244
 245 - "server": Server information (json-object)
 246   - "host": IP address (json-string)
 247   - "port": port number (json-string)
 248   - "family": address family (json-string, "ipv4" or "ipv6")
 249   - "auth": authentication method (json-string, optional)
 250 - "client": Client information (json-object)
 251   - "host": IP address (json-string)
 252   - "port": port number (json-string)
 253   - "family": address family (json-string, "ipv4" or "ipv6")
 254   - "connection-id": spice connection id.  All channels with the same id
 255                      belong to the same spice session (json-int)
 256   - "channel-type": channel type.  "1" is the main control channel, filter for
 257                     this one if you want track spice sessions only (json-int)
 258   - "channel-id": channel id.  Usually "0", might be different needed when
 259                   multiple channels of the same type exist, such as multiple
 260                   display channels in a multihead setup (json-int)
 261   - "tls": whevener the channel is encrypted (json-bool)
 262
 263 Example:
 264
 265 { "timestamp": {"seconds": 1290688046, "microseconds": 417172},
 266   "event": "SPICE_INITIALIZED",
 267   "data": {"server": {"auth": "spice", "port": "5921",
 268                       "family": "ipv4", "host": "127.0.0.1"},
 269            "client": {"port": "49004", "family": "ipv4", "channel-type": 3,
 270                       "connection-id": 1804289383, "host": "127.0.0.1",
 271                       "channel-id": 0, "tls": true}
 272 }}
 273
 274 SPICE_MIGRATE_COMPLETED
 275 -----------------------
 276
 277 Emitted when SPICE migration has completed
 278
 279 Data: None.
 280
 281 Example:
 282
 283 { "timestamp": {"seconds": 1290688046, "microseconds": 417172},
 284   "event": "SPICE_MIGRATE_COMPLETED" }
 285
 286 MIGRATION
 287 ---------
 288
 289 Emitted when a migration event happens
 290
 291 Data: None.
 292
 293  - "status": migration status
 294      See MigrationStatus in ~/qapi-schema.json for possible values
 295
 296 Example:
 297
 298 {"timestamp": {"seconds": 1432121972, "microseconds": 744001},
 299  "event": "MIGRATION", "data": {"status": "completed"}}
 300
 301 MIGRATION_PASS
 302 --------------
 303
 304 Emitted from the source side of a migration at the start of each pass
 305 (when it syncs the dirty bitmap)
 306
 307 Data: None.
 308
 309   - "pass": An incrementing count (starting at 1 on the first pass)
 310
 311 Example:
 312 {"timestamp": {"seconds": 1449669631, "microseconds": 239225},
 313  "event": "MIGRATION_PASS", "data": {"pass": 2}}
 314
 315 VNC_CONNECTED
 316 -------------
 317
 318 Emitted when a VNC client establishes a connection.
 319
 320 Data:
 321
 322 - "server": Server information (json-object)
 323   - "host": IP address (json-string)
 324   - "service": port number (json-string)
 325   - "family": address family (json-string, "ipv4" or "ipv6")
 326   - "auth": authentication method (json-string, optional)
 327 - "client": Client information (json-object)
 328   - "host": IP address (json-string)
 329   - "service": port number (json-string)
 330   - "family": address family (json-string, "ipv4" or "ipv6")
 331
 332 Example:
 333
 334 { "event": "VNC_CONNECTED",
 335     "data": {
 336         "server": { "auth": "sasl", "family": "ipv4",
 337                     "service": "5901", "host": "0.0.0.0" },
 338         "client": { "family": "ipv4", "service": "58425",
 339                     "host": "127.0.0.1" } },
 340     "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
 341
 342
 343 Note: This event is emitted before any authentication takes place, thus
 344 the authentication ID is not provided.
 345
 346 VNC_DISCONNECTED
 347 ----------------
 348
 349 Emitted when the connection is closed.
 350
 351 Data:
 352
 353 - "server": Server information (json-object)
 354   - "host": IP address (json-string)
 355   - "service": port number (json-string)
 356   - "family": address family (json-string, "ipv4" or "ipv6")
 357   - "auth": authentication method (json-string, optional)
 358 - "client": Client information (json-object)
 359   - "host": IP address (json-string)
 360   - "service": port number (json-string)
 361   - "family": address family (json-string, "ipv4" or "ipv6")
 362   - "x509_dname": TLS dname (json-string, optional)
 363   - "sasl_username": SASL username (json-string, optional)
 364
 365 Example:
 366
 367 { "event": "VNC_DISCONNECTED",
 368     "data": {
 369         "server": { "auth": "sasl", "family": "ipv4",
 370                     "service": "5901", "host": "0.0.0.0" },
 371         "client": { "family": "ipv4", "service": "58425",
 372                     "host": "127.0.0.1", "sasl_username": "luiz" } },
 373     "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
 374
 375 VNC_INITIALIZED
 376 ---------------
 377
 378 Emitted after authentication takes place (if any) and the VNC session is
 379 made active.
 380
 381 Data:
 382
 383 - "server": Server information (json-object)
 384   - "host": IP address (json-string)
 385   - "service": port number (json-string)
 386   - "family": address family (json-string, "ipv4" or "ipv6")
 387   - "auth": authentication method (json-string, optional)
 388 - "client": Client information (json-object)
 389   - "host": IP address (json-string)
 390   - "service": port number (json-string)
 391   - "family": address family (json-string, "ipv4" or "ipv6")
 392   - "x509_dname": TLS dname (json-string, optional)
 393   - "sasl_username": SASL username (json-string, optional)
 394
 395 Example:
 396
 397 { "event": "VNC_INITIALIZED",
 398     "data": {
 399         "server": { "auth": "sasl", "family": "ipv4",
 400                     "service": "5901", "host": "0.0.0.0"},
 401         "client": { "family": "ipv4", "service": "46089",
 402                     "host": "127.0.0.1", "sasl_username": "luiz" } },
 403         "timestamp": { "seconds": 1263475302, "microseconds": 150772 } }
 404
 405 VSERPORT_CHANGE
 406 ---------------
 407
 408 Emitted when the guest opens or closes a virtio-serial port.
 409
 410 Data:
 411
 412 - "id": device identifier of the virtio-serial port (json-string)
 413 - "open": true if the guest has opened the virtio-serial port (json-bool)
 414
 415 Example:
 416
 417 { "event": "VSERPORT_CHANGE",
 418     "data": { "id": "channel0", "open": true },
 419     "timestamp": { "seconds": 1401385907, "microseconds": 422329 } }
 420
 421 Note: this event is rate-limited separately for each "id".
 422
 423 WATCHDOG
 424 --------
 425
 426 Emitted when the watchdog device's timer is expired.
 427
 428 Data:
 429
 430 - "action": Action that has been taken, it's one of the following (json-string):
 431             "reset", "shutdown", "poweroff", "pause", "debug", or "none"
 432
 433 Example:
 434
 435 { "event": "WATCHDOG",
 436      "data": { "action": "reset" },
 437      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
 438
 439 Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is
 440 followed respectively by the RESET, SHUTDOWN, or STOP events.
 441
 442 Note: this event is rate-limited.