]>
Commit | Line | Data |
---|---|---|
e3193601 | 1 | # -*- Mode: Python -*- |
4d8bb958 MAL |
2 | ## |
3 | # = Introduction | |
4 | # | |
5 | # This document describes all commands currently supported by QMP. | |
6 | # | |
7 | # Most of the time their usage is exactly the same as in the user Monitor, this | |
8 | # means that any other document which also describe commands (the manpage, | |
9 | # QEMU's manual, etc) can and should be consulted. | |
10 | # | |
11 | # QMP has two types of commands: regular and query commands. Regular commands | |
12 | # usually change the Virtual Machine's state someway, while query commands just | |
13 | # return information. The sections below are divided accordingly. | |
14 | # | |
15 | # It's important to observe that all communication examples are formatted in | |
16 | # a reader-friendly way, so that they're easier to understand. However, in real | |
17 | # protocol usage, they're emitted as a single line. | |
18 | # | |
19 | # Also, the following notation is used to denote data flow: | |
20 | # | |
21 | # Example: | |
22 | # | |
23 | # | -> data issued by the Client | |
24 | # | <- Server data response | |
e3193601 | 25 | # |
4d8bb958 MAL |
26 | # Please, refer to the QMP specification (docs/qmp-spec.txt) for |
27 | # detailed information on the Server command and response formats. | |
28 | # | |
29 | # = Stability Considerations | |
30 | # | |
31 | # The current QMP command set (described in this file) may be useful for a | |
32 | # number of use cases, however it's limited and several commands have bad | |
33 | # defined semantics, specially with regard to command completion. | |
34 | # | |
35 | # These problems are going to be solved incrementally in the next QEMU releases | |
36 | # and we're going to establish a deprecation policy for badly defined commands. | |
37 | # | |
38 | # If you're planning to adopt QMP, please observe the following: | |
39 | # | |
40 | # 1. The deprecation policy will take effect and be documented soon, please | |
41 | # check the documentation of each used command as soon as a new release of | |
42 | # QEMU is available | |
43 | # | |
44 | # 2. DO NOT rely on anything which is not explicit documented | |
45 | # | |
46 | # 3. Errors, in special, are not documented. Applications should NOT check | |
47 | # for specific errors classes or data (it's strongly recommended to only | |
48 | # check for the "error" key) | |
49 | # | |
50 | ## | |
48a32bed | 51 | |
bc52d03f MA |
52 | { 'pragma': { 'doc-required': true } } |
53 | ||
1554a8fa MA |
54 | # Whitelists to permit QAPI rule violations; think twice before you |
55 | # add to them! | |
56 | { 'pragma': { | |
57 | # Commands allowed to return a non-dictionary: | |
58 | 'returns-whitelist': [ | |
59 | 'human-monitor-command', | |
60 | 'qom-get', | |
61 | 'query-migrate-cache-size', | |
62 | 'query-tpm-models', | |
63 | 'query-tpm-types', | |
2cfbae3c MA |
64 | 'ringbuf-read' ], |
65 | 'name-case-whitelist': [ | |
66 | 'ACPISlotType', # DIMM, visible through query-acpi-ospm-status | |
67 | 'CpuInfoMIPS', # PC, visible through query-cpu | |
68 | 'CpuInfoTricore', # PC, visible through query-cpu | |
69 | 'QapiErrorClass', # all members, visible through errors | |
70 | 'UuidInfo', # UUID, visible through query-uuid | |
71 | 'X86CPURegister32', # all members, visible indirectly through qom-get | |
72 | 'q_obj_CpuInfo-base' # CPU, visible through query-cpu | |
73 | ] } } | |
1554a8fa | 74 | |
d34bda71 BC |
75 | # QAPI common definitions |
76 | { 'include': 'qapi/common.json' } | |
104059da | 77 | |
a090187d DB |
78 | # QAPI crypto definitions |
79 | { 'include': 'qapi/crypto.json' } | |
80 | ||
5db15096 BC |
81 | # QAPI block definitions |
82 | { 'include': 'qapi/block.json' } | |
83 | ||
82d72d9d WX |
84 | # QAPI event definitions |
85 | { 'include': 'qapi/event.json' } | |
86 | ||
1dde0f48 LV |
87 | # Tracing commands |
88 | { 'include': 'qapi/trace.json' } | |
89 | ||
39a18158 MA |
90 | # QAPI introspection |
91 | { 'include': 'qapi/introspect.json' } | |
92 | ||
d3a48372 MAL |
93 | ## |
94 | # = QMP commands | |
95 | ## | |
96 | ||
119ebac1 MAL |
97 | ## |
98 | # @qmp_capabilities: | |
99 | # | |
100 | # Enable QMP capabilities. | |
101 | # | |
102 | # Arguments: None. | |
103 | # | |
104 | # Example: | |
105 | # | |
106 | # -> { "execute": "qmp_capabilities" } | |
107 | # <- { "return": {} } | |
108 | # | |
109 | # Notes: This command is valid exactly when first connecting: it must be | |
110 | # issued before any other command will be accepted, and will fail once the | |
111 | # monitor is accepting other commands. (see qemu docs/qmp-spec.txt) | |
112 | # | |
113 | # Since: 0.13 | |
114 | # | |
115 | ## | |
116 | { 'command': 'qmp_capabilities' } | |
117 | ||
104059da | 118 | ## |
801db5ec | 119 | # @LostTickPolicy: |
104059da PB |
120 | # |
121 | # Policy for handling lost ticks in timer devices. | |
122 | # | |
123 | # @discard: throw away the missed tick(s) and continue with future injection | |
124 | # normally. Guest time may be delayed, unless the OS has explicit | |
125 | # handling of lost ticks | |
126 | # | |
127 | # @delay: continue to deliver ticks at the normal rate. Guest time will be | |
128 | # delayed due to the late tick | |
129 | # | |
130 | # @merge: merge the missed tick(s) into one tick and inject. Guest time | |
131 | # may be delayed, depending on how the OS reacts to the merging | |
132 | # of ticks | |
133 | # | |
134 | # @slew: deliver ticks at a higher rate to catch up with the missed tick. The | |
135 | # guest time should not be delayed once catchup is complete. | |
136 | # | |
137 | # Since: 2.0 | |
138 | ## | |
139 | { 'enum': 'LostTickPolicy', | |
140 | 'data': ['discard', 'delay', 'merge', 'slew' ] } | |
141 | ||
49687ace | 142 | ## |
5072f7b3 | 143 | # @add_client: |
b224e5e2 LC |
144 | # |
145 | # Allow client connections for VNC, Spice and socket based | |
146 | # character devices to be passed in to QEMU via SCM_RIGHTS. | |
147 | # | |
148 | # @protocol: protocol name. Valid names are "vnc", "spice" or the | |
149 | # name of a character device (eg. from -chardev id=XXXX) | |
150 | # | |
151 | # @fdname: file descriptor name previously passed via 'getfd' command | |
152 | # | |
1d8bda12 | 153 | # @skipauth: whether to skip authentication. Only applies |
b224e5e2 LC |
154 | # to "vnc" and "spice" protocols |
155 | # | |
1d8bda12 | 156 | # @tls: whether to perform TLS. Only applies to the "spice" |
b224e5e2 LC |
157 | # protocol |
158 | # | |
159 | # Returns: nothing on success. | |
160 | # | |
161 | # Since: 0.14.0 | |
65ce54f5 MAL |
162 | # |
163 | # Example: | |
164 | # | |
165 | # -> { "execute": "add_client", "arguments": { "protocol": "vnc", | |
166 | # "fdname": "myclient" } } | |
167 | # <- { "return": {} } | |
168 | # | |
b224e5e2 LC |
169 | ## |
170 | { 'command': 'add_client', | |
171 | 'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool', | |
172 | '*tls': 'bool' } } | |
173 | ||
48a32bed AL |
174 | ## |
175 | # @NameInfo: | |
176 | # | |
177 | # Guest name information. | |
178 | # | |
1d8bda12 | 179 | # @name: The name of the guest |
48a32bed | 180 | # |
5072f7b3 | 181 | # Since: 0.14.0 |
48a32bed | 182 | ## |
895a2a80 | 183 | { 'struct': 'NameInfo', 'data': {'*name': 'str'} } |
48a32bed AL |
184 | |
185 | ## | |
186 | # @query-name: | |
187 | # | |
188 | # Return the name information of a guest. | |
189 | # | |
190 | # Returns: @NameInfo of the guest | |
191 | # | |
5072f7b3 | 192 | # Since: 0.14.0 |
3aa4c6cd MAL |
193 | # |
194 | # Example: | |
195 | # | |
196 | # -> { "execute": "query-name" } | |
197 | # <- { "return": { "name": "qemu-name" } } | |
198 | # | |
48a32bed AL |
199 | ## |
200 | { 'command': 'query-name', 'returns': 'NameInfo' } | |
b9c15f16 | 201 | |
292a2602 LC |
202 | ## |
203 | # @KvmInfo: | |
204 | # | |
205 | # Information about support for KVM acceleration | |
206 | # | |
207 | # @enabled: true if KVM acceleration is active | |
208 | # | |
209 | # @present: true if KVM acceleration is built into this executable | |
210 | # | |
211 | # Since: 0.14.0 | |
212 | ## | |
895a2a80 | 213 | { 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} } |
292a2602 LC |
214 | |
215 | ## | |
216 | # @query-kvm: | |
217 | # | |
218 | # Returns information about KVM acceleration | |
219 | # | |
220 | # Returns: @KvmInfo | |
221 | # | |
222 | # Since: 0.14.0 | |
b4f65cd2 MAL |
223 | # |
224 | # Example: | |
225 | # | |
226 | # -> { "execute": "query-kvm" } | |
227 | # <- { "return": { "enabled": true, "present": true } } | |
228 | # | |
292a2602 LC |
229 | ## |
230 | { 'command': 'query-kvm', 'returns': 'KvmInfo' } | |
231 | ||
1fa9a5e4 | 232 | ## |
5072f7b3 | 233 | # @RunState: |
1fa9a5e4 | 234 | # |
6932a69b | 235 | # An enumeration of VM run states. |
1fa9a5e4 LC |
236 | # |
237 | # @debug: QEMU is running on a debugger | |
238 | # | |
0a24c7b1 LC |
239 | # @finish-migrate: guest is paused to finish the migration process |
240 | # | |
1e998146 PB |
241 | # @inmigrate: guest is paused waiting for an incoming migration. Note |
242 | # that this state does not tell whether the machine will start at the | |
243 | # end of the migration. This depends on the command-line -S option and | |
244 | # any invocation of 'stop' or 'cont' that has happened since QEMU was | |
245 | # started. | |
1fa9a5e4 LC |
246 | # |
247 | # @internal-error: An internal error that prevents further guest execution | |
248 | # has occurred | |
249 | # | |
250 | # @io-error: the last IOP has failed and the device is configured to pause | |
251 | # on I/O errors | |
252 | # | |
253 | # @paused: guest has been paused via the 'stop' command | |
254 | # | |
255 | # @postmigrate: guest is paused following a successful 'migrate' | |
256 | # | |
257 | # @prelaunch: QEMU was started with -S and guest has not started | |
258 | # | |
1fa9a5e4 LC |
259 | # @restore-vm: guest is paused to restore VM state |
260 | # | |
261 | # @running: guest is actively running | |
262 | # | |
263 | # @save-vm: guest is paused to save the VM state | |
264 | # | |
265 | # @shutdown: guest is shut down (and -no-shutdown is in use) | |
266 | # | |
ad02b96a LC |
267 | # @suspended: guest is suspended (ACPI S3) |
268 | # | |
1fa9a5e4 | 269 | # @watchdog: the watchdog action is configured to pause and has been triggered |
ede085b3 HT |
270 | # |
271 | # @guest-panicked: guest has been panicked as a result of guest OS panic | |
21142ba7 | 272 | # |
252093a7 HZ |
273 | # @colo: guest is paused to save/restore VM state under colo checkpoint, |
274 | # VM can not get into this state unless colo capability is enabled | |
275 | # for migration. (since 2.8) | |
1fa9a5e4 LC |
276 | ## |
277 | { 'enum': 'RunState', | |
278 | 'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused', | |
279 | 'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm', | |
ede085b3 | 280 | 'running', 'save-vm', 'shutdown', 'suspended', 'watchdog', |
21142ba7 | 281 | 'guest-panicked', 'colo' ] } |
1fa9a5e4 LC |
282 | |
283 | ## | |
284 | # @StatusInfo: | |
285 | # | |
286 | # Information about VCPU run state | |
287 | # | |
288 | # @running: true if all VCPUs are runnable, false if not runnable | |
289 | # | |
290 | # @singlestep: true if VCPUs are in single-step mode | |
291 | # | |
292 | # @status: the virtual machine @RunState | |
293 | # | |
294 | # Since: 0.14.0 | |
295 | # | |
296 | # Notes: @singlestep is enabled through the GDB stub | |
297 | ## | |
895a2a80 | 298 | { 'struct': 'StatusInfo', |
1fa9a5e4 LC |
299 | 'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} } |
300 | ||
301 | ## | |
302 | # @query-status: | |
303 | # | |
304 | # Query the run status of all VCPUs | |
305 | # | |
306 | # Returns: @StatusInfo reflecting all VCPUs | |
307 | # | |
308 | # Since: 0.14.0 | |
477bc1e4 MAL |
309 | # |
310 | # Example: | |
311 | # | |
312 | # -> { "execute": "query-status" } | |
313 | # <- { "return": { "running": true, | |
314 | # "singlestep": false, | |
315 | # "status": "running" } } | |
316 | # | |
1fa9a5e4 LC |
317 | ## |
318 | { 'command': 'query-status', 'returns': 'StatusInfo' } | |
319 | ||
efab767e LC |
320 | ## |
321 | # @UuidInfo: | |
322 | # | |
0ed90f77 | 323 | # Guest UUID information (Universally Unique Identifier). |
efab767e LC |
324 | # |
325 | # @UUID: the UUID of the guest | |
326 | # | |
327 | # Since: 0.14.0 | |
328 | # | |
329 | # Notes: If no UUID was specified for the guest, a null UUID is returned. | |
330 | ## | |
895a2a80 | 331 | { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} } |
efab767e LC |
332 | |
333 | ## | |
334 | # @query-uuid: | |
335 | # | |
336 | # Query the guest UUID information. | |
337 | # | |
338 | # Returns: The @UuidInfo for the guest | |
339 | # | |
5072f7b3 | 340 | # Since: 0.14.0 |
0ed90f77 MAL |
341 | # |
342 | # Example: | |
343 | # | |
344 | # -> { "execute": "query-uuid" } | |
345 | # <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } } | |
346 | # | |
efab767e LC |
347 | ## |
348 | { 'command': 'query-uuid', 'returns': 'UuidInfo' } | |
349 | ||
c5a415a0 LC |
350 | ## |
351 | # @ChardevInfo: | |
352 | # | |
353 | # Information about a character device. | |
354 | # | |
355 | # @label: the label of the character device | |
356 | # | |
357 | # @filename: the filename of the character device | |
358 | # | |
32a97ea1 LE |
359 | # @frontend-open: shows whether the frontend device attached to this backend |
360 | # (eg. with the chardev=... option) is in open or closed state | |
361 | # (since 2.1) | |
362 | # | |
c5a415a0 LC |
363 | # Notes: @filename is encoded using the QEMU command line character device |
364 | # encoding. See the QEMU man page for details. | |
365 | # | |
366 | # Since: 0.14.0 | |
367 | ## | |
895a2a80 | 368 | { 'struct': 'ChardevInfo', 'data': {'label': 'str', |
32a97ea1 LE |
369 | 'filename': 'str', |
370 | 'frontend-open': 'bool'} } | |
c5a415a0 LC |
371 | |
372 | ## | |
373 | # @query-chardev: | |
374 | # | |
375 | # Returns information about current character devices. | |
376 | # | |
377 | # Returns: a list of @ChardevInfo | |
378 | # | |
379 | # Since: 0.14.0 | |
4055aa8d MAL |
380 | # |
381 | # Example: | |
382 | # | |
383 | # -> { "execute": "query-chardev" } | |
384 | # <- { | |
385 | # "return": [ | |
386 | # { | |
387 | # "label": "charchannel0", | |
388 | # "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server", | |
389 | # "frontend-open": false | |
390 | # }, | |
391 | # { | |
392 | # "label": "charmonitor", | |
393 | # "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server", | |
394 | # "frontend-open": true | |
395 | # }, | |
396 | # { | |
397 | # "label": "charserial0", | |
398 | # "filename": "pty:/dev/pts/2", | |
399 | # "frontend-open": true | |
400 | # } | |
401 | # ] | |
402 | # } | |
403 | # | |
c5a415a0 LC |
404 | ## |
405 | { 'command': 'query-chardev', 'returns': ['ChardevInfo'] } | |
aa9b79bc | 406 | |
77d1c3c6 MK |
407 | ## |
408 | # @ChardevBackendInfo: | |
409 | # | |
410 | # Information about a character device backend | |
411 | # | |
412 | # @name: The backend name | |
413 | # | |
414 | # Since: 2.0 | |
415 | ## | |
895a2a80 | 416 | { 'struct': 'ChardevBackendInfo', 'data': {'name': 'str'} } |
77d1c3c6 MK |
417 | |
418 | ## | |
419 | # @query-chardev-backends: | |
420 | # | |
421 | # Returns information about character device backends. | |
422 | # | |
423 | # Returns: a list of @ChardevBackendInfo | |
424 | # | |
425 | # Since: 2.0 | |
90e365c0 MAL |
426 | # |
427 | # Example: | |
428 | # | |
429 | # -> { "execute": "query-chardev-backends" } | |
430 | # <- { | |
431 | # "return":[ | |
432 | # { | |
433 | # "name":"udp" | |
434 | # }, | |
435 | # { | |
436 | # "name":"tcp" | |
437 | # }, | |
438 | # { | |
439 | # "name":"unix" | |
440 | # }, | |
441 | # { | |
442 | # "name":"spiceport" | |
443 | # } | |
444 | # ] | |
445 | # } | |
446 | # | |
77d1c3c6 MK |
447 | ## |
448 | { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] } | |
449 | ||
1f590cf9 LL |
450 | ## |
451 | # @DataFormat: | |
452 | # | |
453 | # An enumeration of data format. | |
454 | # | |
3949e594 | 455 | # @utf8: Data is a UTF-8 string (RFC 3629) |
1f590cf9 | 456 | # |
3949e594 | 457 | # @base64: Data is Base64 encoded binary (RFC 3548) |
1f590cf9 LL |
458 | # |
459 | # Since: 1.4 | |
460 | ## | |
ad0f171e | 461 | { 'enum': 'DataFormat', |
1f590cf9 LL |
462 | 'data': [ 'utf8', 'base64' ] } |
463 | ||
464 | ## | |
3949e594 | 465 | # @ringbuf-write: |
1f590cf9 | 466 | # |
3949e594 | 467 | # Write to a ring buffer character device. |
1f590cf9 | 468 | # |
3949e594 | 469 | # @device: the ring buffer character device name |
1f590cf9 | 470 | # |
3949e594 | 471 | # @data: data to write |
1f590cf9 | 472 | # |
1d8bda12 | 473 | # @format: data encoding (default 'utf8'). |
3949e594 MA |
474 | # - base64: data must be base64 encoded text. Its binary |
475 | # decoding gets written. | |
3949e594 MA |
476 | # - utf8: data's UTF-8 encoding is written |
477 | # - data itself is always Unicode regardless of format, like | |
478 | # any other string. | |
1f590cf9 LL |
479 | # |
480 | # Returns: Nothing on success | |
1f590cf9 LL |
481 | # |
482 | # Since: 1.4 | |
a4143a84 MAL |
483 | # |
484 | # Example: | |
485 | # | |
486 | # -> { "execute": "ringbuf-write", | |
487 | # "arguments": { "device": "foo", | |
488 | # "data": "abcdefgh", | |
489 | # "format": "utf8" } } | |
490 | # <- { "return": {} } | |
491 | # | |
1f590cf9 | 492 | ## |
3949e594 | 493 | { 'command': 'ringbuf-write', |
82e59a67 | 494 | 'data': {'device': 'str', 'data': 'str', |
1f590cf9 LL |
495 | '*format': 'DataFormat'} } |
496 | ||
49b6d722 | 497 | ## |
3949e594 | 498 | # @ringbuf-read: |
49b6d722 | 499 | # |
3949e594 | 500 | # Read from a ring buffer character device. |
49b6d722 | 501 | # |
3949e594 | 502 | # @device: the ring buffer character device name |
49b6d722 | 503 | # |
3949e594 | 504 | # @size: how many bytes to read at most |
49b6d722 | 505 | # |
1d8bda12 | 506 | # @format: data encoding (default 'utf8'). |
3949e594 MA |
507 | # - base64: the data read is returned in base64 encoding. |
508 | # - utf8: the data read is interpreted as UTF-8. | |
509 | # Bug: can screw up when the buffer contains invalid UTF-8 | |
510 | # sequences, NUL characters, after the ring buffer lost | |
511 | # data, and when reading stops because the size limit is | |
512 | # reached. | |
513 | # - The return value is always Unicode regardless of format, | |
514 | # like any other string. | |
49b6d722 | 515 | # |
3ab651fc | 516 | # Returns: data read from the device |
49b6d722 LL |
517 | # |
518 | # Since: 1.4 | |
4f19a01b MAL |
519 | # |
520 | # Example: | |
521 | # | |
522 | # -> { "execute": "ringbuf-read", | |
523 | # "arguments": { "device": "foo", | |
524 | # "size": 1000, | |
525 | # "format": "utf8" } } | |
526 | # <- { "return": "abcdefgh" } | |
527 | # | |
49b6d722 | 528 | ## |
3949e594 | 529 | { 'command': 'ringbuf-read', |
49b6d722 | 530 | 'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'}, |
3ab651fc | 531 | 'returns': 'str' } |
49b6d722 | 532 | |
4860853d DB |
533 | ## |
534 | # @EventInfo: | |
535 | # | |
536 | # Information about a QMP event | |
537 | # | |
538 | # @name: The event name | |
539 | # | |
540 | # Since: 1.2.0 | |
541 | ## | |
895a2a80 | 542 | { 'struct': 'EventInfo', 'data': {'name': 'str'} } |
4860853d DB |
543 | |
544 | ## | |
545 | # @query-events: | |
546 | # | |
547 | # Return a list of supported QMP events by this server | |
548 | # | |
549 | # Returns: A list of @EventInfo for all supported events | |
550 | # | |
551 | # Since: 1.2.0 | |
66c2f5a5 MAL |
552 | # |
553 | # Example: | |
554 | # | |
555 | # -> { "execute": "query-events" } | |
556 | # <- { | |
557 | # "return": [ | |
558 | # { | |
559 | # "name":"SHUTDOWN" | |
560 | # }, | |
561 | # { | |
562 | # "name":"RESET" | |
563 | # } | |
564 | # ] | |
565 | # } | |
566 | # | |
567 | # Note: This example has been shortened as the real response is too long. | |
568 | # | |
4860853d DB |
569 | ## |
570 | { 'command': 'query-events', 'returns': ['EventInfo'] } | |
571 | ||
791e7c82 | 572 | ## |
5072f7b3 | 573 | # @MigrationStats: |
791e7c82 LC |
574 | # |
575 | # Detailed migration status. | |
576 | # | |
577 | # @transferred: amount of bytes already transferred to the target VM | |
578 | # | |
579 | # @remaining: amount of bytes remaining to be transferred to the target VM | |
580 | # | |
581 | # @total: total amount of bytes involved in the migration process | |
582 | # | |
f1c72795 PL |
583 | # @duplicate: number of duplicate (zero) pages (since 1.2) |
584 | # | |
585 | # @skipped: number of skipped zero pages (since 1.5) | |
004d4c10 | 586 | # |
5072f7b3 | 587 | # @normal: number of normal pages (since 1.2) |
004d4c10 | 588 | # |
8d017193 JQ |
589 | # @normal-bytes: number of normal bytes sent (since 1.2) |
590 | # | |
591 | # @dirty-pages-rate: number of pages dirtied by second by the | |
592 | # guest (since 1.3) | |
004d4c10 | 593 | # |
7e114f8c MH |
594 | # @mbps: throughput in megabits/sec. (since 1.6) |
595 | # | |
58570ed8 C |
596 | # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1) |
597 | # | |
d3bf5418 DDAG |
598 | # @postcopy-requests: The number of page requests received from the destination |
599 | # (since 2.7) | |
600 | # | |
004d4c10 | 601 | # Since: 0.14.0 |
791e7c82 | 602 | ## |
895a2a80 | 603 | { 'struct': 'MigrationStats', |
d5f8a570 | 604 | 'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' , |
f1c72795 | 605 | 'duplicate': 'int', 'skipped': 'int', 'normal': 'int', |
7e114f8c | 606 | 'normal-bytes': 'int', 'dirty-pages-rate' : 'int', |
d3bf5418 DDAG |
607 | 'mbps' : 'number', 'dirty-sync-count' : 'int', |
608 | 'postcopy-requests' : 'int' } } | |
791e7c82 | 609 | |
f36d55af | 610 | ## |
5072f7b3 | 611 | # @XBZRLECacheStats: |
f36d55af OW |
612 | # |
613 | # Detailed XBZRLE migration cache statistics | |
614 | # | |
615 | # @cache-size: XBZRLE cache size | |
616 | # | |
617 | # @bytes: amount of bytes already transferred to the target VM | |
618 | # | |
619 | # @pages: amount of pages transferred to the target VM | |
620 | # | |
621 | # @cache-miss: number of cache miss | |
622 | # | |
8bc39233 C |
623 | # @cache-miss-rate: rate of cache miss (since 2.1) |
624 | # | |
f36d55af OW |
625 | # @overflow: number of overflows |
626 | # | |
627 | # Since: 1.2 | |
628 | ## | |
895a2a80 | 629 | { 'struct': 'XBZRLECacheStats', |
f36d55af | 630 | 'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int', |
8bc39233 C |
631 | 'cache-miss': 'int', 'cache-miss-rate': 'number', |
632 | 'overflow': 'int' } } | |
f36d55af | 633 | |
49687ace | 634 | ## |
24b8c39b HZ |
635 | # @MigrationStatus: |
636 | # | |
637 | # An enumeration of migration status. | |
638 | # | |
639 | # @none: no migration has ever happened. | |
640 | # | |
641 | # @setup: migration process has been initiated. | |
642 | # | |
643 | # @cancelling: in the process of cancelling migration. | |
644 | # | |
645 | # @cancelled: cancelling migration is finished. | |
646 | # | |
647 | # @active: in the process of doing migration. | |
648 | # | |
9ec055ae DDAG |
649 | # @postcopy-active: like active, but now in postcopy mode. (since 2.5) |
650 | # | |
24b8c39b HZ |
651 | # @completed: migration is finished. |
652 | # | |
653 | # @failed: some error occurred during migration process. | |
654 | # | |
252093a7 HZ |
655 | # @colo: VM is in the process of fault tolerance, VM can not get into this |
656 | # state unless colo capability is enabled for migration. (since 2.8) | |
0b827d5e | 657 | # |
24b8c39b HZ |
658 | # Since: 2.3 |
659 | # | |
660 | ## | |
661 | { 'enum': 'MigrationStatus', | |
662 | 'data': [ 'none', 'setup', 'cancelling', 'cancelled', | |
0b827d5e | 663 | 'active', 'postcopy-active', 'completed', 'failed', 'colo' ] } |
24b8c39b | 664 | |
791e7c82 | 665 | ## |
5072f7b3 | 666 | # @MigrationInfo: |
791e7c82 LC |
667 | # |
668 | # Information about current migration process. | |
669 | # | |
1d8bda12 | 670 | # @status: @MigrationStatus describing the current migration status. |
24b8c39b | 671 | # If this field is not returned, no migration process |
791e7c82 LC |
672 | # has been initiated |
673 | # | |
1d8bda12 | 674 | # @ram: @MigrationStats containing detailed migration |
d5f8a570 | 675 | # status, only returned if status is 'active' or |
24b8c39b | 676 | # 'completed'(since 1.2) |
791e7c82 | 677 | # |
1d8bda12 | 678 | # @disk: @MigrationStats containing detailed disk migration |
791e7c82 LC |
679 | # status, only returned if status is 'active' and it is a block |
680 | # migration | |
681 | # | |
1d8bda12 | 682 | # @xbzrle-cache: @XBZRLECacheStats containing detailed XBZRLE |
f36d55af OW |
683 | # migration statistics, only returned if XBZRLE feature is on and |
684 | # status is 'active' or 'completed' (since 1.2) | |
685 | # | |
1d8bda12 | 686 | # @total-time: total amount of milliseconds since migration started. |
7aa939af JQ |
687 | # If migration has ended, it returns the total migration |
688 | # time. (since 1.2) | |
689 | # | |
1d8bda12 | 690 | # @downtime: only present when migration finishes correctly |
9c5a9fcf JQ |
691 | # total downtime in milliseconds for the guest. |
692 | # (since 1.3) | |
693 | # | |
1d8bda12 | 694 | # @expected-downtime: only present while migration is active |
2c52ddf1 JQ |
695 | # expected downtime in milliseconds for the guest in last walk |
696 | # of the dirty bitmap. (since 1.3) | |
697 | # | |
1d8bda12 | 698 | # @setup-time: amount of setup time in milliseconds _before_ the |
ed4fbd10 MH |
699 | # iterations begin but _after_ the QMP command is issued. This is designed |
700 | # to provide an accounting of any activities (such as RDMA pinning) which | |
701 | # may be expensive, but do not actually occur during the iterative | |
702 | # migration rounds themselves. (since 1.6) | |
703 | # | |
1d8bda12 | 704 | # @cpu-throttle-percentage: percentage of time guest cpus are being |
d85a31d1 JH |
705 | # throttled during auto-converge. This is only present when auto-converge |
706 | # has started throttling guest cpus. (Since 2.7) | |
4782893e | 707 | # |
1d8bda12 | 708 | # @error-desc: the human readable error description string, when |
d59ce6f3 | 709 | # @status is 'failed'. Clients should not attempt to parse the |
bdbba12b | 710 | # error strings. (Since 2.7) |
d59ce6f3 | 711 | # |
791e7c82 LC |
712 | # Since: 0.14.0 |
713 | ## | |
895a2a80 | 714 | { 'struct': 'MigrationInfo', |
24b8c39b | 715 | 'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats', |
f36d55af | 716 | '*disk': 'MigrationStats', |
7aa939af | 717 | '*xbzrle-cache': 'XBZRLECacheStats', |
9c5a9fcf | 718 | '*total-time': 'int', |
2c52ddf1 | 719 | '*expected-downtime': 'int', |
ed4fbd10 | 720 | '*downtime': 'int', |
4782893e | 721 | '*setup-time': 'int', |
d59ce6f3 DB |
722 | '*cpu-throttle-percentage': 'int', |
723 | '*error-desc': 'str'} } | |
791e7c82 LC |
724 | |
725 | ## | |
5072f7b3 | 726 | # @query-migrate: |
791e7c82 | 727 | # |
104b1caf MAL |
728 | # Returns information about current migration process. If migration |
729 | # is active there will be another json-object with RAM migration | |
730 | # status and if block migration is active another one with block | |
731 | # migration status. | |
791e7c82 LC |
732 | # |
733 | # Returns: @MigrationInfo | |
734 | # | |
735 | # Since: 0.14.0 | |
104b1caf MAL |
736 | # |
737 | # Example: | |
738 | # | |
739 | # 1. Before the first migration | |
740 | # | |
741 | # -> { "execute": "query-migrate" } | |
742 | # <- { "return": {} } | |
743 | # | |
744 | # 2. Migration is done and has succeeded | |
745 | # | |
746 | # -> { "execute": "query-migrate" } | |
747 | # <- { "return": { | |
748 | # "status": "completed", | |
749 | # "ram":{ | |
750 | # "transferred":123, | |
751 | # "remaining":123, | |
752 | # "total":246, | |
753 | # "total-time":12345, | |
754 | # "setup-time":12345, | |
755 | # "downtime":12345, | |
756 | # "duplicate":123, | |
757 | # "normal":123, | |
758 | # "normal-bytes":123456, | |
759 | # "dirty-sync-count":15 | |
760 | # } | |
761 | # } | |
762 | # } | |
763 | # | |
764 | # 3. Migration is done and has failed | |
765 | # | |
766 | # -> { "execute": "query-migrate" } | |
767 | # <- { "return": { "status": "failed" } } | |
768 | # | |
769 | # 4. Migration is being performed and is not a block migration: | |
770 | # | |
771 | # -> { "execute": "query-migrate" } | |
772 | # <- { | |
773 | # "return":{ | |
774 | # "status":"active", | |
775 | # "ram":{ | |
776 | # "transferred":123, | |
777 | # "remaining":123, | |
778 | # "total":246, | |
779 | # "total-time":12345, | |
780 | # "setup-time":12345, | |
781 | # "expected-downtime":12345, | |
782 | # "duplicate":123, | |
783 | # "normal":123, | |
784 | # "normal-bytes":123456, | |
785 | # "dirty-sync-count":15 | |
786 | # } | |
787 | # } | |
788 | # } | |
789 | # | |
790 | # 5. Migration is being performed and is a block migration: | |
791 | # | |
792 | # -> { "execute": "query-migrate" } | |
793 | # <- { | |
794 | # "return":{ | |
795 | # "status":"active", | |
796 | # "ram":{ | |
797 | # "total":1057024, | |
798 | # "remaining":1053304, | |
799 | # "transferred":3720, | |
800 | # "total-time":12345, | |
801 | # "setup-time":12345, | |
802 | # "expected-downtime":12345, | |
803 | # "duplicate":123, | |
804 | # "normal":123, | |
805 | # "normal-bytes":123456, | |
806 | # "dirty-sync-count":15 | |
807 | # }, | |
808 | # "disk":{ | |
809 | # "total":20971520, | |
810 | # "remaining":20880384, | |
811 | # "transferred":91136 | |
812 | # } | |
813 | # } | |
814 | # } | |
815 | # | |
816 | # 6. Migration is being performed and XBZRLE is active: | |
817 | # | |
818 | # -> { "execute": "query-migrate" } | |
819 | # <- { | |
820 | # "return":{ | |
821 | # "status":"active", | |
822 | # "capabilities" : [ { "capability": "xbzrle", "state" : true } ], | |
823 | # "ram":{ | |
824 | # "total":1057024, | |
825 | # "remaining":1053304, | |
826 | # "transferred":3720, | |
827 | # "total-time":12345, | |
828 | # "setup-time":12345, | |
829 | # "expected-downtime":12345, | |
830 | # "duplicate":10, | |
831 | # "normal":3333, | |
832 | # "normal-bytes":3412992, | |
833 | # "dirty-sync-count":15 | |
834 | # }, | |
835 | # "xbzrle-cache":{ | |
836 | # "cache-size":67108864, | |
837 | # "bytes":20971520, | |
838 | # "pages":2444343, | |
839 | # "cache-miss":2244, | |
840 | # "cache-miss-rate":0.123, | |
841 | # "overflow":34434 | |
842 | # } | |
843 | # } | |
844 | # } | |
845 | # | |
791e7c82 LC |
846 | ## |
847 | { 'command': 'query-migrate', 'returns': 'MigrationInfo' } | |
848 | ||
bbf6da32 | 849 | ## |
5072f7b3 | 850 | # @MigrationCapability: |
bbf6da32 OW |
851 | # |
852 | # Migration capabilities enumeration | |
853 | # | |
854 | # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding). | |
855 | # This feature allows us to minimize migration traffic for certain work | |
856 | # loads, by sending compressed difference of the pages | |
857 | # | |
41310c68 | 858 | # @rdma-pin-all: Controls whether or not the entire VM memory footprint is |
60d9222c | 859 | # mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage. |
41310c68 | 860 | # Disabled by default. (since 2.0) |
60d9222c | 861 | # |
323004a3 PL |
862 | # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This |
863 | # essentially saves 1MB of zeroes per block on the wire. Enabling requires | |
864 | # source and target VM to support this feature. To enable it is sufficient | |
865 | # to enable the capability on the source VM. The feature is disabled by | |
866 | # default. (since 1.6) | |
867 | # | |
dde4e694 LL |
868 | # @compress: Use multiple compression threads to accelerate live migration. |
869 | # This feature can help to reduce the migration traffic, by sending | |
870 | # compressed pages. Please note that if compress and xbzrle are both | |
871 | # on, compress only takes effect in the ram bulk stage, after that, | |
872 | # it will be disabled and only xbzrle takes effect, this can help to | |
873 | # minimize migration traffic. The feature is disabled by default. | |
874 | # (since 2.4 ) | |
875 | # | |
b05dc723 JQ |
876 | # @events: generate events for each migration state change |
877 | # (since 2.4 ) | |
878 | # | |
9781c371 JQ |
879 | # @auto-converge: If enabled, QEMU will automatically throttle down the guest |
880 | # to speed up convergence of RAM migration. (since 1.6) | |
881 | # | |
32c3db5b | 882 | # @postcopy-ram: Start executing on the migration target before all of RAM has |
53dd370c | 883 | # been migrated, pulling the remaining pages along as needed. NOTE: If |
32c3db5b | 884 | # the migration fails during postcopy the VM will fail. (since 2.6) |
53dd370c | 885 | # |
35a6ed4f HZ |
886 | # @x-colo: If enabled, migration will never end, and the state of the VM on the |
887 | # primary side will be migrated continuously to the VM on secondary | |
888 | # side, this process is called COarse-Grain LOck Stepping (COLO) for | |
889 | # Non-stop Service. (since 2.8) | |
890 | # | |
53f09a10 PB |
891 | # @release-ram: if enabled, qemu will free the migrated ram pages on the source |
892 | # during postcopy-ram migration. (since 2.9) | |
893 | # | |
bbf6da32 OW |
894 | # Since: 1.2 |
895 | ## | |
896 | { 'enum': 'MigrationCapability', | |
dde4e694 | 897 | 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks', |
53f09a10 | 898 | 'compress', 'events', 'postcopy-ram', 'x-colo', 'release-ram'] } |
bbf6da32 OW |
899 | |
900 | ## | |
5072f7b3 | 901 | # @MigrationCapabilityStatus: |
bbf6da32 OW |
902 | # |
903 | # Migration capability information | |
904 | # | |
905 | # @capability: capability enum | |
906 | # | |
907 | # @state: capability state bool | |
908 | # | |
909 | # Since: 1.2 | |
910 | ## | |
895a2a80 | 911 | { 'struct': 'MigrationCapabilityStatus', |
bbf6da32 OW |
912 | 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } } |
913 | ||
914 | ## | |
5072f7b3 | 915 | # @migrate-set-capabilities: |
00458433 OW |
916 | # |
917 | # Enable/Disable the following migration capabilities (like xbzrle) | |
918 | # | |
919 | # @capabilities: json array of capability modifications to make | |
920 | # | |
921 | # Since: 1.2 | |
0a0bb964 MAL |
922 | # |
923 | # Example: | |
924 | # | |
925 | # -> { "execute": "migrate-set-capabilities" , "arguments": | |
926 | # { "capabilities": [ { "capability": "xbzrle", "state": true } ] } } | |
927 | # | |
00458433 OW |
928 | ## |
929 | { 'command': 'migrate-set-capabilities', | |
930 | 'data': { 'capabilities': ['MigrationCapabilityStatus'] } } | |
931 | ||
932 | ## | |
5072f7b3 | 933 | # @query-migrate-capabilities: |
bbf6da32 OW |
934 | # |
935 | # Returns information about the current migration capabilities status | |
936 | # | |
937 | # Returns: @MigrationCapabilitiesStatus | |
938 | # | |
939 | # Since: 1.2 | |
135b238e MAL |
940 | # |
941 | # Example: | |
942 | # | |
943 | # -> { "execute": "query-migrate-capabilities" } | |
944 | # <- { "return": [ | |
945 | # {"state": false, "capability": "xbzrle"}, | |
946 | # {"state": false, "capability": "rdma-pin-all"}, | |
947 | # {"state": false, "capability": "auto-converge"}, | |
948 | # {"state": false, "capability": "zero-blocks"}, | |
949 | # {"state": false, "capability": "compress"}, | |
950 | # {"state": true, "capability": "events"}, | |
951 | # {"state": false, "capability": "postcopy-ram"}, | |
952 | # {"state": false, "capability": "x-colo"} | |
953 | # ]} | |
954 | # | |
bbf6da32 OW |
955 | ## |
956 | { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']} | |
957 | ||
49687ace | 958 | ## |
5072f7b3 | 959 | # @MigrationParameter: |
43c60a81 LL |
960 | # |
961 | # Migration parameters enumeration | |
962 | # | |
963 | # @compress-level: Set the compression level to be used in live migration, | |
964 | # the compression level is an integer between 0 and 9, where 0 means | |
965 | # no compression, 1 means the best compression speed, and 9 means best | |
966 | # compression ratio which will consume more CPU. | |
967 | # | |
968 | # @compress-threads: Set compression thread count to be used in live migration, | |
969 | # the compression thread count is an integer between 1 and 255. | |
970 | # | |
971 | # @decompress-threads: Set decompression thread count to be used in live | |
972 | # migration, the decompression thread count is an integer between 1 | |
973 | # and 255. Usually, decompression is at least 4 times as fast as | |
974 | # compression, so set the decompress-threads to the number about 1/4 | |
975 | # of compress-threads is adequate. | |
976 | # | |
d85a31d1 JH |
977 | # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled |
978 | # when migration auto-converge is activated. The | |
979 | # default value is 20. (Since 2.7) | |
1626fee3 | 980 | # |
d85a31d1 JH |
981 | # @cpu-throttle-increment: throttle percentage increase each time |
982 | # auto-converge detects that migration is not making | |
983 | # progress. The default value is 10. (Since 2.7) | |
69ef1f36 DB |
984 | # |
985 | # @tls-creds: ID of the 'tls-creds' object that provides credentials for | |
986 | # establishing a TLS connection over the migration data channel. | |
987 | # On the outgoing side of the migration, the credentials must | |
988 | # be for a 'client' endpoint, while for the incoming side the | |
989 | # credentials must be for a 'server' endpoint. Setting this | |
990 | # will enable TLS for all migrations. The default is unset, | |
991 | # resulting in unsecured migration at the QEMU level. (Since 2.7) | |
992 | # | |
993 | # @tls-hostname: hostname of the target host for the migration. This is | |
994 | # required when using x509 based TLS credentials and the | |
995 | # migration URI does not already include a hostname. For | |
996 | # example if using fd: or exec: based migration, the | |
997 | # hostname must be provided so that the server's x509 | |
bdbba12b | 998 | # certificate identity can be validated. (Since 2.7) |
69ef1f36 | 999 | # |
2ff30257 AA |
1000 | # @max-bandwidth: to set maximum speed for migration. maximum speed in |
1001 | # bytes per second. (Since 2.8) | |
1002 | # | |
1003 | # @downtime-limit: set maximum tolerated downtime for migration. maximum | |
1004 | # downtime in milliseconds (Since 2.8) | |
1005 | # | |
68b53591 HZ |
1006 | # @x-checkpoint-delay: The delay time (in ms) between two COLO checkpoints in |
1007 | # periodic mode. (Since 2.8) | |
1008 | # | |
43c60a81 LL |
1009 | # Since: 2.4 |
1010 | ## | |
1011 | { 'enum': 'MigrationParameter', | |
1626fee3 | 1012 | 'data': ['compress-level', 'compress-threads', 'decompress-threads', |
69ef1f36 | 1013 | 'cpu-throttle-initial', 'cpu-throttle-increment', |
2ff30257 | 1014 | 'tls-creds', 'tls-hostname', 'max-bandwidth', |
68b53591 | 1015 | 'downtime-limit', 'x-checkpoint-delay' ] } |
43c60a81 | 1016 | |
49687ace | 1017 | ## |
5072f7b3 | 1018 | # @migrate-set-parameters: |
85de8323 | 1019 | # |
c2dd311c | 1020 | # Set various migration parameters. |
69ef1f36 | 1021 | # |
85de8323 | 1022 | # Since: 2.4 |
35db41e5 MAL |
1023 | # |
1024 | # Example: | |
1025 | # | |
1026 | # -> { "execute": "migrate-set-parameters" , | |
1027 | # "arguments": { "compress-level": 1 } } | |
1028 | # | |
85de8323 | 1029 | ## |
7f375e04 | 1030 | { 'command': 'migrate-set-parameters', 'boxed': true, |
de63ab61 | 1031 | 'data': 'MigrationParameters' } |
85de8323 | 1032 | |
49687ace | 1033 | ## |
5072f7b3 | 1034 | # @MigrationParameters: |
85de8323 | 1035 | # |
de63ab61 EB |
1036 | # Optional members can be omitted on input ('migrate-set-parameters') |
1037 | # but most members will always be present on output | |
1038 | # ('query-migrate-parameters'), with the exception of tls-creds and | |
1039 | # tls-hostname. | |
85de8323 | 1040 | # |
1d8bda12 | 1041 | # @compress-level: compression level |
85de8323 | 1042 | # |
1d8bda12 | 1043 | # @compress-threads: compression thread count |
85de8323 | 1044 | # |
1d8bda12 | 1045 | # @decompress-threads: decompression thread count |
1626fee3 | 1046 | # |
1d8bda12 | 1047 | # @cpu-throttle-initial: Initial percentage of time guest cpus are |
de63ab61 EB |
1048 | # throttledwhen migration auto-converge is activated. |
1049 | # The default value is 20. (Since 2.7) | |
1050 | # | |
1d8bda12 | 1051 | # @cpu-throttle-increment: throttle percentage increase each time |
d85a31d1 JH |
1052 | # auto-converge detects that migration is not making |
1053 | # progress. The default value is 10. (Since 2.7) | |
1626fee3 | 1054 | # |
1d8bda12 | 1055 | # @tls-creds: ID of the 'tls-creds' object that provides credentials |
de63ab61 EB |
1056 | # for establishing a TLS connection over the migration data |
1057 | # channel. On the outgoing side of the migration, the credentials | |
1058 | # must be for a 'client' endpoint, while for the incoming side the | |
69ef1f36 DB |
1059 | # credentials must be for a 'server' endpoint. Setting this |
1060 | # will enable TLS for all migrations. The default is unset, | |
bdbba12b | 1061 | # resulting in unsecured migration at the QEMU level. (Since 2.7) |
69ef1f36 | 1062 | # |
1d8bda12 | 1063 | # @tls-hostname: hostname of the target host for the migration. This |
de63ab61 | 1064 | # is required when using x509 based TLS credentials and the |
69ef1f36 DB |
1065 | # migration URI does not already include a hostname. For |
1066 | # example if using fd: or exec: based migration, the | |
1067 | # hostname must be provided so that the server's x509 | |
bdbba12b | 1068 | # certificate identity can be validated. (Since 2.7) |
69ef1f36 | 1069 | # |
2ff30257 AA |
1070 | # @max-bandwidth: to set maximum speed for migration. maximum speed in |
1071 | # bytes per second. (Since 2.8) | |
1072 | # | |
1073 | # @downtime-limit: set maximum tolerated downtime for migration. maximum | |
1074 | # downtime in milliseconds (Since 2.8) | |
1075 | # | |
68b53591 HZ |
1076 | # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since 2.8) |
1077 | # | |
85de8323 LL |
1078 | # Since: 2.4 |
1079 | ## | |
1080 | { 'struct': 'MigrationParameters', | |
de63ab61 EB |
1081 | 'data': { '*compress-level': 'int', |
1082 | '*compress-threads': 'int', | |
1083 | '*decompress-threads': 'int', | |
1084 | '*cpu-throttle-initial': 'int', | |
1085 | '*cpu-throttle-increment': 'int', | |
1086 | '*tls-creds': 'str', | |
2ff30257 AA |
1087 | '*tls-hostname': 'str', |
1088 | '*max-bandwidth': 'int', | |
68b53591 HZ |
1089 | '*downtime-limit': 'int', |
1090 | '*x-checkpoint-delay': 'int'} } | |
6235b9cd | 1091 | |
85de8323 | 1092 | ## |
5072f7b3 | 1093 | # @query-migrate-parameters: |
85de8323 LL |
1094 | # |
1095 | # Returns information about the current migration parameters | |
1096 | # | |
1097 | # Returns: @MigrationParameters | |
1098 | # | |
1099 | # Since: 2.4 | |
cf56cfad MAL |
1100 | # |
1101 | # Example: | |
1102 | # | |
1103 | # -> { "execute": "query-migrate-parameters" } | |
1104 | # <- { "return": { | |
1105 | # "decompress-threads": 2, | |
1106 | # "cpu-throttle-increment": 10, | |
1107 | # "compress-threads": 8, | |
1108 | # "compress-level": 1, | |
1109 | # "cpu-throttle-initial": 20, | |
1110 | # "max-bandwidth": 33554432, | |
1111 | # "downtime-limit": 300 | |
1112 | # } | |
1113 | # } | |
1114 | # | |
85de8323 LL |
1115 | ## |
1116 | { 'command': 'query-migrate-parameters', | |
1117 | 'returns': 'MigrationParameters' } | |
1118 | ||
b8a185bc | 1119 | ## |
5072f7b3 | 1120 | # @client_migrate_info: |
b8a185bc MA |
1121 | # |
1122 | # Set migration information for remote display. This makes the server | |
1123 | # ask the client to automatically reconnect using the new parameters | |
1124 | # once migration finished successfully. Only implemented for SPICE. | |
1125 | # | |
1126 | # @protocol: must be "spice" | |
1127 | # @hostname: migration target hostname | |
1d8bda12 MA |
1128 | # @port: spice tcp port for plaintext channels |
1129 | # @tls-port: spice tcp port for tls-secured channels | |
1130 | # @cert-subject: server certificate subject | |
b8a185bc MA |
1131 | # |
1132 | # Since: 0.14.0 | |
d0d3fc7f MAL |
1133 | # |
1134 | # Example: | |
1135 | # | |
1136 | # -> { "execute": "client_migrate_info", | |
1137 | # "arguments": { "protocol": "spice", | |
1138 | # "hostname": "virt42.lab.kraxel.org", | |
1139 | # "port": 1234 } } | |
1140 | # <- { "return": {} } | |
1141 | # | |
b8a185bc MA |
1142 | ## |
1143 | { 'command': 'client_migrate_info', | |
1144 | 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int', | |
1145 | '*tls-port': 'int', '*cert-subject': 'str' } } | |
1146 | ||
4886a1bc | 1147 | ## |
5072f7b3 | 1148 | # @migrate-start-postcopy: |
4886a1bc | 1149 | # |
a54d340b | 1150 | # Followup to a migration command to switch the migration to postcopy mode. |
32c3db5b | 1151 | # The postcopy-ram capability must be set before the original migration |
a54d340b | 1152 | # command. |
4886a1bc DDAG |
1153 | # |
1154 | # Since: 2.5 | |
3c3ea00a MAL |
1155 | # |
1156 | # Example: | |
1157 | # | |
1158 | # -> { "execute": "migrate-start-postcopy" } | |
1159 | # <- { "return": {} } | |
1160 | # | |
49687ace | 1161 | ## |
4886a1bc DDAG |
1162 | { 'command': 'migrate-start-postcopy' } |
1163 | ||
e235cec3 | 1164 | ## |
5072f7b3 | 1165 | # @COLOMessage: |
4f97558e HZ |
1166 | # |
1167 | # The message transmission between Primary side and Secondary side. | |
1168 | # | |
1169 | # @checkpoint-ready: Secondary VM (SVM) is ready for checkpointing | |
1170 | # | |
1171 | # @checkpoint-request: Primary VM (PVM) tells SVM to prepare for checkpointing | |
1172 | # | |
1173 | # @checkpoint-reply: SVM gets PVM's checkpoint request | |
1174 | # | |
1175 | # @vmstate-send: VM's state will be sent by PVM. | |
1176 | # | |
1177 | # @vmstate-size: The total size of VMstate. | |
1178 | # | |
1179 | # @vmstate-received: VM's state has been received by SVM. | |
1180 | # | |
1181 | # @vmstate-loaded: VM's state has been loaded by SVM. | |
1182 | # | |
1183 | # Since: 2.8 | |
1184 | ## | |
1185 | { 'enum': 'COLOMessage', | |
1186 | 'data': [ 'checkpoint-ready', 'checkpoint-request', 'checkpoint-reply', | |
1187 | 'vmstate-send', 'vmstate-size', 'vmstate-received', | |
1188 | 'vmstate-loaded' ] } | |
1189 | ||
d89e666e | 1190 | ## |
5072f7b3 | 1191 | # @COLOMode: |
d89e666e HZ |
1192 | # |
1193 | # The colo mode | |
1194 | # | |
1195 | # @unknown: unknown mode | |
1196 | # | |
1197 | # @primary: master side | |
1198 | # | |
1199 | # @secondary: slave side | |
1200 | # | |
1201 | # Since: 2.8 | |
1202 | ## | |
1203 | { 'enum': 'COLOMode', | |
1204 | 'data': [ 'unknown', 'primary', 'secondary'] } | |
1205 | ||
aef06085 | 1206 | ## |
5072f7b3 | 1207 | # @FailoverStatus: |
aef06085 HZ |
1208 | # |
1209 | # An enumeration of COLO failover status | |
1210 | # | |
1211 | # @none: no failover has ever happened | |
1212 | # | |
1213 | # @require: got failover requirement but not handled | |
1214 | # | |
1215 | # @active: in the process of doing failover | |
1216 | # | |
1217 | # @completed: finish the process of failover | |
1218 | # | |
a8664ba5 HZ |
1219 | # @relaunch: restart the failover process, from 'none' -> 'completed' (Since 2.9) |
1220 | # | |
aef06085 HZ |
1221 | # Since: 2.8 |
1222 | ## | |
1223 | { 'enum': 'FailoverStatus', | |
a8664ba5 | 1224 | 'data': [ 'none', 'require', 'active', 'completed', 'relaunch' ] } |
aef06085 | 1225 | |
d89e666e | 1226 | ## |
5072f7b3 | 1227 | # @x-colo-lost-heartbeat: |
d89e666e HZ |
1228 | # |
1229 | # Tell qemu that heartbeat is lost, request it to do takeover procedures. | |
1230 | # If this command is sent to the PVM, the Primary side will exit COLO mode. | |
1231 | # If sent to the Secondary, the Secondary side will run failover work, | |
1232 | # then takes over server operation to become the service VM. | |
1233 | # | |
1234 | # Since: 2.8 | |
c08d6443 MAL |
1235 | # |
1236 | # Example: | |
1237 | # | |
1238 | # -> { "execute": "x-colo-lost-heartbeat" } | |
1239 | # <- { "return": {} } | |
1240 | # | |
d89e666e HZ |
1241 | ## |
1242 | { 'command': 'x-colo-lost-heartbeat' } | |
1243 | ||
1244 | ## | |
e235cec3 LC |
1245 | # @MouseInfo: |
1246 | # | |
1247 | # Information about a mouse device. | |
1248 | # | |
1249 | # @name: the name of the mouse device | |
1250 | # | |
1251 | # @index: the index of the mouse device | |
1252 | # | |
1253 | # @current: true if this device is currently receiving mouse events | |
1254 | # | |
1255 | # @absolute: true if this device supports absolute coordinates as input | |
1256 | # | |
1257 | # Since: 0.14.0 | |
1258 | ## | |
895a2a80 | 1259 | { 'struct': 'MouseInfo', |
e235cec3 LC |
1260 | 'data': {'name': 'str', 'index': 'int', 'current': 'bool', |
1261 | 'absolute': 'bool'} } | |
1262 | ||
1263 | ## | |
1264 | # @query-mice: | |
1265 | # | |
1266 | # Returns information about each active mouse device | |
1267 | # | |
1268 | # Returns: a list of @MouseInfo for each device | |
1269 | # | |
1270 | # Since: 0.14.0 | |
60639df5 MAL |
1271 | # |
1272 | # Example: | |
1273 | # | |
1274 | # -> { "execute": "query-mice" } | |
1275 | # <- { "return": [ | |
1276 | # { | |
1277 | # "name":"QEMU Microsoft Mouse", | |
1278 | # "index":0, | |
1279 | # "current":false, | |
1280 | # "absolute":false | |
1281 | # }, | |
1282 | # { | |
1283 | # "name":"QEMU PS/2 Mouse", | |
1284 | # "index":1, | |
1285 | # "current":true, | |
1286 | # "absolute":true | |
1287 | # } | |
1288 | # ] | |
1289 | # } | |
1290 | # | |
e235cec3 LC |
1291 | ## |
1292 | { 'command': 'query-mice', 'returns': ['MouseInfo'] } | |
1293 | ||
de0b36b6 | 1294 | ## |
86f4b687 | 1295 | # @CpuInfoArch: |
de0b36b6 | 1296 | # |
86f4b687 EB |
1297 | # An enumeration of cpu types that enable additional information during |
1298 | # @query-cpus. | |
1299 | # | |
1300 | # Since: 2.6 | |
1301 | ## | |
1302 | { 'enum': 'CpuInfoArch', | |
1303 | 'data': ['x86', 'sparc', 'ppc', 'mips', 'tricore', 'other' ] } | |
1304 | ||
1305 | ## | |
3666a97f | 1306 | # @CpuInfo: |
86f4b687 | 1307 | # |
3666a97f | 1308 | # Information about a virtual CPU |
de0b36b6 LC |
1309 | # |
1310 | # @CPU: the index of the virtual CPU | |
1311 | # | |
86f4b687 | 1312 | # @current: this only exists for backwards compatibility and should be ignored |
b80e560b | 1313 | # |
de0b36b6 LC |
1314 | # @halted: true if the virtual CPU is in the halt state. Halt usually refers |
1315 | # to a processor specific low power mode. | |
1316 | # | |
58f88d4b EH |
1317 | # @qom_path: path to the CPU object in the QOM tree (since 2.4) |
1318 | # | |
de0b36b6 LC |
1319 | # @thread_id: ID of the underlying host thread |
1320 | # | |
86f4b687 EB |
1321 | # @arch: architecture of the cpu, which determines which additional fields |
1322 | # will be listed (since 2.6) | |
1323 | # | |
de0b36b6 LC |
1324 | # Since: 0.14.0 |
1325 | # | |
1326 | # Notes: @halted is a transient state that changes frequently. By the time the | |
1327 | # data is sent to the client, the guest may no longer be halted. | |
1328 | ## | |
3666a97f EB |
1329 | { 'union': 'CpuInfo', |
1330 | 'base': {'CPU': 'int', 'current': 'bool', 'halted': 'bool', | |
1331 | 'qom_path': 'str', 'thread_id': 'int', 'arch': 'CpuInfoArch' }, | |
1332 | 'discriminator': 'arch', | |
86f4b687 EB |
1333 | 'data': { 'x86': 'CpuInfoX86', |
1334 | 'sparc': 'CpuInfoSPARC', | |
1335 | 'ppc': 'CpuInfoPPC', | |
1336 | 'mips': 'CpuInfoMIPS', | |
1337 | 'tricore': 'CpuInfoTricore', | |
1338 | 'other': 'CpuInfoOther' } } | |
1339 | ||
1340 | ## | |
1341 | # @CpuInfoX86: | |
1342 | # | |
1343 | # Additional information about a virtual i386 or x86_64 CPU | |
1344 | # | |
1345 | # @pc: the 64-bit instruction pointer | |
1346 | # | |
5072f7b3 | 1347 | # Since: 2.6 |
86f4b687 EB |
1348 | ## |
1349 | { 'struct': 'CpuInfoX86', 'data': { 'pc': 'int' } } | |
1350 | ||
1351 | ## | |
1352 | # @CpuInfoSPARC: | |
1353 | # | |
1354 | # Additional information about a virtual SPARC CPU | |
1355 | # | |
1356 | # @pc: the PC component of the instruction pointer | |
1357 | # | |
1358 | # @npc: the NPC component of the instruction pointer | |
1359 | # | |
5072f7b3 | 1360 | # Since: 2.6 |
86f4b687 EB |
1361 | ## |
1362 | { 'struct': 'CpuInfoSPARC', 'data': { 'pc': 'int', 'npc': 'int' } } | |
1363 | ||
1364 | ## | |
1365 | # @CpuInfoPPC: | |
1366 | # | |
1367 | # Additional information about a virtual PPC CPU | |
1368 | # | |
1369 | # @nip: the instruction pointer | |
1370 | # | |
5072f7b3 | 1371 | # Since: 2.6 |
86f4b687 EB |
1372 | ## |
1373 | { 'struct': 'CpuInfoPPC', 'data': { 'nip': 'int' } } | |
1374 | ||
1375 | ## | |
1376 | # @CpuInfoMIPS: | |
1377 | # | |
1378 | # Additional information about a virtual MIPS CPU | |
1379 | # | |
1380 | # @PC: the instruction pointer | |
1381 | # | |
5072f7b3 | 1382 | # Since: 2.6 |
86f4b687 EB |
1383 | ## |
1384 | { 'struct': 'CpuInfoMIPS', 'data': { 'PC': 'int' } } | |
1385 | ||
1386 | ## | |
1387 | # @CpuInfoTricore: | |
1388 | # | |
1389 | # Additional information about a virtual Tricore CPU | |
1390 | # | |
1391 | # @PC: the instruction pointer | |
1392 | # | |
5072f7b3 | 1393 | # Since: 2.6 |
86f4b687 EB |
1394 | ## |
1395 | { 'struct': 'CpuInfoTricore', 'data': { 'PC': 'int' } } | |
1396 | ||
1397 | ## | |
1398 | # @CpuInfoOther: | |
1399 | # | |
1400 | # No additional information is available about the virtual CPU | |
1401 | # | |
5072f7b3 | 1402 | # Since: 2.6 |
86f4b687 EB |
1403 | # |
1404 | ## | |
1405 | { 'struct': 'CpuInfoOther', 'data': { } } | |
de0b36b6 LC |
1406 | |
1407 | ## | |
1408 | # @query-cpus: | |
1409 | # | |
1410 | # Returns a list of information about each virtual CPU. | |
1411 | # | |
1412 | # Returns: a list of @CpuInfo for each virtual CPU | |
1413 | # | |
1414 | # Since: 0.14.0 | |
5c5bee64 MAL |
1415 | # |
1416 | # Example: | |
1417 | # | |
1418 | # -> { "execute": "query-cpus" } | |
1419 | # <- { "return": [ | |
1420 | # { | |
1421 | # "CPU":0, | |
1422 | # "current":true, | |
1423 | # "halted":false, | |
1424 | # "qom_path":"/machine/unattached/device[0]", | |
1425 | # "arch":"x86", | |
1426 | # "pc":3227107138, | |
1427 | # "thread_id":3134 | |
1428 | # }, | |
1429 | # { | |
1430 | # "CPU":1, | |
1431 | # "current":false, | |
1432 | # "halted":true, | |
1433 | # "qom_path":"/machine/unattached/device[2]", | |
1434 | # "arch":"x86", | |
1435 | # "pc":7108165, | |
1436 | # "thread_id":3135 | |
1437 | # } | |
1438 | # ] | |
1439 | # } | |
1440 | # | |
de0b36b6 LC |
1441 | ## |
1442 | { 'command': 'query-cpus', 'returns': ['CpuInfo'] } | |
1443 | ||
dc3dd0d2 SH |
1444 | ## |
1445 | # @IOThreadInfo: | |
1446 | # | |
1447 | # Information about an iothread | |
1448 | # | |
1449 | # @id: the identifier of the iothread | |
1450 | # | |
1451 | # @thread-id: ID of the underlying host thread | |
1452 | # | |
5fc00480 PH |
1453 | # @poll-max-ns: maximum polling time in ns, 0 means polling is disabled |
1454 | # (since 2.9) | |
1455 | # | |
1456 | # @poll-grow: how many ns will be added to polling time, 0 means that it's not | |
1457 | # configured (since 2.9) | |
1458 | # | |
1459 | # @poll-shrink: how many ns will be removed from polling time, 0 means that | |
1460 | # it's not configured (since 2.9) | |
1461 | # | |
dc3dd0d2 SH |
1462 | # Since: 2.0 |
1463 | ## | |
895a2a80 | 1464 | { 'struct': 'IOThreadInfo', |
5fc00480 PH |
1465 | 'data': {'id': 'str', |
1466 | 'thread-id': 'int', | |
1467 | 'poll-max-ns': 'int', | |
1468 | 'poll-grow': 'int', | |
1469 | 'poll-shrink': 'int' } } | |
dc3dd0d2 SH |
1470 | |
1471 | ## | |
1472 | # @query-iothreads: | |
1473 | # | |
1474 | # Returns a list of information about each iothread. | |
1475 | # | |
5072f7b3 | 1476 | # Note: this list excludes the QEMU main loop thread, which is not declared |
dc3dd0d2 SH |
1477 | # using the -object iothread command-line option. It is always the main thread |
1478 | # of the process. | |
1479 | # | |
1480 | # Returns: a list of @IOThreadInfo for each iothread | |
1481 | # | |
1482 | # Since: 2.0 | |
fdf4d34f MAL |
1483 | # |
1484 | # Example: | |
1485 | # | |
1486 | # -> { "execute": "query-iothreads" } | |
1487 | # <- { "return": [ | |
1488 | # { | |
1489 | # "id":"iothread0", | |
1490 | # "thread-id":3134 | |
1491 | # }, | |
1492 | # { | |
1493 | # "id":"iothread1", | |
1494 | # "thread-id":3135 | |
1495 | # } | |
1496 | # ] | |
1497 | # } | |
1498 | # | |
dc3dd0d2 SH |
1499 | ## |
1500 | { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] } | |
1501 | ||
2b54aa87 | 1502 | ## |
5072f7b3 | 1503 | # @NetworkAddressFamily: |
2b54aa87 | 1504 | # |
a589569f WX |
1505 | # The network address family |
1506 | # | |
1507 | # @ipv4: IPV4 family | |
1508 | # | |
1509 | # @ipv6: IPV6 family | |
1510 | # | |
1511 | # @unix: unix socket | |
1512 | # | |
6a02c806 SH |
1513 | # @vsock: vsock family (since 2.8) |
1514 | # | |
a589569f WX |
1515 | # @unknown: otherwise |
1516 | # | |
1517 | # Since: 2.1 | |
1518 | ## | |
1519 | { 'enum': 'NetworkAddressFamily', | |
6a02c806 | 1520 | 'data': [ 'ipv4', 'ipv6', 'unix', 'vsock', 'unknown' ] } |
a589569f WX |
1521 | |
1522 | ## | |
5072f7b3 | 1523 | # @VncBasicInfo: |
2b54aa87 | 1524 | # |
a589569f | 1525 | # The basic information for vnc network connection |
2b54aa87 | 1526 | # |
a589569f | 1527 | # @host: IP address |
2b54aa87 | 1528 | # |
2f44a08b WX |
1529 | # @service: The service name of the vnc port. This may depend on the host |
1530 | # system's service database so symbolic names should not be relied | |
1531 | # on. | |
a589569f WX |
1532 | # |
1533 | # @family: address family | |
1534 | # | |
4478aa76 GH |
1535 | # @websocket: true in case the socket is a websocket (since 2.3). |
1536 | # | |
a589569f WX |
1537 | # Since: 2.1 |
1538 | ## | |
895a2a80 | 1539 | { 'struct': 'VncBasicInfo', |
a589569f WX |
1540 | 'data': { 'host': 'str', |
1541 | 'service': 'str', | |
4478aa76 GH |
1542 | 'family': 'NetworkAddressFamily', |
1543 | 'websocket': 'bool' } } | |
a589569f WX |
1544 | |
1545 | ## | |
5072f7b3 | 1546 | # @VncServerInfo: |
2b54aa87 | 1547 | # |
a589569f | 1548 | # The network connection information for server |
2b54aa87 | 1549 | # |
1d8bda12 | 1550 | # @auth: authentication method used for |
2a7e6857 | 1551 | # the plain (non-websocket) VNC server |
2b54aa87 | 1552 | # |
a589569f WX |
1553 | # Since: 2.1 |
1554 | ## | |
895a2a80 | 1555 | { 'struct': 'VncServerInfo', |
a589569f WX |
1556 | 'base': 'VncBasicInfo', |
1557 | 'data': { '*auth': 'str' } } | |
1558 | ||
1559 | ## | |
1560 | # @VncClientInfo: | |
1561 | # | |
1562 | # Information about a connected VNC client. | |
2b54aa87 | 1563 | # |
1d8bda12 | 1564 | # @x509_dname: If x509 authentication is in use, the Distinguished |
2b54aa87 LC |
1565 | # Name of the client. |
1566 | # | |
1d8bda12 | 1567 | # @sasl_username: If SASL authentication is in use, the SASL username |
2b54aa87 LC |
1568 | # used for authentication. |
1569 | # | |
1570 | # Since: 0.14.0 | |
1571 | ## | |
895a2a80 | 1572 | { 'struct': 'VncClientInfo', |
a589569f | 1573 | 'base': 'VncBasicInfo', |
2f44a08b | 1574 | 'data': { '*x509_dname': 'str', '*sasl_username': 'str' } } |
2b54aa87 LC |
1575 | |
1576 | ## | |
1577 | # @VncInfo: | |
1578 | # | |
1579 | # Information about the VNC session. | |
1580 | # | |
1581 | # @enabled: true if the VNC server is enabled, false otherwise | |
1582 | # | |
1d8bda12 | 1583 | # @host: The hostname the VNC server is bound to. This depends on |
2b54aa87 LC |
1584 | # the name resolution on the host and may be an IP address. |
1585 | # | |
1d8bda12 | 1586 | # @family: 'ipv6' if the host is listening for IPv6 connections |
2b54aa87 LC |
1587 | # 'ipv4' if the host is listening for IPv4 connections |
1588 | # 'unix' if the host is listening on a unix domain socket | |
1589 | # 'unknown' otherwise | |
1590 | # | |
1d8bda12 | 1591 | # @service: The service name of the server's port. This may depends |
2b54aa87 LC |
1592 | # on the host system's service database so symbolic names should not |
1593 | # be relied on. | |
1594 | # | |
1d8bda12 | 1595 | # @auth: the current authentication type used by the server |
2b54aa87 LC |
1596 | # 'none' if no authentication is being used |
1597 | # 'vnc' if VNC authentication is being used | |
1598 | # 'vencrypt+plain' if VEncrypt is used with plain text authentication | |
1599 | # 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication | |
1600 | # 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication | |
1601 | # 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth | |
1602 | # 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth | |
1603 | # 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth | |
1604 | # 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth | |
1605 | # 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth | |
1606 | # 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth | |
1607 | # | |
1608 | # @clients: a list of @VncClientInfo of all currently connected clients | |
1609 | # | |
1610 | # Since: 0.14.0 | |
1611 | ## | |
895a2a80 | 1612 | { 'struct': 'VncInfo', |
a589569f WX |
1613 | 'data': {'enabled': 'bool', '*host': 'str', |
1614 | '*family': 'NetworkAddressFamily', | |
2b54aa87 LC |
1615 | '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} } |
1616 | ||
df887684 | 1617 | ## |
4d5c8bc4 | 1618 | # @VncPrimaryAuth: |
df887684 GH |
1619 | # |
1620 | # vnc primary authentication method. | |
1621 | # | |
1622 | # Since: 2.3 | |
1623 | ## | |
1624 | { 'enum': 'VncPrimaryAuth', | |
1625 | 'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra', | |
1626 | 'tls', 'vencrypt', 'sasl' ] } | |
1627 | ||
1628 | ## | |
1629 | # @VncVencryptSubAuth: | |
1630 | # | |
1631 | # vnc sub authentication method with vencrypt. | |
1632 | # | |
1633 | # Since: 2.3 | |
1634 | ## | |
1635 | { 'enum': 'VncVencryptSubAuth', | |
1636 | 'data': [ 'plain', | |
1637 | 'tls-none', 'x509-none', | |
1638 | 'tls-vnc', 'x509-vnc', | |
1639 | 'tls-plain', 'x509-plain', | |
1640 | 'tls-sasl', 'x509-sasl' ] } | |
1641 | ||
2a7e6857 DB |
1642 | |
1643 | ## | |
1644 | # @VncServerInfo2: | |
1645 | # | |
1646 | # The network connection information for server | |
1647 | # | |
1648 | # @auth: The current authentication type used by the servers | |
1649 | # | |
1d8bda12 | 1650 | # @vencrypt: The vencrypt sub authentication type used by the |
2a7e6857 DB |
1651 | # servers, only specified in case auth == vencrypt. |
1652 | # | |
1653 | # Since: 2.9 | |
1654 | ## | |
1655 | { 'struct': 'VncServerInfo2', | |
1656 | 'base': 'VncBasicInfo', | |
1657 | 'data': { 'auth' : 'VncPrimaryAuth', | |
1658 | '*vencrypt' : 'VncVencryptSubAuth' } } | |
1659 | ||
1660 | ||
df887684 GH |
1661 | ## |
1662 | # @VncInfo2: | |
1663 | # | |
1664 | # Information about a vnc server | |
1665 | # | |
1666 | # @id: vnc server name. | |
1667 | # | |
1668 | # @server: A list of @VncBasincInfo describing all listening sockets. | |
1669 | # The list can be empty (in case the vnc server is disabled). | |
1670 | # It also may have multiple entries: normal + websocket, | |
1671 | # possibly also ipv4 + ipv6 in the future. | |
1672 | # | |
1673 | # @clients: A list of @VncClientInfo of all currently connected clients. | |
1674 | # The list can be empty, for obvious reasons. | |
1675 | # | |
2a7e6857 | 1676 | # @auth: The current authentication type used by the non-websockets servers |
df887684 | 1677 | # |
1d8bda12 | 1678 | # @vencrypt: The vencrypt authentication type used by the servers, |
df887684 GH |
1679 | # only specified in case auth == vencrypt. |
1680 | # | |
1d8bda12 | 1681 | # @display: The display device the vnc server is linked to. |
df887684 GH |
1682 | # |
1683 | # Since: 2.3 | |
1684 | ## | |
895a2a80 | 1685 | { 'struct': 'VncInfo2', |
df887684 | 1686 | 'data': { 'id' : 'str', |
2a7e6857 | 1687 | 'server' : ['VncServerInfo2'], |
df887684 GH |
1688 | 'clients' : ['VncClientInfo'], |
1689 | 'auth' : 'VncPrimaryAuth', | |
1690 | '*vencrypt' : 'VncVencryptSubAuth', | |
1691 | '*display' : 'str' } } | |
1692 | ||
2b54aa87 LC |
1693 | ## |
1694 | # @query-vnc: | |
1695 | # | |
1696 | # Returns information about the current VNC server | |
1697 | # | |
1698 | # Returns: @VncInfo | |
2b54aa87 LC |
1699 | # |
1700 | # Since: 0.14.0 | |
85f96549 MAL |
1701 | # |
1702 | # Example: | |
1703 | # | |
1704 | # -> { "execute": "query-vnc" } | |
1705 | # <- { "return": { | |
1706 | # "enabled":true, | |
1707 | # "host":"0.0.0.0", | |
1708 | # "service":"50402", | |
1709 | # "auth":"vnc", | |
1710 | # "family":"ipv4", | |
1711 | # "clients":[ | |
1712 | # { | |
1713 | # "host":"127.0.0.1", | |
1714 | # "service":"50401", | |
1715 | # "family":"ipv4" | |
1716 | # } | |
1717 | # ] | |
1718 | # } | |
1719 | # } | |
1720 | # | |
2b54aa87 LC |
1721 | ## |
1722 | { 'command': 'query-vnc', 'returns': 'VncInfo' } | |
1723 | ||
df887684 GH |
1724 | ## |
1725 | # @query-vnc-servers: | |
1726 | # | |
1727 | # Returns a list of vnc servers. The list can be empty. | |
1728 | # | |
1729 | # Returns: a list of @VncInfo2 | |
1730 | # | |
1731 | # Since: 2.3 | |
1732 | ## | |
1733 | { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] } | |
1734 | ||
d1f29646 | 1735 | ## |
5072f7b3 | 1736 | # @SpiceBasicInfo: |
d1f29646 | 1737 | # |
a589569f WX |
1738 | # The basic information for SPICE network connection |
1739 | # | |
1740 | # @host: IP address | |
d1f29646 | 1741 | # |
a589569f | 1742 | # @port: port number |
d1f29646 | 1743 | # |
a589569f | 1744 | # @family: address family |
d1f29646 | 1745 | # |
a589569f WX |
1746 | # Since: 2.1 |
1747 | ## | |
895a2a80 | 1748 | { 'struct': 'SpiceBasicInfo', |
a589569f WX |
1749 | 'data': { 'host': 'str', |
1750 | 'port': 'str', | |
1751 | 'family': 'NetworkAddressFamily' } } | |
1752 | ||
1753 | ## | |
5072f7b3 | 1754 | # @SpiceServerInfo: |
d1f29646 | 1755 | # |
a589569f | 1756 | # Information about a SPICE server |
d1f29646 | 1757 | # |
1d8bda12 | 1758 | # @auth: authentication method |
d1f29646 | 1759 | # |
a589569f WX |
1760 | # Since: 2.1 |
1761 | ## | |
895a2a80 | 1762 | { 'struct': 'SpiceServerInfo', |
a589569f WX |
1763 | 'base': 'SpiceBasicInfo', |
1764 | 'data': { '*auth': 'str' } } | |
1765 | ||
1766 | ## | |
5072f7b3 | 1767 | # @SpiceChannel: |
a589569f WX |
1768 | # |
1769 | # Information about a SPICE client channel. | |
d1f29646 LC |
1770 | # |
1771 | # @connection-id: SPICE connection id number. All channels with the same id | |
1772 | # belong to the same SPICE session. | |
1773 | # | |
7e781c79 CR |
1774 | # @channel-type: SPICE channel type number. "1" is the main control |
1775 | # channel, filter for this one if you want to track spice | |
1776 | # sessions only | |
d1f29646 | 1777 | # |
419e1bdf AL |
1778 | # @channel-id: SPICE channel ID number. Usually "0", might be different when |
1779 | # multiple channels of the same type exist, such as multiple | |
d1f29646 LC |
1780 | # display channels in a multihead setup |
1781 | # | |
1782 | # @tls: true if the channel is encrypted, false otherwise. | |
1783 | # | |
1784 | # Since: 0.14.0 | |
1785 | ## | |
895a2a80 | 1786 | { 'struct': 'SpiceChannel', |
a589569f WX |
1787 | 'base': 'SpiceBasicInfo', |
1788 | 'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int', | |
d1f29646 LC |
1789 | 'tls': 'bool'} } |
1790 | ||
4efee029 | 1791 | ## |
5072f7b3 | 1792 | # @SpiceQueryMouseMode: |
4efee029 | 1793 | # |
6932a69b | 1794 | # An enumeration of Spice mouse states. |
4efee029 AL |
1795 | # |
1796 | # @client: Mouse cursor position is determined by the client. | |
1797 | # | |
1798 | # @server: Mouse cursor position is determined by the server. | |
1799 | # | |
1800 | # @unknown: No information is available about mouse mode used by | |
1801 | # the spice server. | |
1802 | # | |
1803 | # Note: spice/enums.h has a SpiceMouseMode already, hence the name. | |
1804 | # | |
1805 | # Since: 1.1 | |
1806 | ## | |
1807 | { 'enum': 'SpiceQueryMouseMode', | |
1808 | 'data': [ 'client', 'server', 'unknown' ] } | |
1809 | ||
d1f29646 | 1810 | ## |
5072f7b3 | 1811 | # @SpiceInfo: |
d1f29646 LC |
1812 | # |
1813 | # Information about the SPICE session. | |
b80e560b | 1814 | # |
d1f29646 LC |
1815 | # @enabled: true if the SPICE server is enabled, false otherwise |
1816 | # | |
61c4efe2 | 1817 | # @migrated: true if the last guest migration completed and spice |
bc7e2602 | 1818 | # migration had completed as well. false otherwise. (since 1.4) |
61c4efe2 | 1819 | # |
1d8bda12 | 1820 | # @host: The hostname the SPICE server is bound to. This depends on |
d1f29646 LC |
1821 | # the name resolution on the host and may be an IP address. |
1822 | # | |
1d8bda12 | 1823 | # @port: The SPICE server's port number. |
d1f29646 | 1824 | # |
1d8bda12 | 1825 | # @compiled-version: SPICE server version. |
d1f29646 | 1826 | # |
1d8bda12 | 1827 | # @tls-port: The SPICE server's TLS port number. |
d1f29646 | 1828 | # |
1d8bda12 | 1829 | # @auth: the current authentication type used by the server |
419e1bdf AL |
1830 | # 'none' if no authentication is being used |
1831 | # 'spice' uses SASL or direct TLS authentication, depending on command | |
1832 | # line options | |
d1f29646 | 1833 | # |
4efee029 AL |
1834 | # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can |
1835 | # be determined by the client or the server, or unknown if spice | |
bc7e2602 | 1836 | # server doesn't provide this information. (since: 1.1) |
4efee029 | 1837 | # |
d1f29646 LC |
1838 | # @channels: a list of @SpiceChannel for each active spice channel |
1839 | # | |
1840 | # Since: 0.14.0 | |
1841 | ## | |
895a2a80 | 1842 | { 'struct': 'SpiceInfo', |
61c4efe2 | 1843 | 'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int', |
d1f29646 | 1844 | '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str', |
4efee029 | 1845 | 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} } |
d1f29646 LC |
1846 | |
1847 | ## | |
5072f7b3 | 1848 | # @query-spice: |
d1f29646 LC |
1849 | # |
1850 | # Returns information about the current SPICE server | |
1851 | # | |
1852 | # Returns: @SpiceInfo | |
1853 | # | |
1854 | # Since: 0.14.0 | |
bc7e2602 MAL |
1855 | # |
1856 | # Example: | |
1857 | # | |
1858 | # -> { "execute": "query-spice" } | |
1859 | # <- { "return": { | |
1860 | # "enabled": true, | |
1861 | # "auth": "spice", | |
1862 | # "port": 5920, | |
1863 | # "tls-port": 5921, | |
1864 | # "host": "0.0.0.0", | |
1865 | # "channels": [ | |
1866 | # { | |
1867 | # "port": "54924", | |
1868 | # "family": "ipv4", | |
1869 | # "channel-type": 1, | |
1870 | # "connection-id": 1804289383, | |
1871 | # "host": "127.0.0.1", | |
1872 | # "channel-id": 0, | |
1873 | # "tls": true | |
1874 | # }, | |
1875 | # { | |
1876 | # "port": "36710", | |
1877 | # "family": "ipv4", | |
1878 | # "channel-type": 4, | |
1879 | # "connection-id": 1804289383, | |
1880 | # "host": "127.0.0.1", | |
1881 | # "channel-id": 0, | |
1882 | # "tls": false | |
1883 | # }, | |
1884 | # [ ... more channels follow ... ] | |
1885 | # ] | |
1886 | # } | |
1887 | # } | |
1888 | # | |
d1f29646 LC |
1889 | ## |
1890 | { 'command': 'query-spice', 'returns': 'SpiceInfo' } | |
1891 | ||
96637bcd LC |
1892 | ## |
1893 | # @BalloonInfo: | |
1894 | # | |
1895 | # Information about the guest balloon device. | |
1896 | # | |
1897 | # @actual: the number of bytes the balloon currently contains | |
1898 | # | |
96637bcd LC |
1899 | # Since: 0.14.0 |
1900 | # | |
96637bcd | 1901 | ## |
895a2a80 | 1902 | { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } } |
96637bcd LC |
1903 | |
1904 | ## | |
1905 | # @query-balloon: | |
1906 | # | |
1907 | # Return information about the balloon device. | |
1908 | # | |
1909 | # Returns: @BalloonInfo on success | |
f504e3dc | 1910 | # |
96637bcd LC |
1911 | # If the balloon driver is enabled but not functional because the KVM |
1912 | # kernel module cannot support it, KvmMissingCap | |
f504e3dc | 1913 | # |
96637bcd LC |
1914 | # If no balloon device is present, DeviceNotActive |
1915 | # | |
1916 | # Since: 0.14.0 | |
f504e3dc MAL |
1917 | # |
1918 | # Example: | |
1919 | # | |
1920 | # -> { "execute": "query-balloon" } | |
1921 | # <- { "return": { | |
1922 | # "actual": 1073741824, | |
1923 | # } | |
1924 | # } | |
1925 | # | |
96637bcd LC |
1926 | ## |
1927 | { 'command': 'query-balloon', 'returns': 'BalloonInfo' } | |
1928 | ||
79627472 LC |
1929 | ## |
1930 | # @PciMemoryRange: | |
1931 | # | |
1932 | # A PCI device memory region | |
1933 | # | |
1934 | # @base: the starting address (guest physical) | |
1935 | # | |
1936 | # @limit: the ending address (guest physical) | |
1937 | # | |
1938 | # Since: 0.14.0 | |
1939 | ## | |
895a2a80 | 1940 | { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} } |
79627472 LC |
1941 | |
1942 | ## | |
5072f7b3 | 1943 | # @PciMemoryRegion: |
79627472 LC |
1944 | # |
1945 | # Information about a PCI device I/O region. | |
1946 | # | |
1947 | # @bar: the index of the Base Address Register for this region | |
1948 | # | |
1949 | # @type: 'io' if the region is a PIO region | |
1950 | # 'memory' if the region is a MMIO region | |
1951 | # | |
3fc3aa6d MAL |
1952 | # @size: memory size |
1953 | # | |
1d8bda12 | 1954 | # @prefetch: if @type is 'memory', true if the memory is prefetchable |
79627472 | 1955 | # |
1d8bda12 | 1956 | # @mem_type_64: if @type is 'memory', true if the BAR is 64-bit |
79627472 LC |
1957 | # |
1958 | # Since: 0.14.0 | |
1959 | ## | |
895a2a80 | 1960 | { 'struct': 'PciMemoryRegion', |
79627472 LC |
1961 | 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int', |
1962 | '*prefetch': 'bool', '*mem_type_64': 'bool' } } | |
1963 | ||
1964 | ## | |
9fa02cd1 | 1965 | # @PciBusInfo: |
79627472 | 1966 | # |
9fa02cd1 | 1967 | # Information about a bus of a PCI Bridge device |
79627472 | 1968 | # |
9fa02cd1 EB |
1969 | # @number: primary bus interface number. This should be the number of the |
1970 | # bus the device resides on. | |
79627472 | 1971 | # |
9fa02cd1 EB |
1972 | # @secondary: secondary bus interface number. This is the number of the |
1973 | # main bus for the bridge | |
79627472 | 1974 | # |
9fa02cd1 EB |
1975 | # @subordinate: This is the highest number bus that resides below the |
1976 | # bridge. | |
79627472 | 1977 | # |
9fa02cd1 | 1978 | # @io_range: The PIO range for all devices on this bridge |
79627472 | 1979 | # |
9fa02cd1 | 1980 | # @memory_range: The MMIO range for all devices on this bridge |
79627472 | 1981 | # |
9fa02cd1 EB |
1982 | # @prefetchable_range: The range of prefetchable MMIO for all devices on |
1983 | # this bridge | |
1984 | # | |
1985 | # Since: 2.4 | |
1986 | ## | |
1987 | { 'struct': 'PciBusInfo', | |
1988 | 'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int', | |
1989 | 'io_range': 'PciMemoryRange', | |
1990 | 'memory_range': 'PciMemoryRange', | |
1991 | 'prefetchable_range': 'PciMemoryRange' } } | |
1992 | ||
1993 | ## | |
1994 | # @PciBridgeInfo: | |
1995 | # | |
1996 | # Information about a PCI Bridge device | |
1997 | # | |
1998 | # @bus: information about the bus the device resides on | |
79627472 LC |
1999 | # |
2000 | # @devices: a list of @PciDeviceInfo for each device on this bridge | |
2001 | # | |
2002 | # Since: 0.14.0 | |
2003 | ## | |
895a2a80 | 2004 | { 'struct': 'PciBridgeInfo', |
9fa02cd1 EB |
2005 | 'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} } |
2006 | ||
2007 | ## | |
2008 | # @PciDeviceClass: | |
2009 | # | |
2010 | # Information about the Class of a PCI device | |
2011 | # | |
1d8bda12 | 2012 | # @desc: a string description of the device's class |
9fa02cd1 EB |
2013 | # |
2014 | # @class: the class code of the device | |
2015 | # | |
2016 | # Since: 2.4 | |
2017 | ## | |
2018 | { 'struct': 'PciDeviceClass', | |
2019 | 'data': {'*desc': 'str', 'class': 'int'} } | |
2020 | ||
2021 | ## | |
2022 | # @PciDeviceId: | |
2023 | # | |
2024 | # Information about the Id of a PCI device | |
2025 | # | |
2026 | # @device: the PCI device id | |
2027 | # | |
2028 | # @vendor: the PCI vendor id | |
2029 | # | |
2030 | # Since: 2.4 | |
2031 | ## | |
2032 | { 'struct': 'PciDeviceId', | |
2033 | 'data': {'device': 'int', 'vendor': 'int'} } | |
79627472 LC |
2034 | |
2035 | ## | |
2036 | # @PciDeviceInfo: | |
2037 | # | |
2038 | # Information about a PCI device | |
2039 | # | |
2040 | # @bus: the bus number of the device | |
2041 | # | |
2042 | # @slot: the slot the device is located in | |
2043 | # | |
2044 | # @function: the function of the slot used by the device | |
2045 | # | |
9fa02cd1 | 2046 | # @class_info: the class of the device |
79627472 | 2047 | # |
9fa02cd1 | 2048 | # @id: the PCI device id |
79627472 | 2049 | # |
1d8bda12 | 2050 | # @irq: if an IRQ is assigned to the device, the IRQ number |
79627472 LC |
2051 | # |
2052 | # @qdev_id: the device name of the PCI device | |
2053 | # | |
2054 | # @pci_bridge: if the device is a PCI bridge, the bridge information | |
2055 | # | |
2056 | # @regions: a list of the PCI I/O regions associated with the device | |
2057 | # | |
2058 | # Notes: the contents of @class_info.desc are not stable and should only be | |
2059 | # treated as informational. | |
2060 | # | |
2061 | # Since: 0.14.0 | |
2062 | ## | |
895a2a80 | 2063 | { 'struct': 'PciDeviceInfo', |
79627472 | 2064 | 'data': {'bus': 'int', 'slot': 'int', 'function': 'int', |
9fa02cd1 | 2065 | 'class_info': 'PciDeviceClass', 'id': 'PciDeviceId', |
79627472 LC |
2066 | '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo', |
2067 | 'regions': ['PciMemoryRegion']} } | |
2068 | ||
2069 | ## | |
2070 | # @PciInfo: | |
2071 | # | |
2072 | # Information about a PCI bus | |
2073 | # | |
2074 | # @bus: the bus index | |
2075 | # | |
2076 | # @devices: a list of devices on this bus | |
2077 | # | |
2078 | # Since: 0.14.0 | |
2079 | ## | |
895a2a80 | 2080 | { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} } |
79627472 LC |
2081 | |
2082 | ## | |
2083 | # @query-pci: | |
2084 | # | |
2085 | # Return information about the PCI bus topology of the guest. | |
2086 | # | |
3fc3aa6d MAL |
2087 | # Returns: a list of @PciInfo for each PCI bus. Each bus is |
2088 | # represented by a json-object, which has a key with a json-array of | |
2089 | # all PCI devices attached to it. Each device is represented by a | |
2090 | # json-object. | |
79627472 LC |
2091 | # |
2092 | # Since: 0.14.0 | |
3fc3aa6d MAL |
2093 | # |
2094 | # Example: | |
2095 | # | |
2096 | # -> { "execute": "query-pci" } | |
2097 | # <- { "return": [ | |
2098 | # { | |
2099 | # "bus": 0, | |
2100 | # "devices": [ | |
2101 | # { | |
2102 | # "bus": 0, | |
2103 | # "qdev_id": "", | |
2104 | # "slot": 0, | |
2105 | # "class_info": { | |
2106 | # "class": 1536, | |
2107 | # "desc": "Host bridge" | |
2108 | # }, | |
2109 | # "id": { | |
2110 | # "device": 32902, | |
2111 | # "vendor": 4663 | |
2112 | # }, | |
2113 | # "function": 0, | |
2114 | # "regions": [ | |
2115 | # ] | |
2116 | # }, | |
2117 | # { | |
2118 | # "bus": 0, | |
2119 | # "qdev_id": "", | |
2120 | # "slot": 1, | |
2121 | # "class_info": { | |
2122 | # "class": 1537, | |
2123 | # "desc": "ISA bridge" | |
2124 | # }, | |
2125 | # "id": { | |
2126 | # "device": 32902, | |
2127 | # "vendor": 28672 | |
2128 | # }, | |
2129 | # "function": 0, | |
2130 | # "regions": [ | |
2131 | # ] | |
2132 | # }, | |
2133 | # { | |
2134 | # "bus": 0, | |
2135 | # "qdev_id": "", | |
2136 | # "slot": 1, | |
2137 | # "class_info": { | |
2138 | # "class": 257, | |
2139 | # "desc": "IDE controller" | |
2140 | # }, | |
2141 | # "id": { | |
2142 | # "device": 32902, | |
2143 | # "vendor": 28688 | |
2144 | # }, | |
2145 | # "function": 1, | |
2146 | # "regions": [ | |
2147 | # { | |
2148 | # "bar": 4, | |
2149 | # "size": 16, | |
2150 | # "address": 49152, | |
2151 | # "type": "io" | |
2152 | # } | |
2153 | # ] | |
2154 | # }, | |
2155 | # { | |
2156 | # "bus": 0, | |
2157 | # "qdev_id": "", | |
2158 | # "slot": 2, | |
2159 | # "class_info": { | |
2160 | # "class": 768, | |
2161 | # "desc": "VGA controller" | |
2162 | # }, | |
2163 | # "id": { | |
2164 | # "device": 4115, | |
2165 | # "vendor": 184 | |
2166 | # }, | |
2167 | # "function": 0, | |
2168 | # "regions": [ | |
2169 | # { | |
2170 | # "prefetch": true, | |
2171 | # "mem_type_64": false, | |
2172 | # "bar": 0, | |
2173 | # "size": 33554432, | |
2174 | # "address": 4026531840, | |
2175 | # "type": "memory" | |
2176 | # }, | |
2177 | # { | |
2178 | # "prefetch": false, | |
2179 | # "mem_type_64": false, | |
2180 | # "bar": 1, | |
2181 | # "size": 4096, | |
2182 | # "address": 4060086272, | |
2183 | # "type": "memory" | |
2184 | # }, | |
2185 | # { | |
2186 | # "prefetch": false, | |
2187 | # "mem_type_64": false, | |
2188 | # "bar": 6, | |
2189 | # "size": 65536, | |
2190 | # "address": -1, | |
2191 | # "type": "memory" | |
2192 | # } | |
2193 | # ] | |
2194 | # }, | |
2195 | # { | |
2196 | # "bus": 0, | |
2197 | # "qdev_id": "", | |
2198 | # "irq": 11, | |
2199 | # "slot": 4, | |
2200 | # "class_info": { | |
2201 | # "class": 1280, | |
2202 | # "desc": "RAM controller" | |
2203 | # }, | |
2204 | # "id": { | |
2205 | # "device": 6900, | |
2206 | # "vendor": 4098 | |
2207 | # }, | |
2208 | # "function": 0, | |
2209 | # "regions": [ | |
2210 | # { | |
2211 | # "bar": 0, | |
2212 | # "size": 32, | |
2213 | # "address": 49280, | |
2214 | # "type": "io" | |
2215 | # } | |
2216 | # ] | |
2217 | # } | |
2218 | # ] | |
2219 | # } | |
2220 | # ] | |
2221 | # } | |
2222 | # | |
2223 | # Note: This example has been shortened as the real response is too long. | |
2224 | # | |
79627472 LC |
2225 | ## |
2226 | { 'command': 'query-pci', 'returns': ['PciInfo'] } | |
2227 | ||
7a7f325e LC |
2228 | ## |
2229 | # @quit: | |
2230 | # | |
2231 | # This command will cause the QEMU process to exit gracefully. While every | |
2232 | # attempt is made to send the QMP response before terminating, this is not | |
2233 | # guaranteed. When using this interface, a premature EOF would not be | |
2234 | # unexpected. | |
2235 | # | |
2236 | # Since: 0.14.0 | |
8046bf53 MAL |
2237 | # |
2238 | # Example: | |
2239 | # | |
2240 | # -> { "execute": "quit" } | |
2241 | # <- { "return": {} } | |
7a7f325e LC |
2242 | ## |
2243 | { 'command': 'quit' } | |
5f158f21 LC |
2244 | |
2245 | ## | |
2246 | # @stop: | |
2247 | # | |
2248 | # Stop all guest VCPU execution. | |
2249 | # | |
2250 | # Since: 0.14.0 | |
2251 | # | |
2252 | # Notes: This function will succeed even if the guest is already in the stopped | |
1e998146 PB |
2253 | # state. In "inmigrate" state, it will ensure that the guest |
2254 | # remains paused once migration finishes, as if the -S option was | |
2255 | # passed on the command line. | |
9787339e MAL |
2256 | # |
2257 | # Example: | |
2258 | # | |
2259 | # -> { "execute": "stop" } | |
2260 | # <- { "return": {} } | |
2261 | # | |
5f158f21 LC |
2262 | ## |
2263 | { 'command': 'stop' } | |
38d22653 LC |
2264 | |
2265 | ## | |
2266 | # @system_reset: | |
2267 | # | |
2268 | # Performs a hard reset of a guest. | |
2269 | # | |
2270 | # Since: 0.14.0 | |
cd98e00b MAL |
2271 | # |
2272 | # Example: | |
2273 | # | |
2274 | # -> { "execute": "system_reset" } | |
2275 | # <- { "return": {} } | |
2276 | # | |
38d22653 LC |
2277 | ## |
2278 | { 'command': 'system_reset' } | |
5bc465e4 LC |
2279 | |
2280 | ## | |
2281 | # @system_powerdown: | |
2282 | # | |
2283 | # Requests that a guest perform a powerdown operation. | |
2284 | # | |
2285 | # Since: 0.14.0 | |
2286 | # | |
2287 | # Notes: A guest may or may not respond to this command. This command | |
2288 | # returning does not indicate that a guest has accepted the request or | |
2289 | # that it has shut down. Many guests will respond to this command by | |
2290 | # prompting the user in some way. | |
04fcbabc MAL |
2291 | # Example: |
2292 | # | |
2293 | # -> { "execute": "system_powerdown" } | |
2294 | # <- { "return": {} } | |
2295 | # | |
5bc465e4 LC |
2296 | ## |
2297 | { 'command': 'system_powerdown' } | |
755f1968 LC |
2298 | |
2299 | ## | |
2300 | # @cpu: | |
2301 | # | |
2302 | # This command is a nop that is only provided for the purposes of compatibility. | |
2303 | # | |
2304 | # Since: 0.14.0 | |
2305 | # | |
2306 | # Notes: Do not use this command. | |
2307 | ## | |
2308 | { 'command': 'cpu', 'data': {'index': 'int'} } | |
0cfd6a9a | 2309 | |
69ca3ea5 | 2310 | ## |
5072f7b3 | 2311 | # @cpu-add: |
69ca3ea5 IM |
2312 | # |
2313 | # Adds CPU with specified ID | |
2314 | # | |
2315 | # @id: ID of CPU to be created, valid values [0..max_cpus) | |
2316 | # | |
2317 | # Returns: Nothing on success | |
2318 | # | |
5072f7b3 | 2319 | # Since: 1.5 |
a7b83754 MAL |
2320 | # |
2321 | # Example: | |
2322 | # | |
2323 | # -> { "execute": "cpu-add", "arguments": { "id": 2 } } | |
2324 | # <- { "return": {} } | |
2325 | # | |
69ca3ea5 IM |
2326 | ## |
2327 | { 'command': 'cpu-add', 'data': {'id': 'int'} } | |
2328 | ||
0cfd6a9a LC |
2329 | ## |
2330 | # @memsave: | |
2331 | # | |
2332 | # Save a portion of guest memory to a file. | |
2333 | # | |
2334 | # @val: the virtual address of the guest to start from | |
2335 | # | |
2336 | # @size: the size of memory region to save | |
2337 | # | |
2338 | # @filename: the file to save the memory to as binary data | |
2339 | # | |
1d8bda12 | 2340 | # @cpu-index: the index of the virtual CPU to use for translating the |
0cfd6a9a LC |
2341 | # virtual address (defaults to CPU 0) |
2342 | # | |
2343 | # Returns: Nothing on success | |
0cfd6a9a LC |
2344 | # |
2345 | # Since: 0.14.0 | |
2346 | # | |
2347 | # Notes: Errors were not reliably returned until 1.1 | |
30831b63 MAL |
2348 | # |
2349 | # Example: | |
2350 | # | |
2351 | # -> { "execute": "memsave", | |
2352 | # "arguments": { "val": 10, | |
2353 | # "size": 100, | |
2354 | # "filename": "/tmp/virtual-mem-dump" } } | |
2355 | # <- { "return": {} } | |
2356 | # | |
0cfd6a9a LC |
2357 | ## |
2358 | { 'command': 'memsave', | |
2359 | 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} } | |
6d3962bf LC |
2360 | |
2361 | ## | |
2362 | # @pmemsave: | |
2363 | # | |
2364 | # Save a portion of guest physical memory to a file. | |
2365 | # | |
2366 | # @val: the physical address of the guest to start from | |
2367 | # | |
2368 | # @size: the size of memory region to save | |
2369 | # | |
2370 | # @filename: the file to save the memory to as binary data | |
2371 | # | |
2372 | # Returns: Nothing on success | |
6d3962bf LC |
2373 | # |
2374 | # Since: 0.14.0 | |
2375 | # | |
2376 | # Notes: Errors were not reliably returned until 1.1 | |
978d4d97 MAL |
2377 | # |
2378 | # Example: | |
2379 | # | |
2380 | # -> { "execute": "pmemsave", | |
2381 | # "arguments": { "val": 10, | |
2382 | # "size": 100, | |
2383 | # "filename": "/tmp/physical-mem-dump" } } | |
2384 | # <- { "return": {} } | |
2385 | # | |
6d3962bf LC |
2386 | ## |
2387 | { 'command': 'pmemsave', | |
2388 | 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} } | |
e42e818b LC |
2389 | |
2390 | ## | |
2391 | # @cont: | |
2392 | # | |
2393 | # Resume guest VCPU execution. | |
2394 | # | |
2395 | # Since: 0.14.0 | |
2396 | # | |
2397 | # Returns: If successful, nothing | |
e42e818b LC |
2398 | # If QEMU was started with an encrypted block device and a key has |
2399 | # not yet been set, DeviceEncrypted. | |
2400 | # | |
1e998146 PB |
2401 | # Notes: This command will succeed if the guest is currently running. It |
2402 | # will also succeed if the guest is in the "inmigrate" state; in | |
2403 | # this case, the effect of the command is to make sure the guest | |
2404 | # starts once migration finishes, removing the effect of the -S | |
2405 | # command line option if it was passed. | |
3815d0de MAL |
2406 | # |
2407 | # Example: | |
2408 | # | |
2409 | # -> { "execute": "cont" } | |
2410 | # <- { "return": {} } | |
2411 | # | |
e42e818b LC |
2412 | ## |
2413 | { 'command': 'cont' } | |
2414 | ||
9b9df25a GH |
2415 | ## |
2416 | # @system_wakeup: | |
2417 | # | |
2418 | # Wakeup guest from suspend. Does nothing in case the guest isn't suspended. | |
2419 | # | |
2420 | # Since: 1.1 | |
2421 | # | |
2422 | # Returns: nothing. | |
253cdee1 MAL |
2423 | # |
2424 | # Example: | |
2425 | # | |
2426 | # -> { "execute": "system_wakeup" } | |
2427 | # <- { "return": {} } | |
2428 | # | |
9b9df25a GH |
2429 | ## |
2430 | { 'command': 'system_wakeup' } | |
2431 | ||
ab49ab5c LC |
2432 | ## |
2433 | # @inject-nmi: | |
2434 | # | |
9cb805fd | 2435 | # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64). |
149ea099 | 2436 | # The command fails when the guest doesn't support injecting. |
ab49ab5c LC |
2437 | # |
2438 | # Returns: If successful, nothing | |
ab49ab5c LC |
2439 | # |
2440 | # Since: 0.14.0 | |
2441 | # | |
9cb805fd | 2442 | # Note: prior to 2.1, this command was only supported for x86 and s390 VMs |
149ea099 MAL |
2443 | # |
2444 | # Example: | |
2445 | # | |
2446 | # -> { "execute": "inject-nmi" } | |
2447 | # <- { "return": {} } | |
2448 | # | |
ab49ab5c LC |
2449 | ## |
2450 | { 'command': 'inject-nmi' } | |
4b37156c LC |
2451 | |
2452 | ## | |
2453 | # @set_link: | |
2454 | # | |
2455 | # Sets the link status of a virtual network adapter. | |
2456 | # | |
2457 | # @name: the device name of the virtual network adapter | |
2458 | # | |
2459 | # @up: true to set the link status to be up | |
2460 | # | |
2461 | # Returns: Nothing on success | |
2462 | # If @name is not a valid network device, DeviceNotFound | |
2463 | # | |
2464 | # Since: 0.14.0 | |
2465 | # | |
2466 | # Notes: Not all network adapters support setting link status. This command | |
2467 | # will succeed even if the network adapter does not support link status | |
2468 | # notification. | |
f9cfb8f7 MAL |
2469 | # |
2470 | # Example: | |
2471 | # | |
2472 | # -> { "execute": "set_link", | |
2473 | # "arguments": { "name": "e1000.0", "up": false } } | |
2474 | # <- { "return": {} } | |
2475 | # | |
4b37156c LC |
2476 | ## |
2477 | { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} } | |
a4dea8a9 | 2478 | |
d72f3264 LC |
2479 | ## |
2480 | # @balloon: | |
2481 | # | |
2482 | # Request the balloon driver to change its balloon size. | |
2483 | # | |
2484 | # @value: the target size of the balloon in bytes | |
2485 | # | |
2486 | # Returns: Nothing on success | |
2487 | # If the balloon driver is enabled but not functional because the KVM | |
2488 | # kernel module cannot support it, KvmMissingCap | |
2489 | # If no balloon device is present, DeviceNotActive | |
2490 | # | |
2491 | # Notes: This command just issues a request to the guest. When it returns, | |
2492 | # the balloon size may not have changed. A guest can change the balloon | |
2493 | # size independent of this command. | |
2494 | # | |
2495 | # Since: 0.14.0 | |
7b338db7 MAL |
2496 | # |
2497 | # Example: | |
2498 | # | |
2499 | # -> { "execute": "balloon", "arguments": { "value": 536870912 } } | |
2500 | # <- { "return": {} } | |
2501 | # | |
d72f3264 LC |
2502 | ## |
2503 | { 'command': 'balloon', 'data': {'value': 'int'} } | |
5e7caacb | 2504 | |
78b18b78 | 2505 | ## |
5072f7b3 | 2506 | # @Abort: |
78b18b78 SH |
2507 | # |
2508 | # This action can be used to test transaction failure. | |
2509 | # | |
2510 | # Since: 1.6 | |
5072f7b3 | 2511 | ## |
895a2a80 | 2512 | { 'struct': 'Abort', |
78b18b78 SH |
2513 | 'data': { } } |
2514 | ||
94d16a64 | 2515 | ## |
5072f7b3 | 2516 | # @ActionCompletionMode: |
94d16a64 JS |
2517 | # |
2518 | # An enumeration of Transactional completion modes. | |
2519 | # | |
2520 | # @individual: Do not attempt to cancel any other Actions if any Actions fail | |
2521 | # after the Transaction request succeeds. All Actions that | |
2522 | # can complete successfully will do so without waiting on others. | |
2523 | # This is the default. | |
2524 | # | |
2525 | # @grouped: If any Action fails after the Transaction succeeds, cancel all | |
2526 | # Actions. Actions do not complete until all Actions are ready to | |
2527 | # complete. May be rejected by Actions that do not support this | |
2528 | # completion mode. | |
2529 | # | |
2530 | # Since: 2.5 | |
2531 | ## | |
2532 | { 'enum': 'ActionCompletionMode', | |
2533 | 'data': [ 'individual', 'grouped' ] } | |
2534 | ||
8802d1fd | 2535 | ## |
5072f7b3 | 2536 | # @TransactionAction: |
8802d1fd | 2537 | # |
52e7c241 | 2538 | # A discriminated record of operations that can be performed with |
41dc1dc0 | 2539 | # @transaction. Action @type can be: |
b7b9d39a | 2540 | # |
41dc1dc0 MAL |
2541 | # - @abort: since 1.6 |
2542 | # - @block-dirty-bitmap-add: since 2.5 | |
2543 | # - @block-dirty-bitmap-clear: since 2.5 | |
2544 | # - @blockdev-backup: since 2.3 | |
2545 | # - @blockdev-snapshot: since 2.5 | |
2546 | # - @blockdev-snapshot-internal-sync: since 1.7 | |
2547 | # - @blockdev-snapshot-sync: since 1.1 | |
2548 | # - @drive-backup: since 1.6 | |
b7b9d39a | 2549 | # |
41dc1dc0 | 2550 | # Since: 1.1 |
8802d1fd | 2551 | ## |
c8a83e85 | 2552 | { 'union': 'TransactionAction', |
52e7c241 | 2553 | 'data': { |
bbe86010 | 2554 | 'abort': 'Abort', |
df9a681d | 2555 | 'block-dirty-bitmap-add': 'BlockDirtyBitmapAdd', |
41dc1dc0 MAL |
2556 | 'block-dirty-bitmap-clear': 'BlockDirtyBitmap', |
2557 | 'blockdev-backup': 'BlockdevBackup', | |
2558 | 'blockdev-snapshot': 'BlockdevSnapshot', | |
2559 | 'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal', | |
2560 | 'blockdev-snapshot-sync': 'BlockdevSnapshotSync', | |
2561 | 'drive-backup': 'DriveBackup' | |
52e7c241 | 2562 | } } |
8802d1fd | 2563 | |
94d16a64 | 2564 | ## |
5072f7b3 | 2565 | # @TransactionProperties: |
94d16a64 JS |
2566 | # |
2567 | # Optional arguments to modify the behavior of a Transaction. | |
2568 | # | |
1d8bda12 | 2569 | # @completion-mode: Controls how jobs launched asynchronously by |
94d16a64 JS |
2570 | # Actions will complete or fail as a group. |
2571 | # See @ActionCompletionMode for details. | |
2572 | # | |
2573 | # Since: 2.5 | |
2574 | ## | |
2575 | { 'struct': 'TransactionProperties', | |
2576 | 'data': { | |
2577 | '*completion-mode': 'ActionCompletionMode' | |
2578 | } | |
2579 | } | |
2580 | ||
8802d1fd | 2581 | ## |
5072f7b3 | 2582 | # @transaction: |
8802d1fd | 2583 | # |
c8a83e85 KW |
2584 | # Executes a number of transactionable QMP commands atomically. If any |
2585 | # operation fails, then the entire set of actions will be abandoned and the | |
2586 | # appropriate error returned. | |
8802d1fd | 2587 | # |
5c82b0f1 MAL |
2588 | # For external snapshots, the dictionary contains the device, the file to use for |
2589 | # the new snapshot, and the format. The default format, if not specified, is | |
2590 | # qcow2. | |
2591 | # | |
2592 | # Each new snapshot defaults to being created by QEMU (wiping any | |
2593 | # contents if the file already exists), but it is also possible to reuse | |
2594 | # an externally-created file. In the latter case, you should ensure that | |
2595 | # the new image file has the same contents as the current one; QEMU cannot | |
2596 | # perform any meaningful check. Typically this is achieved by using the | |
2597 | # current image file as the backing file for the new image. | |
2598 | # | |
2599 | # On failure, the original disks pre-snapshot attempt will be used. | |
2600 | # | |
2601 | # For internal snapshots, the dictionary contains the device and the snapshot's | |
2602 | # name. If an internal snapshot matching name already exists, the request will | |
2603 | # be rejected. Only some image formats support it, for example, qcow2, rbd, | |
2604 | # and sheepdog. | |
2605 | # | |
2606 | # On failure, qemu will try delete the newly created internal snapshot in the | |
2607 | # transaction. When an I/O error occurs during deletion, the user needs to fix | |
2608 | # it later with qemu-img or other command. | |
2609 | # | |
94d16a64 JS |
2610 | # @actions: List of @TransactionAction; |
2611 | # information needed for the respective operations. | |
2612 | # | |
1d8bda12 | 2613 | # @properties: structure of additional options to control the |
94d16a64 JS |
2614 | # execution of the transaction. See @TransactionProperties |
2615 | # for additional detail. | |
8802d1fd JC |
2616 | # |
2617 | # Returns: nothing on success | |
5c82b0f1 | 2618 | # |
c8a83e85 | 2619 | # Errors depend on the operations of the transaction |
8802d1fd | 2620 | # |
c8a83e85 KW |
2621 | # Note: The transaction aborts on the first failure. Therefore, there will be |
2622 | # information on only one failed operation returned in an error condition, and | |
52e7c241 PB |
2623 | # subsequent actions will not have been attempted. |
2624 | # | |
5072f7b3 | 2625 | # Since: 1.1 |
5c82b0f1 MAL |
2626 | # |
2627 | # Example: | |
2628 | # | |
2629 | # -> { "execute": "transaction", | |
2630 | # "arguments": { "actions": [ | |
2631 | # { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0", | |
2632 | # "snapshot-file": "/some/place/my-image", | |
2633 | # "format": "qcow2" } }, | |
2634 | # { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile", | |
2635 | # "snapshot-file": "/some/place/my-image2", | |
2636 | # "snapshot-node-name": "node3432", | |
2637 | # "mode": "existing", | |
2638 | # "format": "qcow2" } }, | |
2639 | # { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1", | |
2640 | # "snapshot-file": "/some/place/my-image2", | |
2641 | # "mode": "existing", | |
2642 | # "format": "qcow2" } }, | |
2643 | # { "type": "blockdev-snapshot-internal-sync", "data" : { | |
2644 | # "device": "ide-hd2", | |
2645 | # "name": "snapshot0" } } ] } } | |
2646 | # <- { "return": {} } | |
2647 | # | |
8802d1fd | 2648 | ## |
52e7c241 | 2649 | { 'command': 'transaction', |
94d16a64 JS |
2650 | 'data': { 'actions': [ 'TransactionAction' ], |
2651 | '*properties': 'TransactionProperties' | |
2652 | } | |
2653 | } | |
8802d1fd | 2654 | |
d51a67b4 LC |
2655 | ## |
2656 | # @human-monitor-command: | |
2657 | # | |
2658 | # Execute a command on the human monitor and return the output. | |
2659 | # | |
2660 | # @command-line: the command to execute in the human monitor | |
2661 | # | |
1d8bda12 | 2662 | # @cpu-index: The CPU to use for commands that require an implicit CPU |
d51a67b4 LC |
2663 | # |
2664 | # Returns: the output of the command as a string | |
2665 | # | |
1ad166b6 | 2666 | # Since: 0.14.0 |
08e4ed6c | 2667 | # |
1ad166b6 | 2668 | # Notes: This command only exists as a stop-gap. Its use is highly |
e9ac76ac MAL |
2669 | # discouraged. The semantics of this command are not |
2670 | # guaranteed: this means that command names, arguments and | |
2671 | # responses can change or be removed at ANY time. Applications | |
2672 | # that rely on long term stability guarantees should NOT | |
2673 | # use this command. | |
b952b558 | 2674 | # |
1ad166b6 | 2675 | # Known limitations: |
b952b558 | 2676 | # |
3df58d41 | 2677 | # * This command is stateless, this means that commands that depend |
1ad166b6 | 2678 | # on state information (such as getfd) might not work |
d9b902db | 2679 | # |
3df58d41 MAL |
2680 | # * Commands that prompt the user for data (eg. 'cont' when the block |
2681 | # device is encrypted) don't currently work | |
e9ac76ac MAL |
2682 | # |
2683 | # Example: | |
2684 | # | |
2685 | # -> { "execute": "human-monitor-command", | |
2686 | # "arguments": { "command-line": "info kvm" } } | |
2687 | # <- { "return": "kvm support: enabled\r\n" } | |
2688 | # | |
d9b902db | 2689 | ## |
1ad166b6 BC |
2690 | { 'command': 'human-monitor-command', |
2691 | 'data': {'command-line': 'str', '*cpu-index': 'int'}, | |
2692 | 'returns': 'str' } | |
d9b902db PB |
2693 | |
2694 | ## | |
5072f7b3 | 2695 | # @migrate_cancel: |
6cdedb07 LC |
2696 | # |
2697 | # Cancel the current executing migration process. | |
2698 | # | |
2699 | # Returns: nothing on success | |
2700 | # | |
2701 | # Notes: This command succeeds even if there is no migration process running. | |
2702 | # | |
2703 | # Since: 0.14.0 | |
92dcfb43 MAL |
2704 | # |
2705 | # Example: | |
2706 | # | |
2707 | # -> { "execute": "migrate_cancel" } | |
2708 | # <- { "return": {} } | |
2709 | # | |
6cdedb07 LC |
2710 | ## |
2711 | { 'command': 'migrate_cancel' } | |
4f0a993b LC |
2712 | |
2713 | ## | |
5072f7b3 | 2714 | # @migrate_set_downtime: |
4f0a993b LC |
2715 | # |
2716 | # Set maximum tolerated downtime for migration. | |
2717 | # | |
2718 | # @value: maximum downtime in seconds | |
2719 | # | |
2720 | # Returns: nothing on success | |
2721 | # | |
2ff30257 AA |
2722 | # Notes: This command is deprecated in favor of 'migrate-set-parameters' |
2723 | # | |
4f0a993b | 2724 | # Since: 0.14.0 |
de0b45ea MAL |
2725 | # |
2726 | # Example: | |
2727 | # | |
2728 | # -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } } | |
2729 | # <- { "return": {} } | |
2730 | # | |
4f0a993b LC |
2731 | ## |
2732 | { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} } | |
3dc85383 LC |
2733 | |
2734 | ## | |
5072f7b3 | 2735 | # @migrate_set_speed: |
3dc85383 LC |
2736 | # |
2737 | # Set maximum speed for migration. | |
2738 | # | |
ab989533 | 2739 | # @value: maximum speed in bytes per second. |
3dc85383 LC |
2740 | # |
2741 | # Returns: nothing on success | |
2742 | # | |
2ff30257 | 2743 | # Notes: This command is deprecated in favor of 'migrate-set-parameters' |
3dc85383 LC |
2744 | # |
2745 | # Since: 0.14.0 | |
ab989533 MAL |
2746 | # |
2747 | # Example: | |
2748 | # | |
2749 | # -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } } | |
2750 | # <- { "return": {} } | |
2751 | # | |
3dc85383 LC |
2752 | ## |
2753 | { 'command': 'migrate_set_speed', 'data': {'value': 'int'} } | |
b4b12c62 | 2754 | |
9e1ba4cc | 2755 | ## |
5072f7b3 | 2756 | # @migrate-set-cache-size: |
9e1ba4cc | 2757 | # |
8f457b67 | 2758 | # Set cache size to be used by XBZRLE migration |
9e1ba4cc OW |
2759 | # |
2760 | # @value: cache size in bytes | |
2761 | # | |
2762 | # The size will be rounded down to the nearest power of 2. | |
2763 | # The cache size can be modified before and during ongoing migration | |
2764 | # | |
2765 | # Returns: nothing on success | |
2766 | # | |
2767 | # Since: 1.2 | |
8f457b67 MAL |
2768 | # |
2769 | # Example: | |
2770 | # | |
2771 | # -> { "execute": "migrate-set-cache-size", | |
2772 | # "arguments": { "value": 536870912 } } | |
2773 | # <- { "return": {} } | |
2774 | # | |
9e1ba4cc OW |
2775 | ## |
2776 | { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} } | |
2777 | ||
2778 | ## | |
5072f7b3 | 2779 | # @query-migrate-cache-size: |
9e1ba4cc | 2780 | # |
b953601b | 2781 | # Query migration XBZRLE cache size |
9e1ba4cc OW |
2782 | # |
2783 | # Returns: XBZRLE cache size in bytes | |
2784 | # | |
2785 | # Since: 1.2 | |
b953601b MAL |
2786 | # |
2787 | # Example: | |
2788 | # | |
2789 | # -> { "execute": "query-migrate-cache-size" } | |
2790 | # <- { "return": 67108864 } | |
2791 | # | |
9e1ba4cc OW |
2792 | ## |
2793 | { 'command': 'query-migrate-cache-size', 'returns': 'int' } | |
2794 | ||
b4b12c62 | 2795 | ## |
d03ee401 | 2796 | # @ObjectPropertyInfo: |
b4b12c62 AL |
2797 | # |
2798 | # @name: the name of the property | |
2799 | # | |
2800 | # @type: the type of the property. This will typically come in one of four | |
2801 | # forms: | |
2802 | # | |
2803 | # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'. | |
2804 | # These types are mapped to the appropriate JSON type. | |
2805 | # | |
33b23b4b | 2806 | # 2) A child type in the form 'child<subtype>' where subtype is a qdev |
b4b12c62 AL |
2807 | # device type name. Child properties create the composition tree. |
2808 | # | |
33b23b4b | 2809 | # 3) A link type in the form 'link<subtype>' where subtype is a qdev |
b4b12c62 AL |
2810 | # device type name. Link properties form the device model graph. |
2811 | # | |
51920820 | 2812 | # Since: 1.2 |
b4b12c62 | 2813 | ## |
895a2a80 | 2814 | { 'struct': 'ObjectPropertyInfo', |
b4b12c62 AL |
2815 | 'data': { 'name': 'str', 'type': 'str' } } |
2816 | ||
2817 | ## | |
2818 | # @qom-list: | |
2819 | # | |
57c9fafe | 2820 | # This command will list any properties of a object given a path in the object |
b4b12c62 AL |
2821 | # model. |
2822 | # | |
57c9fafe | 2823 | # @path: the path within the object model. See @qom-get for a description of |
b4b12c62 AL |
2824 | # this parameter. |
2825 | # | |
57c9fafe AL |
2826 | # Returns: a list of @ObjectPropertyInfo that describe the properties of the |
2827 | # object. | |
b4b12c62 | 2828 | # |
51920820 | 2829 | # Since: 1.2 |
b4b12c62 AL |
2830 | ## |
2831 | { 'command': 'qom-list', | |
2832 | 'data': { 'path': 'str' }, | |
57c9fafe | 2833 | 'returns': [ 'ObjectPropertyInfo' ] } |
eb6e8ea5 AL |
2834 | |
2835 | ## | |
2836 | # @qom-get: | |
2837 | # | |
57c9fafe | 2838 | # This command will get a property from a object model path and return the |
eb6e8ea5 AL |
2839 | # value. |
2840 | # | |
57c9fafe | 2841 | # @path: The path within the object model. There are two forms of supported |
eb6e8ea5 AL |
2842 | # paths--absolute and partial paths. |
2843 | # | |
57c9fafe | 2844 | # Absolute paths are derived from the root object and can follow child<> |
eb6e8ea5 AL |
2845 | # or link<> properties. Since they can follow link<> properties, they |
2846 | # can be arbitrarily long. Absolute paths look like absolute filenames | |
2847 | # and are prefixed with a leading slash. | |
2848 | # | |
2849 | # Partial paths look like relative filenames. They do not begin | |
2850 | # with a prefix. The matching rules for partial paths are subtle but | |
57c9fafe | 2851 | # designed to make specifying objects easy. At each level of the |
eb6e8ea5 AL |
2852 | # composition tree, the partial path is matched as an absolute path. |
2853 | # The first match is not returned. At least two matches are searched | |
2854 | # for. A successful result is only returned if only one match is | |
2855 | # found. If more than one match is found, a flag is return to | |
2856 | # indicate that the match was ambiguous. | |
2857 | # | |
2858 | # @property: The property name to read | |
2859 | # | |
33b23b4b MAL |
2860 | # Returns: The property value. The type depends on the property |
2861 | # type. child<> and link<> properties are returned as #str | |
2862 | # pathnames. All integer property types (u8, u16, etc) are | |
2863 | # returned as #int. | |
eb6e8ea5 | 2864 | # |
51920820 | 2865 | # Since: 1.2 |
eb6e8ea5 AL |
2866 | ## |
2867 | { 'command': 'qom-get', | |
2868 | 'data': { 'path': 'str', 'property': 'str' }, | |
6eb3937e | 2869 | 'returns': 'any' } |
eb6e8ea5 AL |
2870 | |
2871 | ## | |
2872 | # @qom-set: | |
2873 | # | |
57c9fafe | 2874 | # This command will set a property from a object model path. |
eb6e8ea5 AL |
2875 | # |
2876 | # @path: see @qom-get for a description of this parameter | |
2877 | # | |
2878 | # @property: the property name to set | |
2879 | # | |
2880 | # @value: a value who's type is appropriate for the property type. See @qom-get | |
2881 | # for a description of type mapping. | |
2882 | # | |
51920820 | 2883 | # Since: 1.2 |
eb6e8ea5 AL |
2884 | ## |
2885 | { 'command': 'qom-set', | |
6eb3937e | 2886 | 'data': { 'path': 'str', 'property': 'str', 'value': 'any' } } |
fbf796fd LC |
2887 | |
2888 | ## | |
2889 | # @set_password: | |
2890 | # | |
2891 | # Sets the password of a remote display session. | |
2892 | # | |
2893 | # @protocol: `vnc' to modify the VNC server password | |
2894 | # `spice' to modify the Spice server password | |
2895 | # | |
2896 | # @password: the new password | |
2897 | # | |
1d8bda12 | 2898 | # @connected: how to handle existing clients when changing the |
b80e560b | 2899 | # password. If nothing is specified, defaults to `keep' |
fbf796fd LC |
2900 | # `fail' to fail the command if clients are connected |
2901 | # `disconnect' to disconnect existing clients | |
2902 | # `keep' to maintain existing clients | |
2903 | # | |
2904 | # Returns: Nothing on success | |
2905 | # If Spice is not enabled, DeviceNotFound | |
fbf796fd LC |
2906 | # |
2907 | # Since: 0.14.0 | |
4d8a374e MAL |
2908 | # |
2909 | # Example: | |
2910 | # | |
2911 | # -> { "execute": "set_password", "arguments": { "protocol": "vnc", | |
2912 | # "password": "secret" } } | |
2913 | # <- { "return": {} } | |
2914 | # | |
fbf796fd LC |
2915 | ## |
2916 | { 'command': 'set_password', | |
2917 | 'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} } | |
9ad5372d LC |
2918 | |
2919 | ## | |
2920 | # @expire_password: | |
2921 | # | |
2922 | # Expire the password of a remote display server. | |
2923 | # | |
2924 | # @protocol: the name of the remote display protocol `vnc' or `spice' | |
2925 | # | |
2926 | # @time: when to expire the password. | |
2927 | # `now' to expire the password immediately | |
2928 | # `never' to cancel password expiration | |
2929 | # `+INT' where INT is the number of seconds from now (integer) | |
2930 | # `INT' where INT is the absolute time in seconds | |
2931 | # | |
2932 | # Returns: Nothing on success | |
2933 | # If @protocol is `spice' and Spice is not active, DeviceNotFound | |
9ad5372d LC |
2934 | # |
2935 | # Since: 0.14.0 | |
2936 | # | |
2937 | # Notes: Time is relative to the server and currently there is no way to | |
2938 | # coordinate server time with client time. It is not recommended to | |
2939 | # use the absolute time version of the @time parameter unless you're | |
2940 | # sure you are on the same machine as the QEMU instance. | |
342816b9 MAL |
2941 | # |
2942 | # Example: | |
2943 | # | |
2944 | # -> { "execute": "expire_password", "arguments": { "protocol": "vnc", | |
2945 | # "time": "+60" } } | |
2946 | # <- { "return": {} } | |
2947 | # | |
9ad5372d LC |
2948 | ## |
2949 | { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} } | |
c245b6a3 | 2950 | |
270b243f LC |
2951 | ## |
2952 | # @change-vnc-password: | |
2953 | # | |
2954 | # Change the VNC server password. | |
2955 | # | |
1c854067 | 2956 | # @password: the new password to use with VNC authentication |
270b243f LC |
2957 | # |
2958 | # Since: 1.1 | |
2959 | # | |
2960 | # Notes: An empty password in this command will set the password to the empty | |
2961 | # string. Existing clients are unaffected by executing this command. | |
2962 | ## | |
2963 | { 'command': 'change-vnc-password', 'data': {'password': 'str'} } | |
333a96ec LC |
2964 | |
2965 | ## | |
2966 | # @change: | |
2967 | # | |
2968 | # This command is multiple commands multiplexed together. | |
2969 | # | |
2970 | # @device: This is normally the name of a block device but it may also be 'vnc'. | |
2971 | # when it's 'vnc', then sub command depends on @target | |
2972 | # | |
2973 | # @target: If @device is a block device, then this is the new filename. | |
2974 | # If @device is 'vnc', then if the value 'password' selects the vnc | |
2975 | # change password command. Otherwise, this specifies a new server URI | |
2976 | # address to listen to for VNC connections. | |
2977 | # | |
2978 | # @arg: If @device is a block device, then this is an optional format to open | |
2979 | # the device with. | |
2980 | # If @device is 'vnc' and @target is 'password', this is the new VNC | |
2981 | # password to set. If this argument is an empty string, then no future | |
2982 | # logins will be allowed. | |
2983 | # | |
2984 | # Returns: Nothing on success. | |
2985 | # If @device is not a valid block device, DeviceNotFound | |
333a96ec LC |
2986 | # If the new block device is encrypted, DeviceEncrypted. Note that |
2987 | # if this error is returned, the device has been opened successfully | |
2988 | # and an additional call to @block_passwd is required to set the | |
2989 | # device's password. The behavior of reads and writes to the block | |
2990 | # device between when these calls are executed is undefined. | |
2991 | # | |
24fb4133 HR |
2992 | # Notes: This interface is deprecated, and it is strongly recommended that you |
2993 | # avoid using it. For changing block devices, use | |
2994 | # blockdev-change-medium; for changing VNC parameters, use | |
2995 | # change-vnc-password. | |
333a96ec LC |
2996 | # |
2997 | # Since: 0.14.0 | |
01387ae5 MAL |
2998 | # |
2999 | # Example: | |
3000 | # | |
3001 | # 1. Change a removable medium | |
3002 | # | |
3003 | # -> { "execute": "change", | |
3004 | # "arguments": { "device": "ide1-cd0", | |
3005 | # "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } } | |
3006 | # <- { "return": {} } | |
3007 | # | |
3008 | # 2. Change VNC password | |
3009 | # | |
3010 | # -> { "execute": "change", | |
3011 | # "arguments": { "device": "vnc", "target": "password", | |
3012 | # "arg": "foobar1" } } | |
3013 | # <- { "return": {} } | |
3014 | # | |
333a96ec LC |
3015 | ## |
3016 | { 'command': 'change', | |
3017 | 'data': {'device': 'str', 'target': 'str', '*arg': 'str'} } | |
80047da5 | 3018 | |
5eeee3fa AL |
3019 | ## |
3020 | # @ObjectTypeInfo: | |
3021 | # | |
3022 | # This structure describes a search result from @qom-list-types | |
3023 | # | |
3024 | # @name: the type name found in the search | |
3025 | # | |
3026 | # Since: 1.1 | |
3027 | # | |
3028 | # Notes: This command is experimental and may change syntax in future releases. | |
3029 | ## | |
895a2a80 | 3030 | { 'struct': 'ObjectTypeInfo', |
5eeee3fa AL |
3031 | 'data': { 'name': 'str' } } |
3032 | ||
3033 | ## | |
3034 | # @qom-list-types: | |
3035 | # | |
3036 | # This command will return a list of types given search parameters | |
3037 | # | |
3038 | # @implements: if specified, only return types that implement this type name | |
3039 | # | |
3040 | # @abstract: if true, include abstract types in the results | |
3041 | # | |
3042 | # Returns: a list of @ObjectTypeInfo or an empty list if no results are found | |
3043 | # | |
3044 | # Since: 1.1 | |
5eeee3fa AL |
3045 | ## |
3046 | { 'command': 'qom-list-types', | |
3047 | 'data': { '*implements': 'str', '*abstract': 'bool' }, | |
3048 | 'returns': [ 'ObjectTypeInfo' ] } | |
e1c37d0e | 3049 | |
1daa31b9 AL |
3050 | ## |
3051 | # @DevicePropertyInfo: | |
3052 | # | |
3053 | # Information about device properties. | |
3054 | # | |
3055 | # @name: the name of the property | |
3056 | # @type: the typename of the property | |
1d8bda12 | 3057 | # @description: if specified, the description of the property. |
07d09c58 | 3058 | # (since 2.2) |
1daa31b9 AL |
3059 | # |
3060 | # Since: 1.2 | |
3061 | ## | |
895a2a80 | 3062 | { 'struct': 'DevicePropertyInfo', |
07d09c58 | 3063 | 'data': { 'name': 'str', 'type': 'str', '*description': 'str' } } |
1daa31b9 AL |
3064 | |
3065 | ## | |
3066 | # @device-list-properties: | |
3067 | # | |
3068 | # List properties associated with a device. | |
3069 | # | |
3070 | # @typename: the type name of a device | |
3071 | # | |
3072 | # Returns: a list of DevicePropertyInfo describing a devices properties | |
3073 | # | |
3074 | # Since: 1.2 | |
3075 | ## | |
3076 | { 'command': 'device-list-properties', | |
3077 | 'data': { 'typename': 'str'}, | |
3078 | 'returns': [ 'DevicePropertyInfo' ] } | |
3079 | ||
e1c37d0e | 3080 | ## |
5072f7b3 | 3081 | # @migrate: |
e1c37d0e LC |
3082 | # |
3083 | # Migrates the current running guest to another Virtual Machine. | |
3084 | # | |
3085 | # @uri: the Uniform Resource Identifier of the destination VM | |
3086 | # | |
1d8bda12 | 3087 | # @blk: do block migration (full disk copy) |
e1c37d0e | 3088 | # |
1d8bda12 | 3089 | # @inc: incremental disk copy migration |
e1c37d0e LC |
3090 | # |
3091 | # @detach: this argument exists only for compatibility reasons and | |
3092 | # is ignored by QEMU | |
3093 | # | |
3094 | # Returns: nothing on success | |
3095 | # | |
3096 | # Since: 0.14.0 | |
b3ac5a0d MAL |
3097 | # |
3098 | # Notes: | |
3099 | # | |
3100 | # 1. The 'query-migrate' command should be used to check migration's progress | |
3101 | # and final result (this information is provided by the 'status' member) | |
3102 | # | |
3103 | # 2. All boolean arguments default to false | |
3104 | # | |
3105 | # 3. The user Monitor's "detach" argument is invalid in QMP and should not | |
3106 | # be used | |
3107 | # | |
3108 | # Example: | |
3109 | # | |
3110 | # -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } } | |
3111 | # <- { "return": {} } | |
3112 | # | |
e1c37d0e LC |
3113 | ## |
3114 | { 'command': 'migrate', | |
3115 | 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } } | |
33cf629a | 3116 | |
bf1ae1f4 | 3117 | ## |
5072f7b3 | 3118 | # @migrate-incoming: |
bf1ae1f4 DDAG |
3119 | # |
3120 | # Start an incoming migration, the qemu must have been started | |
3121 | # with -incoming defer | |
3122 | # | |
3123 | # @uri: The Uniform Resource Identifier identifying the source or | |
3124 | # address to listen on | |
3125 | # | |
3126 | # Returns: nothing on success | |
3127 | # | |
3128 | # Since: 2.3 | |
dbdbddb9 MAL |
3129 | # |
3130 | # Notes: | |
3131 | # | |
3132 | # 1. It's a bad idea to use a string for the uri, but it needs to stay | |
3133 | # compatible with -incoming and the format of the uri is already exposed | |
3134 | # above libvirt. | |
3135 | # | |
3136 | # 2. QEMU must be started with -incoming defer to allow migrate-incoming to | |
3137 | # be used. | |
3138 | # | |
3139 | # 3. The uri format is the same as for -incoming | |
3140 | # | |
3141 | # Example: | |
3142 | # | |
3143 | # -> { "execute": "migrate-incoming", | |
3144 | # "arguments": { "uri": "tcp::4446" } } | |
3145 | # <- { "return": {} } | |
3146 | # | |
bf1ae1f4 DDAG |
3147 | ## |
3148 | { 'command': 'migrate-incoming', 'data': {'uri': 'str' } } | |
3149 | ||
49687ace | 3150 | ## |
a7ae8355 SS |
3151 | # @xen-save-devices-state: |
3152 | # | |
3153 | # Save the state of all devices to file. The RAM and the block devices | |
3154 | # of the VM are not saved by this command. | |
3155 | # | |
3156 | # @filename: the file to save the state of the devices to as binary | |
3157 | # data. See xen-save-devices-state.txt for a description of the binary | |
3158 | # format. | |
3159 | # | |
3160 | # Returns: Nothing on success | |
a7ae8355 SS |
3161 | # |
3162 | # Since: 1.1 | |
2ea72beb MAL |
3163 | # |
3164 | # Example: | |
3165 | # | |
3166 | # -> { "execute": "xen-save-devices-state", | |
3167 | # "arguments": { "filename": "/tmp/save" } } | |
3168 | # <- { "return": {} } | |
3169 | # | |
a7ae8355 SS |
3170 | ## |
3171 | { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} } | |
a15fef21 | 3172 | |
39f42439 | 3173 | ## |
5072f7b3 | 3174 | # @xen-set-global-dirty-log: |
39f42439 AP |
3175 | # |
3176 | # Enable or disable the global dirty log mode. | |
3177 | # | |
3178 | # @enable: true to enable, false to disable. | |
3179 | # | |
3180 | # Returns: nothing | |
3181 | # | |
3182 | # Since: 1.3 | |
a4df6eff MAL |
3183 | # |
3184 | # Example: | |
3185 | # | |
3186 | # -> { "execute": "xen-set-global-dirty-log", | |
3187 | # "arguments": { "enable": true } } | |
3188 | # <- { "return": {} } | |
3189 | # | |
39f42439 AP |
3190 | ## |
3191 | { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } } | |
3192 | ||
94cfd07f MAL |
3193 | ## |
3194 | # @device_add: | |
3195 | # | |
3196 | # @driver: the name of the new device's driver | |
3197 | # | |
1d8bda12 | 3198 | # @bus: the device's parent bus (device tree path) |
94cfd07f | 3199 | # |
1d8bda12 | 3200 | # @id: the device's ID, must be unique |
94cfd07f MAL |
3201 | # |
3202 | # Additional arguments depend on the type. | |
3203 | # | |
3204 | # Add a device. | |
3205 | # | |
3206 | # Notes: | |
3207 | # 1. For detailed information about this command, please refer to the | |
3208 | # 'docs/qdev-device-use.txt' file. | |
3209 | # | |
3210 | # 2. It's possible to list device properties by running QEMU with the | |
3211 | # "-device DEVICE,help" command-line argument, where DEVICE is the | |
3212 | # device's name | |
3213 | # | |
3214 | # Example: | |
3215 | # | |
3216 | # -> { "execute": "device_add", | |
3217 | # "arguments": { "driver": "e1000", "id": "net1", | |
3218 | # "bus": "pci.0", | |
3219 | # "mac": "52:54:00:12:34:56" } } | |
3220 | # <- { "return": {} } | |
3221 | # | |
e22da431 | 3222 | # TODO: This command effectively bypasses QAPI completely due to its |
94cfd07f MAL |
3223 | # "additional arguments" business. It shouldn't have been added to |
3224 | # the schema in this form. It should be qapified properly, or | |
3225 | # replaced by a properly qapified command. | |
3226 | # | |
3227 | # Since: 0.13 | |
3228 | ## | |
3229 | { 'command': 'device_add', | |
b780e9c3 | 3230 | 'data': {'driver': 'str', '*bus': 'str', '*id': 'str'}, |
94cfd07f MAL |
3231 | 'gen': false } # so we can get the additional arguments |
3232 | ||
a15fef21 LC |
3233 | ## |
3234 | # @device_del: | |
3235 | # | |
3236 | # Remove a device from a guest | |
3237 | # | |
e389c004 | 3238 | # @id: the device's ID or QOM path |
a15fef21 LC |
3239 | # |
3240 | # Returns: Nothing on success | |
3241 | # If @id is not a valid device, DeviceNotFound | |
a15fef21 LC |
3242 | # |
3243 | # Notes: When this command completes, the device may not be removed from the | |
3244 | # guest. Hot removal is an operation that requires guest cooperation. | |
3245 | # This command merely requests that the guest begin the hot removal | |
0402a5d6 MT |
3246 | # process. Completion of the device removal process is signaled with a |
3247 | # DEVICE_DELETED event. Guest reset will automatically complete removal | |
3248 | # for all devices. | |
a15fef21 LC |
3249 | # |
3250 | # Since: 0.14.0 | |
e389c004 MAL |
3251 | # |
3252 | # Example: | |
3253 | # | |
3254 | # -> { "execute": "device_del", | |
3255 | # "arguments": { "id": "net1" } } | |
3256 | # <- { "return": {} } | |
3257 | # | |
3258 | # -> { "execute": "device_del", | |
3259 | # "arguments": { "id": "/machine/peripheral-anon/device[0]" } } | |
3260 | # <- { "return": {} } | |
3261 | # | |
a15fef21 LC |
3262 | ## |
3263 | { 'command': 'device_del', 'data': {'id': 'str'} } | |
783e9b48 | 3264 | |
b53ccc30 QN |
3265 | ## |
3266 | # @DumpGuestMemoryFormat: | |
3267 | # | |
3268 | # An enumeration of guest-memory-dump's format. | |
3269 | # | |
3270 | # @elf: elf format | |
3271 | # | |
3272 | # @kdump-zlib: kdump-compressed format with zlib-compressed | |
3273 | # | |
3274 | # @kdump-lzo: kdump-compressed format with lzo-compressed | |
3275 | # | |
3276 | # @kdump-snappy: kdump-compressed format with snappy-compressed | |
3277 | # | |
3278 | # Since: 2.0 | |
3279 | ## | |
3280 | { 'enum': 'DumpGuestMemoryFormat', | |
3281 | 'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] } | |
3282 | ||
783e9b48 | 3283 | ## |
5072f7b3 | 3284 | # @dump-guest-memory: |
783e9b48 WC |
3285 | # |
3286 | # Dump guest's memory to vmcore. It is a synchronous operation that can take | |
f1cd4830 | 3287 | # very long depending on the amount of guest memory. |
f5b0d93b LC |
3288 | # |
3289 | # @paging: if true, do paging to get guest's memory mapping. This allows | |
d691180e | 3290 | # using gdb to process the core file. |
f5b0d93b | 3291 | # |
d691180e LC |
3292 | # IMPORTANT: this option can make QEMU allocate several gigabytes |
3293 | # of RAM. This can happen for a large guest, or a | |
3294 | # malicious guest pretending to be large. | |
3295 | # | |
3296 | # Also, paging=true has the following limitations: | |
3297 | # | |
3298 | # 1. The guest may be in a catastrophic state or can have corrupted | |
3299 | # memory, which cannot be trusted | |
3300 | # 2. The guest can be in real-mode even if paging is enabled. For | |
3301 | # example, the guest uses ACPI to sleep, and ACPI sleep state | |
3302 | # goes in real-mode | |
f1cd4830 | 3303 | # 3. Currently only supported on i386 and x86_64. |
f5b0d93b | 3304 | # |
783e9b48 | 3305 | # @protocol: the filename or file descriptor of the vmcore. The supported |
d691180e | 3306 | # protocols are: |
f5b0d93b | 3307 | # |
d691180e LC |
3308 | # 1. file: the protocol starts with "file:", and the following |
3309 | # string is the file's path. | |
3310 | # 2. fd: the protocol starts with "fd:", and the following string | |
3311 | # is the fd's name. | |
f5b0d93b | 3312 | # |
1d8bda12 | 3313 | # @detach: if true, QMP will return immediately rather than |
39ba2ea6 PX |
3314 | # waiting for the dump to finish. The user can track progress |
3315 | # using "query-dump". (since 2.6). | |
228de9cf | 3316 | # |
1d8bda12 | 3317 | # @begin: if specified, the starting physical address. |
f5b0d93b | 3318 | # |
1d8bda12 | 3319 | # @length: if specified, the memory size, in bytes. If you don't |
d691180e LC |
3320 | # want to dump all guest's memory, please specify the start @begin |
3321 | # and @length | |
783e9b48 | 3322 | # |
1d8bda12 | 3323 | # @format: if specified, the format of guest memory dump. But non-elf |
b53ccc30 QN |
3324 | # format is conflict with paging and filter, ie. @paging, @begin and |
3325 | # @length is not allowed to be specified with non-elf @format at the | |
3326 | # same time (since 2.0) | |
3327 | # | |
58e4300a MAL |
3328 | # Note: All boolean arguments default to false |
3329 | # | |
783e9b48 | 3330 | # Returns: nothing on success |
783e9b48 WC |
3331 | # |
3332 | # Since: 1.2 | |
58e4300a MAL |
3333 | # |
3334 | # Example: | |
3335 | # | |
3336 | # -> { "execute": "dump-guest-memory", | |
3337 | # "arguments": { "protocol": "fd:dump" } } | |
3338 | # <- { "return": {} } | |
3339 | # | |
783e9b48 WC |
3340 | ## |
3341 | { 'command': 'dump-guest-memory', | |
228de9cf PX |
3342 | 'data': { 'paging': 'bool', 'protocol': 'str', '*detach': 'bool', |
3343 | '*begin': 'int', '*length': 'int', | |
3344 | '*format': 'DumpGuestMemoryFormat'} } | |
d691180e | 3345 | |
baf28f57 | 3346 | ## |
5072f7b3 | 3347 | # @DumpStatus: |
baf28f57 PX |
3348 | # |
3349 | # Describe the status of a long-running background guest memory dump. | |
3350 | # | |
3351 | # @none: no dump-guest-memory has started yet. | |
3352 | # | |
3353 | # @active: there is one dump running in background. | |
3354 | # | |
3355 | # @completed: the last dump has finished successfully. | |
3356 | # | |
3357 | # @failed: the last dump has failed. | |
3358 | # | |
5072f7b3 | 3359 | # Since: 2.6 |
baf28f57 PX |
3360 | ## |
3361 | { 'enum': 'DumpStatus', | |
3362 | 'data': [ 'none', 'active', 'completed', 'failed' ] } | |
3363 | ||
39ba2ea6 | 3364 | ## |
5072f7b3 | 3365 | # @DumpQueryResult: |
39ba2ea6 PX |
3366 | # |
3367 | # The result format for 'query-dump'. | |
3368 | # | |
3369 | # @status: enum of @DumpStatus, which shows current dump status | |
3370 | # | |
3371 | # @completed: bytes written in latest dump (uncompressed) | |
3372 | # | |
3373 | # @total: total bytes to be written in latest dump (uncompressed) | |
3374 | # | |
5072f7b3 | 3375 | # Since: 2.6 |
39ba2ea6 PX |
3376 | ## |
3377 | { 'struct': 'DumpQueryResult', | |
3378 | 'data': { 'status': 'DumpStatus', | |
3379 | 'completed': 'int', | |
3380 | 'total': 'int' } } | |
3381 | ||
3382 | ## | |
5072f7b3 | 3383 | # @query-dump: |
39ba2ea6 PX |
3384 | # |
3385 | # Query latest dump status. | |
3386 | # | |
3387 | # Returns: A @DumpStatus object showing the dump status. | |
3388 | # | |
3389 | # Since: 2.6 | |
926dce5c MAL |
3390 | # |
3391 | # Example: | |
3392 | # | |
3393 | # -> { "execute": "query-dump" } | |
3394 | # <- { "return": { "status": "active", "completed": 1024000, | |
3395 | # "total": 2048000 } } | |
3396 | # | |
39ba2ea6 PX |
3397 | ## |
3398 | { 'command': 'query-dump', 'returns': 'DumpQueryResult' } | |
3399 | ||
7d6dc7f3 QN |
3400 | ## |
3401 | # @DumpGuestMemoryCapability: | |
3402 | # | |
3403 | # A list of the available formats for dump-guest-memory | |
3404 | # | |
3405 | # Since: 2.0 | |
3406 | ## | |
895a2a80 | 3407 | { 'struct': 'DumpGuestMemoryCapability', |
7d6dc7f3 QN |
3408 | 'data': { |
3409 | 'formats': ['DumpGuestMemoryFormat'] } } | |
3410 | ||
3411 | ## | |
3412 | # @query-dump-guest-memory-capability: | |
3413 | # | |
3414 | # Returns the available formats for dump-guest-memory | |
3415 | # | |
3416 | # Returns: A @DumpGuestMemoryCapability object listing available formats for | |
3417 | # dump-guest-memory | |
3418 | # | |
3419 | # Since: 2.0 | |
2ccb9803 MAL |
3420 | # |
3421 | # Example: | |
3422 | # | |
3423 | # -> { "execute": "query-dump-guest-memory-capability" } | |
3424 | # <- { "return": { "formats": | |
3425 | # ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] } | |
3426 | # | |
7d6dc7f3 QN |
3427 | ## |
3428 | { 'command': 'query-dump-guest-memory-capability', | |
3429 | 'returns': 'DumpGuestMemoryCapability' } | |
d691180e | 3430 | |
7ee0c3e3 | 3431 | ## |
5072f7b3 | 3432 | # @dump-skeys: |
7ee0c3e3 JH |
3433 | # |
3434 | # Dump guest's storage keys | |
3435 | # | |
3436 | # @filename: the path to the file to dump to | |
3437 | # | |
3438 | # This command is only supported on s390 architecture. | |
3439 | # | |
3440 | # Since: 2.5 | |
ee332b51 MAL |
3441 | # |
3442 | # Example: | |
3443 | # | |
3444 | # -> { "execute": "dump-skeys", | |
3445 | # "arguments": { "filename": "/tmp/skeys" } } | |
3446 | # <- { "return": {} } | |
3447 | # | |
7ee0c3e3 JH |
3448 | ## |
3449 | { 'command': 'dump-skeys', | |
3450 | 'data': { 'filename': 'str' } } | |
3451 | ||
928059a3 LC |
3452 | ## |
3453 | # @netdev_add: | |
3454 | # | |
3455 | # Add a network backend. | |
3456 | # | |
3457 | # @type: the type of network backend. Current valid values are 'user', 'tap', | |
3458 | # 'vde', 'socket', 'dump' and 'bridge' | |
3459 | # | |
3460 | # @id: the name of the new network backend | |
3461 | # | |
b8a98326 | 3462 | # Additional arguments depend on the type. |
928059a3 | 3463 | # |
e22da431 | 3464 | # TODO: This command effectively bypasses QAPI completely due to its |
b8a98326 MA |
3465 | # "additional arguments" business. It shouldn't have been added to |
3466 | # the schema in this form. It should be qapified properly, or | |
3467 | # replaced by a properly qapified command. | |
928059a3 LC |
3468 | # |
3469 | # Since: 0.14.0 | |
3470 | # | |
3471 | # Returns: Nothing on success | |
3472 | # If @type is not a valid network backend, DeviceNotFound | |
aa72941b MAL |
3473 | # |
3474 | # Example: | |
3475 | # | |
3476 | # -> { "execute": "netdev_add", | |
3477 | # "arguments": { "type": "user", "id": "netdev1", | |
3478 | # "dnssearch": "example.org" } } | |
3479 | # <- { "return": {} } | |
3480 | # | |
928059a3 LC |
3481 | ## |
3482 | { 'command': 'netdev_add', | |
b8a98326 MA |
3483 | 'data': {'type': 'str', 'id': 'str'}, |
3484 | 'gen': false } # so we can get the additional arguments | |
5f964155 LC |
3485 | |
3486 | ## | |
3487 | # @netdev_del: | |
3488 | # | |
3489 | # Remove a network backend. | |
3490 | # | |
3491 | # @id: the name of the network backend to remove | |
3492 | # | |
3493 | # Returns: Nothing on success | |
3494 | # If @id is not a valid network backend, DeviceNotFound | |
3495 | # | |
3496 | # Since: 0.14.0 | |
d071f6be MAL |
3497 | # |
3498 | # Example: | |
3499 | # | |
3500 | # -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } } | |
3501 | # <- { "return": {} } | |
3502 | # | |
5f964155 LC |
3503 | ## |
3504 | { 'command': 'netdev_del', 'data': {'id': 'str'} } | |
208c9d1b | 3505 | |
cff8b2c6 PB |
3506 | ## |
3507 | # @object-add: | |
3508 | # | |
3509 | # Create a QOM object. | |
3510 | # | |
3511 | # @qom-type: the class name for the object to be created | |
3512 | # | |
3513 | # @id: the name of the new object | |
3514 | # | |
1d8bda12 | 3515 | # @props: a dictionary of properties to be passed to the backend |
cff8b2c6 PB |
3516 | # |
3517 | # Returns: Nothing on success | |
3518 | # Error if @qom-type is not a valid class name | |
3519 | # | |
3520 | # Since: 2.0 | |
6517192b MAL |
3521 | # |
3522 | # Example: | |
3523 | # | |
3524 | # -> { "execute": "object-add", | |
3525 | # "arguments": { "qom-type": "rng-random", "id": "rng1", | |
3526 | # "props": { "filename": "/dev/hwrng" } } } | |
3527 | # <- { "return": {} } | |
3528 | # | |
cff8b2c6 PB |
3529 | ## |
3530 | { 'command': 'object-add', | |
6eb3937e | 3531 | 'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} } |
cff8b2c6 | 3532 | |
ab2d0531 PB |
3533 | ## |
3534 | # @object-del: | |
3535 | # | |
3536 | # Remove a QOM object. | |
3537 | # | |
3538 | # @id: the name of the QOM object to remove | |
3539 | # | |
3540 | # Returns: Nothing on success | |
3541 | # Error if @id is not a valid id for a QOM object | |
3542 | # | |
3543 | # Since: 2.0 | |
de0ba662 MAL |
3544 | # |
3545 | # Example: | |
3546 | # | |
3547 | # -> { "execute": "object-del", "arguments": { "id": "rng1" } } | |
3548 | # <- { "return": {} } | |
3549 | # | |
ab2d0531 PB |
3550 | ## |
3551 | { 'command': 'object-del', 'data': {'id': 'str'} } | |
3552 | ||
14aa0c2d | 3553 | ## |
5072f7b3 | 3554 | # @NetdevNoneOptions: |
14aa0c2d LE |
3555 | # |
3556 | # Use it alone to have zero network devices. | |
3557 | # | |
5072f7b3 | 3558 | # Since: 1.2 |
14aa0c2d | 3559 | ## |
895a2a80 | 3560 | { 'struct': 'NetdevNoneOptions', |
14aa0c2d LE |
3561 | 'data': { } } |
3562 | ||
3563 | ## | |
5072f7b3 | 3564 | # @NetLegacyNicOptions: |
14aa0c2d LE |
3565 | # |
3566 | # Create a new Network Interface Card. | |
3567 | # | |
1d8bda12 | 3568 | # @netdev: id of -netdev to connect to |
14aa0c2d | 3569 | # |
1d8bda12 | 3570 | # @macaddr: MAC address |
14aa0c2d | 3571 | # |
1d8bda12 | 3572 | # @model: device model (e1000, rtl8139, virtio etc.) |
14aa0c2d | 3573 | # |
1d8bda12 | 3574 | # @addr: PCI device address |
14aa0c2d | 3575 | # |
1d8bda12 | 3576 | # @vectors: number of MSI-x vectors, 0 to disable MSI-X |
14aa0c2d | 3577 | # |
5072f7b3 | 3578 | # Since: 1.2 |
14aa0c2d | 3579 | ## |
895a2a80 | 3580 | { 'struct': 'NetLegacyNicOptions', |
14aa0c2d LE |
3581 | 'data': { |
3582 | '*netdev': 'str', | |
3583 | '*macaddr': 'str', | |
3584 | '*model': 'str', | |
3585 | '*addr': 'str', | |
3586 | '*vectors': 'uint32' } } | |
3587 | ||
3588 | ## | |
5072f7b3 | 3589 | # @String: |
14aa0c2d LE |
3590 | # |
3591 | # A fat type wrapping 'str', to be embedded in lists. | |
3592 | # | |
5072f7b3 | 3593 | # Since: 1.2 |
14aa0c2d | 3594 | ## |
895a2a80 | 3595 | { 'struct': 'String', |
14aa0c2d LE |
3596 | 'data': { |
3597 | 'str': 'str' } } | |
3598 | ||
3599 | ## | |
5072f7b3 | 3600 | # @NetdevUserOptions: |
14aa0c2d LE |
3601 | # |
3602 | # Use the user mode network stack which requires no administrator privilege to | |
3603 | # run. | |
3604 | # | |
1d8bda12 | 3605 | # @hostname: client hostname reported by the builtin DHCP server |
14aa0c2d | 3606 | # |
1d8bda12 | 3607 | # @restrict: isolate the guest from the host |
14aa0c2d | 3608 | # |
1d8bda12 | 3609 | # @ipv4: whether to support IPv4, default true for enabled |
0b11c036 ST |
3610 | # (since 2.6) |
3611 | # | |
1d8bda12 | 3612 | # @ipv6: whether to support IPv6, default true for enabled |
0b11c036 ST |
3613 | # (since 2.6) |
3614 | # | |
1d8bda12 | 3615 | # @ip: legacy parameter, use net= instead |
14aa0c2d | 3616 | # |
1d8bda12 | 3617 | # @net: IP network address that the guest will see, in the |
d8eb3864 ST |
3618 | # form addr[/netmask] The netmask is optional, and can be |
3619 | # either in the form a.b.c.d or as a number of valid top-most | |
3620 | # bits. Default is 10.0.2.0/24. | |
14aa0c2d | 3621 | # |
1d8bda12 | 3622 | # @host: guest-visible address of the host |
14aa0c2d | 3623 | # |
1d8bda12 | 3624 | # @tftp: root directory of the built-in TFTP server |
14aa0c2d | 3625 | # |
1d8bda12 | 3626 | # @bootfile: BOOTP filename, for use with tftp= |
14aa0c2d | 3627 | # |
1d8bda12 | 3628 | # @dhcpstart: the first of the 16 IPs the built-in DHCP server can |
14aa0c2d LE |
3629 | # assign |
3630 | # | |
1d8bda12 | 3631 | # @dns: guest-visible address of the virtual nameserver |
14aa0c2d | 3632 | # |
1d8bda12 | 3633 | # @dnssearch: list of DNS suffixes to search, passed as DHCP option |
63d2960b KS |
3634 | # to the guest |
3635 | # | |
1d8bda12 | 3636 | # @ipv6-prefix: IPv6 network prefix (default is fec0::) (since |
d8eb3864 ST |
3637 | # 2.6). The network prefix is given in the usual |
3638 | # hexadecimal IPv6 address notation. | |
7aac531e | 3639 | # |
1d8bda12 | 3640 | # @ipv6-prefixlen: IPv6 network prefix length (default is 64) |
d8eb3864 | 3641 | # (since 2.6) |
7aac531e | 3642 | # |
1d8bda12 | 3643 | # @ipv6-host: guest-visible IPv6 address of the host (since 2.6) |
7aac531e | 3644 | # |
1d8bda12 | 3645 | # @ipv6-dns: guest-visible IPv6 address of the virtual |
d8eb3864 | 3646 | # nameserver (since 2.6) |
7aac531e | 3647 | # |
1d8bda12 | 3648 | # @smb: root directory of the built-in SMB server |
14aa0c2d | 3649 | # |
1d8bda12 | 3650 | # @smbserver: IP address of the built-in SMB server |
14aa0c2d | 3651 | # |
1d8bda12 | 3652 | # @hostfwd: redirect incoming TCP or UDP host connections to guest |
14aa0c2d LE |
3653 | # endpoints |
3654 | # | |
1d8bda12 | 3655 | # @guestfwd: forward guest TCP connections |
14aa0c2d | 3656 | # |
5072f7b3 | 3657 | # Since: 1.2 |
14aa0c2d | 3658 | ## |
895a2a80 | 3659 | { 'struct': 'NetdevUserOptions', |
14aa0c2d LE |
3660 | 'data': { |
3661 | '*hostname': 'str', | |
3662 | '*restrict': 'bool', | |
0b11c036 ST |
3663 | '*ipv4': 'bool', |
3664 | '*ipv6': 'bool', | |
14aa0c2d LE |
3665 | '*ip': 'str', |
3666 | '*net': 'str', | |
3667 | '*host': 'str', | |
3668 | '*tftp': 'str', | |
3669 | '*bootfile': 'str', | |
3670 | '*dhcpstart': 'str', | |
3671 | '*dns': 'str', | |
63d2960b | 3672 | '*dnssearch': ['String'], |
d8eb3864 ST |
3673 | '*ipv6-prefix': 'str', |
3674 | '*ipv6-prefixlen': 'int', | |
3675 | '*ipv6-host': 'str', | |
3676 | '*ipv6-dns': 'str', | |
14aa0c2d LE |
3677 | '*smb': 'str', |
3678 | '*smbserver': 'str', | |
3679 | '*hostfwd': ['String'], | |
3680 | '*guestfwd': ['String'] } } | |
3681 | ||
3682 | ## | |
5072f7b3 | 3683 | # @NetdevTapOptions: |
14aa0c2d LE |
3684 | # |
3685 | # Connect the host TAP network interface name to the VLAN. | |
3686 | # | |
1d8bda12 | 3687 | # @ifname: interface name |
14aa0c2d | 3688 | # |
1d8bda12 | 3689 | # @fd: file descriptor of an already opened tap |
14aa0c2d | 3690 | # |
1d8bda12 | 3691 | # @fds: multiple file descriptors of already opened multiqueue capable |
2ca81baa JW |
3692 | # tap |
3693 | # | |
1d8bda12 | 3694 | # @script: script to initialize the interface |
14aa0c2d | 3695 | # |
1d8bda12 | 3696 | # @downscript: script to shut down the interface |
14aa0c2d | 3697 | # |
1d8bda12 | 3698 | # @br: bridge name (since 2.8) |
584613ea | 3699 | # |
1d8bda12 | 3700 | # @helper: command to execute to configure bridge |
14aa0c2d | 3701 | # |
1d8bda12 | 3702 | # @sndbuf: send buffer limit. Understands [TGMKkb] suffixes. |
14aa0c2d | 3703 | # |
1d8bda12 | 3704 | # @vnet_hdr: enable the IFF_VNET_HDR flag on the tap interface |
14aa0c2d | 3705 | # |
1d8bda12 | 3706 | # @vhost: enable vhost-net network accelerator |
14aa0c2d | 3707 | # |
1d8bda12 | 3708 | # @vhostfd: file descriptor of an already opened vhost net device |
14aa0c2d | 3709 | # |
1d8bda12 | 3710 | # @vhostfds: file descriptors of multiple already opened vhost net |
2ca81baa JW |
3711 | # devices |
3712 | # | |
1d8bda12 | 3713 | # @vhostforce: vhost on for non-MSIX virtio guests |
14aa0c2d | 3714 | # |
1d8bda12 | 3715 | # @queues: number of queues to be created for multiqueue capable tap |
ec396014 | 3716 | # |
1d8bda12 | 3717 | # @poll-us: maximum number of microseconds that could |
69e87b32 JW |
3718 | # be spent on busy polling for tap (since 2.7) |
3719 | # | |
5072f7b3 | 3720 | # Since: 1.2 |
14aa0c2d | 3721 | ## |
895a2a80 | 3722 | { 'struct': 'NetdevTapOptions', |
14aa0c2d LE |
3723 | 'data': { |
3724 | '*ifname': 'str', | |
3725 | '*fd': 'str', | |
264986e2 | 3726 | '*fds': 'str', |
14aa0c2d LE |
3727 | '*script': 'str', |
3728 | '*downscript': 'str', | |
584613ea | 3729 | '*br': 'str', |
14aa0c2d LE |
3730 | '*helper': 'str', |
3731 | '*sndbuf': 'size', | |
3732 | '*vnet_hdr': 'bool', | |
3733 | '*vhost': 'bool', | |
3734 | '*vhostfd': 'str', | |
264986e2 JW |
3735 | '*vhostfds': 'str', |
3736 | '*vhostforce': 'bool', | |
69e87b32 JW |
3737 | '*queues': 'uint32', |
3738 | '*poll-us': 'uint32'} } | |
14aa0c2d LE |
3739 | |
3740 | ## | |
5072f7b3 | 3741 | # @NetdevSocketOptions: |
14aa0c2d LE |
3742 | # |
3743 | # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP | |
3744 | # socket connection. | |
3745 | # | |
1d8bda12 | 3746 | # @fd: file descriptor of an already opened socket |
14aa0c2d | 3747 | # |
1d8bda12 | 3748 | # @listen: port number, and optional hostname, to listen on |
14aa0c2d | 3749 | # |
1d8bda12 | 3750 | # @connect: port number, and optional hostname, to connect to |
14aa0c2d | 3751 | # |
1d8bda12 | 3752 | # @mcast: UDP multicast address and port number |
14aa0c2d | 3753 | # |
1d8bda12 | 3754 | # @localaddr: source address and port for multicast and udp packets |
14aa0c2d | 3755 | # |
1d8bda12 | 3756 | # @udp: UDP unicast address and port number |
14aa0c2d | 3757 | # |
5072f7b3 | 3758 | # Since: 1.2 |
14aa0c2d | 3759 | ## |
895a2a80 | 3760 | { 'struct': 'NetdevSocketOptions', |
14aa0c2d LE |
3761 | 'data': { |
3762 | '*fd': 'str', | |
3763 | '*listen': 'str', | |
3764 | '*connect': 'str', | |
3765 | '*mcast': 'str', | |
3766 | '*localaddr': 'str', | |
3767 | '*udp': 'str' } } | |
3768 | ||
3fb69aa1 | 3769 | ## |
5072f7b3 | 3770 | # @NetdevL2TPv3Options: |
3fb69aa1 AI |
3771 | # |
3772 | # Connect the VLAN to Ethernet over L2TPv3 Static tunnel | |
3773 | # | |
3774 | # @src: source address | |
3775 | # | |
3776 | # @dst: destination address | |
3777 | # | |
1d8bda12 | 3778 | # @srcport: source port - mandatory for udp, optional for ip |
3fb69aa1 | 3779 | # |
1d8bda12 | 3780 | # @dstport: destination port - mandatory for udp, optional for ip |
3fb69aa1 | 3781 | # |
1d8bda12 | 3782 | # @ipv6: force the use of ipv6 |
3fb69aa1 | 3783 | # |
1d8bda12 | 3784 | # @udp: use the udp version of l2tpv3 encapsulation |
3fb69aa1 | 3785 | # |
1d8bda12 | 3786 | # @cookie64: use 64 bit coookies |
3fb69aa1 | 3787 | # |
1d8bda12 | 3788 | # @counter: have sequence counter |
3fb69aa1 | 3789 | # |
1d8bda12 | 3790 | # @pincounter: pin sequence counter to zero - |
3fb69aa1 AI |
3791 | # workaround for buggy implementations or |
3792 | # networks with packet reorder | |
3793 | # | |
1d8bda12 | 3794 | # @txcookie: 32 or 64 bit transmit cookie |
3fb69aa1 | 3795 | # |
1d8bda12 | 3796 | # @rxcookie: 32 or 64 bit receive cookie |
3fb69aa1 AI |
3797 | # |
3798 | # @txsession: 32 bit transmit session | |
3799 | # | |
1d8bda12 | 3800 | # @rxsession: 32 bit receive session - if not specified |
3fb69aa1 AI |
3801 | # set to the same value as transmit |
3802 | # | |
1d8bda12 | 3803 | # @offset: additional offset - allows the insertion of |
3fb69aa1 AI |
3804 | # additional application-specific data before the packet payload |
3805 | # | |
5072f7b3 | 3806 | # Since: 2.1 |
3fb69aa1 | 3807 | ## |
895a2a80 | 3808 | { 'struct': 'NetdevL2TPv3Options', |
3fb69aa1 AI |
3809 | 'data': { |
3810 | 'src': 'str', | |
3811 | 'dst': 'str', | |
3812 | '*srcport': 'str', | |
3813 | '*dstport': 'str', | |
3814 | '*ipv6': 'bool', | |
3815 | '*udp': 'bool', | |
3816 | '*cookie64': 'bool', | |
3817 | '*counter': 'bool', | |
3818 | '*pincounter': 'bool', | |
3819 | '*txcookie': 'uint64', | |
3820 | '*rxcookie': 'uint64', | |
3821 | 'txsession': 'uint32', | |
3822 | '*rxsession': 'uint32', | |
3823 | '*offset': 'uint32' } } | |
3824 | ||
14aa0c2d | 3825 | ## |
5072f7b3 | 3826 | # @NetdevVdeOptions: |
14aa0c2d LE |
3827 | # |
3828 | # Connect the VLAN to a vde switch running on the host. | |
3829 | # | |
1d8bda12 | 3830 | # @sock: socket path |
14aa0c2d | 3831 | # |
1d8bda12 | 3832 | # @port: port number |
14aa0c2d | 3833 | # |
1d8bda12 | 3834 | # @group: group owner of socket |
14aa0c2d | 3835 | # |
1d8bda12 | 3836 | # @mode: permissions for socket |
14aa0c2d | 3837 | # |
5072f7b3 | 3838 | # Since: 1.2 |
14aa0c2d | 3839 | ## |
895a2a80 | 3840 | { 'struct': 'NetdevVdeOptions', |
14aa0c2d LE |
3841 | 'data': { |
3842 | '*sock': 'str', | |
3843 | '*port': 'uint16', | |
3844 | '*group': 'str', | |
3845 | '*mode': 'uint16' } } | |
3846 | ||
3847 | ## | |
5072f7b3 | 3848 | # @NetdevDumpOptions: |
14aa0c2d LE |
3849 | # |
3850 | # Dump VLAN network traffic to a file. | |
3851 | # | |
1d8bda12 | 3852 | # @len: per-packet size limit (64k default). Understands [TGMKkb] |
14aa0c2d LE |
3853 | # suffixes. |
3854 | # | |
1d8bda12 | 3855 | # @file: dump file path (default is qemu-vlan0.pcap) |
14aa0c2d | 3856 | # |
5072f7b3 | 3857 | # Since: 1.2 |
14aa0c2d | 3858 | ## |
895a2a80 | 3859 | { 'struct': 'NetdevDumpOptions', |
14aa0c2d LE |
3860 | 'data': { |
3861 | '*len': 'size', | |
3862 | '*file': 'str' } } | |
3863 | ||
3864 | ## | |
5072f7b3 | 3865 | # @NetdevBridgeOptions: |
14aa0c2d LE |
3866 | # |
3867 | # Connect a host TAP network interface to a host bridge device. | |
3868 | # | |
1d8bda12 | 3869 | # @br: bridge name |
14aa0c2d | 3870 | # |
1d8bda12 | 3871 | # @helper: command to execute to configure bridge |
14aa0c2d | 3872 | # |
5072f7b3 | 3873 | # Since: 1.2 |
14aa0c2d | 3874 | ## |
895a2a80 | 3875 | { 'struct': 'NetdevBridgeOptions', |
14aa0c2d LE |
3876 | 'data': { |
3877 | '*br': 'str', | |
3878 | '*helper': 'str' } } | |
3879 | ||
f6c874e3 | 3880 | ## |
5072f7b3 | 3881 | # @NetdevHubPortOptions: |
f6c874e3 SH |
3882 | # |
3883 | # Connect two or more net clients through a software hub. | |
3884 | # | |
3885 | # @hubid: hub identifier number | |
3886 | # | |
5072f7b3 | 3887 | # Since: 1.2 |
f6c874e3 | 3888 | ## |
895a2a80 | 3889 | { 'struct': 'NetdevHubPortOptions', |
f6c874e3 SH |
3890 | 'data': { |
3891 | 'hubid': 'int32' } } | |
3892 | ||
58952137 | 3893 | ## |
5072f7b3 | 3894 | # @NetdevNetmapOptions: |
58952137 VM |
3895 | # |
3896 | # Connect a client to a netmap-enabled NIC or to a VALE switch port | |
3897 | # | |
3898 | # @ifname: Either the name of an existing network interface supported by | |
3899 | # netmap, or the name of a VALE port (created on the fly). | |
3900 | # A VALE port name is in the form 'valeXXX:YYY', where XXX and | |
3901 | # YYY are non-negative integers. XXX identifies a switch and | |
3902 | # YYY identifies a port of the switch. VALE ports having the | |
3903 | # same XXX are therefore connected to the same switch. | |
3904 | # | |
1d8bda12 | 3905 | # @devname: path of the netmap device (default: '/dev/netmap'). |
58952137 | 3906 | # |
5072f7b3 | 3907 | # Since: 2.0 |
58952137 | 3908 | ## |
895a2a80 | 3909 | { 'struct': 'NetdevNetmapOptions', |
58952137 VM |
3910 | 'data': { |
3911 | 'ifname': 'str', | |
3912 | '*devname': 'str' } } | |
3913 | ||
03ce5744 | 3914 | ## |
5072f7b3 | 3915 | # @NetdevVhostUserOptions: |
03ce5744 NN |
3916 | # |
3917 | # Vhost-user network backend | |
3918 | # | |
3919 | # @chardev: name of a unix socket chardev | |
3920 | # | |
1d8bda12 | 3921 | # @vhostforce: vhost on for non-MSIX virtio guests (default: false). |
03ce5744 | 3922 | # |
1d8bda12 | 3923 | # @queues: number of queues to be created for multiqueue vhost-user |
b931bfbf CO |
3924 | # (default: 1) (Since 2.5) |
3925 | # | |
5072f7b3 | 3926 | # Since: 2.1 |
03ce5744 | 3927 | ## |
895a2a80 | 3928 | { 'struct': 'NetdevVhostUserOptions', |
03ce5744 NN |
3929 | 'data': { |
3930 | 'chardev': 'str', | |
b931bfbf CO |
3931 | '*vhostforce': 'bool', |
3932 | '*queues': 'int' } } | |
03ce5744 | 3933 | |
14aa0c2d | 3934 | ## |
5072f7b3 | 3935 | # @NetClientDriver: |
14aa0c2d | 3936 | # |
f394b2e2 EB |
3937 | # Available netdev drivers. |
3938 | # | |
5072f7b3 | 3939 | # Since: 2.7 |
f394b2e2 EB |
3940 | ## |
3941 | { 'enum': 'NetClientDriver', | |
3942 | 'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde', 'dump', | |
3943 | 'bridge', 'hubport', 'netmap', 'vhost-user' ] } | |
3944 | ||
3945 | ## | |
5072f7b3 | 3946 | # @Netdev: |
f394b2e2 EB |
3947 | # |
3948 | # Captures the configuration of a network device. | |
3949 | # | |
3950 | # @id: identifier for monitor commands. | |
3951 | # | |
3952 | # @type: Specify the driver used for interpreting remaining arguments. | |
14aa0c2d | 3953 | # |
5072f7b3 | 3954 | # Since: 1.2 |
3fb69aa1 AI |
3955 | # |
3956 | # 'l2tpv3' - since 2.1 | |
14aa0c2d | 3957 | ## |
f394b2e2 EB |
3958 | { 'union': 'Netdev', |
3959 | 'base': { 'id': 'str', 'type': 'NetClientDriver' }, | |
3960 | 'discriminator': 'type', | |
14aa0c2d | 3961 | 'data': { |
f6c874e3 SH |
3962 | 'none': 'NetdevNoneOptions', |
3963 | 'nic': 'NetLegacyNicOptions', | |
3964 | 'user': 'NetdevUserOptions', | |
3965 | 'tap': 'NetdevTapOptions', | |
3fb69aa1 | 3966 | 'l2tpv3': 'NetdevL2TPv3Options', |
f6c874e3 SH |
3967 | 'socket': 'NetdevSocketOptions', |
3968 | 'vde': 'NetdevVdeOptions', | |
3969 | 'dump': 'NetdevDumpOptions', | |
3970 | 'bridge': 'NetdevBridgeOptions', | |
58952137 | 3971 | 'hubport': 'NetdevHubPortOptions', |
03ce5744 NN |
3972 | 'netmap': 'NetdevNetmapOptions', |
3973 | 'vhost-user': 'NetdevVhostUserOptions' } } | |
14aa0c2d LE |
3974 | |
3975 | ## | |
5072f7b3 | 3976 | # @NetLegacy: |
14aa0c2d LE |
3977 | # |
3978 | # Captures the configuration of a network device; legacy. | |
3979 | # | |
1d8bda12 | 3980 | # @vlan: vlan number |
14aa0c2d | 3981 | # |
1d8bda12 | 3982 | # @id: identifier for monitor commands |
14aa0c2d | 3983 | # |
1d8bda12 | 3984 | # @name: identifier for monitor commands, ignored if @id is present |
14aa0c2d LE |
3985 | # |
3986 | # @opts: device type specific properties (legacy) | |
3987 | # | |
5072f7b3 | 3988 | # Since: 1.2 |
14aa0c2d | 3989 | ## |
895a2a80 | 3990 | { 'struct': 'NetLegacy', |
14aa0c2d LE |
3991 | 'data': { |
3992 | '*vlan': 'int32', | |
3993 | '*id': 'str', | |
3994 | '*name': 'str', | |
f394b2e2 | 3995 | 'opts': 'NetLegacyOptions' } } |
14aa0c2d | 3996 | |
d3be4b57 MA |
3997 | ## |
3998 | # @NetLegacyOptionsType: | |
3999 | # | |
4000 | # Since: 1.2 | |
4001 | ## | |
4002 | { 'enum': 'NetLegacyOptionsType', | |
4003 | 'data': ['none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde', | |
4004 | 'dump', 'bridge', 'netmap', 'vhost-user'] } | |
4005 | ||
14aa0c2d | 4006 | ## |
5072f7b3 | 4007 | # @NetLegacyOptions: |
14aa0c2d | 4008 | # |
f394b2e2 | 4009 | # Like Netdev, but for use only by the legacy command line options |
14aa0c2d | 4010 | # |
5072f7b3 | 4011 | # Since: 1.2 |
14aa0c2d | 4012 | ## |
f394b2e2 | 4013 | { 'union': 'NetLegacyOptions', |
d3be4b57 MA |
4014 | 'base': { 'type': 'NetLegacyOptionsType' }, |
4015 | 'discriminator': 'type', | |
14aa0c2d | 4016 | 'data': { |
f394b2e2 EB |
4017 | 'none': 'NetdevNoneOptions', |
4018 | 'nic': 'NetLegacyNicOptions', | |
4019 | 'user': 'NetdevUserOptions', | |
4020 | 'tap': 'NetdevTapOptions', | |
4021 | 'l2tpv3': 'NetdevL2TPv3Options', | |
4022 | 'socket': 'NetdevSocketOptions', | |
4023 | 'vde': 'NetdevVdeOptions', | |
4024 | 'dump': 'NetdevDumpOptions', | |
4025 | 'bridge': 'NetdevBridgeOptions', | |
4026 | 'netmap': 'NetdevNetmapOptions', | |
4027 | 'vhost-user': 'NetdevVhostUserOptions' } } | |
14aa0c2d | 4028 | |
fdccce45 | 4029 | ## |
5072f7b3 | 4030 | # @NetFilterDirection: |
fdccce45 YH |
4031 | # |
4032 | # Indicates whether a netfilter is attached to a netdev's transmit queue or | |
4033 | # receive queue or both. | |
4034 | # | |
4035 | # @all: the filter is attached both to the receive and the transmit | |
4036 | # queue of the netdev (default). | |
4037 | # | |
4038 | # @rx: the filter is attached to the receive queue of the netdev, | |
4039 | # where it will receive packets sent to the netdev. | |
4040 | # | |
4041 | # @tx: the filter is attached to the transmit queue of the netdev, | |
4042 | # where it will receive packets sent by the netdev. | |
4043 | # | |
5072f7b3 | 4044 | # Since: 2.5 |
fdccce45 YH |
4045 | ## |
4046 | { 'enum': 'NetFilterDirection', | |
4047 | 'data': [ 'all', 'rx', 'tx' ] } | |
4048 | ||
5be8c759 | 4049 | ## |
5072f7b3 | 4050 | # @InetSocketAddress: |
5be8c759 PB |
4051 | # |
4052 | # Captures a socket address or address range in the Internet namespace. | |
4053 | # | |
4054 | # @host: host part of the address | |
4055 | # | |
2ea1793b | 4056 | # @port: port part of the address, or lowest port if @to is present |
5be8c759 | 4057 | # |
1d8bda12 | 4058 | # @numeric: true if the host/port are guaranteed to be numeric, |
6979a813 DB |
4059 | # false if name resolution should be attempted. Defaults to false. |
4060 | # (Since 2.9) | |
4061 | # | |
5be8c759 PB |
4062 | # @to: highest port to try |
4063 | # | |
4064 | # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6 | |
5be8c759 PB |
4065 | # |
4066 | # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6 | |
5be8c759 | 4067 | # |
5072f7b3 | 4068 | # Since: 1.3 |
5be8c759 | 4069 | ## |
895a2a80 | 4070 | { 'struct': 'InetSocketAddress', |
5be8c759 PB |
4071 | 'data': { |
4072 | 'host': 'str', | |
2ea1793b | 4073 | 'port': 'str', |
6979a813 | 4074 | '*numeric': 'bool', |
5be8c759 PB |
4075 | '*to': 'uint16', |
4076 | '*ipv4': 'bool', | |
4077 | '*ipv6': 'bool' } } | |
4078 | ||
4079 | ## | |
5072f7b3 | 4080 | # @UnixSocketAddress: |
5be8c759 PB |
4081 | # |
4082 | # Captures a socket address in the local ("Unix socket") namespace. | |
4083 | # | |
4084 | # @path: filesystem path to use | |
4085 | # | |
5072f7b3 | 4086 | # Since: 1.3 |
5be8c759 | 4087 | ## |
895a2a80 | 4088 | { 'struct': 'UnixSocketAddress', |
5be8c759 PB |
4089 | 'data': { |
4090 | 'path': 'str' } } | |
4091 | ||
6a02c806 | 4092 | ## |
5072f7b3 | 4093 | # @VsockSocketAddress: |
6a02c806 SH |
4094 | # |
4095 | # Captures a socket address in the vsock namespace. | |
4096 | # | |
4097 | # @cid: unique host identifier | |
4098 | # @port: port | |
4099 | # | |
5072f7b3 | 4100 | # Note: string types are used to allow for possible future hostname or |
6a02c806 SH |
4101 | # service resolution support. |
4102 | # | |
5072f7b3 | 4103 | # Since: 2.8 |
6a02c806 SH |
4104 | ## |
4105 | { 'struct': 'VsockSocketAddress', | |
4106 | 'data': { | |
4107 | 'cid': 'str', | |
4108 | 'port': 'str' } } | |
4109 | ||
5be8c759 | 4110 | ## |
5072f7b3 | 4111 | # @SocketAddress: |
5be8c759 PB |
4112 | # |
4113 | # Captures the address of a socket, which could also be a named file descriptor | |
4114 | # | |
5072f7b3 | 4115 | # Since: 1.3 |
5be8c759 PB |
4116 | ## |
4117 | { 'union': 'SocketAddress', | |
4118 | 'data': { | |
4119 | 'inet': 'InetSocketAddress', | |
4120 | 'unix': 'UnixSocketAddress', | |
6a02c806 | 4121 | 'vsock': 'VsockSocketAddress', |
5be8c759 PB |
4122 | 'fd': 'String' } } |
4123 | ||
2b733709 MA |
4124 | ## |
4125 | # @SocketAddressFlatType: | |
4126 | # | |
4127 | # Available SocketAddressFlat types | |
4128 | # | |
c5f1ae3a | 4129 | # @inet: Internet address |
2b733709 MA |
4130 | # |
4131 | # @unix: Unix domain socket | |
4132 | # | |
4133 | # Since: 2.9 | |
4134 | ## | |
4135 | { 'enum': 'SocketAddressFlatType', | |
c5f1ae3a | 4136 | 'data': [ 'unix', 'inet' ] } |
2b733709 MA |
4137 | |
4138 | ## | |
4139 | # @SocketAddressFlat: | |
4140 | # | |
4141 | # Captures the address of a socket | |
4142 | # | |
4143 | # @type: Transport type | |
4144 | # | |
4145 | # This is similar to SocketAddress, only distinction: | |
4146 | # | |
4147 | # 1. SocketAddressFlat is a flat union, SocketAddress is a simple union. | |
4148 | # A flat union is nicer than simple because it avoids nesting | |
4149 | # (i.e. more {}) on the wire. | |
4150 | # | |
c5f1ae3a | 4151 | # 2. SocketAddressFlat supports only types 'unix' and 'inet', because |
2b733709 MA |
4152 | # that's what its current users need. |
4153 | # | |
4154 | # Since: 2.9 | |
4155 | ## | |
4156 | { 'union': 'SocketAddressFlat', | |
4157 | 'base': { 'type': 'SocketAddressFlatType' }, | |
4158 | 'discriminator': 'type', | |
4159 | 'data': { 'unix': 'UnixSocketAddress', | |
c5f1ae3a | 4160 | 'inet': 'InetSocketAddress' } } |
2b733709 | 4161 | |
208c9d1b CB |
4162 | ## |
4163 | # @getfd: | |
4164 | # | |
4165 | # Receive a file descriptor via SCM rights and assign it a name | |
4166 | # | |
4167 | # @fdname: file descriptor name | |
4168 | # | |
4169 | # Returns: Nothing on success | |
208c9d1b CB |
4170 | # |
4171 | # Since: 0.14.0 | |
4172 | # | |
4173 | # Notes: If @fdname already exists, the file descriptor assigned to | |
4174 | # it will be closed and replaced by the received file | |
4175 | # descriptor. | |
179bf59a | 4176 | # |
208c9d1b CB |
4177 | # The 'closefd' command can be used to explicitly close the |
4178 | # file descriptor when it is no longer needed. | |
179bf59a MAL |
4179 | # |
4180 | # Example: | |
4181 | # | |
4182 | # -> { "execute": "getfd", "arguments": { "fdname": "fd1" } } | |
4183 | # <- { "return": {} } | |
4184 | # | |
208c9d1b CB |
4185 | ## |
4186 | { 'command': 'getfd', 'data': {'fdname': 'str'} } | |
4187 | ||
4188 | ## | |
4189 | # @closefd: | |
4190 | # | |
4191 | # Close a file descriptor previously passed via SCM rights | |
4192 | # | |
4193 | # @fdname: file descriptor name | |
4194 | # | |
4195 | # Returns: Nothing on success | |
208c9d1b CB |
4196 | # |
4197 | # Since: 0.14.0 | |
f5ad8e87 MAL |
4198 | # |
4199 | # Example: | |
4200 | # | |
4201 | # -> { "execute": "closefd", "arguments": { "fdname": "fd1" } } | |
4202 | # <- { "return": {} } | |
4203 | # | |
208c9d1b CB |
4204 | ## |
4205 | { 'command': 'closefd', 'data': {'fdname': 'str'} } | |
01d3c80d AL |
4206 | |
4207 | ## | |
4208 | # @MachineInfo: | |
4209 | # | |
4210 | # Information describing a machine. | |
4211 | # | |
4212 | # @name: the name of the machine | |
4213 | # | |
1d8bda12 | 4214 | # @alias: an alias for the machine name |
01d3c80d | 4215 | # |
1d8bda12 | 4216 | # @is-default: whether the machine is default |
01d3c80d | 4217 | # |
c72e7688 MN |
4218 | # @cpu-max: maximum number of CPUs supported by the machine type |
4219 | # (since 1.5.0) | |
4220 | # | |
62c9467d PK |
4221 | # @hotpluggable-cpus: cpu hotplug via -device is supported (since 2.7.0) |
4222 | # | |
01d3c80d AL |
4223 | # Since: 1.2.0 |
4224 | ## | |
895a2a80 | 4225 | { 'struct': 'MachineInfo', |
01d3c80d | 4226 | 'data': { 'name': 'str', '*alias': 'str', |
62c9467d PK |
4227 | '*is-default': 'bool', 'cpu-max': 'int', |
4228 | 'hotpluggable-cpus': 'bool'} } | |
01d3c80d AL |
4229 | |
4230 | ## | |
4231 | # @query-machines: | |
4232 | # | |
4233 | # Return a list of supported machines | |
4234 | # | |
4235 | # Returns: a list of MachineInfo | |
4236 | # | |
4237 | # Since: 1.2.0 | |
4238 | ## | |
4239 | { 'command': 'query-machines', 'returns': ['MachineInfo'] } | |
e4e31c63 AL |
4240 | |
4241 | ## | |
4242 | # @CpuDefinitionInfo: | |
4243 | # | |
4244 | # Virtual CPU definition. | |
4245 | # | |
4246 | # @name: the name of the CPU definition | |
4247 | # | |
1d8bda12 | 4248 | # @migration-safe: whether a CPU definition can be safely used for |
fc4b84b1 DH |
4249 | # migration in combination with a QEMU compatibility machine |
4250 | # when migrating between different QMU versions and between | |
4251 | # hosts with different sets of (hardware or software) | |
4252 | # capabilities. If not provided, information is not available | |
4253 | # and callers should not assume the CPU definition to be | |
4254 | # migration-safe. (since 2.8) | |
4255 | # | |
4256 | # @static: whether a CPU definition is static and will not change depending on | |
4257 | # QEMU version, machine type, machine options and accelerator options. | |
4258 | # A static model is always migration-safe. (since 2.8) | |
4259 | # | |
1d8bda12 | 4260 | # @unavailable-features: List of properties that prevent |
9504e710 EH |
4261 | # the CPU model from running in the current |
4262 | # host. (since 2.8) | |
8ed877b7 EH |
4263 | # @typename: Type name that can be used as argument to @device-list-properties, |
4264 | # to introspect properties configurable using -cpu or -global. | |
4265 | # (since 2.9) | |
9504e710 EH |
4266 | # |
4267 | # @unavailable-features is a list of QOM property names that | |
4268 | # represent CPU model attributes that prevent the CPU from running. | |
4269 | # If the QOM property is read-only, that means there's no known | |
4270 | # way to make the CPU model run in the current host. Implementations | |
4271 | # that choose not to provide specific information return the | |
4272 | # property name "type". | |
4273 | # If the property is read-write, it means that it MAY be possible | |
4274 | # to run the CPU model in the current host if that property is | |
4275 | # changed. Management software can use it as hints to suggest or | |
4276 | # choose an alternative for the user, or just to generate meaningful | |
4277 | # error messages explaining why the CPU model can't be used. | |
4278 | # If @unavailable-features is an empty list, the CPU model is | |
4279 | # runnable using the current host and machine-type. | |
4280 | # If @unavailable-features is not present, runnability | |
4281 | # information for the CPU is not available. | |
4282 | # | |
e4e31c63 AL |
4283 | # Since: 1.2.0 |
4284 | ## | |
895a2a80 | 4285 | { 'struct': 'CpuDefinitionInfo', |
9504e710 | 4286 | 'data': { 'name': 'str', '*migration-safe': 'bool', 'static': 'bool', |
8ed877b7 | 4287 | '*unavailable-features': [ 'str' ], 'typename': 'str' } } |
e4e31c63 AL |
4288 | |
4289 | ## | |
4290 | # @query-cpu-definitions: | |
4291 | # | |
4292 | # Return a list of supported virtual CPU definitions | |
4293 | # | |
4294 | # Returns: a list of CpuDefInfo | |
4295 | # | |
4296 | # Since: 1.2.0 | |
4297 | ## | |
4298 | { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] } | |
ba1c048a | 4299 | |
e09484ef DH |
4300 | ## |
4301 | # @CpuModelInfo: | |
4302 | # | |
4303 | # Virtual CPU model. | |
4304 | # | |
4305 | # A CPU model consists of the name of a CPU definition, to which | |
4306 | # delta changes are applied (e.g. features added/removed). Most magic values | |
4307 | # that an architecture might require should be hidden behind the name. | |
4308 | # However, if required, architectures can expose relevant properties. | |
4309 | # | |
4310 | # @name: the name of the CPU definition the model is based on | |
1d8bda12 | 4311 | # @props: a dictionary of QOM properties to be applied |
e09484ef DH |
4312 | # |
4313 | # Since: 2.8.0 | |
4314 | ## | |
4315 | { 'struct': 'CpuModelInfo', | |
4316 | 'data': { 'name': 'str', | |
4317 | '*props': 'any' } } | |
4318 | ||
4319 | ## | |
5072f7b3 | 4320 | # @CpuModelExpansionType: |
e09484ef DH |
4321 | # |
4322 | # An enumeration of CPU model expansion types. | |
4323 | # | |
4324 | # @static: Expand to a static CPU model, a combination of a static base | |
4325 | # model name and property delta changes. As the static base model will | |
4326 | # never change, the expanded CPU model will be the same, independant of | |
4327 | # independent of QEMU version, machine type, machine options, and | |
4328 | # accelerator options. Therefore, the resulting model can be used by | |
4329 | # tooling without having to specify a compatibility machine - e.g. when | |
4330 | # displaying the "host" model. static CPU models are migration-safe. | |
4331 | # | |
4332 | # @full: Expand all properties. The produced model is not guaranteed to be | |
4333 | # migration-safe, but allows tooling to get an insight and work with | |
4334 | # model details. | |
4335 | # | |
a357a65b EH |
4336 | # Note: When a non-migration-safe CPU model is expanded in static mode, some |
4337 | # features enabled by the CPU model may be omitted, because they can't be | |
4338 | # implemented by a static CPU model definition (e.g. cache info passthrough and | |
4339 | # PMU passthrough in x86). If you need an accurate representation of the | |
4340 | # features enabled by a non-migration-safe CPU model, use @full. If you need a | |
4341 | # static representation that will keep ABI compatibility even when changing QEMU | |
4342 | # version or machine-type, use @static (but keep in mind that some features may | |
4343 | # be omitted). | |
4344 | # | |
e09484ef DH |
4345 | # Since: 2.8.0 |
4346 | ## | |
4347 | { 'enum': 'CpuModelExpansionType', | |
4348 | 'data': [ 'static', 'full' ] } | |
4349 | ||
4350 | ||
4351 | ## | |
5072f7b3 | 4352 | # @CpuModelExpansionInfo: |
e09484ef DH |
4353 | # |
4354 | # The result of a cpu model expansion. | |
4355 | # | |
4356 | # @model: the expanded CpuModelInfo. | |
4357 | # | |
4358 | # Since: 2.8.0 | |
4359 | ## | |
4360 | { 'struct': 'CpuModelExpansionInfo', | |
4361 | 'data': { 'model': 'CpuModelInfo' } } | |
4362 | ||
4363 | ||
4364 | ## | |
4365 | # @query-cpu-model-expansion: | |
4366 | # | |
4367 | # Expands a given CPU model (or a combination of CPU model + additional options) | |
4368 | # to different granularities, allowing tooling to get an understanding what a | |
4369 | # specific CPU model looks like in QEMU under a certain configuration. | |
4370 | # | |
4371 | # This interface can be used to query the "host" CPU model. | |
4372 | # | |
4373 | # The data returned by this command may be affected by: | |
4374 | # | |
4375 | # * QEMU version: CPU models may look different depending on the QEMU version. | |
4376 | # (Except for CPU models reported as "static" in query-cpu-definitions.) | |
4377 | # * machine-type: CPU model may look different depending on the machine-type. | |
4378 | # (Except for CPU models reported as "static" in query-cpu-definitions.) | |
4379 | # * machine options (including accelerator): in some architectures, CPU models | |
4380 | # may look different depending on machine and accelerator options. (Except for | |
4381 | # CPU models reported as "static" in query-cpu-definitions.) | |
4382 | # * "-cpu" arguments and global properties: arguments to the -cpu option and | |
4383 | # global properties may affect expansion of CPU models. Using | |
4384 | # query-cpu-model-expansion while using these is not advised. | |
4385 | # | |
137974ce DH |
4386 | # Some architectures may not support all expansion types. s390x supports |
4387 | # "full" and "static". | |
e09484ef DH |
4388 | # |
4389 | # Returns: a CpuModelExpansionInfo. Returns an error if expanding CPU models is | |
4390 | # not supported, if the model cannot be expanded, if the model contains | |
4391 | # an unknown CPU definition name, unknown properties or properties | |
4392 | # with a wrong type. Also returns an error if an expansion type is | |
4393 | # not supported. | |
4394 | # | |
4395 | # Since: 2.8.0 | |
4396 | ## | |
4397 | { 'command': 'query-cpu-model-expansion', | |
4398 | 'data': { 'type': 'CpuModelExpansionType', | |
4399 | 'model': 'CpuModelInfo' }, | |
4400 | 'returns': 'CpuModelExpansionInfo' } | |
4401 | ||
0031e0d6 DH |
4402 | ## |
4403 | # @CpuModelCompareResult: | |
4404 | # | |
4405 | # An enumeration of CPU model comparation results. The result is usually | |
4d4ccabd | 4406 | # calculated using e.g. CPU features or CPU generations. |
0031e0d6 DH |
4407 | # |
4408 | # @incompatible: If model A is incompatible to model B, model A is not | |
4409 | # guaranteed to run where model B runs and the other way around. | |
4410 | # | |
4411 | # @identical: If model A is identical to model B, model A is guaranteed to run | |
4412 | # where model B runs and the other way around. | |
4413 | # | |
4414 | # @superset: If model A is a superset of model B, model B is guaranteed to run | |
4415 | # where model A runs. There are no guarantees about the other way. | |
4416 | # | |
4417 | # @subset: If model A is a subset of model B, model A is guaranteed to run | |
4418 | # where model B runs. There are no guarantees about the other way. | |
4419 | # | |
4420 | # Since: 2.8.0 | |
4421 | ## | |
4422 | { 'enum': 'CpuModelCompareResult', | |
4423 | 'data': [ 'incompatible', 'identical', 'superset', 'subset' ] } | |
4424 | ||
4425 | ## | |
5072f7b3 | 4426 | # @CpuModelCompareInfo: |
0031e0d6 DH |
4427 | # |
4428 | # The result of a CPU model comparison. | |
4429 | # | |
4430 | # @result: The result of the compare operation. | |
4431 | # @responsible-properties: List of properties that led to the comparison result | |
4432 | # not being identical. | |
4433 | # | |
4434 | # @responsible-properties is a list of QOM property names that led to | |
4435 | # both CPUs not being detected as identical. For identical models, this | |
4436 | # list is empty. | |
4437 | # If a QOM property is read-only, that means there's no known way to make the | |
4438 | # CPU models identical. If the special property name "type" is included, the | |
4439 | # models are by definition not identical and cannot be made identical. | |
4440 | # | |
4441 | # Since: 2.8.0 | |
4442 | ## | |
4443 | { 'struct': 'CpuModelCompareInfo', | |
4444 | 'data': {'result': 'CpuModelCompareResult', | |
4445 | 'responsible-properties': ['str'] | |
4446 | } | |
4447 | } | |
4448 | ||
4449 | ## | |
4450 | # @query-cpu-model-comparison: | |
4451 | # | |
4452 | # Compares two CPU models, returning how they compare in a specific | |
4453 | # configuration. The results indicates how both models compare regarding | |
4454 | # runnability. This result can be used by tooling to make decisions if a | |
4455 | # certain CPU model will run in a certain configuration or if a compatible | |
4456 | # CPU model has to be created by baselining. | |
4457 | # | |
4458 | # Usually, a CPU model is compared against the maximum possible CPU model | |
4d4ccabd | 4459 | # of a certain configuration (e.g. the "host" model for KVM). If that CPU |
0031e0d6 DH |
4460 | # model is identical or a subset, it will run in that configuration. |
4461 | # | |
4462 | # The result returned by this command may be affected by: | |
4463 | # | |
4464 | # * QEMU version: CPU models may look different depending on the QEMU version. | |
4465 | # (Except for CPU models reported as "static" in query-cpu-definitions.) | |
4d4ccabd | 4466 | # * machine-type: CPU model may look different depending on the machine-type. |
0031e0d6 DH |
4467 | # (Except for CPU models reported as "static" in query-cpu-definitions.) |
4468 | # * machine options (including accelerator): in some architectures, CPU models | |
4469 | # may look different depending on machine and accelerator options. (Except for | |
4470 | # CPU models reported as "static" in query-cpu-definitions.) | |
4471 | # * "-cpu" arguments and global properties: arguments to the -cpu option and | |
4472 | # global properties may affect expansion of CPU models. Using | |
4473 | # query-cpu-model-expansion while using these is not advised. | |
4474 | # | |
4e82ef05 DH |
4475 | # Some architectures may not support comparing CPU models. s390x supports |
4476 | # comparing CPU models. | |
0031e0d6 DH |
4477 | # |
4478 | # Returns: a CpuModelBaselineInfo. Returns an error if comparing CPU models is | |
4479 | # not supported, if a model cannot be used, if a model contains | |
4480 | # an unknown cpu definition name, unknown properties or properties | |
4481 | # with wrong types. | |
4482 | # | |
4483 | # Since: 2.8.0 | |
4484 | ## | |
4485 | { 'command': 'query-cpu-model-comparison', | |
4486 | 'data': { 'modela': 'CpuModelInfo', 'modelb': 'CpuModelInfo' }, | |
4487 | 'returns': 'CpuModelCompareInfo' } | |
4488 | ||
b18b6043 | 4489 | ## |
5072f7b3 | 4490 | # @CpuModelBaselineInfo: |
b18b6043 DH |
4491 | # |
4492 | # The result of a CPU model baseline. | |
4493 | # | |
4494 | # @model: the baselined CpuModelInfo. | |
4495 | # | |
4496 | # Since: 2.8.0 | |
4497 | ## | |
4498 | { 'struct': 'CpuModelBaselineInfo', | |
4499 | 'data': { 'model': 'CpuModelInfo' } } | |
4500 | ||
4501 | ## | |
4502 | # @query-cpu-model-baseline: | |
4503 | # | |
4504 | # Baseline two CPU models, creating a compatible third model. The created | |
4505 | # model will always be a static, migration-safe CPU model (see "static" | |
4506 | # CPU model expansion for details). | |
4507 | # | |
4508 | # This interface can be used by tooling to create a compatible CPU model out | |
4509 | # two CPU models. The created CPU model will be identical to or a subset of | |
4510 | # both CPU models when comparing them. Therefore, the created CPU model is | |
4511 | # guaranteed to run where the given CPU models run. | |
4512 | # | |
4513 | # The result returned by this command may be affected by: | |
4514 | # | |
4515 | # * QEMU version: CPU models may look different depending on the QEMU version. | |
4516 | # (Except for CPU models reported as "static" in query-cpu-definitions.) | |
4d4ccabd | 4517 | # * machine-type: CPU model may look different depending on the machine-type. |
b18b6043 DH |
4518 | # (Except for CPU models reported as "static" in query-cpu-definitions.) |
4519 | # * machine options (including accelerator): in some architectures, CPU models | |
4520 | # may look different depending on machine and accelerator options. (Except for | |
4521 | # CPU models reported as "static" in query-cpu-definitions.) | |
4522 | # * "-cpu" arguments and global properties: arguments to the -cpu option and | |
4523 | # global properties may affect expansion of CPU models. Using | |
4524 | # query-cpu-model-expansion while using these is not advised. | |
4525 | # | |
f1a47d08 DH |
4526 | # Some architectures may not support baselining CPU models. s390x supports |
4527 | # baselining CPU models. | |
b18b6043 DH |
4528 | # |
4529 | # Returns: a CpuModelBaselineInfo. Returns an error if baselining CPU models is | |
4530 | # not supported, if a model cannot be used, if a model contains | |
4531 | # an unknown cpu definition name, unknown properties or properties | |
4532 | # with wrong types. | |
4533 | # | |
4534 | # Since: 2.8.0 | |
4535 | ## | |
4536 | { 'command': 'query-cpu-model-baseline', | |
4537 | 'data': { 'modela': 'CpuModelInfo', | |
4538 | 'modelb': 'CpuModelInfo' }, | |
4539 | 'returns': 'CpuModelBaselineInfo' } | |
4540 | ||
49687ace | 4541 | ## |
ba1c048a CB |
4542 | # @AddfdInfo: |
4543 | # | |
4544 | # Information about a file descriptor that was added to an fd set. | |
4545 | # | |
4546 | # @fdset-id: The ID of the fd set that @fd was added to. | |
4547 | # | |
4548 | # @fd: The file descriptor that was received via SCM rights and | |
4549 | # added to the fd set. | |
4550 | # | |
4551 | # Since: 1.2.0 | |
4552 | ## | |
895a2a80 | 4553 | { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} } |
ba1c048a CB |
4554 | |
4555 | ## | |
4556 | # @add-fd: | |
4557 | # | |
4558 | # Add a file descriptor, that was passed via SCM rights, to an fd set. | |
4559 | # | |
1d8bda12 | 4560 | # @fdset-id: The ID of the fd set to add the file descriptor to. |
ba1c048a | 4561 | # |
1d8bda12 | 4562 | # @opaque: A free-form string that can be used to describe the fd. |
ba1c048a CB |
4563 | # |
4564 | # Returns: @AddfdInfo on success | |
43fef34a | 4565 | # |
ba1c048a | 4566 | # If file descriptor was not received, FdNotSupplied |
43fef34a | 4567 | # |
9ac54af0 | 4568 | # If @fdset-id is a negative value, InvalidParameterValue |
ba1c048a CB |
4569 | # |
4570 | # Notes: The list of fd sets is shared by all monitor connections. | |
4571 | # | |
4572 | # If @fdset-id is not specified, a new fd set will be created. | |
4573 | # | |
4574 | # Since: 1.2.0 | |
43fef34a MAL |
4575 | # |
4576 | # Example: | |
4577 | # | |
4578 | # -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } } | |
4579 | # <- { "return": { "fdset-id": 1, "fd": 3 } } | |
4580 | # | |
ba1c048a CB |
4581 | ## |
4582 | { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'}, | |
4583 | 'returns': 'AddfdInfo' } | |
4584 | ||
4585 | ## | |
4586 | # @remove-fd: | |
4587 | # | |
4588 | # Remove a file descriptor from an fd set. | |
4589 | # | |
4590 | # @fdset-id: The ID of the fd set that the file descriptor belongs to. | |
4591 | # | |
1d8bda12 | 4592 | # @fd: The file descriptor that is to be removed. |
ba1c048a CB |
4593 | # |
4594 | # Returns: Nothing on success | |
4595 | # If @fdset-id or @fd is not found, FdNotFound | |
4596 | # | |
4597 | # Since: 1.2.0 | |
4598 | # | |
4599 | # Notes: The list of fd sets is shared by all monitor connections. | |
4600 | # | |
4601 | # If @fd is not specified, all file descriptors in @fdset-id | |
4602 | # will be removed. | |
4503e4b3 MAL |
4603 | # |
4604 | # Example: | |
4605 | # | |
4606 | # -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } } | |
4607 | # <- { "return": {} } | |
4608 | # | |
ba1c048a CB |
4609 | ## |
4610 | { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} } | |
4611 | ||
4612 | ## | |
4613 | # @FdsetFdInfo: | |
4614 | # | |
4615 | # Information about a file descriptor that belongs to an fd set. | |
4616 | # | |
4617 | # @fd: The file descriptor value. | |
4618 | # | |
1d8bda12 | 4619 | # @opaque: A free-form string that can be used to describe the fd. |
ba1c048a CB |
4620 | # |
4621 | # Since: 1.2.0 | |
4622 | ## | |
895a2a80 | 4623 | { 'struct': 'FdsetFdInfo', |
ba1c048a CB |
4624 | 'data': {'fd': 'int', '*opaque': 'str'} } |
4625 | ||
4626 | ## | |
4627 | # @FdsetInfo: | |
4628 | # | |
4629 | # Information about an fd set. | |
4630 | # | |
4631 | # @fdset-id: The ID of the fd set. | |
4632 | # | |
4633 | # @fds: A list of file descriptors that belong to this fd set. | |
4634 | # | |
4635 | # Since: 1.2.0 | |
4636 | ## | |
895a2a80 | 4637 | { 'struct': 'FdsetInfo', |
ba1c048a CB |
4638 | 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} } |
4639 | ||
4640 | ## | |
4641 | # @query-fdsets: | |
4642 | # | |
4643 | # Return information describing all fd sets. | |
4644 | # | |
4645 | # Returns: A list of @FdsetInfo | |
4646 | # | |
4647 | # Since: 1.2.0 | |
4648 | # | |
4649 | # Note: The list of fd sets is shared by all monitor connections. | |
4650 | # | |
d71ca35d MAL |
4651 | # Example: |
4652 | # | |
4653 | # -> { "execute": "query-fdsets" } | |
4654 | # <- { "return": [ | |
4655 | # { | |
4656 | # "fds": [ | |
4657 | # { | |
4658 | # "fd": 30, | |
4659 | # "opaque": "rdonly:/path/to/file" | |
4660 | # }, | |
4661 | # { | |
4662 | # "fd": 24, | |
4663 | # "opaque": "rdwr:/path/to/file" | |
4664 | # } | |
4665 | # ], | |
4666 | # "fdset-id": 1 | |
4667 | # }, | |
4668 | # { | |
4669 | # "fds": [ | |
4670 | # { | |
4671 | # "fd": 28 | |
4672 | # }, | |
4673 | # { | |
4674 | # "fd": 29 | |
4675 | # } | |
4676 | # ], | |
4677 | # "fdset-id": 0 | |
4678 | # } | |
4679 | # ] | |
4680 | # } | |
4681 | # | |
ba1c048a CB |
4682 | ## |
4683 | { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] } | |
99afc91d | 4684 | |
99afc91d DB |
4685 | ## |
4686 | # @TargetInfo: | |
4687 | # | |
4688 | # Information describing the QEMU target. | |
4689 | # | |
4690 | # @arch: the target architecture (eg "x86_64", "i386", etc) | |
4691 | # | |
4692 | # Since: 1.2.0 | |
4693 | ## | |
895a2a80 | 4694 | { 'struct': 'TargetInfo', |
c02a9552 | 4695 | 'data': { 'arch': 'str' } } |
99afc91d DB |
4696 | |
4697 | ## | |
4698 | # @query-target: | |
4699 | # | |
4700 | # Return information about the target for this QEMU | |
4701 | # | |
4702 | # Returns: TargetInfo | |
4703 | # | |
4704 | # Since: 1.2.0 | |
4705 | ## | |
4706 | { 'command': 'query-target', 'returns': 'TargetInfo' } | |
411656f4 AK |
4707 | |
4708 | ## | |
4709 | # @QKeyCode: | |
4710 | # | |
515b17c2 MAL |
4711 | # An enumeration of key name. |
4712 | # | |
4713 | # This is used by the @send-key command. | |
4714 | # | |
9f2a70e4 MAL |
4715 | # @unmapped: since 2.0 |
4716 | # @pause: since 2.0 | |
4717 | # @ro: since 2.4 | |
4718 | # @kp_comma: since 2.4 | |
4719 | # @kp_equals: since 2.6 | |
4720 | # @power: since 2.6 | |
e9346441 OH |
4721 | # @hiragana: since 2.9 |
4722 | # @henkan: since 2.9 | |
4723 | # @yen: since 2.9 | |
9f2a70e4 | 4724 | # |
411656f4 | 4725 | # Since: 1.3.0 |
bbd1b1cc | 4726 | # |
411656f4 AK |
4727 | ## |
4728 | { 'enum': 'QKeyCode', | |
bbd1b1cc GH |
4729 | 'data': [ 'unmapped', |
4730 | 'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl', | |
411656f4 AK |
4731 | 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8', |
4732 | '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e', | |
4733 | 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right', | |
4734 | 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon', | |
4735 | 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b', | |
4736 | 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock', | |
4737 | 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10', | |
4738 | 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply', | |
4739 | 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0', | |
4740 | 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8', | |
4741 | 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end', | |
4742 | 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again', | |
4743 | 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut', | |
e9346441 OH |
4744 | 'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause', |
4745 | 'ro', 'hiragana', 'henkan', 'yen', | |
a3541278 | 4746 | 'kp_comma', 'kp_equals', 'power' ] } |
e4c8f004 | 4747 | |
9f328977 | 4748 | ## |
5072f7b3 | 4749 | # @KeyValue: |
9f328977 LC |
4750 | # |
4751 | # Represents a keyboard key. | |
4752 | # | |
4753 | # Since: 1.3.0 | |
4754 | ## | |
4755 | { 'union': 'KeyValue', | |
4756 | 'data': { | |
4757 | 'number': 'int', | |
4758 | 'qcode': 'QKeyCode' } } | |
4759 | ||
e4c8f004 AK |
4760 | ## |
4761 | # @send-key: | |
4762 | # | |
4763 | # Send keys to guest. | |
4764 | # | |
9f328977 LC |
4765 | # @keys: An array of @KeyValue elements. All @KeyValues in this array are |
4766 | # simultaneously sent to the guest. A @KeyValue.number value is sent | |
4767 | # directly to the guest, while @KeyValue.qcode must be a valid | |
4768 | # @QKeyCode value | |
e4c8f004 | 4769 | # |
1d8bda12 | 4770 | # @hold-time: time to delay key up events, milliseconds. Defaults |
e4c8f004 AK |
4771 | # to 100 |
4772 | # | |
4773 | # Returns: Nothing on success | |
4774 | # If key is unknown or redundant, InvalidParameter | |
4775 | # | |
4776 | # Since: 1.3.0 | |
4777 | # | |
f45fd52c MAL |
4778 | # Example: |
4779 | # | |
4780 | # -> { "execute": "send-key", | |
4781 | # "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" }, | |
4782 | # { "type": "qcode", "data": "alt" }, | |
4783 | # { "type": "qcode", "data": "delete" } ] } } | |
4784 | # <- { "return": {} } | |
4785 | # | |
e4c8f004 AK |
4786 | ## |
4787 | { 'command': 'send-key', | |
9f328977 | 4788 | 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } } |
ad39cf6d LC |
4789 | |
4790 | ## | |
4791 | # @screendump: | |
4792 | # | |
4793 | # Write a PPM of the VGA screen to a file. | |
4794 | # | |
4795 | # @filename: the path of a new PPM file to store the image | |
4796 | # | |
4797 | # Returns: Nothing on success | |
4798 | # | |
4799 | # Since: 0.14.0 | |
77b6681e MAL |
4800 | # |
4801 | # Example: | |
4802 | # | |
4803 | # -> { "execute": "screendump", | |
4804 | # "arguments": { "filename": "/tmp/image" } } | |
4805 | # <- { "return": {} } | |
4806 | # | |
ad39cf6d LC |
4807 | ## |
4808 | { 'command': 'screendump', 'data': {'filename': 'str'} } | |
6dd844db | 4809 | |
d0d7708b DB |
4810 | |
4811 | ## | |
4812 | # @ChardevCommon: | |
4813 | # | |
4814 | # Configuration shared across all chardev backends | |
4815 | # | |
1d8bda12 MA |
4816 | # @logfile: The name of a logfile to save output |
4817 | # @logappend: true to append instead of truncate | |
d0d7708b DB |
4818 | # (default to false to truncate) |
4819 | # | |
4820 | # Since: 2.6 | |
4821 | ## | |
4822 | { 'struct': 'ChardevCommon', 'data': { '*logfile': 'str', | |
4823 | '*logappend': 'bool' } } | |
4824 | ||
ffbdbe59 GH |
4825 | ## |
4826 | # @ChardevFile: | |
4827 | # | |
4828 | # Configuration info for file chardevs. | |
4829 | # | |
1d8bda12 | 4830 | # @in: The name of the input file |
ffbdbe59 | 4831 | # @out: The name of the output file |
1d8bda12 | 4832 | # @append: Open the file in append mode (default false to |
31e38a22 | 4833 | # truncate) (Since 2.6) |
ffbdbe59 GH |
4834 | # |
4835 | # Since: 1.4 | |
4836 | ## | |
895a2a80 | 4837 | { 'struct': 'ChardevFile', 'data': { '*in' : 'str', |
31e38a22 | 4838 | 'out' : 'str', |
d0d7708b DB |
4839 | '*append': 'bool' }, |
4840 | 'base': 'ChardevCommon' } | |
ffbdbe59 | 4841 | |
d59044ef | 4842 | ## |
d36b2b90 | 4843 | # @ChardevHostdev: |
d59044ef | 4844 | # |
548cbb36 | 4845 | # Configuration info for device and pipe chardevs. |
d59044ef GH |
4846 | # |
4847 | # @device: The name of the special file for the device, | |
4848 | # i.e. /dev/ttyS0 on Unix or COM1: on Windows | |
d59044ef GH |
4849 | # |
4850 | # Since: 1.4 | |
4851 | ## | |
d0d7708b DB |
4852 | { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' }, |
4853 | 'base': 'ChardevCommon' } | |
d59044ef | 4854 | |
f6bd5d6e GH |
4855 | ## |
4856 | # @ChardevSocket: | |
4857 | # | |
3ecc059d | 4858 | # Configuration info for (stream) socket chardevs. |
f6bd5d6e GH |
4859 | # |
4860 | # @addr: socket address to listen on (server=true) | |
4861 | # or connect to (server=false) | |
1d8bda12 MA |
4862 | # @tls-creds: the ID of the TLS credentials object (since 2.6) |
4863 | # @server: create server socket (default: true) | |
4864 | # @wait: wait for incoming connection on server | |
ef993ba7 | 4865 | # sockets (default: false). |
1d8bda12 MA |
4866 | # @nodelay: set TCP_NODELAY socket option (default: false) |
4867 | # @telnet: enable telnet protocol on server | |
ef993ba7 | 4868 | # sockets (default: false) |
1d8bda12 | 4869 | # @reconnect: For a client socket, if a socket is disconnected, |
5dd1f02b CM |
4870 | # then attempt a reconnect after the given number of seconds. |
4871 | # Setting this to zero disables this function. (default: 0) | |
4872 | # (Since: 2.2) | |
f6bd5d6e GH |
4873 | # |
4874 | # Since: 1.4 | |
4875 | ## | |
895a2a80 | 4876 | { 'struct': 'ChardevSocket', 'data': { 'addr' : 'SocketAddress', |
a8fb5427 | 4877 | '*tls-creds' : 'str', |
5dd1f02b CM |
4878 | '*server' : 'bool', |
4879 | '*wait' : 'bool', | |
4880 | '*nodelay' : 'bool', | |
4881 | '*telnet' : 'bool', | |
d0d7708b DB |
4882 | '*reconnect' : 'int' }, |
4883 | 'base': 'ChardevCommon' } | |
f6bd5d6e | 4884 | |
3ecc059d | 4885 | ## |
08d0ab3f | 4886 | # @ChardevUdp: |
3ecc059d GH |
4887 | # |
4888 | # Configuration info for datagram socket chardevs. | |
4889 | # | |
4890 | # @remote: remote address | |
1d8bda12 | 4891 | # @local: local address |
3ecc059d GH |
4892 | # |
4893 | # Since: 1.5 | |
4894 | ## | |
895a2a80 | 4895 | { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress', |
d0d7708b DB |
4896 | '*local' : 'SocketAddress' }, |
4897 | 'base': 'ChardevCommon' } | |
3ecc059d | 4898 | |
edb2fb3c GH |
4899 | ## |
4900 | # @ChardevMux: | |
4901 | # | |
4902 | # Configuration info for mux chardevs. | |
4903 | # | |
4904 | # @chardev: name of the base chardev. | |
4905 | # | |
4906 | # Since: 1.5 | |
4907 | ## | |
d0d7708b DB |
4908 | { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' }, |
4909 | 'base': 'ChardevCommon' } | |
edb2fb3c | 4910 | |
7c358031 GH |
4911 | ## |
4912 | # @ChardevStdio: | |
4913 | # | |
4914 | # Configuration info for stdio chardevs. | |
4915 | # | |
1d8bda12 | 4916 | # @signal: Allow signals (such as SIGINT triggered by ^C) |
7c358031 GH |
4917 | # be delivered to qemu. Default: true in -nographic mode, |
4918 | # false otherwise. | |
4919 | # | |
4920 | # Since: 1.5 | |
4921 | ## | |
d0d7708b DB |
4922 | { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' }, |
4923 | 'base': 'ChardevCommon' } | |
4924 | ||
7c358031 | 4925 | |
cd153e2a GH |
4926 | ## |
4927 | # @ChardevSpiceChannel: | |
4928 | # | |
4929 | # Configuration info for spice vm channel chardevs. | |
4930 | # | |
4931 | # @type: kind of channel (for example vdagent). | |
4932 | # | |
4933 | # Since: 1.5 | |
4934 | ## | |
d0d7708b DB |
4935 | { 'struct': 'ChardevSpiceChannel', 'data': { 'type' : 'str' }, |
4936 | 'base': 'ChardevCommon' } | |
cd153e2a GH |
4937 | |
4938 | ## | |
4939 | # @ChardevSpicePort: | |
4940 | # | |
4941 | # Configuration info for spice port chardevs. | |
4942 | # | |
4943 | # @fqdn: name of the channel (see docs/spice-port-fqdn.txt) | |
4944 | # | |
4945 | # Since: 1.5 | |
4946 | ## | |
d0d7708b DB |
4947 | { 'struct': 'ChardevSpicePort', 'data': { 'fqdn' : 'str' }, |
4948 | 'base': 'ChardevCommon' } | |
cd153e2a | 4949 | |
702ec69c GH |
4950 | ## |
4951 | # @ChardevVC: | |
4952 | # | |
4953 | # Configuration info for virtual console chardevs. | |
4954 | # | |
4955 | # @width: console width, in pixels | |
4956 | # @height: console height, in pixels | |
4957 | # @cols: console width, in chars | |
4958 | # @rows: console height, in chars | |
4959 | # | |
4960 | # Since: 1.5 | |
4961 | ## | |
895a2a80 | 4962 | { 'struct': 'ChardevVC', 'data': { '*width' : 'int', |
702ec69c GH |
4963 | '*height' : 'int', |
4964 | '*cols' : 'int', | |
d0d7708b DB |
4965 | '*rows' : 'int' }, |
4966 | 'base': 'ChardevCommon' } | |
702ec69c | 4967 | |
1da48c65 | 4968 | ## |
4f57378f | 4969 | # @ChardevRingbuf: |
1da48c65 | 4970 | # |
3a1da42e | 4971 | # Configuration info for ring buffer chardevs. |
1da48c65 | 4972 | # |
1d8bda12 | 4973 | # @size: ring buffer size, must be power of two, default is 65536 |
1da48c65 GH |
4974 | # |
4975 | # Since: 1.5 | |
4976 | ## | |
d0d7708b DB |
4977 | { 'struct': 'ChardevRingbuf', 'data': { '*size' : 'int' }, |
4978 | 'base': 'ChardevCommon' } | |
1da48c65 | 4979 | |
f1a1a356 GH |
4980 | ## |
4981 | # @ChardevBackend: | |
4982 | # | |
4983 | # Configuration info for the new chardev backend. | |
4984 | # | |
378af961 | 4985 | # Since: 1.4 (testdev since 2.2, wctablet since 2.9) |
f1a1a356 | 4986 | ## |
f6bd5d6e | 4987 | { 'union': 'ChardevBackend', 'data': { 'file' : 'ChardevFile', |
d36b2b90 MA |
4988 | 'serial' : 'ChardevHostdev', |
4989 | 'parallel': 'ChardevHostdev', | |
548cbb36 | 4990 | 'pipe' : 'ChardevHostdev', |
f6bd5d6e | 4991 | 'socket' : 'ChardevSocket', |
08d0ab3f | 4992 | 'udp' : 'ChardevUdp', |
b1918fbb EB |
4993 | 'pty' : 'ChardevCommon', |
4994 | 'null' : 'ChardevCommon', | |
f5a51cab | 4995 | 'mux' : 'ChardevMux', |
b1918fbb | 4996 | 'msmouse': 'ChardevCommon', |
378af961 | 4997 | 'wctablet' : 'ChardevCommon', |
b1918fbb EB |
4998 | 'braille': 'ChardevCommon', |
4999 | 'testdev': 'ChardevCommon', | |
d9ac374f | 5000 | 'stdio' : 'ChardevStdio', |
b1918fbb | 5001 | 'console': 'ChardevCommon', |
cd153e2a | 5002 | 'spicevmc' : 'ChardevSpiceChannel', |
702ec69c | 5003 | 'spiceport' : 'ChardevSpicePort', |
1da48c65 | 5004 | 'vc' : 'ChardevVC', |
3a1da42e MA |
5005 | 'ringbuf': 'ChardevRingbuf', |
5006 | # next one is just for compatibility | |
4f57378f | 5007 | 'memory' : 'ChardevRingbuf' } } |
f1a1a356 GH |
5008 | |
5009 | ## | |
5010 | # @ChardevReturn: | |
5011 | # | |
5012 | # Return info about the chardev backend just created. | |
5013 | # | |
1d8bda12 | 5014 | # @pty: name of the slave pseudoterminal device, present if |
58fa4325 MA |
5015 | # and only if a chardev of type 'pty' was created |
5016 | # | |
f1a1a356 GH |
5017 | # Since: 1.4 |
5018 | ## | |
895a2a80 | 5019 | { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } } |
f1a1a356 GH |
5020 | |
5021 | ## | |
5022 | # @chardev-add: | |
5023 | # | |
58fa4325 | 5024 | # Add a character device backend |
f1a1a356 GH |
5025 | # |
5026 | # @id: the chardev's ID, must be unique | |
5027 | # @backend: backend type and parameters | |
5028 | # | |
58fa4325 | 5029 | # Returns: ChardevReturn. |
f1a1a356 GH |
5030 | # |
5031 | # Since: 1.4 | |
2212092e MAL |
5032 | # |
5033 | # Example: | |
5034 | # | |
5035 | # -> { "execute" : "chardev-add", | |
5036 | # "arguments" : { "id" : "foo", | |
5037 | # "backend" : { "type" : "null", "data" : {} } } } | |
5038 | # <- { "return": {} } | |
5039 | # | |
5040 | # -> { "execute" : "chardev-add", | |
5041 | # "arguments" : { "id" : "bar", | |
5042 | # "backend" : { "type" : "file", | |
5043 | # "data" : { "out" : "/tmp/bar.log" } } } } | |
5044 | # <- { "return": {} } | |
5045 | # | |
5046 | # -> { "execute" : "chardev-add", | |
5047 | # "arguments" : { "id" : "baz", | |
5048 | # "backend" : { "type" : "pty", "data" : {} } } } | |
5049 | # <- { "return": { "pty" : "/dev/pty/42" } } | |
5050 | # | |
f1a1a356 GH |
5051 | ## |
5052 | { 'command': 'chardev-add', 'data': {'id' : 'str', | |
5053 | 'backend' : 'ChardevBackend' }, | |
5054 | 'returns': 'ChardevReturn' } | |
5055 | ||
5056 | ## | |
5057 | # @chardev-remove: | |
5058 | # | |
58fa4325 | 5059 | # Remove a character device backend |
f1a1a356 GH |
5060 | # |
5061 | # @id: the chardev's ID, must exist and not be in use | |
5062 | # | |
5063 | # Returns: Nothing on success | |
5064 | # | |
5065 | # Since: 1.4 | |
7cfee8d9 MAL |
5066 | # |
5067 | # Example: | |
5068 | # | |
5069 | # -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } } | |
5070 | # <- { "return": {} } | |
5071 | # | |
f1a1a356 GH |
5072 | ## |
5073 | { 'command': 'chardev-remove', 'data': {'id': 'str'} } | |
d1a0cf73 SB |
5074 | |
5075 | ## | |
5076 | # @TpmModel: | |
5077 | # | |
5078 | # An enumeration of TPM models | |
5079 | # | |
5080 | # @tpm-tis: TPM TIS model | |
5081 | # | |
5082 | # Since: 1.5 | |
5083 | ## | |
5084 | { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] } | |
5085 | ||
5086 | ## | |
5087 | # @query-tpm-models: | |
5088 | # | |
5089 | # Return a list of supported TPM models | |
5090 | # | |
5091 | # Returns: a list of TpmModel | |
5092 | # | |
5093 | # Since: 1.5 | |
b7c7941b MAL |
5094 | # |
5095 | # Example: | |
5096 | # | |
5097 | # -> { "execute": "query-tpm-models" } | |
5098 | # <- { "return": [ "tpm-tis" ] } | |
5099 | # | |
d1a0cf73 SB |
5100 | ## |
5101 | { 'command': 'query-tpm-models', 'returns': ['TpmModel'] } | |
5102 | ||
5103 | ## | |
5104 | # @TpmType: | |
5105 | # | |
5106 | # An enumeration of TPM types | |
5107 | # | |
5108 | # @passthrough: TPM passthrough type | |
5109 | # | |
5110 | # Since: 1.5 | |
5111 | ## | |
5112 | { 'enum': 'TpmType', 'data': [ 'passthrough' ] } | |
5113 | ||
5114 | ## | |
5115 | # @query-tpm-types: | |
5116 | # | |
5117 | # Return a list of supported TPM types | |
5118 | # | |
5119 | # Returns: a list of TpmType | |
5120 | # | |
5121 | # Since: 1.5 | |
5a4c0316 MAL |
5122 | # |
5123 | # Example: | |
5124 | # | |
5125 | # -> { "execute": "query-tpm-types" } | |
5126 | # <- { "return": [ "passthrough" ] } | |
5127 | # | |
d1a0cf73 SB |
5128 | ## |
5129 | { 'command': 'query-tpm-types', 'returns': ['TpmType'] } | |
5130 | ||
5131 | ## | |
5132 | # @TPMPassthroughOptions: | |
5133 | # | |
5134 | # Information about the TPM passthrough type | |
5135 | # | |
1d8bda12 | 5136 | # @path: string describing the path used for accessing the TPM device |
d1a0cf73 | 5137 | # |
1d8bda12 | 5138 | # @cancel-path: string showing the TPM's sysfs cancel file |
d1a0cf73 SB |
5139 | # for cancellation of TPM commands while they are executing |
5140 | # | |
5141 | # Since: 1.5 | |
5142 | ## | |
895a2a80 | 5143 | { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str', |
d1a0cf73 SB |
5144 | '*cancel-path' : 'str'} } |
5145 | ||
5146 | ## | |
5147 | # @TpmTypeOptions: | |
5148 | # | |
5149 | # A union referencing different TPM backend types' configuration options | |
5150 | # | |
4d5c8bc4 | 5151 | # @type: 'passthrough' The configuration options for the TPM passthrough type |
d1a0cf73 SB |
5152 | # |
5153 | # Since: 1.5 | |
5154 | ## | |
5155 | { 'union': 'TpmTypeOptions', | |
88ca7bcf | 5156 | 'data': { 'passthrough' : 'TPMPassthroughOptions' } } |
d1a0cf73 SB |
5157 | |
5158 | ## | |
4d5c8bc4 | 5159 | # @TPMInfo: |
d1a0cf73 SB |
5160 | # |
5161 | # Information about the TPM | |
5162 | # | |
5163 | # @id: The Id of the TPM | |
5164 | # | |
5165 | # @model: The TPM frontend model | |
5166 | # | |
88ca7bcf | 5167 | # @options: The TPM (backend) type configuration options |
d1a0cf73 SB |
5168 | # |
5169 | # Since: 1.5 | |
5170 | ## | |
895a2a80 | 5171 | { 'struct': 'TPMInfo', |
d1a0cf73 SB |
5172 | 'data': {'id': 'str', |
5173 | 'model': 'TpmModel', | |
88ca7bcf | 5174 | 'options': 'TpmTypeOptions' } } |
d1a0cf73 SB |
5175 | |
5176 | ## | |
5177 | # @query-tpm: | |
5178 | # | |
5179 | # Return information about the TPM device | |
5180 | # | |
5181 | # Returns: @TPMInfo on success | |
5182 | # | |
5183 | # Since: 1.5 | |
4e022d01 MAL |
5184 | # |
5185 | # Example: | |
5186 | # | |
5187 | # -> { "execute": "query-tpm" } | |
5188 | # <- { "return": | |
5189 | # [ | |
5190 | # { "model": "tpm-tis", | |
5191 | # "options": | |
5192 | # { "type": "passthrough", | |
5193 | # "data": | |
5194 | # { "cancel-path": "/sys/class/misc/tpm0/device/cancel", | |
5195 | # "path": "/dev/tpm0" | |
5196 | # } | |
5197 | # }, | |
5198 | # "id": "tpm0" | |
5199 | # } | |
5200 | # ] | |
5201 | # } | |
5202 | # | |
d1a0cf73 SB |
5203 | ## |
5204 | { 'command': 'query-tpm', 'returns': ['TPMInfo'] } | |
8ccbad5c LE |
5205 | |
5206 | ## | |
5072f7b3 | 5207 | # @AcpiTableOptions: |
8ccbad5c LE |
5208 | # |
5209 | # Specify an ACPI table on the command line to load. | |
5210 | # | |
5211 | # At most one of @file and @data can be specified. The list of files specified | |
5212 | # by any one of them is loaded and concatenated in order. If both are omitted, | |
5213 | # @data is implied. | |
5214 | # | |
5215 | # Other fields / optargs can be used to override fields of the generic ACPI | |
5216 | # table header; refer to the ACPI specification 5.0, section 5.2.6 System | |
5217 | # Description Table Header. If a header field is not overridden, then the | |
5218 | # corresponding value from the concatenated blob is used (in case of @file), or | |
5219 | # it is filled in with a hard-coded value (in case of @data). | |
5220 | # | |
5221 | # String fields are copied into the matching ACPI member from lowest address | |
5222 | # upwards, and silently truncated / NUL-padded to length. | |
5223 | # | |
1d8bda12 | 5224 | # @sig: table signature / identifier (4 bytes) |
8ccbad5c | 5225 | # |
1d8bda12 | 5226 | # @rev: table revision number (dependent on signature, 1 byte) |
8ccbad5c | 5227 | # |
1d8bda12 | 5228 | # @oem_id: OEM identifier (6 bytes) |
8ccbad5c | 5229 | # |
1d8bda12 | 5230 | # @oem_table_id: OEM table identifier (8 bytes) |
8ccbad5c | 5231 | # |
1d8bda12 | 5232 | # @oem_rev: OEM-supplied revision number (4 bytes) |
8ccbad5c | 5233 | # |
1d8bda12 | 5234 | # @asl_compiler_id: identifier of the utility that created the table |
8ccbad5c LE |
5235 | # (4 bytes) |
5236 | # | |
1d8bda12 | 5237 | # @asl_compiler_rev: revision number of the utility that created the |
8ccbad5c LE |
5238 | # table (4 bytes) |
5239 | # | |
1d8bda12 | 5240 | # @file: colon (:) separated list of pathnames to load and |
8ccbad5c LE |
5241 | # concatenate as table data. The resultant binary blob is expected to |
5242 | # have an ACPI table header. At least one file is required. This field | |
5243 | # excludes @data. | |
5244 | # | |
1d8bda12 | 5245 | # @data: colon (:) separated list of pathnames to load and |
8ccbad5c LE |
5246 | # concatenate as table data. The resultant binary blob must not have an |
5247 | # ACPI table header. At least one file is required. This field excludes | |
5248 | # @file. | |
5249 | # | |
5072f7b3 | 5250 | # Since: 1.5 |
8ccbad5c | 5251 | ## |
895a2a80 | 5252 | { 'struct': 'AcpiTableOptions', |
8ccbad5c LE |
5253 | 'data': { |
5254 | '*sig': 'str', | |
5255 | '*rev': 'uint8', | |
5256 | '*oem_id': 'str', | |
5257 | '*oem_table_id': 'str', | |
5258 | '*oem_rev': 'uint32', | |
5259 | '*asl_compiler_id': 'str', | |
5260 | '*asl_compiler_rev': 'uint32', | |
5261 | '*file': 'str', | |
5262 | '*data': 'str' }} | |
1f8f987d AK |
5263 | |
5264 | ## | |
5265 | # @CommandLineParameterType: | |
5266 | # | |
5267 | # Possible types for an option parameter. | |
5268 | # | |
5269 | # @string: accepts a character string | |
5270 | # | |
5271 | # @boolean: accepts "on" or "off" | |
5272 | # | |
5273 | # @number: accepts a number | |
5274 | # | |
5275 | # @size: accepts a number followed by an optional suffix (K)ilo, | |
5276 | # (M)ega, (G)iga, (T)era | |
5277 | # | |
5072f7b3 | 5278 | # Since: 1.5 |
1f8f987d AK |
5279 | ## |
5280 | { 'enum': 'CommandLineParameterType', | |
5281 | 'data': ['string', 'boolean', 'number', 'size'] } | |
5282 | ||
5283 | ## | |
5284 | # @CommandLineParameterInfo: | |
5285 | # | |
5286 | # Details about a single parameter of a command line option. | |
5287 | # | |
5288 | # @name: parameter name | |
5289 | # | |
5290 | # @type: parameter @CommandLineParameterType | |
5291 | # | |
1d8bda12 | 5292 | # @help: human readable text string, not suitable for parsing. |
1f8f987d | 5293 | # |
1d8bda12 | 5294 | # @default: default value string (since 2.1) |
e36af94f | 5295 | # |
5072f7b3 | 5296 | # Since: 1.5 |
1f8f987d | 5297 | ## |
895a2a80 | 5298 | { 'struct': 'CommandLineParameterInfo', |
1f8f987d AK |
5299 | 'data': { 'name': 'str', |
5300 | 'type': 'CommandLineParameterType', | |
e36af94f CL |
5301 | '*help': 'str', |
5302 | '*default': 'str' } } | |
1f8f987d AK |
5303 | |
5304 | ## | |
5305 | # @CommandLineOptionInfo: | |
5306 | # | |
5307 | # Details about a command line option, including its list of parameter details | |
5308 | # | |
5309 | # @option: option name | |
5310 | # | |
5311 | # @parameters: an array of @CommandLineParameterInfo | |
5312 | # | |
5072f7b3 | 5313 | # Since: 1.5 |
1f8f987d | 5314 | ## |
895a2a80 | 5315 | { 'struct': 'CommandLineOptionInfo', |
1f8f987d AK |
5316 | 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } } |
5317 | ||
5318 | ## | |
5319 | # @query-command-line-options: | |
5320 | # | |
5321 | # Query command line option schema. | |
5322 | # | |
1d8bda12 | 5323 | # @option: option name |
1f8f987d AK |
5324 | # |
5325 | # Returns: list of @CommandLineOptionInfo for all options (or for the given | |
5326 | # @option). Returns an error if the given @option doesn't exist. | |
5327 | # | |
5072f7b3 | 5328 | # Since: 1.5 |
e26a0d00 MAL |
5329 | # |
5330 | # Example: | |
5331 | # | |
5332 | # -> { "execute": "query-command-line-options", | |
5333 | # "arguments": { "option": "option-rom" } } | |
5334 | # <- { "return": [ | |
5335 | # { | |
5336 | # "parameters": [ | |
5337 | # { | |
5338 | # "name": "romfile", | |
5339 | # "type": "string" | |
5340 | # }, | |
5341 | # { | |
5342 | # "name": "bootindex", | |
5343 | # "type": "number" | |
5344 | # } | |
5345 | # ], | |
5346 | # "option": "option-rom" | |
5347 | # } | |
5348 | # ] | |
5349 | # } | |
5350 | # | |
1f8f987d AK |
5351 | ## |
5352 | {'command': 'query-command-line-options', 'data': { '*option': 'str' }, | |
5353 | 'returns': ['CommandLineOptionInfo'] } | |
8e8aba50 EH |
5354 | |
5355 | ## | |
5072f7b3 | 5356 | # @X86CPURegister32: |
8e8aba50 EH |
5357 | # |
5358 | # A X86 32-bit register | |
5359 | # | |
5360 | # Since: 1.5 | |
5361 | ## | |
5362 | { 'enum': 'X86CPURegister32', | |
5363 | 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] } | |
5364 | ||
5365 | ## | |
5072f7b3 | 5366 | # @X86CPUFeatureWordInfo: |
8e8aba50 EH |
5367 | # |
5368 | # Information about a X86 CPU feature word | |
5369 | # | |
5370 | # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word | |
5371 | # | |
1d8bda12 | 5372 | # @cpuid-input-ecx: Input ECX value for CPUID instruction for that |
8e8aba50 EH |
5373 | # feature word |
5374 | # | |
5375 | # @cpuid-register: Output register containing the feature bits | |
5376 | # | |
5377 | # @features: value of output register, containing the feature bits | |
5378 | # | |
5379 | # Since: 1.5 | |
5380 | ## | |
895a2a80 | 5381 | { 'struct': 'X86CPUFeatureWordInfo', |
8e8aba50 EH |
5382 | 'data': { 'cpuid-input-eax': 'int', |
5383 | '*cpuid-input-ecx': 'int', | |
5384 | 'cpuid-register': 'X86CPURegister32', | |
5385 | 'features': 'int' } } | |
b1be4280 | 5386 | |
9f08c8ec | 5387 | ## |
5072f7b3 | 5388 | # @DummyForceArrays: |
9f08c8ec EB |
5389 | # |
5390 | # Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally | |
5391 | # | |
5072f7b3 | 5392 | # Since: 2.5 |
9f08c8ec EB |
5393 | ## |
5394 | { 'struct': 'DummyForceArrays', | |
5395 | 'data': { 'unused': ['X86CPUFeatureWordInfo'] } } | |
5396 | ||
5397 | ||
b1be4280 AK |
5398 | ## |
5399 | # @RxState: | |
5400 | # | |
5401 | # Packets receiving state | |
5402 | # | |
5403 | # @normal: filter assigned packets according to the mac-table | |
5404 | # | |
5405 | # @none: don't receive any assigned packet | |
5406 | # | |
5407 | # @all: receive all assigned packets | |
5408 | # | |
5409 | # Since: 1.6 | |
5410 | ## | |
5411 | { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] } | |
5412 | ||
5413 | ## | |
5414 | # @RxFilterInfo: | |
5415 | # | |
5416 | # Rx-filter information for a NIC. | |
5417 | # | |
5418 | # @name: net client name | |
5419 | # | |
5420 | # @promiscuous: whether promiscuous mode is enabled | |
5421 | # | |
5422 | # @multicast: multicast receive state | |
5423 | # | |
5424 | # @unicast: unicast receive state | |
5425 | # | |
f7bc8ef8 AK |
5426 | # @vlan: vlan receive state (Since 2.0) |
5427 | # | |
b1be4280 AK |
5428 | # @broadcast-allowed: whether to receive broadcast |
5429 | # | |
5430 | # @multicast-overflow: multicast table is overflowed or not | |
5431 | # | |
5432 | # @unicast-overflow: unicast table is overflowed or not | |
5433 | # | |
5434 | # @main-mac: the main macaddr string | |
5435 | # | |
5436 | # @vlan-table: a list of active vlan id | |
5437 | # | |
5438 | # @unicast-table: a list of unicast macaddr string | |
5439 | # | |
5440 | # @multicast-table: a list of multicast macaddr string | |
5441 | # | |
5072f7b3 | 5442 | # Since: 1.6 |
b1be4280 | 5443 | ## |
895a2a80 | 5444 | { 'struct': 'RxFilterInfo', |
b1be4280 AK |
5445 | 'data': { |
5446 | 'name': 'str', | |
5447 | 'promiscuous': 'bool', | |
5448 | 'multicast': 'RxState', | |
5449 | 'unicast': 'RxState', | |
f7bc8ef8 | 5450 | 'vlan': 'RxState', |
b1be4280 AK |
5451 | 'broadcast-allowed': 'bool', |
5452 | 'multicast-overflow': 'bool', | |
5453 | 'unicast-overflow': 'bool', | |
5454 | 'main-mac': 'str', | |
5455 | 'vlan-table': ['int'], | |
5456 | 'unicast-table': ['str'], | |
5457 | 'multicast-table': ['str'] }} | |
5458 | ||
5459 | ## | |
5460 | # @query-rx-filter: | |
5461 | # | |
5462 | # Return rx-filter information for all NICs (or for the given NIC). | |
5463 | # | |
1d8bda12 | 5464 | # @name: net client name |
b1be4280 AK |
5465 | # |
5466 | # Returns: list of @RxFilterInfo for all NICs (or for the given NIC). | |
5467 | # Returns an error if the given @name doesn't exist, or given | |
5468 | # NIC doesn't support rx-filter querying, or given net client | |
5469 | # isn't a NIC. | |
5470 | # | |
5471 | # Since: 1.6 | |
043ea312 MAL |
5472 | # |
5473 | # Example: | |
5474 | # | |
5475 | # -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } } | |
5476 | # <- { "return": [ | |
5477 | # { | |
5478 | # "promiscuous": true, | |
5479 | # "name": "vnet0", | |
5480 | # "main-mac": "52:54:00:12:34:56", | |
5481 | # "unicast": "normal", | |
5482 | # "vlan": "normal", | |
5483 | # "vlan-table": [ | |
5484 | # 4, | |
5485 | # 0 | |
5486 | # ], | |
5487 | # "unicast-table": [ | |
5488 | # ], | |
5489 | # "multicast": "normal", | |
5490 | # "multicast-overflow": false, | |
5491 | # "unicast-overflow": false, | |
5492 | # "multicast-table": [ | |
5493 | # "01:00:5e:00:00:01", | |
5494 | # "33:33:00:00:00:01", | |
5495 | # "33:33:ff:12:34:56" | |
5496 | # ], | |
5497 | # "broadcast-allowed": false | |
5498 | # } | |
5499 | # ] | |
5500 | # } | |
5501 | # | |
b1be4280 AK |
5502 | ## |
5503 | { 'command': 'query-rx-filter', 'data': { '*name': 'str' }, | |
5504 | 'returns': ['RxFilterInfo'] } | |
d26c9a15 | 5505 | |
031fa964 | 5506 | ## |
5072f7b3 | 5507 | # @InputButton: |
031fa964 GH |
5508 | # |
5509 | # Button of a pointer input device (mouse, tablet). | |
5510 | # | |
0095cc62 FL |
5511 | # @side: front side button of a 5-button mouse (since 2.9) |
5512 | # | |
5513 | # @extra: rear side button of a 5-button mouse (since 2.9) | |
5514 | # | |
031fa964 GH |
5515 | # Since: 2.0 |
5516 | ## | |
5517 | { 'enum' : 'InputButton', | |
0095cc62 FL |
5518 | 'data' : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down', 'side', |
5519 | 'extra' ] } | |
031fa964 GH |
5520 | |
5521 | ## | |
5072f7b3 | 5522 | # @InputAxis: |
031fa964 GH |
5523 | # |
5524 | # Position axis of a pointer input device (mouse, tablet). | |
5525 | # | |
5526 | # Since: 2.0 | |
5527 | ## | |
5528 | { 'enum' : 'InputAxis', | |
01df5143 | 5529 | 'data' : [ 'x', 'y' ] } |
031fa964 GH |
5530 | |
5531 | ## | |
5072f7b3 | 5532 | # @InputKeyEvent: |
031fa964 GH |
5533 | # |
5534 | # Keyboard input event. | |
5535 | # | |
5536 | # @key: Which key this event is for. | |
5537 | # @down: True for key-down and false for key-up events. | |
5538 | # | |
5539 | # Since: 2.0 | |
5540 | ## | |
895a2a80 | 5541 | { 'struct' : 'InputKeyEvent', |
031fa964 GH |
5542 | 'data' : { 'key' : 'KeyValue', |
5543 | 'down' : 'bool' } } | |
5544 | ||
5545 | ## | |
5072f7b3 | 5546 | # @InputBtnEvent: |
031fa964 GH |
5547 | # |
5548 | # Pointer button input event. | |
5549 | # | |
5550 | # @button: Which button this event is for. | |
5551 | # @down: True for key-down and false for key-up events. | |
5552 | # | |
5553 | # Since: 2.0 | |
5554 | ## | |
895a2a80 | 5555 | { 'struct' : 'InputBtnEvent', |
031fa964 GH |
5556 | 'data' : { 'button' : 'InputButton', |
5557 | 'down' : 'bool' } } | |
5558 | ||
5559 | ## | |
5072f7b3 | 5560 | # @InputMoveEvent: |
031fa964 GH |
5561 | # |
5562 | # Pointer motion input event. | |
5563 | # | |
5564 | # @axis: Which axis is referenced by @value. | |
5565 | # @value: Pointer position. For absolute coordinates the | |
5566 | # valid range is 0 -> 0x7ffff | |
5567 | # | |
5568 | # Since: 2.0 | |
5569 | ## | |
895a2a80 | 5570 | { 'struct' : 'InputMoveEvent', |
031fa964 GH |
5571 | 'data' : { 'axis' : 'InputAxis', |
5572 | 'value' : 'int' } } | |
5573 | ||
5574 | ## | |
5072f7b3 | 5575 | # @InputEvent: |
031fa964 GH |
5576 | # |
5577 | # Input event union. | |
5578 | # | |
4d5c8bc4 MAL |
5579 | # @type: the input type, one of: |
5580 | # - 'key': Input event of Keyboard | |
5581 | # - 'btn': Input event of pointer buttons | |
5582 | # - 'rel': Input event of relative pointer motion | |
5583 | # - 'abs': Input event of absolute pointer motion | |
935fb915 | 5584 | # |
031fa964 GH |
5585 | # Since: 2.0 |
5586 | ## | |
5587 | { 'union' : 'InputEvent', | |
5588 | 'data' : { 'key' : 'InputKeyEvent', | |
5589 | 'btn' : 'InputBtnEvent', | |
5590 | 'rel' : 'InputMoveEvent', | |
5591 | 'abs' : 'InputMoveEvent' } } | |
0042109a | 5592 | |
50c6617f | 5593 | ## |
5072f7b3 | 5594 | # @input-send-event: |
50c6617f MT |
5595 | # |
5596 | # Send input event(s) to guest. | |
5597 | # | |
1d8bda12 MA |
5598 | # @device: display device to send event(s) to. |
5599 | # @head: head to send event(s) to, in case the | |
b98d26e3 | 5600 | # display device supports multiple scanouts. |
50c6617f MT |
5601 | # @events: List of InputEvent union. |
5602 | # | |
5603 | # Returns: Nothing on success. | |
5604 | # | |
70d5b0c2 MAL |
5605 | # The @device and @head parameters can be used to send the input event |
5606 | # to specific input devices in case (a) multiple input devices of the | |
5607 | # same kind are added to the virtual machine and (b) you have | |
b98d26e3 GH |
5608 | # configured input routing (see docs/multiseat.txt) for those input |
5609 | # devices. The parameters work exactly like the device and head | |
5610 | # properties of input devices. If @device is missing, only devices | |
5611 | # that have no input routing config are admissible. If @device is | |
5612 | # specified, both input devices with and without input routing config | |
5613 | # are admissible, but devices with input routing config take | |
5614 | # precedence. | |
df5b2adb | 5615 | # |
6575ccdd | 5616 | # Since: 2.6 |
70d5b0c2 MAL |
5617 | # |
5618 | # Note: The consoles are visible in the qom tree, under | |
5619 | # /backend/console[$index]. They have a device link and head property, | |
5620 | # so it is possible to map which console belongs to which device and | |
5621 | # display. | |
5622 | # | |
5623 | # Example: | |
5624 | # | |
5625 | # 1. Press left mouse button. | |
5626 | # | |
5627 | # -> { "execute": "input-send-event", | |
5628 | # "arguments": { "device": "video0", | |
5629 | # "events": [ { "type": "btn", | |
5630 | # "data" : { "down": true, "button": "left" } } ] } } | |
5631 | # <- { "return": {} } | |
5632 | # | |
5633 | # -> { "execute": "input-send-event", | |
5634 | # "arguments": { "device": "video0", | |
5635 | # "events": [ { "type": "btn", | |
5636 | # "data" : { "down": false, "button": "left" } } ] } } | |
5637 | # <- { "return": {} } | |
5638 | # | |
5639 | # 2. Press ctrl-alt-del. | |
5640 | # | |
5641 | # -> { "execute": "input-send-event", | |
5642 | # "arguments": { "events": [ | |
5643 | # { "type": "key", "data" : { "down": true, | |
5644 | # "key": {"type": "qcode", "data": "ctrl" } } }, | |
5645 | # { "type": "key", "data" : { "down": true, | |
5646 | # "key": {"type": "qcode", "data": "alt" } } }, | |
5647 | # { "type": "key", "data" : { "down": true, | |
5648 | # "key": {"type": "qcode", "data": "delete" } } } ] } } | |
5649 | # <- { "return": {} } | |
5650 | # | |
5651 | # 3. Move mouse pointer to absolute coordinates (20000, 400). | |
5652 | # | |
5653 | # -> { "execute": "input-send-event" , | |
5654 | # "arguments": { "events": [ | |
5655 | # { "type": "abs", "data" : { "axis": "x", "value" : 20000 } }, | |
5656 | # { "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } } | |
5657 | # <- { "return": {} } | |
5658 | # | |
50c6617f | 5659 | ## |
6575ccdd | 5660 | { 'command': 'input-send-event', |
b98d26e3 GH |
5661 | 'data': { '*device': 'str', |
5662 | '*head' : 'int', | |
5663 | 'events' : [ 'InputEvent' ] } } | |
50c6617f | 5664 | |
d081a49a MA |
5665 | ## |
5666 | # @NumaOptionsType: | |
5667 | # | |
5668 | # Since: 2.1 | |
5669 | ## | |
5670 | { 'enum': 'NumaOptionsType', | |
5671 | 'data': [ 'node' ] } | |
5672 | ||
0042109a | 5673 | ## |
5072f7b3 | 5674 | # @NumaOptions: |
0042109a WG |
5675 | # |
5676 | # A discriminated record of NUMA options. (for OptsVisitor) | |
5677 | # | |
5072f7b3 | 5678 | # Since: 2.1 |
0042109a WG |
5679 | ## |
5680 | { 'union': 'NumaOptions', | |
d081a49a MA |
5681 | 'base': { 'type': 'NumaOptionsType' }, |
5682 | 'discriminator': 'type', | |
0042109a WG |
5683 | 'data': { |
5684 | 'node': 'NumaNodeOptions' }} | |
5685 | ||
5686 | ## | |
5072f7b3 | 5687 | # @NumaNodeOptions: |
0042109a WG |
5688 | # |
5689 | # Create a guest NUMA node. (for OptsVisitor) | |
5690 | # | |
1d8bda12 | 5691 | # @nodeid: NUMA node ID (increase by 1 from 0 if omitted) |
0042109a | 5692 | # |
1d8bda12 | 5693 | # @cpus: VCPUs belonging to this node (assign VCPUS round-robin |
0042109a WG |
5694 | # if omitted) |
5695 | # | |
1d8bda12 | 5696 | # @mem: memory size of this node; mutually exclusive with @memdev. |
7febe36f PB |
5697 | # Equally divide total memory among nodes if both @mem and @memdev are |
5698 | # omitted. | |
5699 | # | |
1d8bda12 | 5700 | # @memdev: memory backend object. If specified for one node, |
7febe36f | 5701 | # it must be specified for all nodes. |
0042109a WG |
5702 | # |
5703 | # Since: 2.1 | |
5704 | ## | |
895a2a80 | 5705 | { 'struct': 'NumaNodeOptions', |
0042109a WG |
5706 | 'data': { |
5707 | '*nodeid': 'uint16', | |
5708 | '*cpus': ['uint16'], | |
7febe36f PB |
5709 | '*mem': 'size', |
5710 | '*memdev': 'str' }} | |
4cf1b76b HT |
5711 | |
5712 | ## | |
5072f7b3 | 5713 | # @HostMemPolicy: |
4cf1b76b HT |
5714 | # |
5715 | # Host memory policy types | |
5716 | # | |
5717 | # @default: restore default policy, remove any nondefault policy | |
5718 | # | |
5719 | # @preferred: set the preferred host nodes for allocation | |
5720 | # | |
5721 | # @bind: a strict policy that restricts memory allocation to the | |
5722 | # host nodes specified | |
5723 | # | |
5724 | # @interleave: memory allocations are interleaved across the set | |
5725 | # of host nodes specified | |
5726 | # | |
5072f7b3 | 5727 | # Since: 2.1 |
4cf1b76b HT |
5728 | ## |
5729 | { 'enum': 'HostMemPolicy', | |
5730 | 'data': [ 'default', 'preferred', 'bind', 'interleave' ] } | |
76b5d850 HT |
5731 | |
5732 | ## | |
5733 | # @Memdev: | |
5734 | # | |
8f4e5ac3 | 5735 | # Information about memory backend |
76b5d850 | 5736 | # |
1d8bda12 | 5737 | # @id: backend's ID if backend has 'id' property (since 2.9) |
e1ff3c67 | 5738 | # |
8f4e5ac3 | 5739 | # @size: memory backend size |
76b5d850 HT |
5740 | # |
5741 | # @merge: enables or disables memory merge support | |
5742 | # | |
8f4e5ac3 | 5743 | # @dump: includes memory backend's memory in a core dump or not |
76b5d850 HT |
5744 | # |
5745 | # @prealloc: enables or disables memory preallocation | |
5746 | # | |
5747 | # @host-nodes: host nodes for its memory policy | |
5748 | # | |
8f4e5ac3 | 5749 | # @policy: memory policy of memory backend |
76b5d850 HT |
5750 | # |
5751 | # Since: 2.1 | |
5752 | ## | |
895a2a80 | 5753 | { 'struct': 'Memdev', |
76b5d850 | 5754 | 'data': { |
e1ff3c67 | 5755 | '*id': 'str', |
76b5d850 HT |
5756 | 'size': 'size', |
5757 | 'merge': 'bool', | |
5758 | 'dump': 'bool', | |
5759 | 'prealloc': 'bool', | |
5760 | 'host-nodes': ['uint16'], | |
5761 | 'policy': 'HostMemPolicy' }} | |
5762 | ||
5763 | ## | |
5764 | # @query-memdev: | |
5765 | # | |
8f4e5ac3 | 5766 | # Returns information for all memory backends. |
76b5d850 HT |
5767 | # |
5768 | # Returns: a list of @Memdev. | |
5769 | # | |
5770 | # Since: 2.1 | |
cfc84c8b MAL |
5771 | # |
5772 | # Example: | |
5773 | # | |
5774 | # -> { "execute": "query-memdev" } | |
5775 | # <- { "return": [ | |
5776 | # { | |
5777 | # "id": "mem1", | |
5778 | # "size": 536870912, | |
5779 | # "merge": false, | |
5780 | # "dump": true, | |
5781 | # "prealloc": false, | |
5782 | # "host-nodes": [0, 1], | |
5783 | # "policy": "bind" | |
5784 | # }, | |
5785 | # { | |
5786 | # "size": 536870912, | |
5787 | # "merge": false, | |
5788 | # "dump": true, | |
5789 | # "prealloc": true, | |
5790 | # "host-nodes": [2, 3], | |
5791 | # "policy": "preferred" | |
5792 | # } | |
5793 | # ] | |
5794 | # } | |
5795 | # | |
76b5d850 HT |
5796 | ## |
5797 | { 'command': 'query-memdev', 'returns': ['Memdev'] } | |
8f4e5ac3 IM |
5798 | |
5799 | ## | |
6f2e2730 IM |
5800 | # @PCDIMMDeviceInfo: |
5801 | # | |
5802 | # PCDIMMDevice state information | |
5803 | # | |
1d8bda12 | 5804 | # @id: device's ID |
6f2e2730 IM |
5805 | # |
5806 | # @addr: physical address, where device is mapped | |
5807 | # | |
5808 | # @size: size of memory that the device provides | |
5809 | # | |
5810 | # @slot: slot number at which device is plugged in | |
5811 | # | |
5812 | # @node: NUMA node number where device is plugged in | |
5813 | # | |
5814 | # @memdev: memory backend linked with device | |
5815 | # | |
5816 | # @hotplugged: true if device was hotplugged | |
5817 | # | |
5818 | # @hotpluggable: true if device if could be added/removed while machine is running | |
5819 | # | |
5820 | # Since: 2.1 | |
5821 | ## | |
895a2a80 | 5822 | { 'struct': 'PCDIMMDeviceInfo', |
6f2e2730 IM |
5823 | 'data': { '*id': 'str', |
5824 | 'addr': 'int', | |
5825 | 'size': 'int', | |
5826 | 'slot': 'int', | |
5827 | 'node': 'int', | |
5828 | 'memdev': 'str', | |
5829 | 'hotplugged': 'bool', | |
5830 | 'hotpluggable': 'bool' | |
5831 | } | |
5832 | } | |
5833 | ||
5834 | ## | |
5835 | # @MemoryDeviceInfo: | |
5836 | # | |
5837 | # Union containing information about a memory device | |
5838 | # | |
5839 | # Since: 2.1 | |
5840 | ## | |
5841 | { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} } | |
5842 | ||
5843 | ## | |
5072f7b3 | 5844 | # @query-memory-devices: |
6f2e2730 IM |
5845 | # |
5846 | # Lists available memory devices and their state | |
5847 | # | |
5848 | # Since: 2.1 | |
22f9a094 MAL |
5849 | # |
5850 | # Example: | |
5851 | # | |
5852 | # -> { "execute": "query-memory-devices" } | |
5853 | # <- { "return": [ { "data": | |
5854 | # { "addr": 5368709120, | |
5855 | # "hotpluggable": true, | |
5856 | # "hotplugged": true, | |
5857 | # "id": "d1", | |
5858 | # "memdev": "/objects/memX", | |
5859 | # "node": 0, | |
5860 | # "size": 1073741824, | |
5861 | # "slot": 0}, | |
5862 | # "type": "dimm" | |
5863 | # } ] } | |
5864 | # | |
6f2e2730 IM |
5865 | ## |
5866 | { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] } | |
521b3673 | 5867 | |
49687ace | 5868 | ## |
5072f7b3 | 5869 | # @ACPISlotType: |
521b3673 IM |
5870 | # |
5871 | # @DIMM: memory slot | |
76623d00 | 5872 | # @CPU: logical CPU slot (since 2.7) |
49687ace | 5873 | ## |
76623d00 | 5874 | { 'enum': 'ACPISlotType', 'data': [ 'DIMM', 'CPU' ] } |
521b3673 | 5875 | |
49687ace | 5876 | ## |
5072f7b3 | 5877 | # @ACPIOSTInfo: |
521b3673 IM |
5878 | # |
5879 | # OSPM Status Indication for a device | |
5880 | # For description of possible values of @source and @status fields | |
5881 | # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec. | |
5882 | # | |
1d8bda12 | 5883 | # @device: device ID associated with slot |
521b3673 IM |
5884 | # |
5885 | # @slot: slot ID, unique per slot of a given @slot-type | |
5886 | # | |
5887 | # @slot-type: type of the slot | |
5888 | # | |
5889 | # @source: an integer containing the source event | |
5890 | # | |
5891 | # @status: an integer containing the status code | |
5892 | # | |
5893 | # Since: 2.1 | |
5894 | ## | |
895a2a80 | 5895 | { 'struct': 'ACPIOSTInfo', |
521b3673 IM |
5896 | 'data' : { '*device': 'str', |
5897 | 'slot': 'str', | |
5898 | 'slot-type': 'ACPISlotType', | |
5899 | 'source': 'int', | |
5900 | 'status': 'int' } } | |
02419bcb IM |
5901 | |
5902 | ## | |
5072f7b3 | 5903 | # @query-acpi-ospm-status: |
02419bcb | 5904 | # |
18b43003 MAL |
5905 | # Return a list of ACPIOSTInfo for devices that support status |
5906 | # reporting via ACPI _OST method. | |
02419bcb IM |
5907 | # |
5908 | # Since: 2.1 | |
18b43003 MAL |
5909 | # |
5910 | # Example: | |
5911 | # | |
5912 | # -> { "execute": "query-acpi-ospm-status" } | |
5913 | # <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0}, | |
5914 | # { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0}, | |
5915 | # { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0}, | |
5916 | # { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0} | |
5917 | # ]} | |
5918 | # | |
02419bcb IM |
5919 | ## |
5920 | { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] } | |
f668470f | 5921 | |
99eaf09c | 5922 | ## |
5072f7b3 | 5923 | # @WatchdogExpirationAction: |
99eaf09c WX |
5924 | # |
5925 | # An enumeration of the actions taken when the watchdog device's timer is | |
5926 | # expired | |
5927 | # | |
5928 | # @reset: system resets | |
5929 | # | |
5930 | # @shutdown: system shutdown, note that it is similar to @powerdown, which | |
5931 | # tries to set to system status and notify guest | |
5932 | # | |
5933 | # @poweroff: system poweroff, the emulator program exits | |
5934 | # | |
5935 | # @pause: system pauses, similar to @stop | |
5936 | # | |
5937 | # @debug: system enters debug state | |
5938 | # | |
5939 | # @none: nothing is done | |
5940 | # | |
795dc6e4 MCL |
5941 | # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all |
5942 | # VCPUS on x86) (since 2.4) | |
5943 | # | |
99eaf09c WX |
5944 | # Since: 2.1 |
5945 | ## | |
5946 | { 'enum': 'WatchdogExpirationAction', | |
795dc6e4 MCL |
5947 | 'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none', |
5948 | 'inject-nmi' ] } | |
99eaf09c | 5949 | |
5a2d2cbd | 5950 | ## |
5072f7b3 | 5951 | # @IoOperationType: |
5a2d2cbd WX |
5952 | # |
5953 | # An enumeration of the I/O operation types | |
5954 | # | |
5955 | # @read: read operation | |
5956 | # | |
5957 | # @write: write operation | |
5958 | # | |
5959 | # Since: 2.1 | |
5960 | ## | |
5961 | { 'enum': 'IoOperationType', | |
5962 | 'data': [ 'read', 'write' ] } | |
5963 | ||
3a449690 | 5964 | ## |
5072f7b3 | 5965 | # @GuestPanicAction: |
3a449690 WX |
5966 | # |
5967 | # An enumeration of the actions taken when guest OS panic is detected | |
5968 | # | |
5969 | # @pause: system pauses | |
5970 | # | |
864111f4 | 5971 | # Since: 2.1 (poweroff since 2.8) |
3a449690 WX |
5972 | ## |
5973 | { 'enum': 'GuestPanicAction', | |
864111f4 | 5974 | 'data': [ 'pause', 'poweroff' ] } |
f2ae8abf | 5975 | |
e8ed97a6 AN |
5976 | ## |
5977 | # @GuestPanicInformationType: | |
5978 | # | |
5979 | # An enumeration of the guest panic information types | |
5980 | # | |
5981 | # Since: 2.9 | |
5982 | ## | |
5983 | { 'enum': 'GuestPanicInformationType', | |
5984 | 'data': [ 'hyper-v'] } | |
5985 | ||
d187e08d AN |
5986 | ## |
5987 | # @GuestPanicInformation: | |
5988 | # | |
5989 | # Information about a guest panic | |
5990 | # | |
5991 | # Since: 2.9 | |
5992 | ## | |
5993 | {'union': 'GuestPanicInformation', | |
e8ed97a6 AN |
5994 | 'base': {'type': 'GuestPanicInformationType'}, |
5995 | 'discriminator': 'type', | |
d187e08d AN |
5996 | 'data': { 'hyper-v': 'GuestPanicInformationHyperV' } } |
5997 | ||
5998 | ## | |
5999 | # @GuestPanicInformationHyperV: | |
6000 | # | |
6001 | # Hyper-V specific guest panic information (HV crash MSRs) | |
6002 | # | |
6003 | # Since: 2.9 | |
6004 | ## | |
6005 | {'struct': 'GuestPanicInformationHyperV', | |
6006 | 'data': { 'arg1': 'uint64', | |
6007 | 'arg2': 'uint64', | |
6008 | 'arg3': 'uint64', | |
6009 | 'arg4': 'uint64', | |
6010 | 'arg5': 'uint64' } } | |
6011 | ||
f2ae8abf | 6012 | ## |
5072f7b3 | 6013 | # @rtc-reset-reinjection: |
f2ae8abf MT |
6014 | # |
6015 | # This command will reset the RTC interrupt reinjection backlog. | |
6016 | # Can be used if another mechanism to synchronize guest time | |
6017 | # is in effect, for example QEMU guest agent's guest-set-time | |
6018 | # command. | |
6019 | # | |
6020 | # Since: 2.1 | |
5c32b4cc MAL |
6021 | # |
6022 | # Example: | |
6023 | # | |
6024 | # -> { "execute": "rtc-reset-reinjection" } | |
6025 | # <- { "return": {} } | |
6026 | # | |
f2ae8abf MT |
6027 | ## |
6028 | { 'command': 'rtc-reset-reinjection' } | |
fafa4d50 SF |
6029 | |
6030 | # Rocker ethernet network switch | |
6031 | { 'include': 'qapi/rocker.json' } | |
d73abd6d PD |
6032 | |
6033 | ## | |
c5927e7a | 6034 | # @ReplayMode: |
d73abd6d PD |
6035 | # |
6036 | # Mode of the replay subsystem. | |
6037 | # | |
6038 | # @none: normal execution mode. Replay or record are not enabled. | |
6039 | # | |
6040 | # @record: record mode. All non-deterministic data is written into the | |
6041 | # replay log. | |
6042 | # | |
6043 | # @play: replay mode. Non-deterministic data required for system execution | |
6044 | # is read from the log. | |
6045 | # | |
6046 | # Since: 2.5 | |
6047 | ## | |
6048 | { 'enum': 'ReplayMode', | |
6049 | 'data': [ 'none', 'record', 'play' ] } | |
ae50a770 | 6050 | |
88c16567 WC |
6051 | ## |
6052 | # @xen-load-devices-state: | |
6053 | # | |
6054 | # Load the state of all devices from file. The RAM and the block devices | |
6055 | # of the VM are not loaded by this command. | |
6056 | # | |
6057 | # @filename: the file to load the state of the devices from as binary | |
6058 | # data. See xen-save-devices-state.txt for a description of the binary | |
6059 | # format. | |
6060 | # | |
6061 | # Since: 2.7 | |
7d1182d9 MAL |
6062 | # |
6063 | # Example: | |
6064 | # | |
6065 | # -> { "execute": "xen-load-devices-state", | |
6066 | # "arguments": { "filename": "/tmp/resume" } } | |
6067 | # <- { "return": {} } | |
6068 | # | |
88c16567 WC |
6069 | ## |
6070 | { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} } | |
6071 | ||
2c9639ec ZC |
6072 | ## |
6073 | # @xen-set-replication: | |
6074 | # | |
6075 | # Enable or disable replication. | |
6076 | # | |
6077 | # @enable: true to enable, false to disable. | |
6078 | # | |
6079 | # @primary: true for primary or false for secondary. | |
6080 | # | |
1d8bda12 | 6081 | # @failover: true to do failover, false to stop. but cannot be |
2c9639ec ZC |
6082 | # specified if 'enable' is true. default value is false. |
6083 | # | |
6084 | # Returns: nothing. | |
6085 | # | |
6086 | # Example: | |
6087 | # | |
6088 | # -> { "execute": "xen-set-replication", | |
6089 | # "arguments": {"enable": true, "primary": false} } | |
6090 | # <- { "return": {} } | |
6091 | # | |
6092 | # Since: 2.9 | |
6093 | ## | |
6094 | { 'command': 'xen-set-replication', | |
6095 | 'data': { 'enable': 'bool', 'primary': 'bool', '*failover' : 'bool' } } | |
6096 | ||
daa33c52 ZC |
6097 | ## |
6098 | # @ReplicationStatus: | |
6099 | # | |
6100 | # The result format for 'query-xen-replication-status'. | |
6101 | # | |
6102 | # @error: true if an error happened, false if replication is normal. | |
6103 | # | |
1d8bda12 | 6104 | # @desc: the human readable error description string, when |
daa33c52 ZC |
6105 | # @error is 'true'. |
6106 | # | |
6107 | # Since: 2.9 | |
6108 | ## | |
6109 | { 'struct': 'ReplicationStatus', | |
6110 | 'data': { 'error': 'bool', '*desc': 'str' } } | |
6111 | ||
6112 | ## | |
6113 | # @query-xen-replication-status: | |
6114 | # | |
6115 | # Query replication status while the vm is running. | |
6116 | # | |
6117 | # Returns: A @ReplicationResult object showing the status. | |
6118 | # | |
6119 | # Example: | |
6120 | # | |
6121 | # -> { "execute": "query-xen-replication-status" } | |
6122 | # <- { "return": { "error": false } } | |
6123 | # | |
6124 | # Since: 2.9 | |
6125 | ## | |
6126 | { 'command': 'query-xen-replication-status', | |
6127 | 'returns': 'ReplicationStatus' } | |
6128 | ||
6129 | ## | |
6130 | # @xen-colo-do-checkpoint: | |
6131 | # | |
6132 | # Xen uses this command to notify replication to trigger a checkpoint. | |
6133 | # | |
6134 | # Returns: nothing. | |
6135 | # | |
6136 | # Example: | |
6137 | # | |
6138 | # -> { "execute": "xen-colo-do-checkpoint" } | |
6139 | # <- { "return": {} } | |
6140 | # | |
6141 | # Since: 2.9 | |
6142 | ## | |
6143 | { 'command': 'xen-colo-do-checkpoint' } | |
6144 | ||
ae50a770 PX |
6145 | ## |
6146 | # @GICCapability: | |
6147 | # | |
6148 | # The struct describes capability for a specific GIC (Generic | |
6149 | # Interrupt Controller) version. These bits are not only decided by | |
6150 | # QEMU/KVM software version, but also decided by the hardware that | |
6151 | # the program is running upon. | |
6152 | # | |
6153 | # @version: version of GIC to be described. Currently, only 2 and 3 | |
6154 | # are supported. | |
6155 | # | |
6156 | # @emulated: whether current QEMU/hardware supports emulated GIC | |
6157 | # device in user space. | |
6158 | # | |
6159 | # @kernel: whether current QEMU/hardware supports hardware | |
6160 | # accelerated GIC device in kernel. | |
6161 | # | |
6162 | # Since: 2.6 | |
6163 | ## | |
6164 | { 'struct': 'GICCapability', | |
6165 | 'data': { 'version': 'int', | |
6166 | 'emulated': 'bool', | |
6167 | 'kernel': 'bool' } } | |
6168 | ||
6169 | ## | |
6170 | # @query-gic-capabilities: | |
6171 | # | |
6172 | # This command is ARM-only. It will return a list of GICCapability | |
6173 | # objects that describe its capability bits. | |
6174 | # | |
6175 | # Returns: a list of GICCapability objects. | |
6176 | # | |
6177 | # Since: 2.6 | |
1965e98d MAL |
6178 | # |
6179 | # Example: | |
6180 | # | |
6181 | # -> { "execute": "query-gic-capabilities" } | |
6182 | # <- { "return": [{ "version": 2, "emulated": true, "kernel": false }, | |
6183 | # { "version": 3, "emulated": false, "kernel": true } ] } | |
6184 | # | |
ae50a770 PX |
6185 | ## |
6186 | { 'command': 'query-gic-capabilities', 'returns': ['GICCapability'] } | |
d4633541 IM |
6187 | |
6188 | ## | |
5072f7b3 | 6189 | # @CpuInstanceProperties: |
d4633541 IM |
6190 | # |
6191 | # List of properties to be used for hotplugging a CPU instance, | |
6192 | # it should be passed by management with device_add command when | |
6193 | # a CPU is being hotplugged. | |
6194 | # | |
1d8bda12 MA |
6195 | # @node-id: NUMA node ID the CPU belongs to |
6196 | # @socket-id: socket number within node/board the CPU belongs to | |
6197 | # @core-id: core number within socket the CPU belongs to | |
6198 | # @thread-id: thread number within core the CPU belongs to | |
5807ff88 | 6199 | # |
d4633541 IM |
6200 | # Note: currently there are 4 properties that could be present |
6201 | # but management should be prepared to pass through other | |
6202 | # properties with device_add command to allow for future | |
27393c33 PK |
6203 | # interface extension. This also requires the filed names to be kept in |
6204 | # sync with the properties passed to -device/device_add. | |
d4633541 | 6205 | # |
d4633541 IM |
6206 | # Since: 2.7 |
6207 | ## | |
6208 | { 'struct': 'CpuInstanceProperties', | |
27393c33 PK |
6209 | 'data': { '*node-id': 'int', |
6210 | '*socket-id': 'int', | |
6211 | '*core-id': 'int', | |
6212 | '*thread-id': 'int' | |
d4633541 IM |
6213 | } |
6214 | } | |
6215 | ||
6216 | ## | |
5072f7b3 | 6217 | # @HotpluggableCPU: |
d4633541 IM |
6218 | # |
6219 | # @type: CPU object type for usage with device_add command | |
6220 | # @props: list of properties to be used for hotplugging CPU | |
6221 | # @vcpus-count: number of logical VCPU threads @HotpluggableCPU provides | |
1d8bda12 | 6222 | # @qom-path: link to existing CPU object if CPU is present or |
d4633541 IM |
6223 | # omitted if CPU is not present. |
6224 | # | |
6225 | # Since: 2.7 | |
6226 | ## | |
6227 | { 'struct': 'HotpluggableCPU', | |
6228 | 'data': { 'type': 'str', | |
6229 | 'vcpus-count': 'int', | |
6230 | 'props': 'CpuInstanceProperties', | |
6231 | '*qom-path': 'str' | |
6232 | } | |
6233 | } | |
6234 | ||
6235 | ## | |
5072f7b3 | 6236 | # @query-hotpluggable-cpus: |
d4633541 IM |
6237 | # |
6238 | # Returns: a list of HotpluggableCPU objects. | |
6239 | # | |
6240 | # Since: 2.7 | |
7e31d1ae MAL |
6241 | # |
6242 | # Example: | |
6243 | # | |
6244 | # For pseries machine type started with -smp 2,cores=2,maxcpus=4 -cpu POWER8: | |
6245 | # | |
6246 | # -> { "execute": "query-hotpluggable-cpus" } | |
6247 | # <- {"return": [ | |
6248 | # { "props": { "core": 8 }, "type": "POWER8-spapr-cpu-core", | |
6249 | # "vcpus-count": 1 }, | |
6250 | # { "props": { "core": 0 }, "type": "POWER8-spapr-cpu-core", | |
6251 | # "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"} | |
6252 | # ]}' | |
6253 | # | |
6254 | # For pc machine type started with -smp 1,maxcpus=2: | |
6255 | # | |
6256 | # -> { "execute": "query-hotpluggable-cpus" } | |
6257 | # <- {"return": [ | |
6258 | # { | |
6259 | # "type": "qemu64-x86_64-cpu", "vcpus-count": 1, | |
6260 | # "props": {"core-id": 0, "socket-id": 1, "thread-id": 0} | |
6261 | # }, | |
6262 | # { | |
6263 | # "qom-path": "/machine/unattached/device[0]", | |
6264 | # "type": "qemu64-x86_64-cpu", "vcpus-count": 1, | |
6265 | # "props": {"core-id": 0, "socket-id": 0, "thread-id": 0} | |
6266 | # } | |
6267 | # ]} | |
6268 | # | |
d4633541 IM |
6269 | ## |
6270 | { 'command': 'query-hotpluggable-cpus', 'returns': ['HotpluggableCPU'] } | |
39164c13 IM |
6271 | |
6272 | ## | |
6273 | # @GuidInfo: | |
6274 | # | |
6275 | # GUID information. | |
6276 | # | |
6277 | # @guid: the globally unique identifier | |
6278 | # | |
6279 | # Since: 2.9 | |
6280 | ## | |
6281 | { 'struct': 'GuidInfo', 'data': {'guid': 'str'} } | |
6282 | ||
6283 | ## | |
6284 | # @query-vm-generation-id: | |
6285 | # | |
6286 | # Show Virtual Machine Generation ID | |
6287 | # | |
6288 | # Since 2.9 | |
6289 | ## | |
6290 | { 'command': 'query-vm-generation-id', 'returns': 'GuidInfo' } |