diff options
Diffstat (limited to 'qapi/event.json')
| -rw-r--r-- | qapi/event.json | 248 |
1 files changed, 247 insertions, 1 deletions
diff --git a/qapi/event.json b/qapi/event.json index 37bf34ed6d..f3737b771f 100644 --- a/qapi/event.json +++ b/qapi/event.json @@ -1,3 +1,9 @@ +# -*- Mode: Python -*- + +## +# = Other events +## + ## # @SHUTDOWN: # @@ -8,6 +14,12 @@ # not exit, and a STOP event will eventually follow the SHUTDOWN event # # Since: 0.12.0 +# +# Example: +# +# <- { "event": "SHUTDOWN", +# "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } +# ## { 'event': 'SHUTDOWN' } @@ -18,6 +30,12 @@ # system, such as via ACPI. # # Since: 0.12.0 +# +# Example: +# +# <- { "event": "POWERDOWN", +# "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } +# ## { 'event': 'POWERDOWN' } @@ -27,6 +45,12 @@ # Emitted when the virtual machine is reset # # Since: 0.12.0 +# +# Example: +# +# <- { "event": "RESET", +# "timestamp": { "seconds": 1267041653, "microseconds": 9518 } } +# ## { 'event': 'RESET' } @@ -36,6 +60,12 @@ # Emitted when the virtual machine is stopped # # Since: 0.12.0 +# +# Example: +# +# <- { "event": "STOP", +# "timestamp": { "seconds": 1267041730, "microseconds": 281295 } } +# ## { 'event': 'STOP' } @@ -45,6 +75,12 @@ # Emitted when the virtual machine resumes execution # # Since: 0.12.0 +# +# Example: +# +# <- { "event": "RESUME", +# "timestamp": { "seconds": 1271770767, "microseconds": 582542 } } +# ## { 'event': 'RESUME' } @@ -55,6 +91,12 @@ # which is sometimes called standby state # # Since: 1.1 +# +# Example: +# +# <- { "event": "SUSPEND", +# "timestamp": { "seconds": 1344456160, "microseconds": 309119 } } +# ## { 'event': 'SUSPEND' } @@ -67,6 +109,12 @@ # Note: QEMU shuts down (similar to event @SHUTDOWN) when entering this state # # Since: 1.2 +# +# Example: +# +# <- { "event": "SUSPEND_DISK", +# "timestamp": { "seconds": 1344456160, "microseconds": 309119 } } +# ## { 'event': 'SUSPEND_DISK' } @@ -76,6 +124,12 @@ # Emitted when the guest has woken up from suspend state and is running # # Since: 1.1 +# +# Example: +# +# <- { "event": "WAKEUP", +# "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } +# ## { 'event': 'WAKEUP' } @@ -87,7 +141,16 @@ # @offset: offset between base RTC clock (as specified by -rtc base), and # new RTC clock value # +# Note: This event is rate-limited. +# # Since: 0.13.0 +# +# Example: +# +# <- { "event": "RTC_CHANGE", +# "data": { "offset": 78 }, +# "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } +# ## { 'event': 'RTC_CHANGE', 'data': { 'offset': 'int' } } @@ -102,7 +165,16 @@ # Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is # followed respectively by the RESET, SHUTDOWN, or STOP events # +# Note: This event is rate-limited. +# # Since: 0.13.0 +# +# Example: +# +# <- { "event": "WATCHDOG", +# "data": { "action": "reset" }, +# "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } +# ## { 'event': 'WATCHDOG', 'data': { 'action': 'WatchdogExpirationAction' } } @@ -119,6 +191,14 @@ # @path: device path # # Since: 1.5 +# +# Example: +# +# <- { "event": "DEVICE_DELETED", +# "data": { "device": "virtio-net-pci-0", +# "path": "/machine/peripheral/virtio-net-pci-0" }, +# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } +# ## { 'event': 'DEVICE_DELETED', 'data': { '*device': 'str', 'path': 'str' } } @@ -134,6 +214,15 @@ # @path: device path # # Since: 1.6 +# +# Example: +# +# <- { "event": "NIC_RX_FILTER_CHANGED", +# "data": { "name": "vnet0", +# "path": "/machine/peripheral/vnet0/virtio-backend" }, +# "timestamp": { "seconds": 1368697518, "microseconds": 326866 } } +# } +# ## { 'event': 'NIC_RX_FILTER_CHANGED', 'data': { '*name': 'str', 'path': 'str' } } @@ -151,6 +240,17 @@ # the authentication ID is not provided # # Since: 0.13.0 +# +# Example: +# +# <- { "event": "VNC_CONNECTED", +# "data": { +# "server": { "auth": "sasl", "family": "ipv4", +# "service": "5901", "host": "0.0.0.0" }, +# "client": { "family": "ipv4", "service": "58425", +# "host": "127.0.0.1" } }, +# "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } +# ## { 'event': 'VNC_CONNECTED', 'data': { 'server': 'VncServerInfo', @@ -167,6 +267,17 @@ # @client: client information # # Since: 0.13.0 +# +# Example: +# +# <- { "event": "VNC_INITIALIZED", +# "data": { +# "server": { "auth": "sasl", "family": "ipv4", +# "service": "5901", "host": "0.0.0.0"}, +# "client": { "family": "ipv4", "service": "46089", +# "host": "127.0.0.1", "sasl_username": "luiz" } }, +# "timestamp": { "seconds": 1263475302, "microseconds": 150772 } } +# ## { 'event': 'VNC_INITIALIZED', 'data': { 'server': 'VncServerInfo', @@ -182,6 +293,17 @@ # @client: client information # # Since: 0.13.0 +# +# Example: +# +# <- { "event": "VNC_DISCONNECTED", +# "data": { +# "server": { "auth": "sasl", "family": "ipv4", +# "service": "5901", "host": "0.0.0.0" }, +# "client": { "family": "ipv4", "service": "58425", +# "host": "127.0.0.1", "sasl_username": "luiz" } }, +# "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } +# ## { 'event': 'VNC_DISCONNECTED', 'data': { 'server': 'VncServerInfo', @@ -197,6 +319,16 @@ # @client: client information # # Since: 0.14.0 +# +# Example: +# +# <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707}, +# "event": "SPICE_CONNECTED", +# "data": { +# "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"}, +# "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} +# }} +# ## { 'event': 'SPICE_CONNECTED', 'data': { 'server': 'SpiceBasicInfo', @@ -213,6 +345,18 @@ # @client: client information # # Since: 0.14.0 +# +# Example: +# +# <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172}, +# "event": "SPICE_INITIALIZED", +# "data": {"server": {"auth": "spice", "port": "5921", +# "family": "ipv4", "host": "127.0.0.1"}, +# "client": {"port": "49004", "family": "ipv4", "channel-type": 3, +# "connection-id": 1804289383, "host": "127.0.0.1", +# "channel-id": 0, "tls": true} +# }} +# ## { 'event': 'SPICE_INITIALIZED', 'data': { 'server': 'SpiceServerInfo', @@ -228,6 +372,16 @@ # @client: client information # # Since: 0.14.0 +# +# Example: +# +# <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707}, +# "event": "SPICE_DISCONNECTED", +# "data": { +# "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"}, +# "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} +# }} +# ## { 'event': 'SPICE_DISCONNECTED', 'data': { 'server': 'SpiceBasicInfo', @@ -239,6 +393,12 @@ # Emitted when SPICE migration has completed # # Since: 1.3 +# +# Example: +# +# <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172}, +# "event": "SPICE_MIGRATE_COMPLETED" } +# ## { 'event': 'SPICE_MIGRATE_COMPLETED' } @@ -250,6 +410,13 @@ # @status: @MigrationStatus describing the current migration status. # # Since: 2.4 +# +# Example: +# +# <- {"timestamp": {"seconds": 1432121972, "microseconds": 744001}, +# "event": "MIGRATION", +# "data": {"status": "completed"} } +# ## { 'event': 'MIGRATION', 'data': {'status': 'MigrationStatus'}} @@ -263,6 +430,12 @@ # @pass: An incrementing count (starting at 1 on the first pass) # # Since: 2.6 +# +# Example: +# +# { "timestamp": {"seconds": 1449669631, "microseconds": 239225}, +# "event": "MIGRATION_PASS", "data": {"pass": 2} } +# ## { 'event': 'MIGRATION_PASS', 'data': { 'pass': 'int' } } @@ -272,9 +445,16 @@ # # Emitted when guest executes ACPI _OST method. # +# @info: ACPIOSTInfo type as described in qapi-schema.json +# # Since: 2.1 # -# @info: ACPIOSTInfo type as described in qapi-schema.json +# Example: +# +# <- { "event": "ACPI_DEVICE_OST", +# "data": { "device": "d1", "slot": "0", +# "slot-type": "DIMM", "source": 1, "status": 0 } } +# ## { 'event': 'ACPI_DEVICE_OST', 'data': { 'info': 'ACPIOSTInfo' } } @@ -287,7 +467,16 @@ # # @actual: actual level of the guest memory balloon in bytes # +# Note: this event is rate-limited. +# # Since: 1.2 +# +# Example: +# +# <- { "event": "BALLOON_CHANGE", +# "data": { "actual": 944766976 }, +# "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } +# ## { 'event': 'BALLOON_CHANGE', 'data': { 'actual': 'int' } } @@ -300,6 +489,12 @@ # @action: action that has been taken, currently always "pause" # # Since: 1.5 +# +# Example: +# +# <- { "event": "GUEST_PANICKED", +# "data": { "action": "pause" } } +# ## { 'event': 'GUEST_PANICKED', 'data': { 'action': 'GuestPanicAction' } } @@ -315,7 +510,16 @@ # # @sectors-count: failed read operation sector count # +# Note: This event is rate-limited. +# # Since: 2.0 +# +# Example: +# +# <- { "event": "QUORUM_FAILURE", +# "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 }, +# "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } +# ## { 'event': 'QUORUM_FAILURE', 'data': { 'reference': 'str', 'sector-num': 'int', 'sectors-count': 'int' } } @@ -338,7 +542,26 @@ # # @sectors-count: failed read operation sector count # +# Note: This event is rate-limited. +# # Since: 2.0 +# +# Example: +# +# 1. Read operation +# +# { "event": "QUORUM_REPORT_BAD", +# "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5, +# "type": "read" }, +# "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } +# +# 2. Flush operation +# +# { "event": "QUORUM_REPORT_BAD", +# "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120, +# "type": "flush", "error": "Broken pipe" }, +# "timestamp": { "seconds": 1456406829, "microseconds": 291763 } } +# ## { 'event': 'QUORUM_REPORT_BAD', 'data': { 'type': 'QuorumOpType', '*error': 'str', 'node-name': 'str', @@ -354,6 +577,13 @@ # @open: true if the guest has opened the virtio-serial port # # Since: 2.1 +# +# Example: +# +# <- { "event": "VSERPORT_CHANGE", +# "data": { "id": "channel0", "open": true }, +# "timestamp": { "seconds": 1401385907, "microseconds": 422329 } } +# ## { 'event': 'VSERPORT_CHANGE', 'data': { 'id': 'str', 'open': 'bool' } } @@ -368,6 +598,15 @@ # @msg: Informative message # # Since: 2.4 +# +# Example: +# +# <- { "event": "MEM_UNPLUG_ERROR" +# "data": { "device": "dimm1", +# "msg": "acpi: device unplug for unsupported device" +# }, +# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } +# ## { 'event': 'MEM_UNPLUG_ERROR', 'data': { 'device': 'str', 'msg': 'str' } } @@ -384,6 +623,13 @@ # user should not try to interpret the error string. # # Since: 2.6 +# +# Example: +# +# { "event": "DUMP_COMPLETED", +# "data": {"result": {"total": 1090650112, "status": "completed", +# "completed": 1090650112} } } +# ## { 'event': 'DUMP_COMPLETED' , 'data': { 'result': 'DumpQueryResult', '*error': 'str' } } |