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