docs/qmp-events.txt

   1                    QEMU Machine Protocol Events
   2                    ============================
   3
   4 BALLOON_CHANGE
   5 --------------
   6
   7 Emitted when the guest changes the actual BALLOON level. This
   8 value is equivalent to the 'actual' field return by the
   9 'query-balloon' command
  10
  11 Data:
  12
  13 - "actual": actual level of the guest memory balloon in bytes (json-number)
  14
  15 Example:
  16
  17 { "event": "BALLOON_CHANGE",
  18     "data": { "actual": 944766976 },
  19     "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
  20
  21 Note: this event is rate-limited.
  22
  23 DUMP_COMPLETED
  24 --------------
  25
  26 Emitted when the guest has finished one memory dump.
  27
  28 Data:
  29
  30 - "result": DumpQueryResult type described in qapi-schema.json
  31 - "error": Error message when dump failed. This is only a
  32   human-readable string provided when dump failed. It should not be
  33   parsed in any way (json-string, optional)
  34
  35 Example:
  36
  37 { "event": "DUMP_COMPLETED",
  38   "data": {"result": {"total": 1090650112, "status": "completed",
  39                       "completed": 1090650112} } }
  40
  41 GUEST_PANICKED
  42 --------------
  43
  44 Emitted when guest OS panic is detected.
  45
  46 Data:
  47
  48 - "action": Action that has been taken (json-string, currently always "pause").
  49
  50 Example:
  51
  52 { "event": "GUEST_PANICKED",
  53      "data": { "action": "pause" } }
  54
  55 MEM_UNPLUG_ERROR
  56 --------------------
  57 Emitted when memory hot unplug error occurs.
  58
  59 Data:
  60
  61 - "device": device name (json-string)
  62 - "msg": Informative message (e.g., reason for the error) (json-string)
  63
  64 Example:
  65
  66 { "event": "MEM_UNPLUG_ERROR"
  67   "data": { "device": "dimm1",
  68             "msg": "acpi: device unplug for unsupported device"
  69   },
  70   "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
  71
  72 QUORUM_FAILURE
  73 --------------
  74
  75 Emitted by the Quorum block driver if it fails to establish a quorum.
  76
  77 Data:
  78
  79 - "reference":     device name if defined else node name.
  80 - "sector-num":    Number of the first sector of the failed read operation.
  81 - "sectors-count": Failed read operation sector count.
  82
  83 Example:
  84
  85 { "event": "QUORUM_FAILURE",
  86      "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 },
  87      "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
  88
  89 Note: this event is rate-limited.
  90
  91 QUORUM_REPORT_BAD
  92 -----------------
  93
  94 Emitted to report a corruption of a Quorum file.
  95
  96 Data:
  97
  98 - "type":          Quorum operation type
  99 - "error":         Error message (json-string, optional)
 100                    Only present on failure.  This field contains a human-readable
 101                    error message.  There are no semantics other than that the
 102                    block layer reported an error and clients should not try to
 103                    interpret the error string.
 104 - "node-name":     The graph node name of the block driver state.
 105 - "sector-num":    Number of the first sector of the failed read operation.
 106 - "sectors-count": Failed read operation sector count.
 107
 108 Example:
 109
 110 Read operation:
 111 { "event": "QUORUM_REPORT_BAD",
 112      "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5,
 113                "type": "read" },
 114      "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
 115
 116 Flush operation:
 117 { "event": "QUORUM_REPORT_BAD",
 118      "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120,
 119                "type": "flush", "error": "Broken pipe" },
 120      "timestamp": { "seconds": 1456406829, "microseconds": 291763 } }
 121
 122 Note: this event is rate-limited.
 123
 124 MIGRATION_PASS
 125 --------------
 126
 127 Emitted from the source side of a migration at the start of each pass
 128 (when it syncs the dirty bitmap)
 129
 130 Data: None.
 131
 132   - "pass": An incrementing count (starting at 1 on the first pass)
 133
 134 Example:
 135 {"timestamp": {"seconds": 1449669631, "microseconds": 239225},
 136  "event": "MIGRATION_PASS", "data": {"pass": 2}}
 137
 138 VSERPORT_CHANGE
 139 ---------------
 140
 141 Emitted when the guest opens or closes a virtio-serial port.
 142
 143 Data:
 144
 145 - "id": device identifier of the virtio-serial port (json-string)
 146 - "open": true if the guest has opened the virtio-serial port (json-bool)
 147
 148 Example:
 149
 150 { "event": "VSERPORT_CHANGE",
 151     "data": { "id": "channel0", "open": true },
 152     "timestamp": { "seconds": 1401385907, "microseconds": 422329 } }
 153
 154 Note: this event is rate-limited separately for each "id".