Statistics
| Branch: | Revision:

root / QMP / qmp-events.txt @ 9eedeb3b

History | View | Annotate | Download (5.1 kB)

1
                   QEMU Monitor Protocol Events
2
                   ============================
3

    
4
BLOCK_IO_ERROR
5
--------------
6

    
7
Emitted when a disk I/O error occurs.
8

    
9
Data:
10

    
11
- "device": device name (json-string)
12
- "operation": I/O operation (json-string, "read" or "write")
13
- "action": action that has been taken, it's one of the following (json-string):
14
    "ignore": error has been ignored
15
    "report": error has been reported to the device
16
    "stop": error caused VM to be stopped
17

    
18
Example:
19

    
20
{ "event": "BLOCK_IO_ERROR",
21
    "data": { "device": "ide0-hd1",
22
              "operation": "write",
23
              "action": "stop" },
24
    "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
25

    
26
Note: If action is "stop", a STOP event will eventually follow the
27
BLOCK_IO_ERROR event.
28

    
29
RESET
30
-----
31

    
32
Emitted when the Virtual Machine is reseted.
33

    
34
Data: None.
35

    
36
Example:
37

    
38
{ "event": "RESET",
39
    "timestamp": { "seconds": 1267041653, "microseconds": 9518 } }
40

    
41
RTC_CHANGE
42
----------
43

    
44
Emitted when the RTC time changes.
45

    
46
Data:
47

    
48
- "offset": delta against the host UTC in seconds (json-number)
49

    
50
Example:
51

    
52
{ "event": "RTC_CHANGE",
53
    "data": { "offset": 78 },
54
    "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
55

    
56
SHUTDOWN
57
--------
58

    
59
Emitted when the Virtual Machine is powered down.
60

    
61
Data: None.
62

    
63
Example:
64

    
65
{ "event": "SHUTDOWN",
66
    "timestamp": { "seconds": 1267040730, "microseconds": 682951 } }
67

    
68
Note: If the command-line option "-no-shutdown" has been specified, a STOP
69
event will eventually follow the SHUTDOWN event.
70

    
71
STOP
72
----
73

    
74
Emitted when the Virtual Machine is stopped.
75

    
76
Data: None.
77

    
78
Example:
79

    
80
{ "event": "SHUTDOWN",
81
    "timestamp": { "seconds": 1267041730, "microseconds": 281295 } }
82

    
83
VNC_CONNECTED
84
-------------
85

    
86
Emitted when a VNC client establishes a connection.
87

    
88
Data:
89

    
90
- "server": Server information (json-object)
91
  - "host": IP address (json-string)
92
  - "service": port number (json-string)
93
  - "family": address family (json-string, "ipv4" or "ipv6")
94
  - "auth": authentication method (json-string, optional)
95
- "client": Client information (json-object)
96
  - "host": IP address (json-string)
97
  - "service": port number (json-string)
98
  - "family": address family (json-string, "ipv4" or "ipv6")
99

    
100
Example:
101

    
102
{ "event": "VNC_CONNECTED",
103
    "data": {
104
        "server": { "auth": "sasl", "family": "ipv4",
105
                    "service": "5901", "host": "0.0.0.0" },
106
        "client": { "family": "ipv4", "service": "58425",
107
                    "host": "127.0.0.1" } },
108
    "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
109

    
110

    
111
Note: This event is emitted before any authentication takes place, thus
112
the authentication ID is not provided.
113

    
114
VNC_DISCONNECTED
115
----------------
116

    
117
Emitted when the conection is closed.
118

    
119
Data:
120

    
121
- "server": Server information (json-object)
122
  - "host": IP address (json-string)
123
  - "service": port number (json-string)
124
  - "family": address family (json-string, "ipv4" or "ipv6")
125
  - "auth": authentication method (json-string, optional)
126
- "client": Client information (json-object)
127
  - "host": IP address (json-string)
128
  - "service": port number (json-string)
129
  - "family": address family (json-string, "ipv4" or "ipv6")
130
  - "x509_dname": TLS dname (json-string, optional)
131
  - "sasl_username": SASL username (json-string, optional)
132

    
133
Example:
134

    
135
{ "event": "VNC_DISCONNECTED",
136
    "data": {
137
        "server": { "auth": "sasl", "family": "ipv4",
138
                    "service": "5901", "host": "0.0.0.0" },
139
        "client": { "family": "ipv4", "service": "58425",
140
                    "host": "127.0.0.1", "sasl_username": "luiz" } },
141
    "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
142

    
143
VNC_INITIALIZED
144
---------------
145

    
146
Emitted after authentication takes place (if any) and the VNC session is
147
made active.
148

    
149
Data:
150

    
151
- "server": Server information (json-object)
152
  - "host": IP address (json-string)
153
  - "service": port number (json-string)
154
  - "family": address family (json-string, "ipv4" or "ipv6")
155
  - "auth": authentication method (json-string, optional)
156
- "client": Client information (json-object)
157
  - "host": IP address (json-string)
158
  - "service": port number (json-string)
159
  - "family": address family (json-string, "ipv4" or "ipv6")
160
  - "x509_dname": TLS dname (json-string, optional)
161
  - "sasl_username": SASL username (json-string, optional)
162

    
163
Example:
164

    
165
{ "event": "VNC_INITIALIZED",
166
    "data": {
167
        "server": { "auth": "sasl", "family": "ipv4",
168
                    "service": "5901", "host": "0.0.0.0"},
169
        "client": { "family": "ipv4", "service": "46089",
170
                    "host": "127.0.0.1", "sasl_username": "luiz" } },
171
        "timestamp": { "seconds": 1263475302, "microseconds": 150772 } }
172

    
173
WATCHDOG
174
--------
175

    
176
Emitted when the watchdog device's timer is expired.
177

    
178
Data:
179

    
180
- "action": Action that has been taken, it's one of the following (json-string):
181
            "reset", "shutdown", "poweroff", "pause", "debug", or "none"
182

    
183
Example:
184

    
185
{ "event": "WATCHDOG",
186
     "data": { "action": "reset" },
187
     "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
188

    
189
Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is
190
followed respectively by the RESET, SHUTDOWN, or STOP events.