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