migration: convert unix socket protocol to use QIOChannel
[qemu.git] / qapi-schema.json
1 # -*- Mode: Python -*-
2 #
3 # QAPI Schema
4
5 # QAPI common definitions
6 { 'include': 'qapi/common.json' }
7
8 # QAPI crypto definitions
9 { 'include': 'qapi/crypto.json' }
10
11 # QAPI block definitions
12 { 'include': 'qapi/block.json' }
13
14 # QAPI event definitions
15 { 'include': 'qapi/event.json' }
16
17 # Tracing commands
18 { 'include': 'qapi/trace.json' }
19
20 # QAPI introspection
21 { 'include': 'qapi/introspect.json' }
22
23 ##
24 # @LostTickPolicy:
25 #
26 # Policy for handling lost ticks in timer devices.
27 #
28 # @discard: throw away the missed tick(s) and continue with future injection
29 #           normally.  Guest time may be delayed, unless the OS has explicit
30 #           handling of lost ticks
31 #
32 # @delay: continue to deliver ticks at the normal rate.  Guest time will be
33 #         delayed due to the late tick
34 #
35 # @merge: merge the missed tick(s) into one tick and inject.  Guest time
36 #         may be delayed, depending on how the OS reacts to the merging
37 #         of ticks
38 #
39 # @slew: deliver ticks at a higher rate to catch up with the missed tick. The
40 #        guest time should not be delayed once catchup is complete.
41 #
42 # Since: 2.0
43 ##
44 { 'enum': 'LostTickPolicy',
45   'data': ['discard', 'delay', 'merge', 'slew' ] }
46
47 # @add_client
48 #
49 # Allow client connections for VNC, Spice and socket based
50 # character devices to be passed in to QEMU via SCM_RIGHTS.
51 #
52 # @protocol: protocol name. Valid names are "vnc", "spice" or the
53 #            name of a character device (eg. from -chardev id=XXXX)
54 #
55 # @fdname: file descriptor name previously passed via 'getfd' command
56 #
57 # @skipauth: #optional whether to skip authentication. Only applies
58 #            to "vnc" and "spice" protocols
59 #
60 # @tls: #optional whether to perform TLS. Only applies to the "spice"
61 #       protocol
62 #
63 # Returns: nothing on success.
64 #
65 # Since: 0.14.0
66 ##
67 { 'command': 'add_client',
68   'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
69             '*tls': 'bool' } }
70
71 ##
72 # @NameInfo:
73 #
74 # Guest name information.
75 #
76 # @name: #optional The name of the guest
77 #
78 # Since 0.14.0
79 ##
80 { 'struct': 'NameInfo', 'data': {'*name': 'str'} }
81
82 ##
83 # @query-name:
84 #
85 # Return the name information of a guest.
86 #
87 # Returns: @NameInfo of the guest
88 #
89 # Since 0.14.0
90 ##
91 { 'command': 'query-name', 'returns': 'NameInfo' }
92
93 ##
94 # @KvmInfo:
95 #
96 # Information about support for KVM acceleration
97 #
98 # @enabled: true if KVM acceleration is active
99 #
100 # @present: true if KVM acceleration is built into this executable
101 #
102 # Since: 0.14.0
103 ##
104 { 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
105
106 ##
107 # @query-kvm:
108 #
109 # Returns information about KVM acceleration
110 #
111 # Returns: @KvmInfo
112 #
113 # Since: 0.14.0
114 ##
115 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
116
117 ##
118 # @RunState
119 #
120 # An enumeration of VM run states.
121 #
122 # @debug: QEMU is running on a debugger
123 #
124 # @finish-migrate: guest is paused to finish the migration process
125 #
126 # @inmigrate: guest is paused waiting for an incoming migration.  Note
127 # that this state does not tell whether the machine will start at the
128 # end of the migration.  This depends on the command-line -S option and
129 # any invocation of 'stop' or 'cont' that has happened since QEMU was
130 # started.
131 #
132 # @internal-error: An internal error that prevents further guest execution
133 # has occurred
134 #
135 # @io-error: the last IOP has failed and the device is configured to pause
136 # on I/O errors
137 #
138 # @paused: guest has been paused via the 'stop' command
139 #
140 # @postmigrate: guest is paused following a successful 'migrate'
141 #
142 # @prelaunch: QEMU was started with -S and guest has not started
143 #
144 # @restore-vm: guest is paused to restore VM state
145 #
146 # @running: guest is actively running
147 #
148 # @save-vm: guest is paused to save the VM state
149 #
150 # @shutdown: guest is shut down (and -no-shutdown is in use)
151 #
152 # @suspended: guest is suspended (ACPI S3)
153 #
154 # @watchdog: the watchdog action is configured to pause and has been triggered
155 #
156 # @guest-panicked: guest has been panicked as a result of guest OS panic
157 ##
158 { 'enum': 'RunState',
159   'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
160             'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
161             'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
162             'guest-panicked' ] }
163
164 ##
165 # @StatusInfo:
166 #
167 # Information about VCPU run state
168 #
169 # @running: true if all VCPUs are runnable, false if not runnable
170 #
171 # @singlestep: true if VCPUs are in single-step mode
172 #
173 # @status: the virtual machine @RunState
174 #
175 # Since:  0.14.0
176 #
177 # Notes: @singlestep is enabled through the GDB stub
178 ##
179 { 'struct': 'StatusInfo',
180   'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
181
182 ##
183 # @query-status:
184 #
185 # Query the run status of all VCPUs
186 #
187 # Returns: @StatusInfo reflecting all VCPUs
188 #
189 # Since:  0.14.0
190 ##
191 { 'command': 'query-status', 'returns': 'StatusInfo' }
192
193 ##
194 # @UuidInfo:
195 #
196 # Guest UUID information.
197 #
198 # @UUID: the UUID of the guest
199 #
200 # Since: 0.14.0
201 #
202 # Notes: If no UUID was specified for the guest, a null UUID is returned.
203 ##
204 { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
205
206 ##
207 # @query-uuid:
208 #
209 # Query the guest UUID information.
210 #
211 # Returns: The @UuidInfo for the guest
212 #
213 # Since 0.14.0
214 ##
215 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
216
217 ##
218 # @ChardevInfo:
219 #
220 # Information about a character device.
221 #
222 # @label: the label of the character device
223 #
224 # @filename: the filename of the character device
225 #
226 # @frontend-open: shows whether the frontend device attached to this backend
227 #                 (eg. with the chardev=... option) is in open or closed state
228 #                 (since 2.1)
229 #
230 # Notes: @filename is encoded using the QEMU command line character device
231 #        encoding.  See the QEMU man page for details.
232 #
233 # Since: 0.14.0
234 ##
235 { 'struct': 'ChardevInfo', 'data': {'label': 'str',
236                                   'filename': 'str',
237                                   'frontend-open': 'bool'} }
238
239 ##
240 # @query-chardev:
241 #
242 # Returns information about current character devices.
243 #
244 # Returns: a list of @ChardevInfo
245 #
246 # Since: 0.14.0
247 ##
248 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
249
250 ##
251 # @ChardevBackendInfo:
252 #
253 # Information about a character device backend
254 #
255 # @name: The backend name
256 #
257 # Since: 2.0
258 ##
259 { 'struct': 'ChardevBackendInfo', 'data': {'name': 'str'} }
260
261 ##
262 # @query-chardev-backends:
263 #
264 # Returns information about character device backends.
265 #
266 # Returns: a list of @ChardevBackendInfo
267 #
268 # Since: 2.0
269 ##
270 { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
271
272 ##
273 # @DataFormat:
274 #
275 # An enumeration of data format.
276 #
277 # @utf8: Data is a UTF-8 string (RFC 3629)
278 #
279 # @base64: Data is Base64 encoded binary (RFC 3548)
280 #
281 # Since: 1.4
282 ##
283 { 'enum': 'DataFormat',
284   'data': [ 'utf8', 'base64' ] }
285
286 ##
287 # @ringbuf-write:
288 #
289 # Write to a ring buffer character device.
290 #
291 # @device: the ring buffer character device name
292 #
293 # @data: data to write
294 #
295 # @format: #optional data encoding (default 'utf8').
296 #          - base64: data must be base64 encoded text.  Its binary
297 #            decoding gets written.
298 #          - utf8: data's UTF-8 encoding is written
299 #          - data itself is always Unicode regardless of format, like
300 #            any other string.
301 #
302 # Returns: Nothing on success
303 #
304 # Since: 1.4
305 ##
306 { 'command': 'ringbuf-write',
307   'data': {'device': 'str', 'data': 'str',
308            '*format': 'DataFormat'} }
309
310 ##
311 # @ringbuf-read:
312 #
313 # Read from a ring buffer character device.
314 #
315 # @device: the ring buffer character device name
316 #
317 # @size: how many bytes to read at most
318 #
319 # @format: #optional data encoding (default 'utf8').
320 #          - base64: the data read is returned in base64 encoding.
321 #          - utf8: the data read is interpreted as UTF-8.
322 #            Bug: can screw up when the buffer contains invalid UTF-8
323 #            sequences, NUL characters, after the ring buffer lost
324 #            data, and when reading stops because the size limit is
325 #            reached.
326 #          - The return value is always Unicode regardless of format,
327 #            like any other string.
328 #
329 # Returns: data read from the device
330 #
331 # Since: 1.4
332 ##
333 { 'command': 'ringbuf-read',
334   'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
335   'returns': 'str' }
336
337 ##
338 # @EventInfo:
339 #
340 # Information about a QMP event
341 #
342 # @name: The event name
343 #
344 # Since: 1.2.0
345 ##
346 { 'struct': 'EventInfo', 'data': {'name': 'str'} }
347
348 ##
349 # @query-events:
350 #
351 # Return a list of supported QMP events by this server
352 #
353 # Returns: A list of @EventInfo for all supported events
354 #
355 # Since: 1.2.0
356 ##
357 { 'command': 'query-events', 'returns': ['EventInfo'] }
358
359 ##
360 # @MigrationStats
361 #
362 # Detailed migration status.
363 #
364 # @transferred: amount of bytes already transferred to the target VM
365 #
366 # @remaining: amount of bytes remaining to be transferred to the target VM
367 #
368 # @total: total amount of bytes involved in the migration process
369 #
370 # @duplicate: number of duplicate (zero) pages (since 1.2)
371 #
372 # @skipped: number of skipped zero pages (since 1.5)
373 #
374 # @normal : number of normal pages (since 1.2)
375 #
376 # @normal-bytes: number of normal bytes sent (since 1.2)
377 #
378 # @dirty-pages-rate: number of pages dirtied by second by the
379 #        guest (since 1.3)
380 #
381 # @mbps: throughput in megabits/sec. (since 1.6)
382 #
383 # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
384 #
385 # Since: 0.14.0
386 ##
387 { 'struct': 'MigrationStats',
388   'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
389            'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
390            'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
391            'mbps' : 'number', 'dirty-sync-count' : 'int' } }
392
393 ##
394 # @XBZRLECacheStats
395 #
396 # Detailed XBZRLE migration cache statistics
397 #
398 # @cache-size: XBZRLE cache size
399 #
400 # @bytes: amount of bytes already transferred to the target VM
401 #
402 # @pages: amount of pages transferred to the target VM
403 #
404 # @cache-miss: number of cache miss
405 #
406 # @cache-miss-rate: rate of cache miss (since 2.1)
407 #
408 # @overflow: number of overflows
409 #
410 # Since: 1.2
411 ##
412 { 'struct': 'XBZRLECacheStats',
413   'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
414            'cache-miss': 'int', 'cache-miss-rate': 'number',
415            'overflow': 'int' } }
416
417 # @MigrationStatus:
418 #
419 # An enumeration of migration status.
420 #
421 # @none: no migration has ever happened.
422 #
423 # @setup: migration process has been initiated.
424 #
425 # @cancelling: in the process of cancelling migration.
426 #
427 # @cancelled: cancelling migration is finished.
428 #
429 # @active: in the process of doing migration.
430 #
431 # @postcopy-active: like active, but now in postcopy mode. (since 2.5)
432 #
433 # @completed: migration is finished.
434 #
435 # @failed: some error occurred during migration process.
436 #
437 # Since: 2.3
438 #
439 ##
440 { 'enum': 'MigrationStatus',
441   'data': [ 'none', 'setup', 'cancelling', 'cancelled',
442             'active', 'postcopy-active', 'completed', 'failed' ] }
443
444 ##
445 # @MigrationInfo
446 #
447 # Information about current migration process.
448 #
449 # @status: #optional @MigrationStatus describing the current migration status.
450 #          If this field is not returned, no migration process
451 #          has been initiated
452 #
453 # @ram: #optional @MigrationStats containing detailed migration
454 #       status, only returned if status is 'active' or
455 #       'completed'(since 1.2)
456 #
457 # @disk: #optional @MigrationStats containing detailed disk migration
458 #        status, only returned if status is 'active' and it is a block
459 #        migration
460 #
461 # @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
462 #                migration statistics, only returned if XBZRLE feature is on and
463 #                status is 'active' or 'completed' (since 1.2)
464 #
465 # @total-time: #optional total amount of milliseconds since migration started.
466 #        If migration has ended, it returns the total migration
467 #        time. (since 1.2)
468 #
469 # @downtime: #optional only present when migration finishes correctly
470 #        total downtime in milliseconds for the guest.
471 #        (since 1.3)
472 #
473 # @expected-downtime: #optional only present while migration is active
474 #        expected downtime in milliseconds for the guest in last walk
475 #        of the dirty bitmap. (since 1.3)
476 #
477 # @setup-time: #optional amount of setup time in milliseconds _before_ the
478 #        iterations begin but _after_ the QMP command is issued. This is designed
479 #        to provide an accounting of any activities (such as RDMA pinning) which
480 #        may be expensive, but do not actually occur during the iterative
481 #        migration rounds themselves. (since 1.6)
482 #
483 # @cpu-throttle-percentage: #optional percentage of time guest cpus are being
484 #        throttled during auto-converge. This is only present when auto-converge
485 #        has started throttling guest cpus. (Since 2.7)
486 #
487 # @error-desc: #optional the human readable error description string, when
488 #              @status is 'failed'. Clients should not attempt to parse the
489 #              error strings. (Since 2.6)
490 #
491 # Since: 0.14.0
492 ##
493 { 'struct': 'MigrationInfo',
494   'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
495            '*disk': 'MigrationStats',
496            '*xbzrle-cache': 'XBZRLECacheStats',
497            '*total-time': 'int',
498            '*expected-downtime': 'int',
499            '*downtime': 'int',
500            '*setup-time': 'int',
501            '*cpu-throttle-percentage': 'int',
502            '*error-desc': 'str'} }
503
504 ##
505 # @query-migrate
506 #
507 # Returns information about current migration process.
508 #
509 # Returns: @MigrationInfo
510 #
511 # Since: 0.14.0
512 ##
513 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
514
515 ##
516 # @MigrationCapability
517 #
518 # Migration capabilities enumeration
519 #
520 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
521 #          This feature allows us to minimize migration traffic for certain work
522 #          loads, by sending compressed difference of the pages
523 #
524 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
525 #          mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
526 #          Disabled by default. (since 2.0)
527 #
528 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
529 #          essentially saves 1MB of zeroes per block on the wire. Enabling requires
530 #          source and target VM to support this feature. To enable it is sufficient
531 #          to enable the capability on the source VM. The feature is disabled by
532 #          default. (since 1.6)
533 #
534 # @compress: Use multiple compression threads to accelerate live migration.
535 #          This feature can help to reduce the migration traffic, by sending
536 #          compressed pages. Please note that if compress and xbzrle are both
537 #          on, compress only takes effect in the ram bulk stage, after that,
538 #          it will be disabled and only xbzrle takes effect, this can help to
539 #          minimize migration traffic. The feature is disabled by default.
540 #          (since 2.4 )
541 #
542 # @events: generate events for each migration state change
543 #          (since 2.4 )
544 #
545 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
546 #          to speed up convergence of RAM migration. (since 1.6)
547 #
548 # @postcopy-ram: Start executing on the migration target before all of RAM has
549 #          been migrated, pulling the remaining pages along as needed. NOTE: If
550 #          the migration fails during postcopy the VM will fail.  (since 2.6)
551 #
552 # Since: 1.2
553 ##
554 { 'enum': 'MigrationCapability',
555   'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
556            'compress', 'events', 'postcopy-ram'] }
557
558 ##
559 # @MigrationCapabilityStatus
560 #
561 # Migration capability information
562 #
563 # @capability: capability enum
564 #
565 # @state: capability state bool
566 #
567 # Since: 1.2
568 ##
569 { 'struct': 'MigrationCapabilityStatus',
570   'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
571
572 ##
573 # @migrate-set-capabilities
574 #
575 # Enable/Disable the following migration capabilities (like xbzrle)
576 #
577 # @capabilities: json array of capability modifications to make
578 #
579 # Since: 1.2
580 ##
581 { 'command': 'migrate-set-capabilities',
582   'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
583
584 ##
585 # @query-migrate-capabilities
586 #
587 # Returns information about the current migration capabilities status
588 #
589 # Returns: @MigrationCapabilitiesStatus
590 #
591 # Since: 1.2
592 ##
593 { 'command': 'query-migrate-capabilities', 'returns':   ['MigrationCapabilityStatus']}
594
595 # @MigrationParameter
596 #
597 # Migration parameters enumeration
598 #
599 # @compress-level: Set the compression level to be used in live migration,
600 #          the compression level is an integer between 0 and 9, where 0 means
601 #          no compression, 1 means the best compression speed, and 9 means best
602 #          compression ratio which will consume more CPU.
603 #
604 # @compress-threads: Set compression thread count to be used in live migration,
605 #          the compression thread count is an integer between 1 and 255.
606 #
607 # @decompress-threads: Set decompression thread count to be used in live
608 #          migration, the decompression thread count is an integer between 1
609 #          and 255. Usually, decompression is at least 4 times as fast as
610 #          compression, so set the decompress-threads to the number about 1/4
611 #          of compress-threads is adequate.
612 #
613 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
614 #                        when migration auto-converge is activated. The
615 #                        default value is 20. (Since 2.7)
616 #
617 # @cpu-throttle-increment: throttle percentage increase each time
618 #                          auto-converge detects that migration is not making
619 #                          progress. The default value is 10. (Since 2.7)
620 # Since: 2.4
621 ##
622 { 'enum': 'MigrationParameter',
623   'data': ['compress-level', 'compress-threads', 'decompress-threads',
624            'cpu-throttle-initial', 'cpu-throttle-increment'] }
625
626 #
627 # @migrate-set-parameters
628 #
629 # Set the following migration parameters
630 #
631 # @compress-level: compression level
632 #
633 # @compress-threads: compression thread count
634 #
635 # @decompress-threads: decompression thread count
636 #
637 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
638 #                        when migration auto-converge is activated. The
639 #                        default value is 20. (Since 2.7)
640 #
641 # @cpu-throttle-increment: throttle percentage increase each time
642 #                          auto-converge detects that migration is not making
643 #                          progress. The default value is 10. (Since 2.7)
644 # Since: 2.4
645 ##
646 { 'command': 'migrate-set-parameters',
647   'data': { '*compress-level': 'int',
648             '*compress-threads': 'int',
649             '*decompress-threads': 'int',
650             '*cpu-throttle-initial': 'int',
651             '*cpu-throttle-increment': 'int'} }
652
653 #
654 # @MigrationParameters
655 #
656 # @compress-level: compression level
657 #
658 # @compress-threads: compression thread count
659 #
660 # @decompress-threads: decompression thread count
661 #
662 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
663 #                        when migration auto-converge is activated. The
664 #                        default value is 20. (Since 2.7)
665 #
666 # @cpu-throttle-increment: throttle percentage increase each time
667 #                          auto-converge detects that migration is not making
668 #                          progress. The default value is 10. (Since 2.7)
669 #
670 # Since: 2.4
671 ##
672 { 'struct': 'MigrationParameters',
673   'data': { 'compress-level': 'int',
674             'compress-threads': 'int',
675             'decompress-threads': 'int',
676             'cpu-throttle-initial': 'int',
677             'cpu-throttle-increment': 'int'} }
678 ##
679 # @query-migrate-parameters
680 #
681 # Returns information about the current migration parameters
682 #
683 # Returns: @MigrationParameters
684 #
685 # Since: 2.4
686 ##
687 { 'command': 'query-migrate-parameters',
688   'returns': 'MigrationParameters' }
689
690 ##
691 # @client_migrate_info
692 #
693 # Set migration information for remote display.  This makes the server
694 # ask the client to automatically reconnect using the new parameters
695 # once migration finished successfully.  Only implemented for SPICE.
696 #
697 # @protocol:     must be "spice"
698 # @hostname:     migration target hostname
699 # @port:         #optional spice tcp port for plaintext channels
700 # @tls-port:     #optional spice tcp port for tls-secured channels
701 # @cert-subject: #optional server certificate subject
702 #
703 # Since: 0.14.0
704 ##
705 { 'command': 'client_migrate_info',
706   'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
707             '*tls-port': 'int', '*cert-subject': 'str' } }
708
709 ##
710 # @migrate-start-postcopy
711 #
712 # Followup to a migration command to switch the migration to postcopy mode.
713 # The postcopy-ram capability must be set before the original migration
714 # command.
715 #
716 # Since: 2.5
717 { 'command': 'migrate-start-postcopy' }
718
719 ##
720 # @MouseInfo:
721 #
722 # Information about a mouse device.
723 #
724 # @name: the name of the mouse device
725 #
726 # @index: the index of the mouse device
727 #
728 # @current: true if this device is currently receiving mouse events
729 #
730 # @absolute: true if this device supports absolute coordinates as input
731 #
732 # Since: 0.14.0
733 ##
734 { 'struct': 'MouseInfo',
735   'data': {'name': 'str', 'index': 'int', 'current': 'bool',
736            'absolute': 'bool'} }
737
738 ##
739 # @query-mice:
740 #
741 # Returns information about each active mouse device
742 #
743 # Returns: a list of @MouseInfo for each device
744 #
745 # Since: 0.14.0
746 ##
747 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
748
749 ##
750 # @CpuInfoArch:
751 #
752 # An enumeration of cpu types that enable additional information during
753 # @query-cpus.
754 #
755 # Since: 2.6
756 ##
757 { 'enum': 'CpuInfoArch',
758   'data': ['x86', 'sparc', 'ppc', 'mips', 'tricore', 'other' ] }
759
760 ##
761 # @CpuInfo:
762 #
763 # Information about a virtual CPU
764 #
765 # @CPU: the index of the virtual CPU
766 #
767 # @current: this only exists for backwards compatibility and should be ignored
768 #
769 # @halted: true if the virtual CPU is in the halt state.  Halt usually refers
770 #          to a processor specific low power mode.
771 #
772 # @qom_path: path to the CPU object in the QOM tree (since 2.4)
773 #
774 # @thread_id: ID of the underlying host thread
775 #
776 # @arch: architecture of the cpu, which determines which additional fields
777 #        will be listed (since 2.6)
778 #
779 # Since: 0.14.0
780 #
781 # Notes: @halted is a transient state that changes frequently.  By the time the
782 #        data is sent to the client, the guest may no longer be halted.
783 ##
784 { 'union': 'CpuInfo',
785   'base': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
786            'qom_path': 'str', 'thread_id': 'int', 'arch': 'CpuInfoArch' },
787   'discriminator': 'arch',
788   'data': { 'x86': 'CpuInfoX86',
789             'sparc': 'CpuInfoSPARC',
790             'ppc': 'CpuInfoPPC',
791             'mips': 'CpuInfoMIPS',
792             'tricore': 'CpuInfoTricore',
793             'other': 'CpuInfoOther' } }
794
795 ##
796 # @CpuInfoX86:
797 #
798 # Additional information about a virtual i386 or x86_64 CPU
799 #
800 # @pc: the 64-bit instruction pointer
801 #
802 # Since 2.6
803 ##
804 { 'struct': 'CpuInfoX86', 'data': { 'pc': 'int' } }
805
806 ##
807 # @CpuInfoSPARC:
808 #
809 # Additional information about a virtual SPARC CPU
810 #
811 # @pc: the PC component of the instruction pointer
812 #
813 # @npc: the NPC component of the instruction pointer
814 #
815 # Since 2.6
816 ##
817 { 'struct': 'CpuInfoSPARC', 'data': { 'pc': 'int', 'npc': 'int' } }
818
819 ##
820 # @CpuInfoPPC:
821 #
822 # Additional information about a virtual PPC CPU
823 #
824 # @nip: the instruction pointer
825 #
826 # Since 2.6
827 ##
828 { 'struct': 'CpuInfoPPC', 'data': { 'nip': 'int' } }
829
830 ##
831 # @CpuInfoMIPS:
832 #
833 # Additional information about a virtual MIPS CPU
834 #
835 # @PC: the instruction pointer
836 #
837 # Since 2.6
838 ##
839 { 'struct': 'CpuInfoMIPS', 'data': { 'PC': 'int' } }
840
841 ##
842 # @CpuInfoTricore:
843 #
844 # Additional information about a virtual Tricore CPU
845 #
846 # @PC: the instruction pointer
847 #
848 # Since 2.6
849 ##
850 { 'struct': 'CpuInfoTricore', 'data': { 'PC': 'int' } }
851
852 ##
853 # @CpuInfoOther:
854 #
855 # No additional information is available about the virtual CPU
856 #
857 # Since 2.6
858 #
859 ##
860 { 'struct': 'CpuInfoOther', 'data': { } }
861
862 ##
863 # @query-cpus:
864 #
865 # Returns a list of information about each virtual CPU.
866 #
867 # Returns: a list of @CpuInfo for each virtual CPU
868 #
869 # Since: 0.14.0
870 ##
871 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
872
873 ##
874 # @IOThreadInfo:
875 #
876 # Information about an iothread
877 #
878 # @id: the identifier of the iothread
879 #
880 # @thread-id: ID of the underlying host thread
881 #
882 # Since: 2.0
883 ##
884 { 'struct': 'IOThreadInfo',
885   'data': {'id': 'str', 'thread-id': 'int'} }
886
887 ##
888 # @query-iothreads:
889 #
890 # Returns a list of information about each iothread.
891 #
892 # Note this list excludes the QEMU main loop thread, which is not declared
893 # using the -object iothread command-line option.  It is always the main thread
894 # of the process.
895 #
896 # Returns: a list of @IOThreadInfo for each iothread
897 #
898 # Since: 2.0
899 ##
900 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
901
902 ##
903 # @NetworkAddressFamily
904 #
905 # The network address family
906 #
907 # @ipv4: IPV4 family
908 #
909 # @ipv6: IPV6 family
910 #
911 # @unix: unix socket
912 #
913 # @unknown: otherwise
914 #
915 # Since: 2.1
916 ##
917 { 'enum': 'NetworkAddressFamily',
918   'data': [ 'ipv4', 'ipv6', 'unix', 'unknown' ] }
919
920 ##
921 # @VncBasicInfo
922 #
923 # The basic information for vnc network connection
924 #
925 # @host: IP address
926 #
927 # @service: The service name of the vnc port. This may depend on the host
928 #           system's service database so symbolic names should not be relied
929 #           on.
930 #
931 # @family: address family
932 #
933 # @websocket: true in case the socket is a websocket (since 2.3).
934 #
935 # Since: 2.1
936 ##
937 { 'struct': 'VncBasicInfo',
938   'data': { 'host': 'str',
939             'service': 'str',
940             'family': 'NetworkAddressFamily',
941             'websocket': 'bool' } }
942
943 ##
944 # @VncServerInfo
945 #
946 # The network connection information for server
947 #
948 # @auth: #optional, authentication method
949 #
950 # Since: 2.1
951 ##
952 { 'struct': 'VncServerInfo',
953   'base': 'VncBasicInfo',
954   'data': { '*auth': 'str' } }
955
956 ##
957 # @VncClientInfo:
958 #
959 # Information about a connected VNC client.
960 #
961 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
962 #              Name of the client.
963 #
964 # @sasl_username: #optional If SASL authentication is in use, the SASL username
965 #                 used for authentication.
966 #
967 # Since: 0.14.0
968 ##
969 { 'struct': 'VncClientInfo',
970   'base': 'VncBasicInfo',
971   'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
972
973 ##
974 # @VncInfo:
975 #
976 # Information about the VNC session.
977 #
978 # @enabled: true if the VNC server is enabled, false otherwise
979 #
980 # @host: #optional The hostname the VNC server is bound to.  This depends on
981 #        the name resolution on the host and may be an IP address.
982 #
983 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
984 #                    'ipv4' if the host is listening for IPv4 connections
985 #                    'unix' if the host is listening on a unix domain socket
986 #                    'unknown' otherwise
987 #
988 # @service: #optional The service name of the server's port.  This may depends
989 #           on the host system's service database so symbolic names should not
990 #           be relied on.
991 #
992 # @auth: #optional the current authentication type used by the server
993 #        'none' if no authentication is being used
994 #        'vnc' if VNC authentication is being used
995 #        'vencrypt+plain' if VEncrypt is used with plain text authentication
996 #        'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
997 #        'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
998 #        'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
999 #        'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
1000 #        'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
1001 #        'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
1002 #        'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
1003 #        'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
1004 #
1005 # @clients: a list of @VncClientInfo of all currently connected clients
1006 #
1007 # Since: 0.14.0
1008 ##
1009 { 'struct': 'VncInfo',
1010   'data': {'enabled': 'bool', '*host': 'str',
1011            '*family': 'NetworkAddressFamily',
1012            '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
1013
1014 ##
1015 # @VncPriAuth:
1016 #
1017 # vnc primary authentication method.
1018 #
1019 # Since: 2.3
1020 ##
1021 { 'enum': 'VncPrimaryAuth',
1022   'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
1023             'tls', 'vencrypt', 'sasl' ] }
1024
1025 ##
1026 # @VncVencryptSubAuth:
1027 #
1028 # vnc sub authentication method with vencrypt.
1029 #
1030 # Since: 2.3
1031 ##
1032 { 'enum': 'VncVencryptSubAuth',
1033   'data': [ 'plain',
1034             'tls-none',  'x509-none',
1035             'tls-vnc',   'x509-vnc',
1036             'tls-plain', 'x509-plain',
1037             'tls-sasl',  'x509-sasl' ] }
1038
1039 ##
1040 # @VncInfo2:
1041 #
1042 # Information about a vnc server
1043 #
1044 # @id: vnc server name.
1045 #
1046 # @server: A list of @VncBasincInfo describing all listening sockets.
1047 #          The list can be empty (in case the vnc server is disabled).
1048 #          It also may have multiple entries: normal + websocket,
1049 #          possibly also ipv4 + ipv6 in the future.
1050 #
1051 # @clients: A list of @VncClientInfo of all currently connected clients.
1052 #           The list can be empty, for obvious reasons.
1053 #
1054 # @auth: The current authentication type used by the server
1055 #
1056 # @vencrypt: #optional The vencrypt sub authentication type used by the server,
1057 #            only specified in case auth == vencrypt.
1058 #
1059 # @display: #optional The display device the vnc server is linked to.
1060 #
1061 # Since: 2.3
1062 ##
1063 { 'struct': 'VncInfo2',
1064   'data': { 'id'        : 'str',
1065             'server'    : ['VncBasicInfo'],
1066             'clients'   : ['VncClientInfo'],
1067             'auth'      : 'VncPrimaryAuth',
1068             '*vencrypt' : 'VncVencryptSubAuth',
1069             '*display'  : 'str' } }
1070
1071 ##
1072 # @query-vnc:
1073 #
1074 # Returns information about the current VNC server
1075 #
1076 # Returns: @VncInfo
1077 #
1078 # Since: 0.14.0
1079 ##
1080 { 'command': 'query-vnc', 'returns': 'VncInfo' }
1081
1082 ##
1083 # @query-vnc-servers:
1084 #
1085 # Returns a list of vnc servers.  The list can be empty.
1086 #
1087 # Returns: a list of @VncInfo2
1088 #
1089 # Since: 2.3
1090 ##
1091 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }
1092
1093 ##
1094 # @SpiceBasicInfo
1095 #
1096 # The basic information for SPICE network connection
1097 #
1098 # @host: IP address
1099 #
1100 # @port: port number
1101 #
1102 # @family: address family
1103 #
1104 # Since: 2.1
1105 ##
1106 { 'struct': 'SpiceBasicInfo',
1107   'data': { 'host': 'str',
1108             'port': 'str',
1109             'family': 'NetworkAddressFamily' } }
1110
1111 ##
1112 # @SpiceServerInfo
1113 #
1114 # Information about a SPICE server
1115 #
1116 # @auth: #optional, authentication method
1117 #
1118 # Since: 2.1
1119 ##
1120 { 'struct': 'SpiceServerInfo',
1121   'base': 'SpiceBasicInfo',
1122   'data': { '*auth': 'str' } }
1123
1124 ##
1125 # @SpiceChannel
1126 #
1127 # Information about a SPICE client channel.
1128 #
1129 # @connection-id: SPICE connection id number.  All channels with the same id
1130 #                 belong to the same SPICE session.
1131 #
1132 # @channel-type: SPICE channel type number.  "1" is the main control
1133 #                channel, filter for this one if you want to track spice
1134 #                sessions only
1135 #
1136 # @channel-id: SPICE channel ID number.  Usually "0", might be different when
1137 #              multiple channels of the same type exist, such as multiple
1138 #              display channels in a multihead setup
1139 #
1140 # @tls: true if the channel is encrypted, false otherwise.
1141 #
1142 # Since: 0.14.0
1143 ##
1144 { 'struct': 'SpiceChannel',
1145   'base': 'SpiceBasicInfo',
1146   'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1147            'tls': 'bool'} }
1148
1149 ##
1150 # @SpiceQueryMouseMode
1151 #
1152 # An enumeration of Spice mouse states.
1153 #
1154 # @client: Mouse cursor position is determined by the client.
1155 #
1156 # @server: Mouse cursor position is determined by the server.
1157 #
1158 # @unknown: No information is available about mouse mode used by
1159 #           the spice server.
1160 #
1161 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1162 #
1163 # Since: 1.1
1164 ##
1165 { 'enum': 'SpiceQueryMouseMode',
1166   'data': [ 'client', 'server', 'unknown' ] }
1167
1168 ##
1169 # @SpiceInfo
1170 #
1171 # Information about the SPICE session.
1172 #
1173 # @enabled: true if the SPICE server is enabled, false otherwise
1174 #
1175 # @migrated: true if the last guest migration completed and spice
1176 #            migration had completed as well. false otherwise.
1177 #
1178 # @host: #optional The hostname the SPICE server is bound to.  This depends on
1179 #        the name resolution on the host and may be an IP address.
1180 #
1181 # @port: #optional The SPICE server's port number.
1182 #
1183 # @compiled-version: #optional SPICE server version.
1184 #
1185 # @tls-port: #optional The SPICE server's TLS port number.
1186 #
1187 # @auth: #optional the current authentication type used by the server
1188 #        'none'  if no authentication is being used
1189 #        'spice' uses SASL or direct TLS authentication, depending on command
1190 #                line options
1191 #
1192 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1193 #              be determined by the client or the server, or unknown if spice
1194 #              server doesn't provide this information.
1195 #
1196 #              Since: 1.1
1197 #
1198 # @channels: a list of @SpiceChannel for each active spice channel
1199 #
1200 # Since: 0.14.0
1201 ##
1202 { 'struct': 'SpiceInfo',
1203   'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1204            '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1205            'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1206
1207 ##
1208 # @query-spice
1209 #
1210 # Returns information about the current SPICE server
1211 #
1212 # Returns: @SpiceInfo
1213 #
1214 # Since: 0.14.0
1215 ##
1216 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1217
1218 ##
1219 # @BalloonInfo:
1220 #
1221 # Information about the guest balloon device.
1222 #
1223 # @actual: the number of bytes the balloon currently contains
1224 #
1225 # Since: 0.14.0
1226 #
1227 ##
1228 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
1229
1230 ##
1231 # @query-balloon:
1232 #
1233 # Return information about the balloon device.
1234 #
1235 # Returns: @BalloonInfo on success
1236 #          If the balloon driver is enabled but not functional because the KVM
1237 #          kernel module cannot support it, KvmMissingCap
1238 #          If no balloon device is present, DeviceNotActive
1239 #
1240 # Since: 0.14.0
1241 ##
1242 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1243
1244 ##
1245 # @PciMemoryRange:
1246 #
1247 # A PCI device memory region
1248 #
1249 # @base: the starting address (guest physical)
1250 #
1251 # @limit: the ending address (guest physical)
1252 #
1253 # Since: 0.14.0
1254 ##
1255 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1256
1257 ##
1258 # @PciMemoryRegion
1259 #
1260 # Information about a PCI device I/O region.
1261 #
1262 # @bar: the index of the Base Address Register for this region
1263 #
1264 # @type: 'io' if the region is a PIO region
1265 #        'memory' if the region is a MMIO region
1266 #
1267 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1268 #
1269 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1270 #
1271 # Since: 0.14.0
1272 ##
1273 { 'struct': 'PciMemoryRegion',
1274   'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1275            '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1276
1277 ##
1278 # @PciBusInfo:
1279 #
1280 # Information about a bus of a PCI Bridge device
1281 #
1282 # @number: primary bus interface number.  This should be the number of the
1283 #          bus the device resides on.
1284 #
1285 # @secondary: secondary bus interface number.  This is the number of the
1286 #             main bus for the bridge
1287 #
1288 # @subordinate: This is the highest number bus that resides below the
1289 #               bridge.
1290 #
1291 # @io_range: The PIO range for all devices on this bridge
1292 #
1293 # @memory_range: The MMIO range for all devices on this bridge
1294 #
1295 # @prefetchable_range: The range of prefetchable MMIO for all devices on
1296 #                      this bridge
1297 #
1298 # Since: 2.4
1299 ##
1300 { 'struct': 'PciBusInfo',
1301   'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1302            'io_range': 'PciMemoryRange',
1303            'memory_range': 'PciMemoryRange',
1304            'prefetchable_range': 'PciMemoryRange' } }
1305
1306 ##
1307 # @PciBridgeInfo:
1308 #
1309 # Information about a PCI Bridge device
1310 #
1311 # @bus: information about the bus the device resides on
1312 #
1313 # @devices: a list of @PciDeviceInfo for each device on this bridge
1314 #
1315 # Since: 0.14.0
1316 ##
1317 { 'struct': 'PciBridgeInfo',
1318   'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
1319
1320 ##
1321 # @PciDeviceClass:
1322 #
1323 # Information about the Class of a PCI device
1324 #
1325 # @desc: #optional a string description of the device's class
1326 #
1327 # @class: the class code of the device
1328 #
1329 # Since: 2.4
1330 ##
1331 { 'struct': 'PciDeviceClass',
1332   'data': {'*desc': 'str', 'class': 'int'} }
1333
1334 ##
1335 # @PciDeviceId:
1336 #
1337 # Information about the Id of a PCI device
1338 #
1339 # @device: the PCI device id
1340 #
1341 # @vendor: the PCI vendor id
1342 #
1343 # Since: 2.4
1344 ##
1345 { 'struct': 'PciDeviceId',
1346   'data': {'device': 'int', 'vendor': 'int'} }
1347
1348 ##
1349 # @PciDeviceInfo:
1350 #
1351 # Information about a PCI device
1352 #
1353 # @bus: the bus number of the device
1354 #
1355 # @slot: the slot the device is located in
1356 #
1357 # @function: the function of the slot used by the device
1358 #
1359 # @class_info: the class of the device
1360 #
1361 # @id: the PCI device id
1362 #
1363 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
1364 #
1365 # @qdev_id: the device name of the PCI device
1366 #
1367 # @pci_bridge: if the device is a PCI bridge, the bridge information
1368 #
1369 # @regions: a list of the PCI I/O regions associated with the device
1370 #
1371 # Notes: the contents of @class_info.desc are not stable and should only be
1372 #        treated as informational.
1373 #
1374 # Since: 0.14.0
1375 ##
1376 { 'struct': 'PciDeviceInfo',
1377   'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1378            'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
1379            '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
1380            'regions': ['PciMemoryRegion']} }
1381
1382 ##
1383 # @PciInfo:
1384 #
1385 # Information about a PCI bus
1386 #
1387 # @bus: the bus index
1388 #
1389 # @devices: a list of devices on this bus
1390 #
1391 # Since: 0.14.0
1392 ##
1393 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
1394
1395 ##
1396 # @query-pci:
1397 #
1398 # Return information about the PCI bus topology of the guest.
1399 #
1400 # Returns: a list of @PciInfo for each PCI bus
1401 #
1402 # Since: 0.14.0
1403 ##
1404 { 'command': 'query-pci', 'returns': ['PciInfo'] }
1405
1406 ##
1407 # @quit:
1408 #
1409 # This command will cause the QEMU process to exit gracefully.  While every
1410 # attempt is made to send the QMP response before terminating, this is not
1411 # guaranteed.  When using this interface, a premature EOF would not be
1412 # unexpected.
1413 #
1414 # Since: 0.14.0
1415 ##
1416 { 'command': 'quit' }
1417
1418 ##
1419 # @stop:
1420 #
1421 # Stop all guest VCPU execution.
1422 #
1423 # Since:  0.14.0
1424 #
1425 # Notes:  This function will succeed even if the guest is already in the stopped
1426 #         state.  In "inmigrate" state, it will ensure that the guest
1427 #         remains paused once migration finishes, as if the -S option was
1428 #         passed on the command line.
1429 ##
1430 { 'command': 'stop' }
1431
1432 ##
1433 # @system_reset:
1434 #
1435 # Performs a hard reset of a guest.
1436 #
1437 # Since: 0.14.0
1438 ##
1439 { 'command': 'system_reset' }
1440
1441 ##
1442 # @system_powerdown:
1443 #
1444 # Requests that a guest perform a powerdown operation.
1445 #
1446 # Since: 0.14.0
1447 #
1448 # Notes: A guest may or may not respond to this command.  This command
1449 #        returning does not indicate that a guest has accepted the request or
1450 #        that it has shut down.  Many guests will respond to this command by
1451 #        prompting the user in some way.
1452 ##
1453 { 'command': 'system_powerdown' }
1454
1455 ##
1456 # @cpu:
1457 #
1458 # This command is a nop that is only provided for the purposes of compatibility.
1459 #
1460 # Since: 0.14.0
1461 #
1462 # Notes: Do not use this command.
1463 ##
1464 { 'command': 'cpu', 'data': {'index': 'int'} }
1465
1466 ##
1467 # @cpu-add
1468 #
1469 # Adds CPU with specified ID
1470 #
1471 # @id: ID of CPU to be created, valid values [0..max_cpus)
1472 #
1473 # Returns: Nothing on success
1474 #
1475 # Since 1.5
1476 ##
1477 { 'command': 'cpu-add', 'data': {'id': 'int'} }
1478
1479 ##
1480 # @memsave:
1481 #
1482 # Save a portion of guest memory to a file.
1483 #
1484 # @val: the virtual address of the guest to start from
1485 #
1486 # @size: the size of memory region to save
1487 #
1488 # @filename: the file to save the memory to as binary data
1489 #
1490 # @cpu-index: #optional the index of the virtual CPU to use for translating the
1491 #                       virtual address (defaults to CPU 0)
1492 #
1493 # Returns: Nothing on success
1494 #
1495 # Since: 0.14.0
1496 #
1497 # Notes: Errors were not reliably returned until 1.1
1498 ##
1499 { 'command': 'memsave',
1500   'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
1501
1502 ##
1503 # @pmemsave:
1504 #
1505 # Save a portion of guest physical memory to a file.
1506 #
1507 # @val: the physical address of the guest to start from
1508 #
1509 # @size: the size of memory region to save
1510 #
1511 # @filename: the file to save the memory to as binary data
1512 #
1513 # Returns: Nothing on success
1514 #
1515 # Since: 0.14.0
1516 #
1517 # Notes: Errors were not reliably returned until 1.1
1518 ##
1519 { 'command': 'pmemsave',
1520   'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
1521
1522 ##
1523 # @cont:
1524 #
1525 # Resume guest VCPU execution.
1526 #
1527 # Since:  0.14.0
1528 #
1529 # Returns:  If successful, nothing
1530 #           If QEMU was started with an encrypted block device and a key has
1531 #              not yet been set, DeviceEncrypted.
1532 #
1533 # Notes:  This command will succeed if the guest is currently running.  It
1534 #         will also succeed if the guest is in the "inmigrate" state; in
1535 #         this case, the effect of the command is to make sure the guest
1536 #         starts once migration finishes, removing the effect of the -S
1537 #         command line option if it was passed.
1538 ##
1539 { 'command': 'cont' }
1540
1541 ##
1542 # @system_wakeup:
1543 #
1544 # Wakeup guest from suspend.  Does nothing in case the guest isn't suspended.
1545 #
1546 # Since:  1.1
1547 #
1548 # Returns:  nothing.
1549 ##
1550 { 'command': 'system_wakeup' }
1551
1552 ##
1553 # @inject-nmi:
1554 #
1555 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
1556 #
1557 # Returns:  If successful, nothing
1558 #
1559 # Since:  0.14.0
1560 #
1561 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
1562 ##
1563 { 'command': 'inject-nmi' }
1564
1565 ##
1566 # @set_link:
1567 #
1568 # Sets the link status of a virtual network adapter.
1569 #
1570 # @name: the device name of the virtual network adapter
1571 #
1572 # @up: true to set the link status to be up
1573 #
1574 # Returns: Nothing on success
1575 #          If @name is not a valid network device, DeviceNotFound
1576 #
1577 # Since: 0.14.0
1578 #
1579 # Notes: Not all network adapters support setting link status.  This command
1580 #        will succeed even if the network adapter does not support link status
1581 #        notification.
1582 ##
1583 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1584
1585 ##
1586 # @balloon:
1587 #
1588 # Request the balloon driver to change its balloon size.
1589 #
1590 # @value: the target size of the balloon in bytes
1591 #
1592 # Returns: Nothing on success
1593 #          If the balloon driver is enabled but not functional because the KVM
1594 #            kernel module cannot support it, KvmMissingCap
1595 #          If no balloon device is present, DeviceNotActive
1596 #
1597 # Notes: This command just issues a request to the guest.  When it returns,
1598 #        the balloon size may not have changed.  A guest can change the balloon
1599 #        size independent of this command.
1600 #
1601 # Since: 0.14.0
1602 ##
1603 { 'command': 'balloon', 'data': {'value': 'int'} }
1604
1605 ##
1606 # @Abort
1607 #
1608 # This action can be used to test transaction failure.
1609 #
1610 # Since: 1.6
1611 ###
1612 { 'struct': 'Abort',
1613   'data': { } }
1614
1615 ##
1616 # @ActionCompletionMode
1617 #
1618 # An enumeration of Transactional completion modes.
1619 #
1620 # @individual: Do not attempt to cancel any other Actions if any Actions fail
1621 #              after the Transaction request succeeds. All Actions that
1622 #              can complete successfully will do so without waiting on others.
1623 #              This is the default.
1624 #
1625 # @grouped: If any Action fails after the Transaction succeeds, cancel all
1626 #           Actions. Actions do not complete until all Actions are ready to
1627 #           complete. May be rejected by Actions that do not support this
1628 #           completion mode.
1629 #
1630 # Since: 2.5
1631 ##
1632 { 'enum': 'ActionCompletionMode',
1633   'data': [ 'individual', 'grouped' ] }
1634
1635 ##
1636 # @TransactionAction
1637 #
1638 # A discriminated record of operations that can be performed with
1639 # @transaction.
1640 #
1641 # Since 1.1
1642 #
1643 # drive-backup since 1.6
1644 # abort since 1.6
1645 # blockdev-snapshot-internal-sync since 1.7
1646 # blockdev-backup since 2.3
1647 # blockdev-snapshot since 2.5
1648 # block-dirty-bitmap-add since 2.5
1649 # block-dirty-bitmap-clear since 2.5
1650 ##
1651 { 'union': 'TransactionAction',
1652   'data': {
1653        'blockdev-snapshot': 'BlockdevSnapshot',
1654        'blockdev-snapshot-sync': 'BlockdevSnapshotSync',
1655        'drive-backup': 'DriveBackup',
1656        'blockdev-backup': 'BlockdevBackup',
1657        'abort': 'Abort',
1658        'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal',
1659        'block-dirty-bitmap-add': 'BlockDirtyBitmapAdd',
1660        'block-dirty-bitmap-clear': 'BlockDirtyBitmap'
1661    } }
1662
1663 ##
1664 # @TransactionProperties
1665 #
1666 # Optional arguments to modify the behavior of a Transaction.
1667 #
1668 # @completion-mode: #optional Controls how jobs launched asynchronously by
1669 #                   Actions will complete or fail as a group.
1670 #                   See @ActionCompletionMode for details.
1671 #
1672 # Since: 2.5
1673 ##
1674 { 'struct': 'TransactionProperties',
1675   'data': {
1676        '*completion-mode': 'ActionCompletionMode'
1677   }
1678 }
1679
1680 ##
1681 # @transaction
1682 #
1683 # Executes a number of transactionable QMP commands atomically. If any
1684 # operation fails, then the entire set of actions will be abandoned and the
1685 # appropriate error returned.
1686 #
1687 # @actions: List of @TransactionAction;
1688 #           information needed for the respective operations.
1689 #
1690 # @properties: #optional structure of additional options to control the
1691 #              execution of the transaction. See @TransactionProperties
1692 #              for additional detail.
1693 #
1694 # Returns: nothing on success
1695 #          Errors depend on the operations of the transaction
1696 #
1697 # Note: The transaction aborts on the first failure.  Therefore, there will be
1698 # information on only one failed operation returned in an error condition, and
1699 # subsequent actions will not have been attempted.
1700 #
1701 # Since 1.1
1702 ##
1703 { 'command': 'transaction',
1704   'data': { 'actions': [ 'TransactionAction' ],
1705             '*properties': 'TransactionProperties'
1706           }
1707 }
1708
1709 ##
1710 # @human-monitor-command:
1711 #
1712 # Execute a command on the human monitor and return the output.
1713 #
1714 # @command-line: the command to execute in the human monitor
1715 #
1716 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1717 #
1718 # Returns: the output of the command as a string
1719 #
1720 # Since: 0.14.0
1721 #
1722 # Notes: This command only exists as a stop-gap.  Its use is highly
1723 #        discouraged.  The semantics of this command are not guaranteed.
1724 #
1725 #        Known limitations:
1726 #
1727 #        o This command is stateless, this means that commands that depend
1728 #          on state information (such as getfd) might not work
1729 #
1730 #       o Commands that prompt the user for data (eg. 'cont' when the block
1731 #         device is encrypted) don't currently work
1732 ##
1733 { 'command': 'human-monitor-command',
1734   'data': {'command-line': 'str', '*cpu-index': 'int'},
1735   'returns': 'str' }
1736
1737 ##
1738 # @migrate_cancel
1739 #
1740 # Cancel the current executing migration process.
1741 #
1742 # Returns: nothing on success
1743 #
1744 # Notes: This command succeeds even if there is no migration process running.
1745 #
1746 # Since: 0.14.0
1747 ##
1748 { 'command': 'migrate_cancel' }
1749
1750 ##
1751 # @migrate_set_downtime
1752 #
1753 # Set maximum tolerated downtime for migration.
1754 #
1755 # @value: maximum downtime in seconds
1756 #
1757 # Returns: nothing on success
1758 #
1759 # Since: 0.14.0
1760 ##
1761 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1762
1763 ##
1764 # @migrate_set_speed
1765 #
1766 # Set maximum speed for migration.
1767 #
1768 # @value: maximum speed in bytes.
1769 #
1770 # Returns: nothing on success
1771 #
1772 # Notes: A value lesser than zero will be automatically round up to zero.
1773 #
1774 # Since: 0.14.0
1775 ##
1776 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1777
1778 ##
1779 # @migrate-set-cache-size
1780 #
1781 # Set XBZRLE cache size
1782 #
1783 # @value: cache size in bytes
1784 #
1785 # The size will be rounded down to the nearest power of 2.
1786 # The cache size can be modified before and during ongoing migration
1787 #
1788 # Returns: nothing on success
1789 #
1790 # Since: 1.2
1791 ##
1792 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
1793
1794 ##
1795 # @query-migrate-cache-size
1796 #
1797 # query XBZRLE cache size
1798 #
1799 # Returns: XBZRLE cache size in bytes
1800 #
1801 # Since: 1.2
1802 ##
1803 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1804
1805 ##
1806 # @ObjectPropertyInfo:
1807 #
1808 # @name: the name of the property
1809 #
1810 # @type: the type of the property.  This will typically come in one of four
1811 #        forms:
1812 #
1813 #        1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1814 #           These types are mapped to the appropriate JSON type.
1815 #
1816 #        2) A child type in the form 'child<subtype>' where subtype is a qdev
1817 #           device type name.  Child properties create the composition tree.
1818 #
1819 #        3) A link type in the form 'link<subtype>' where subtype is a qdev
1820 #           device type name.  Link properties form the device model graph.
1821 #
1822 # Since: 1.2
1823 ##
1824 { 'struct': 'ObjectPropertyInfo',
1825   'data': { 'name': 'str', 'type': 'str' } }
1826
1827 ##
1828 # @qom-list:
1829 #
1830 # This command will list any properties of a object given a path in the object
1831 # model.
1832 #
1833 # @path: the path within the object model.  See @qom-get for a description of
1834 #        this parameter.
1835 #
1836 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
1837 #          object.
1838 #
1839 # Since: 1.2
1840 ##
1841 { 'command': 'qom-list',
1842   'data': { 'path': 'str' },
1843   'returns': [ 'ObjectPropertyInfo' ] }
1844
1845 ##
1846 # @qom-get:
1847 #
1848 # This command will get a property from a object model path and return the
1849 # value.
1850 #
1851 # @path: The path within the object model.  There are two forms of supported
1852 #        paths--absolute and partial paths.
1853 #
1854 #        Absolute paths are derived from the root object and can follow child<>
1855 #        or link<> properties.  Since they can follow link<> properties, they
1856 #        can be arbitrarily long.  Absolute paths look like absolute filenames
1857 #        and are prefixed  with a leading slash.
1858 #
1859 #        Partial paths look like relative filenames.  They do not begin
1860 #        with a prefix.  The matching rules for partial paths are subtle but
1861 #        designed to make specifying objects easy.  At each level of the
1862 #        composition tree, the partial path is matched as an absolute path.
1863 #        The first match is not returned.  At least two matches are searched
1864 #        for.  A successful result is only returned if only one match is
1865 #        found.  If more than one match is found, a flag is return to
1866 #        indicate that the match was ambiguous.
1867 #
1868 # @property: The property name to read
1869 #
1870 # Returns: The property value.  The type depends on the property
1871 #          type. child<> and link<> properties are returned as #str
1872 #          pathnames.  All integer property types (u8, u16, etc) are
1873 #          returned as #int.
1874 #
1875 # Since: 1.2
1876 ##
1877 { 'command': 'qom-get',
1878   'data': { 'path': 'str', 'property': 'str' },
1879   'returns': 'any' }
1880
1881 ##
1882 # @qom-set:
1883 #
1884 # This command will set a property from a object model path.
1885 #
1886 # @path: see @qom-get for a description of this parameter
1887 #
1888 # @property: the property name to set
1889 #
1890 # @value: a value who's type is appropriate for the property type.  See @qom-get
1891 #         for a description of type mapping.
1892 #
1893 # Since: 1.2
1894 ##
1895 { 'command': 'qom-set',
1896   'data': { 'path': 'str', 'property': 'str', 'value': 'any' } }
1897
1898 ##
1899 # @set_password:
1900 #
1901 # Sets the password of a remote display session.
1902 #
1903 # @protocol: `vnc' to modify the VNC server password
1904 #            `spice' to modify the Spice server password
1905 #
1906 # @password: the new password
1907 #
1908 # @connected: #optional how to handle existing clients when changing the
1909 #                       password.  If nothing is specified, defaults to `keep'
1910 #                       `fail' to fail the command if clients are connected
1911 #                       `disconnect' to disconnect existing clients
1912 #                       `keep' to maintain existing clients
1913 #
1914 # Returns: Nothing on success
1915 #          If Spice is not enabled, DeviceNotFound
1916 #
1917 # Since: 0.14.0
1918 ##
1919 { 'command': 'set_password',
1920   'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
1921
1922 ##
1923 # @expire_password:
1924 #
1925 # Expire the password of a remote display server.
1926 #
1927 # @protocol: the name of the remote display protocol `vnc' or `spice'
1928 #
1929 # @time: when to expire the password.
1930 #        `now' to expire the password immediately
1931 #        `never' to cancel password expiration
1932 #        `+INT' where INT is the number of seconds from now (integer)
1933 #        `INT' where INT is the absolute time in seconds
1934 #
1935 # Returns: Nothing on success
1936 #          If @protocol is `spice' and Spice is not active, DeviceNotFound
1937 #
1938 # Since: 0.14.0
1939 #
1940 # Notes: Time is relative to the server and currently there is no way to
1941 #        coordinate server time with client time.  It is not recommended to
1942 #        use the absolute time version of the @time parameter unless you're
1943 #        sure you are on the same machine as the QEMU instance.
1944 ##
1945 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
1946
1947 ##
1948 # @change-vnc-password:
1949 #
1950 # Change the VNC server password.
1951 #
1952 # @password:  the new password to use with VNC authentication
1953 #
1954 # Since: 1.1
1955 #
1956 # Notes:  An empty password in this command will set the password to the empty
1957 #         string.  Existing clients are unaffected by executing this command.
1958 ##
1959 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
1960
1961 ##
1962 # @change:
1963 #
1964 # This command is multiple commands multiplexed together.
1965 #
1966 # @device: This is normally the name of a block device but it may also be 'vnc'.
1967 #          when it's 'vnc', then sub command depends on @target
1968 #
1969 # @target: If @device is a block device, then this is the new filename.
1970 #          If @device is 'vnc', then if the value 'password' selects the vnc
1971 #          change password command.   Otherwise, this specifies a new server URI
1972 #          address to listen to for VNC connections.
1973 #
1974 # @arg:    If @device is a block device, then this is an optional format to open
1975 #          the device with.
1976 #          If @device is 'vnc' and @target is 'password', this is the new VNC
1977 #          password to set.  If this argument is an empty string, then no future
1978 #          logins will be allowed.
1979 #
1980 # Returns: Nothing on success.
1981 #          If @device is not a valid block device, DeviceNotFound
1982 #          If the new block device is encrypted, DeviceEncrypted.  Note that
1983 #          if this error is returned, the device has been opened successfully
1984 #          and an additional call to @block_passwd is required to set the
1985 #          device's password.  The behavior of reads and writes to the block
1986 #          device between when these calls are executed is undefined.
1987 #
1988 # Notes:  This interface is deprecated, and it is strongly recommended that you
1989 #         avoid using it.  For changing block devices, use
1990 #         blockdev-change-medium; for changing VNC parameters, use
1991 #         change-vnc-password.
1992 #
1993 # Since: 0.14.0
1994 ##
1995 { 'command': 'change',
1996   'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
1997
1998 ##
1999 # @ObjectTypeInfo:
2000 #
2001 # This structure describes a search result from @qom-list-types
2002 #
2003 # @name: the type name found in the search
2004 #
2005 # Since: 1.1
2006 #
2007 # Notes: This command is experimental and may change syntax in future releases.
2008 ##
2009 { 'struct': 'ObjectTypeInfo',
2010   'data': { 'name': 'str' } }
2011
2012 ##
2013 # @qom-list-types:
2014 #
2015 # This command will return a list of types given search parameters
2016 #
2017 # @implements: if specified, only return types that implement this type name
2018 #
2019 # @abstract: if true, include abstract types in the results
2020 #
2021 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
2022 #
2023 # Since: 1.1
2024 ##
2025 { 'command': 'qom-list-types',
2026   'data': { '*implements': 'str', '*abstract': 'bool' },
2027   'returns': [ 'ObjectTypeInfo' ] }
2028
2029 ##
2030 # @DevicePropertyInfo:
2031 #
2032 # Information about device properties.
2033 #
2034 # @name: the name of the property
2035 # @type: the typename of the property
2036 # @description: #optional if specified, the description of the property.
2037 #               (since 2.2)
2038 #
2039 # Since: 1.2
2040 ##
2041 { 'struct': 'DevicePropertyInfo',
2042   'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
2043
2044 ##
2045 # @device-list-properties:
2046 #
2047 # List properties associated with a device.
2048 #
2049 # @typename: the type name of a device
2050 #
2051 # Returns: a list of DevicePropertyInfo describing a devices properties
2052 #
2053 # Since: 1.2
2054 ##
2055 { 'command': 'device-list-properties',
2056   'data': { 'typename': 'str'},
2057   'returns': [ 'DevicePropertyInfo' ] }
2058
2059 ##
2060 # @migrate
2061 #
2062 # Migrates the current running guest to another Virtual Machine.
2063 #
2064 # @uri: the Uniform Resource Identifier of the destination VM
2065 #
2066 # @blk: #optional do block migration (full disk copy)
2067 #
2068 # @inc: #optional incremental disk copy migration
2069 #
2070 # @detach: this argument exists only for compatibility reasons and
2071 #          is ignored by QEMU
2072 #
2073 # Returns: nothing on success
2074 #
2075 # Since: 0.14.0
2076 ##
2077 { 'command': 'migrate',
2078   'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
2079
2080 ##
2081 # @migrate-incoming
2082 #
2083 # Start an incoming migration, the qemu must have been started
2084 # with -incoming defer
2085 #
2086 # @uri: The Uniform Resource Identifier identifying the source or
2087 #       address to listen on
2088 #
2089 # Returns: nothing on success
2090 #
2091 # Since: 2.3
2092 # Note: It's a bad idea to use a string for the uri, but it needs to stay
2093 # compatible with -incoming and the format of the uri is already exposed
2094 # above libvirt
2095 ##
2096 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
2097
2098 # @xen-save-devices-state:
2099 #
2100 # Save the state of all devices to file. The RAM and the block devices
2101 # of the VM are not saved by this command.
2102 #
2103 # @filename: the file to save the state of the devices to as binary
2104 # data. See xen-save-devices-state.txt for a description of the binary
2105 # format.
2106 #
2107 # Returns: Nothing on success
2108 #
2109 # Since: 1.1
2110 ##
2111 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
2112
2113 ##
2114 # @xen-set-global-dirty-log
2115 #
2116 # Enable or disable the global dirty log mode.
2117 #
2118 # @enable: true to enable, false to disable.
2119 #
2120 # Returns: nothing
2121 #
2122 # Since: 1.3
2123 ##
2124 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
2125
2126 ##
2127 # @device_del:
2128 #
2129 # Remove a device from a guest
2130 #
2131 # @id: the name or QOM path of the device
2132 #
2133 # Returns: Nothing on success
2134 #          If @id is not a valid device, DeviceNotFound
2135 #
2136 # Notes: When this command completes, the device may not be removed from the
2137 #        guest.  Hot removal is an operation that requires guest cooperation.
2138 #        This command merely requests that the guest begin the hot removal
2139 #        process.  Completion of the device removal process is signaled with a
2140 #        DEVICE_DELETED event. Guest reset will automatically complete removal
2141 #        for all devices.
2142 #
2143 # Since: 0.14.0
2144 ##
2145 { 'command': 'device_del', 'data': {'id': 'str'} }
2146
2147 ##
2148 # @DumpGuestMemoryFormat:
2149 #
2150 # An enumeration of guest-memory-dump's format.
2151 #
2152 # @elf: elf format
2153 #
2154 # @kdump-zlib: kdump-compressed format with zlib-compressed
2155 #
2156 # @kdump-lzo: kdump-compressed format with lzo-compressed
2157 #
2158 # @kdump-snappy: kdump-compressed format with snappy-compressed
2159 #
2160 # Since: 2.0
2161 ##
2162 { 'enum': 'DumpGuestMemoryFormat',
2163   'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
2164
2165 ##
2166 # @dump-guest-memory
2167 #
2168 # Dump guest's memory to vmcore. It is a synchronous operation that can take
2169 # very long depending on the amount of guest memory.
2170 #
2171 # @paging: if true, do paging to get guest's memory mapping. This allows
2172 #          using gdb to process the core file.
2173 #
2174 #          IMPORTANT: this option can make QEMU allocate several gigabytes
2175 #                     of RAM. This can happen for a large guest, or a
2176 #                     malicious guest pretending to be large.
2177 #
2178 #          Also, paging=true has the following limitations:
2179 #
2180 #             1. The guest may be in a catastrophic state or can have corrupted
2181 #                memory, which cannot be trusted
2182 #             2. The guest can be in real-mode even if paging is enabled. For
2183 #                example, the guest uses ACPI to sleep, and ACPI sleep state
2184 #                goes in real-mode
2185 #             3. Currently only supported on i386 and x86_64.
2186 #
2187 # @protocol: the filename or file descriptor of the vmcore. The supported
2188 #            protocols are:
2189 #
2190 #            1. file: the protocol starts with "file:", and the following
2191 #               string is the file's path.
2192 #            2. fd: the protocol starts with "fd:", and the following string
2193 #               is the fd's name.
2194 #
2195 # @detach: #optional if true, QMP will return immediately rather than
2196 #          waiting for the dump to finish. The user can track progress
2197 #          using "query-dump". (since 2.6).
2198 #
2199 # @begin: #optional if specified, the starting physical address.
2200 #
2201 # @length: #optional if specified, the memory size, in bytes. If you don't
2202 #          want to dump all guest's memory, please specify the start @begin
2203 #          and @length
2204 #
2205 # @format: #optional if specified, the format of guest memory dump. But non-elf
2206 #          format is conflict with paging and filter, ie. @paging, @begin and
2207 #          @length is not allowed to be specified with non-elf @format at the
2208 #          same time (since 2.0)
2209 #
2210 # Returns: nothing on success
2211 #
2212 # Since: 1.2
2213 ##
2214 { 'command': 'dump-guest-memory',
2215   'data': { 'paging': 'bool', 'protocol': 'str', '*detach': 'bool',
2216             '*begin': 'int', '*length': 'int',
2217             '*format': 'DumpGuestMemoryFormat'} }
2218
2219 ##
2220 # @DumpStatus
2221 #
2222 # Describe the status of a long-running background guest memory dump.
2223 #
2224 # @none: no dump-guest-memory has started yet.
2225 #
2226 # @active: there is one dump running in background.
2227 #
2228 # @completed: the last dump has finished successfully.
2229 #
2230 # @failed: the last dump has failed.
2231 #
2232 # Since 2.6
2233 ##
2234 { 'enum': 'DumpStatus',
2235   'data': [ 'none', 'active', 'completed', 'failed' ] }
2236
2237 ##
2238 # @DumpQueryResult
2239 #
2240 # The result format for 'query-dump'.
2241 #
2242 # @status: enum of @DumpStatus, which shows current dump status
2243 #
2244 # @completed: bytes written in latest dump (uncompressed)
2245 #
2246 # @total: total bytes to be written in latest dump (uncompressed)
2247 #
2248 # Since 2.6
2249 ##
2250 { 'struct': 'DumpQueryResult',
2251   'data': { 'status': 'DumpStatus',
2252             'completed': 'int',
2253             'total': 'int' } }
2254
2255 ##
2256 # @query-dump
2257 #
2258 # Query latest dump status.
2259 #
2260 # Returns: A @DumpStatus object showing the dump status.
2261 #
2262 # Since: 2.6
2263 ##
2264 { 'command': 'query-dump', 'returns': 'DumpQueryResult' }
2265
2266 ##
2267 # @DumpGuestMemoryCapability:
2268 #
2269 # A list of the available formats for dump-guest-memory
2270 #
2271 # Since: 2.0
2272 ##
2273 { 'struct': 'DumpGuestMemoryCapability',
2274   'data': {
2275       'formats': ['DumpGuestMemoryFormat'] } }
2276
2277 ##
2278 # @query-dump-guest-memory-capability:
2279 #
2280 # Returns the available formats for dump-guest-memory
2281 #
2282 # Returns:  A @DumpGuestMemoryCapability object listing available formats for
2283 #           dump-guest-memory
2284 #
2285 # Since: 2.0
2286 ##
2287 { 'command': 'query-dump-guest-memory-capability',
2288   'returns': 'DumpGuestMemoryCapability' }
2289
2290 ##
2291 # @dump-skeys
2292 #
2293 # Dump guest's storage keys
2294 #
2295 # @filename: the path to the file to dump to
2296 #
2297 # This command is only supported on s390 architecture.
2298 #
2299 # Since: 2.5
2300 ##
2301 { 'command': 'dump-skeys',
2302   'data': { 'filename': 'str' } }
2303
2304 ##
2305 # @netdev_add:
2306 #
2307 # Add a network backend.
2308 #
2309 # @type: the type of network backend.  Current valid values are 'user', 'tap',
2310 #        'vde', 'socket', 'dump' and 'bridge'
2311 #
2312 # @id: the name of the new network backend
2313 #
2314 # Additional arguments depend on the type.
2315 #
2316 # TODO This command effectively bypasses QAPI completely due to its
2317 # "additional arguments" business.  It shouldn't have been added to
2318 # the schema in this form.  It should be qapified properly, or
2319 # replaced by a properly qapified command.
2320 #
2321 # Since: 0.14.0
2322 #
2323 # Returns: Nothing on success
2324 #          If @type is not a valid network backend, DeviceNotFound
2325 ##
2326 { 'command': 'netdev_add',
2327   'data': {'type': 'str', 'id': 'str'},
2328   'gen': false }                # so we can get the additional arguments
2329
2330 ##
2331 # @netdev_del:
2332 #
2333 # Remove a network backend.
2334 #
2335 # @id: the name of the network backend to remove
2336 #
2337 # Returns: Nothing on success
2338 #          If @id is not a valid network backend, DeviceNotFound
2339 #
2340 # Since: 0.14.0
2341 ##
2342 { 'command': 'netdev_del', 'data': {'id': 'str'} }
2343
2344 ##
2345 # @object-add:
2346 #
2347 # Create a QOM object.
2348 #
2349 # @qom-type: the class name for the object to be created
2350 #
2351 # @id: the name of the new object
2352 #
2353 # @props: #optional a dictionary of properties to be passed to the backend
2354 #
2355 # Returns: Nothing on success
2356 #          Error if @qom-type is not a valid class name
2357 #
2358 # Since: 2.0
2359 ##
2360 { 'command': 'object-add',
2361   'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} }
2362
2363 ##
2364 # @object-del:
2365 #
2366 # Remove a QOM object.
2367 #
2368 # @id: the name of the QOM object to remove
2369 #
2370 # Returns: Nothing on success
2371 #          Error if @id is not a valid id for a QOM object
2372 #
2373 # Since: 2.0
2374 ##
2375 { 'command': 'object-del', 'data': {'id': 'str'} }
2376
2377 ##
2378 # @NetdevNoneOptions
2379 #
2380 # Use it alone to have zero network devices.
2381 #
2382 # Since 1.2
2383 ##
2384 { 'struct': 'NetdevNoneOptions',
2385   'data': { } }
2386
2387 ##
2388 # @NetLegacyNicOptions
2389 #
2390 # Create a new Network Interface Card.
2391 #
2392 # @netdev: #optional id of -netdev to connect to
2393 #
2394 # @macaddr: #optional MAC address
2395 #
2396 # @model: #optional device model (e1000, rtl8139, virtio etc.)
2397 #
2398 # @addr: #optional PCI device address
2399 #
2400 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
2401 #
2402 # Since 1.2
2403 ##
2404 { 'struct': 'NetLegacyNicOptions',
2405   'data': {
2406     '*netdev':  'str',
2407     '*macaddr': 'str',
2408     '*model':   'str',
2409     '*addr':    'str',
2410     '*vectors': 'uint32' } }
2411
2412 ##
2413 # @String
2414 #
2415 # A fat type wrapping 'str', to be embedded in lists.
2416 #
2417 # Since 1.2
2418 ##
2419 { 'struct': 'String',
2420   'data': {
2421     'str': 'str' } }
2422
2423 ##
2424 # @NetdevUserOptions
2425 #
2426 # Use the user mode network stack which requires no administrator privilege to
2427 # run.
2428 #
2429 # @hostname: #optional client hostname reported by the builtin DHCP server
2430 #
2431 # @restrict: #optional isolate the guest from the host
2432 #
2433 # @ipv4: #optional whether to support IPv4, default true for enabled
2434 #        (since 2.6)
2435 #
2436 # @ipv6: #optional whether to support IPv6, default true for enabled
2437 #        (since 2.6)
2438 #
2439 # @ip: #optional legacy parameter, use net= instead
2440 #
2441 # @net: #optional IP network address that the guest will see, in the
2442 #       form addr[/netmask] The netmask is optional, and can be
2443 #       either in the form a.b.c.d or as a number of valid top-most
2444 #       bits. Default is 10.0.2.0/24.
2445 #
2446 # @host: #optional guest-visible address of the host
2447 #
2448 # @tftp: #optional root directory of the built-in TFTP server
2449 #
2450 # @bootfile: #optional BOOTP filename, for use with tftp=
2451 #
2452 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
2453 #             assign
2454 #
2455 # @dns: #optional guest-visible address of the virtual nameserver
2456 #
2457 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
2458 #             to the guest
2459 #
2460 # @ipv6-prefix: #optional IPv6 network prefix (default is fec0::) (since
2461 #               2.6). The network prefix is given in the usual
2462 #               hexadecimal IPv6 address notation.
2463 #
2464 # @ipv6-prefixlen: #optional IPv6 network prefix length (default is 64)
2465 #                  (since 2.6)
2466 #
2467 # @ipv6-host: #optional guest-visible IPv6 address of the host (since 2.6)
2468 #
2469 # @ipv6-dns: #optional guest-visible IPv6 address of the virtual
2470 #            nameserver (since 2.6)
2471 #
2472 # @smb: #optional root directory of the built-in SMB server
2473 #
2474 # @smbserver: #optional IP address of the built-in SMB server
2475 #
2476 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
2477 #           endpoints
2478 #
2479 # @guestfwd: #optional forward guest TCP connections
2480 #
2481 # Since 1.2
2482 ##
2483 { 'struct': 'NetdevUserOptions',
2484   'data': {
2485     '*hostname':  'str',
2486     '*restrict':  'bool',
2487     '*ipv4':      'bool',
2488     '*ipv6':      'bool',
2489     '*ip':        'str',
2490     '*net':       'str',
2491     '*host':      'str',
2492     '*tftp':      'str',
2493     '*bootfile':  'str',
2494     '*dhcpstart': 'str',
2495     '*dns':       'str',
2496     '*dnssearch': ['String'],
2497     '*ipv6-prefix':      'str',
2498     '*ipv6-prefixlen':   'int',
2499     '*ipv6-host':        'str',
2500     '*ipv6-dns':         'str',
2501     '*smb':       'str',
2502     '*smbserver': 'str',
2503     '*hostfwd':   ['String'],
2504     '*guestfwd':  ['String'] } }
2505
2506 ##
2507 # @NetdevTapOptions
2508 #
2509 # Connect the host TAP network interface name to the VLAN.
2510 #
2511 # @ifname: #optional interface name
2512 #
2513 # @fd: #optional file descriptor of an already opened tap
2514 #
2515 # @fds: #optional multiple file descriptors of already opened multiqueue capable
2516 # tap
2517 #
2518 # @script: #optional script to initialize the interface
2519 #
2520 # @downscript: #optional script to shut down the interface
2521 #
2522 # @helper: #optional command to execute to configure bridge
2523 #
2524 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
2525 #
2526 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
2527 #
2528 # @vhost: #optional enable vhost-net network accelerator
2529 #
2530 # @vhostfd: #optional file descriptor of an already opened vhost net device
2531 #
2532 # @vhostfds: #optional file descriptors of multiple already opened vhost net
2533 # devices
2534 #
2535 # @vhostforce: #optional vhost on for non-MSIX virtio guests
2536 #
2537 # @queues: #optional number of queues to be created for multiqueue capable tap
2538 #
2539 # Since 1.2
2540 ##
2541 { 'struct': 'NetdevTapOptions',
2542   'data': {
2543     '*ifname':     'str',
2544     '*fd':         'str',
2545     '*fds':        'str',
2546     '*script':     'str',
2547     '*downscript': 'str',
2548     '*helper':     'str',
2549     '*sndbuf':     'size',
2550     '*vnet_hdr':   'bool',
2551     '*vhost':      'bool',
2552     '*vhostfd':    'str',
2553     '*vhostfds':   'str',
2554     '*vhostforce': 'bool',
2555     '*queues':     'uint32'} }
2556
2557 ##
2558 # @NetdevSocketOptions
2559 #
2560 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
2561 # socket connection.
2562 #
2563 # @fd: #optional file descriptor of an already opened socket
2564 #
2565 # @listen: #optional port number, and optional hostname, to listen on
2566 #
2567 # @connect: #optional port number, and optional hostname, to connect to
2568 #
2569 # @mcast: #optional UDP multicast address and port number
2570 #
2571 # @localaddr: #optional source address and port for multicast and udp packets
2572 #
2573 # @udp: #optional UDP unicast address and port number
2574 #
2575 # Since 1.2
2576 ##
2577 { 'struct': 'NetdevSocketOptions',
2578   'data': {
2579     '*fd':        'str',
2580     '*listen':    'str',
2581     '*connect':   'str',
2582     '*mcast':     'str',
2583     '*localaddr': 'str',
2584     '*udp':       'str' } }
2585
2586 ##
2587 # @NetdevL2TPv3Options
2588 #
2589 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
2590 #
2591 # @src: source address
2592 #
2593 # @dst: destination address
2594 #
2595 # @srcport: #optional source port - mandatory for udp, optional for ip
2596 #
2597 # @dstport: #optional destination port - mandatory for udp, optional for ip
2598 #
2599 # @ipv6: #optional - force the use of ipv6
2600 #
2601 # @udp: #optional - use the udp version of l2tpv3 encapsulation
2602 #
2603 # @cookie64: #optional - use 64 bit coookies
2604 #
2605 # @counter: #optional have sequence counter
2606 #
2607 # @pincounter: #optional pin sequence counter to zero -
2608 #              workaround for buggy implementations or
2609 #              networks with packet reorder
2610 #
2611 # @txcookie: #optional 32 or 64 bit transmit cookie
2612 #
2613 # @rxcookie: #optional 32 or 64 bit receive cookie
2614 #
2615 # @txsession: 32 bit transmit session
2616 #
2617 # @rxsession: #optional 32 bit receive session - if not specified
2618 #             set to the same value as transmit
2619 #
2620 # @offset: #optional additional offset - allows the insertion of
2621 #          additional application-specific data before the packet payload
2622 #
2623 # Since 2.1
2624 ##
2625 { 'struct': 'NetdevL2TPv3Options',
2626   'data': {
2627     'src':          'str',
2628     'dst':          'str',
2629     '*srcport':     'str',
2630     '*dstport':     'str',
2631     '*ipv6':        'bool',
2632     '*udp':         'bool',
2633     '*cookie64':    'bool',
2634     '*counter':     'bool',
2635     '*pincounter':  'bool',
2636     '*txcookie':    'uint64',
2637     '*rxcookie':    'uint64',
2638     'txsession':    'uint32',
2639     '*rxsession':   'uint32',
2640     '*offset':      'uint32' } }
2641
2642 ##
2643 # @NetdevVdeOptions
2644 #
2645 # Connect the VLAN to a vde switch running on the host.
2646 #
2647 # @sock: #optional socket path
2648 #
2649 # @port: #optional port number
2650 #
2651 # @group: #optional group owner of socket
2652 #
2653 # @mode: #optional permissions for socket
2654 #
2655 # Since 1.2
2656 ##
2657 { 'struct': 'NetdevVdeOptions',
2658   'data': {
2659     '*sock':  'str',
2660     '*port':  'uint16',
2661     '*group': 'str',
2662     '*mode':  'uint16' } }
2663
2664 ##
2665 # @NetdevDumpOptions
2666 #
2667 # Dump VLAN network traffic to a file.
2668 #
2669 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
2670 # suffixes.
2671 #
2672 # @file: #optional dump file path (default is qemu-vlan0.pcap)
2673 #
2674 # Since 1.2
2675 ##
2676 { 'struct': 'NetdevDumpOptions',
2677   'data': {
2678     '*len':  'size',
2679     '*file': 'str' } }
2680
2681 ##
2682 # @NetdevBridgeOptions
2683 #
2684 # Connect a host TAP network interface to a host bridge device.
2685 #
2686 # @br: #optional bridge name
2687 #
2688 # @helper: #optional command to execute to configure bridge
2689 #
2690 # Since 1.2
2691 ##
2692 { 'struct': 'NetdevBridgeOptions',
2693   'data': {
2694     '*br':     'str',
2695     '*helper': 'str' } }
2696
2697 ##
2698 # @NetdevHubPortOptions
2699 #
2700 # Connect two or more net clients through a software hub.
2701 #
2702 # @hubid: hub identifier number
2703 #
2704 # Since 1.2
2705 ##
2706 { 'struct': 'NetdevHubPortOptions',
2707   'data': {
2708     'hubid':     'int32' } }
2709
2710 ##
2711 # @NetdevNetmapOptions
2712 #
2713 # Connect a client to a netmap-enabled NIC or to a VALE switch port
2714 #
2715 # @ifname: Either the name of an existing network interface supported by
2716 #          netmap, or the name of a VALE port (created on the fly).
2717 #          A VALE port name is in the form 'valeXXX:YYY', where XXX and
2718 #          YYY are non-negative integers. XXX identifies a switch and
2719 #          YYY identifies a port of the switch. VALE ports having the
2720 #          same XXX are therefore connected to the same switch.
2721 #
2722 # @devname: #optional path of the netmap device (default: '/dev/netmap').
2723 #
2724 # Since 2.0
2725 ##
2726 { 'struct': 'NetdevNetmapOptions',
2727   'data': {
2728     'ifname':     'str',
2729     '*devname':    'str' } }
2730
2731 ##
2732 # @NetdevVhostUserOptions
2733 #
2734 # Vhost-user network backend
2735 #
2736 # @chardev: name of a unix socket chardev
2737 #
2738 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
2739 #
2740 # @queues: #optional number of queues to be created for multiqueue vhost-user
2741 #          (default: 1) (Since 2.5)
2742 #
2743 # Since 2.1
2744 ##
2745 { 'struct': 'NetdevVhostUserOptions',
2746   'data': {
2747     'chardev':        'str',
2748     '*vhostforce':    'bool',
2749     '*queues':        'int' } }
2750
2751 ##
2752 # @NetClientOptions
2753 #
2754 # A discriminated record of network device traits.
2755 #
2756 # Since 1.2
2757 #
2758 # 'l2tpv3' - since 2.1
2759 #
2760 ##
2761 { 'union': 'NetClientOptions',
2762   'data': {
2763     'none':     'NetdevNoneOptions',
2764     'nic':      'NetLegacyNicOptions',
2765     'user':     'NetdevUserOptions',
2766     'tap':      'NetdevTapOptions',
2767     'l2tpv3':   'NetdevL2TPv3Options',
2768     'socket':   'NetdevSocketOptions',
2769     'vde':      'NetdevVdeOptions',
2770     'dump':     'NetdevDumpOptions',
2771     'bridge':   'NetdevBridgeOptions',
2772     'hubport':  'NetdevHubPortOptions',
2773     'netmap':   'NetdevNetmapOptions',
2774     'vhost-user': 'NetdevVhostUserOptions' } }
2775
2776 ##
2777 # @NetLegacy
2778 #
2779 # Captures the configuration of a network device; legacy.
2780 #
2781 # @vlan: #optional vlan number
2782 #
2783 # @id: #optional identifier for monitor commands
2784 #
2785 # @name: #optional identifier for monitor commands, ignored if @id is present
2786 #
2787 # @opts: device type specific properties (legacy)
2788 #
2789 # Since 1.2
2790 ##
2791 { 'struct': 'NetLegacy',
2792   'data': {
2793     '*vlan': 'int32',
2794     '*id':   'str',
2795     '*name': 'str',
2796     'opts':  'NetClientOptions' } }
2797
2798 ##
2799 # @Netdev
2800 #
2801 # Captures the configuration of a network device.
2802 #
2803 # @id: identifier for monitor commands.
2804 #
2805 # @opts: device type specific properties
2806 #
2807 # Since 1.2
2808 ##
2809 { 'struct': 'Netdev',
2810   'data': {
2811     'id':   'str',
2812     'opts': 'NetClientOptions' } }
2813
2814 ##
2815 # @NetFilterDirection
2816 #
2817 # Indicates whether a netfilter is attached to a netdev's transmit queue or
2818 # receive queue or both.
2819 #
2820 # @all: the filter is attached both to the receive and the transmit
2821 #       queue of the netdev (default).
2822 #
2823 # @rx: the filter is attached to the receive queue of the netdev,
2824 #      where it will receive packets sent to the netdev.
2825 #
2826 # @tx: the filter is attached to the transmit queue of the netdev,
2827 #      where it will receive packets sent by the netdev.
2828 #
2829 # Since 2.5
2830 ##
2831 { 'enum': 'NetFilterDirection',
2832   'data': [ 'all', 'rx', 'tx' ] }
2833
2834 ##
2835 # @InetSocketAddress
2836 #
2837 # Captures a socket address or address range in the Internet namespace.
2838 #
2839 # @host: host part of the address
2840 #
2841 # @port: port part of the address, or lowest port if @to is present
2842 #
2843 # @to: highest port to try
2844 #
2845 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
2846 #        #optional
2847 #
2848 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
2849 #        #optional
2850 #
2851 # Since 1.3
2852 ##
2853 { 'struct': 'InetSocketAddress',
2854   'data': {
2855     'host': 'str',
2856     'port': 'str',
2857     '*to': 'uint16',
2858     '*ipv4': 'bool',
2859     '*ipv6': 'bool' } }
2860
2861 ##
2862 # @UnixSocketAddress
2863 #
2864 # Captures a socket address in the local ("Unix socket") namespace.
2865 #
2866 # @path: filesystem path to use
2867 #
2868 # Since 1.3
2869 ##
2870 { 'struct': 'UnixSocketAddress',
2871   'data': {
2872     'path': 'str' } }
2873
2874 ##
2875 # @SocketAddress
2876 #
2877 # Captures the address of a socket, which could also be a named file descriptor
2878 #
2879 # Since 1.3
2880 ##
2881 { 'union': 'SocketAddress',
2882   'data': {
2883     'inet': 'InetSocketAddress',
2884     'unix': 'UnixSocketAddress',
2885     'fd': 'String' } }
2886
2887 ##
2888 # @getfd:
2889 #
2890 # Receive a file descriptor via SCM rights and assign it a name
2891 #
2892 # @fdname: file descriptor name
2893 #
2894 # Returns: Nothing on success
2895 #
2896 # Since: 0.14.0
2897 #
2898 # Notes: If @fdname already exists, the file descriptor assigned to
2899 #        it will be closed and replaced by the received file
2900 #        descriptor.
2901 #        The 'closefd' command can be used to explicitly close the
2902 #        file descriptor when it is no longer needed.
2903 ##
2904 { 'command': 'getfd', 'data': {'fdname': 'str'} }
2905
2906 ##
2907 # @closefd:
2908 #
2909 # Close a file descriptor previously passed via SCM rights
2910 #
2911 # @fdname: file descriptor name
2912 #
2913 # Returns: Nothing on success
2914 #
2915 # Since: 0.14.0
2916 ##
2917 { 'command': 'closefd', 'data': {'fdname': 'str'} }
2918
2919 ##
2920 # @MachineInfo:
2921 #
2922 # Information describing a machine.
2923 #
2924 # @name: the name of the machine
2925 #
2926 # @alias: #optional an alias for the machine name
2927 #
2928 # @default: #optional whether the machine is default
2929 #
2930 # @cpu-max: maximum number of CPUs supported by the machine type
2931 #           (since 1.5.0)
2932 #
2933 # Since: 1.2.0
2934 ##
2935 { 'struct': 'MachineInfo',
2936   'data': { 'name': 'str', '*alias': 'str',
2937             '*is-default': 'bool', 'cpu-max': 'int' } }
2938
2939 ##
2940 # @query-machines:
2941 #
2942 # Return a list of supported machines
2943 #
2944 # Returns: a list of MachineInfo
2945 #
2946 # Since: 1.2.0
2947 ##
2948 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
2949
2950 ##
2951 # @CpuDefinitionInfo:
2952 #
2953 # Virtual CPU definition.
2954 #
2955 # @name: the name of the CPU definition
2956 #
2957 # Since: 1.2.0
2958 ##
2959 { 'struct': 'CpuDefinitionInfo',
2960   'data': { 'name': 'str' } }
2961
2962 ##
2963 # @query-cpu-definitions:
2964 #
2965 # Return a list of supported virtual CPU definitions
2966 #
2967 # Returns: a list of CpuDefInfo
2968 #
2969 # Since: 1.2.0
2970 ##
2971 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
2972
2973 # @AddfdInfo:
2974 #
2975 # Information about a file descriptor that was added to an fd set.
2976 #
2977 # @fdset-id: The ID of the fd set that @fd was added to.
2978 #
2979 # @fd: The file descriptor that was received via SCM rights and
2980 #      added to the fd set.
2981 #
2982 # Since: 1.2.0
2983 ##
2984 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
2985
2986 ##
2987 # @add-fd:
2988 #
2989 # Add a file descriptor, that was passed via SCM rights, to an fd set.
2990 #
2991 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
2992 #
2993 # @opaque: #optional A free-form string that can be used to describe the fd.
2994 #
2995 # Returns: @AddfdInfo on success
2996 #          If file descriptor was not received, FdNotSupplied
2997 #          If @fdset-id is a negative value, InvalidParameterValue
2998 #
2999 # Notes: The list of fd sets is shared by all monitor connections.
3000 #
3001 #        If @fdset-id is not specified, a new fd set will be created.
3002 #
3003 # Since: 1.2.0
3004 ##
3005 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
3006   'returns': 'AddfdInfo' }
3007
3008 ##
3009 # @remove-fd:
3010 #
3011 # Remove a file descriptor from an fd set.
3012 #
3013 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
3014 #
3015 # @fd: #optional The file descriptor that is to be removed.
3016 #
3017 # Returns: Nothing on success
3018 #          If @fdset-id or @fd is not found, FdNotFound
3019 #
3020 # Since: 1.2.0
3021 #
3022 # Notes: The list of fd sets is shared by all monitor connections.
3023 #
3024 #        If @fd is not specified, all file descriptors in @fdset-id
3025 #        will be removed.
3026 ##
3027 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
3028
3029 ##
3030 # @FdsetFdInfo:
3031 #
3032 # Information about a file descriptor that belongs to an fd set.
3033 #
3034 # @fd: The file descriptor value.
3035 #
3036 # @opaque: #optional A free-form string that can be used to describe the fd.
3037 #
3038 # Since: 1.2.0
3039 ##
3040 { 'struct': 'FdsetFdInfo',
3041   'data': {'fd': 'int', '*opaque': 'str'} }
3042
3043 ##
3044 # @FdsetInfo:
3045 #
3046 # Information about an fd set.
3047 #
3048 # @fdset-id: The ID of the fd set.
3049 #
3050 # @fds: A list of file descriptors that belong to this fd set.
3051 #
3052 # Since: 1.2.0
3053 ##
3054 { 'struct': 'FdsetInfo',
3055   'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
3056
3057 ##
3058 # @query-fdsets:
3059 #
3060 # Return information describing all fd sets.
3061 #
3062 # Returns: A list of @FdsetInfo
3063 #
3064 # Since: 1.2.0
3065 #
3066 # Note: The list of fd sets is shared by all monitor connections.
3067 #
3068 ##
3069 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
3070
3071 ##
3072 # @TargetInfo:
3073 #
3074 # Information describing the QEMU target.
3075 #
3076 # @arch: the target architecture (eg "x86_64", "i386", etc)
3077 #
3078 # Since: 1.2.0
3079 ##
3080 { 'struct': 'TargetInfo',
3081   'data': { 'arch': 'str' } }
3082
3083 ##
3084 # @query-target:
3085 #
3086 # Return information about the target for this QEMU
3087 #
3088 # Returns: TargetInfo
3089 #
3090 # Since: 1.2.0
3091 ##
3092 { 'command': 'query-target', 'returns': 'TargetInfo' }
3093
3094 ##
3095 # @QKeyCode:
3096 #
3097 # An enumeration of key name.
3098 #
3099 # This is used by the send-key command.
3100 #
3101 # Since: 1.3.0
3102 #
3103 # 'unmapped' and 'pause' since 2.0
3104 # 'ro' and 'kp_comma' since 2.4
3105 # 'kp_equals' and 'power' since 2.6
3106 ##
3107 { 'enum': 'QKeyCode',
3108   'data': [ 'unmapped',
3109             'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
3110             'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
3111             '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
3112             'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
3113             'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
3114             'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
3115             'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
3116             'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
3117             'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
3118             'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
3119             'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
3120             'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
3121             'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
3122             'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
3123             'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause', 'ro',
3124             'kp_comma', 'kp_equals', 'power' ] }
3125
3126 ##
3127 # @KeyValue
3128 #
3129 # Represents a keyboard key.
3130 #
3131 # Since: 1.3.0
3132 ##
3133 { 'union': 'KeyValue',
3134   'data': {
3135     'number': 'int',
3136     'qcode': 'QKeyCode' } }
3137
3138 ##
3139 # @send-key:
3140 #
3141 # Send keys to guest.
3142 #
3143 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
3144 #        simultaneously sent to the guest. A @KeyValue.number value is sent
3145 #        directly to the guest, while @KeyValue.qcode must be a valid
3146 #        @QKeyCode value
3147 #
3148 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
3149 #             to 100
3150 #
3151 # Returns: Nothing on success
3152 #          If key is unknown or redundant, InvalidParameter
3153 #
3154 # Since: 1.3.0
3155 #
3156 ##
3157 { 'command': 'send-key',
3158   'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
3159
3160 ##
3161 # @screendump:
3162 #
3163 # Write a PPM of the VGA screen to a file.
3164 #
3165 # @filename: the path of a new PPM file to store the image
3166 #
3167 # Returns: Nothing on success
3168 #
3169 # Since: 0.14.0
3170 ##
3171 { 'command': 'screendump', 'data': {'filename': 'str'} }
3172
3173
3174 ##
3175 # @ChardevCommon:
3176 #
3177 # Configuration shared across all chardev backends
3178 #
3179 # @logfile: #optional The name of a logfile to save output
3180 # @logappend: #optional true to append instead of truncate
3181 #             (default to false to truncate)
3182 #
3183 # Since: 2.6
3184 ##
3185 { 'struct': 'ChardevCommon', 'data': { '*logfile': 'str',
3186                                        '*logappend': 'bool' } }
3187
3188 ##
3189 # @ChardevFile:
3190 #
3191 # Configuration info for file chardevs.
3192 #
3193 # @in:  #optional The name of the input file
3194 # @out: The name of the output file
3195 # @append: #optional Open the file in append mode (default false to
3196 #          truncate) (Since 2.6)
3197 #
3198 # Since: 1.4
3199 ##
3200 { 'struct': 'ChardevFile', 'data': { '*in' : 'str',
3201                                    'out' : 'str',
3202                                    '*append': 'bool' },
3203   'base': 'ChardevCommon' }
3204
3205 ##
3206 # @ChardevHostdev:
3207 #
3208 # Configuration info for device and pipe chardevs.
3209 #
3210 # @device: The name of the special file for the device,
3211 #          i.e. /dev/ttyS0 on Unix or COM1: on Windows
3212 # @type: What kind of device this is.
3213 #
3214 # Since: 1.4
3215 ##
3216 { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' },
3217   'base': 'ChardevCommon' }
3218
3219 ##
3220 # @ChardevSocket:
3221 #
3222 # Configuration info for (stream) socket chardevs.
3223 #
3224 # @addr: socket address to listen on (server=true)
3225 #        or connect to (server=false)
3226 # @tls-creds: #optional the ID of the TLS credentials object (since 2.6)
3227 # @server: #optional create server socket (default: true)
3228 # @wait: #optional wait for incoming connection on server
3229 #        sockets (default: false).
3230 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
3231 # @telnet: #optional enable telnet protocol on server
3232 #          sockets (default: false)
3233 # @reconnect: #optional For a client socket, if a socket is disconnected,
3234 #          then attempt a reconnect after the given number of seconds.
3235 #          Setting this to zero disables this function. (default: 0)
3236 #          (Since: 2.2)
3237 #
3238 # Since: 1.4
3239 ##
3240 { 'struct': 'ChardevSocket', 'data': { 'addr'       : 'SocketAddress',
3241                                      '*tls-creds'  : 'str',
3242                                      '*server'    : 'bool',
3243                                      '*wait'      : 'bool',
3244                                      '*nodelay'   : 'bool',
3245                                      '*telnet'    : 'bool',
3246                                      '*reconnect' : 'int' },
3247   'base': 'ChardevCommon' }
3248
3249 ##
3250 # @ChardevUdp:
3251 #
3252 # Configuration info for datagram socket chardevs.
3253 #
3254 # @remote: remote address
3255 # @local: #optional local address
3256 #
3257 # Since: 1.5
3258 ##
3259 { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
3260                                   '*local' : 'SocketAddress' },
3261   'base': 'ChardevCommon' }
3262
3263 ##
3264 # @ChardevMux:
3265 #
3266 # Configuration info for mux chardevs.
3267 #
3268 # @chardev: name of the base chardev.
3269 #
3270 # Since: 1.5
3271 ##
3272 { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' },
3273   'base': 'ChardevCommon' }
3274
3275 ##
3276 # @ChardevStdio:
3277 #
3278 # Configuration info for stdio chardevs.
3279 #
3280 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
3281 #          be delivered to qemu.  Default: true in -nographic mode,
3282 #          false otherwise.
3283 #
3284 # Since: 1.5
3285 ##
3286 { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' },
3287   'base': 'ChardevCommon' }
3288
3289
3290 ##
3291 # @ChardevSpiceChannel:
3292 #
3293 # Configuration info for spice vm channel chardevs.
3294 #
3295 # @type: kind of channel (for example vdagent).
3296 #
3297 # Since: 1.5
3298 ##
3299 { 'struct': 'ChardevSpiceChannel', 'data': { 'type'  : 'str' },
3300   'base': 'ChardevCommon' }
3301
3302 ##
3303 # @ChardevSpicePort:
3304 #
3305 # Configuration info for spice port chardevs.
3306 #
3307 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
3308 #
3309 # Since: 1.5
3310 ##
3311 { 'struct': 'ChardevSpicePort', 'data': { 'fqdn'  : 'str' },
3312   'base': 'ChardevCommon' }
3313
3314 ##
3315 # @ChardevVC:
3316 #
3317 # Configuration info for virtual console chardevs.
3318 #
3319 # @width:  console width,  in pixels
3320 # @height: console height, in pixels
3321 # @cols:   console width,  in chars
3322 # @rows:   console height, in chars
3323 #
3324 # Since: 1.5
3325 ##
3326 { 'struct': 'ChardevVC', 'data': { '*width'  : 'int',
3327                                  '*height' : 'int',
3328                                  '*cols'   : 'int',
3329                                  '*rows'   : 'int' },
3330   'base': 'ChardevCommon' }
3331
3332 ##
3333 # @ChardevRingbuf:
3334 #
3335 # Configuration info for ring buffer chardevs.
3336 #
3337 # @size: #optional ring buffer size, must be power of two, default is 65536
3338 #
3339 # Since: 1.5
3340 ##
3341 { 'struct': 'ChardevRingbuf', 'data': { '*size'  : 'int' },
3342   'base': 'ChardevCommon' }
3343
3344 ##
3345 # @ChardevBackend:
3346 #
3347 # Configuration info for the new chardev backend.
3348 #
3349 # Since: 1.4 (testdev since 2.2)
3350 ##
3351 { 'union': 'ChardevBackend', 'data': { 'file'   : 'ChardevFile',
3352                                        'serial' : 'ChardevHostdev',
3353                                        'parallel': 'ChardevHostdev',
3354                                        'pipe'   : 'ChardevHostdev',
3355                                        'socket' : 'ChardevSocket',
3356                                        'udp'    : 'ChardevUdp',
3357                                        'pty'    : 'ChardevCommon',
3358                                        'null'   : 'ChardevCommon',
3359                                        'mux'    : 'ChardevMux',
3360                                        'msmouse': 'ChardevCommon',
3361                                        'braille': 'ChardevCommon',
3362                                        'testdev': 'ChardevCommon',
3363                                        'stdio'  : 'ChardevStdio',
3364                                        'console': 'ChardevCommon',
3365                                        'spicevmc' : 'ChardevSpiceChannel',
3366                                        'spiceport' : 'ChardevSpicePort',
3367                                        'vc'     : 'ChardevVC',
3368                                        'ringbuf': 'ChardevRingbuf',
3369                                        # next one is just for compatibility
3370                                        'memory' : 'ChardevRingbuf' } }
3371
3372 ##
3373 # @ChardevReturn:
3374 #
3375 # Return info about the chardev backend just created.
3376 #
3377 # @pty: #optional name of the slave pseudoterminal device, present if
3378 #       and only if a chardev of type 'pty' was created
3379 #
3380 # Since: 1.4
3381 ##
3382 { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
3383
3384 ##
3385 # @chardev-add:
3386 #
3387 # Add a character device backend
3388 #
3389 # @id: the chardev's ID, must be unique
3390 # @backend: backend type and parameters
3391 #
3392 # Returns: ChardevReturn.
3393 #
3394 # Since: 1.4
3395 ##
3396 { 'command': 'chardev-add', 'data': {'id'      : 'str',
3397                                      'backend' : 'ChardevBackend' },
3398   'returns': 'ChardevReturn' }
3399
3400 ##
3401 # @chardev-remove:
3402 #
3403 # Remove a character device backend
3404 #
3405 # @id: the chardev's ID, must exist and not be in use
3406 #
3407 # Returns: Nothing on success
3408 #
3409 # Since: 1.4
3410 ##
3411 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
3412
3413 ##
3414 # @TpmModel:
3415 #
3416 # An enumeration of TPM models
3417 #
3418 # @tpm-tis: TPM TIS model
3419 #
3420 # Since: 1.5
3421 ##
3422 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
3423
3424 ##
3425 # @query-tpm-models:
3426 #
3427 # Return a list of supported TPM models
3428 #
3429 # Returns: a list of TpmModel
3430 #
3431 # Since: 1.5
3432 ##
3433 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
3434
3435 ##
3436 # @TpmType:
3437 #
3438 # An enumeration of TPM types
3439 #
3440 # @passthrough: TPM passthrough type
3441 #
3442 # Since: 1.5
3443 ##
3444 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
3445
3446 ##
3447 # @query-tpm-types:
3448 #
3449 # Return a list of supported TPM types
3450 #
3451 # Returns: a list of TpmType
3452 #
3453 # Since: 1.5
3454 ##
3455 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
3456
3457 ##
3458 # @TPMPassthroughOptions:
3459 #
3460 # Information about the TPM passthrough type
3461 #
3462 # @path: #optional string describing the path used for accessing the TPM device
3463 #
3464 # @cancel-path: #optional string showing the TPM's sysfs cancel file
3465 #               for cancellation of TPM commands while they are executing
3466 #
3467 # Since: 1.5
3468 ##
3469 { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
3470                                              '*cancel-path' : 'str'} }
3471
3472 ##
3473 # @TpmTypeOptions:
3474 #
3475 # A union referencing different TPM backend types' configuration options
3476 #
3477 # @passthrough: The configuration options for the TPM passthrough type
3478 #
3479 # Since: 1.5
3480 ##
3481 { 'union': 'TpmTypeOptions',
3482    'data': { 'passthrough' : 'TPMPassthroughOptions' } }
3483
3484 ##
3485 # @TpmInfo:
3486 #
3487 # Information about the TPM
3488 #
3489 # @id: The Id of the TPM
3490 #
3491 # @model: The TPM frontend model
3492 #
3493 # @options: The TPM (backend) type configuration options
3494 #
3495 # Since: 1.5
3496 ##
3497 { 'struct': 'TPMInfo',
3498   'data': {'id': 'str',
3499            'model': 'TpmModel',
3500            'options': 'TpmTypeOptions' } }
3501
3502 ##
3503 # @query-tpm:
3504 #
3505 # Return information about the TPM device
3506 #
3507 # Returns: @TPMInfo on success
3508 #
3509 # Since: 1.5
3510 ##
3511 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
3512
3513 ##
3514 # @AcpiTableOptions
3515 #
3516 # Specify an ACPI table on the command line to load.
3517 #
3518 # At most one of @file and @data can be specified. The list of files specified
3519 # by any one of them is loaded and concatenated in order. If both are omitted,
3520 # @data is implied.
3521 #
3522 # Other fields / optargs can be used to override fields of the generic ACPI
3523 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
3524 # Description Table Header. If a header field is not overridden, then the
3525 # corresponding value from the concatenated blob is used (in case of @file), or
3526 # it is filled in with a hard-coded value (in case of @data).
3527 #
3528 # String fields are copied into the matching ACPI member from lowest address
3529 # upwards, and silently truncated / NUL-padded to length.
3530 #
3531 # @sig: #optional table signature / identifier (4 bytes)
3532 #
3533 # @rev: #optional table revision number (dependent on signature, 1 byte)
3534 #
3535 # @oem_id: #optional OEM identifier (6 bytes)
3536 #
3537 # @oem_table_id: #optional OEM table identifier (8 bytes)
3538 #
3539 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
3540 #
3541 # @asl_compiler_id: #optional identifier of the utility that created the table
3542 #                   (4 bytes)
3543 #
3544 # @asl_compiler_rev: #optional revision number of the utility that created the
3545 #                    table (4 bytes)
3546 #
3547 # @file: #optional colon (:) separated list of pathnames to load and
3548 #        concatenate as table data. The resultant binary blob is expected to
3549 #        have an ACPI table header. At least one file is required. This field
3550 #        excludes @data.
3551 #
3552 # @data: #optional colon (:) separated list of pathnames to load and
3553 #        concatenate as table data. The resultant binary blob must not have an
3554 #        ACPI table header. At least one file is required. This field excludes
3555 #        @file.
3556 #
3557 # Since 1.5
3558 ##
3559 { 'struct': 'AcpiTableOptions',
3560   'data': {
3561     '*sig':               'str',
3562     '*rev':               'uint8',
3563     '*oem_id':            'str',
3564     '*oem_table_id':      'str',
3565     '*oem_rev':           'uint32',
3566     '*asl_compiler_id':   'str',
3567     '*asl_compiler_rev':  'uint32',
3568     '*file':              'str',
3569     '*data':              'str' }}
3570
3571 ##
3572 # @CommandLineParameterType:
3573 #
3574 # Possible types for an option parameter.
3575 #
3576 # @string: accepts a character string
3577 #
3578 # @boolean: accepts "on" or "off"
3579 #
3580 # @number: accepts a number
3581 #
3582 # @size: accepts a number followed by an optional suffix (K)ilo,
3583 #        (M)ega, (G)iga, (T)era
3584 #
3585 # Since 1.5
3586 ##
3587 { 'enum': 'CommandLineParameterType',
3588   'data': ['string', 'boolean', 'number', 'size'] }
3589
3590 ##
3591 # @CommandLineParameterInfo:
3592 #
3593 # Details about a single parameter of a command line option.
3594 #
3595 # @name: parameter name
3596 #
3597 # @type: parameter @CommandLineParameterType
3598 #
3599 # @help: #optional human readable text string, not suitable for parsing.
3600 #
3601 # @default: #optional default value string (since 2.1)
3602 #
3603 # Since 1.5
3604 ##
3605 { 'struct': 'CommandLineParameterInfo',
3606   'data': { 'name': 'str',
3607             'type': 'CommandLineParameterType',
3608             '*help': 'str',
3609             '*default': 'str' } }
3610
3611 ##
3612 # @CommandLineOptionInfo:
3613 #
3614 # Details about a command line option, including its list of parameter details
3615 #
3616 # @option: option name
3617 #
3618 # @parameters: an array of @CommandLineParameterInfo
3619 #
3620 # Since 1.5
3621 ##
3622 { 'struct': 'CommandLineOptionInfo',
3623   'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
3624
3625 ##
3626 # @query-command-line-options:
3627 #
3628 # Query command line option schema.
3629 #
3630 # @option: #optional option name
3631 #
3632 # Returns: list of @CommandLineOptionInfo for all options (or for the given
3633 #          @option).  Returns an error if the given @option doesn't exist.
3634 #
3635 # Since 1.5
3636 ##
3637 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
3638  'returns': ['CommandLineOptionInfo'] }
3639
3640 ##
3641 # @X86CPURegister32
3642 #
3643 # A X86 32-bit register
3644 #
3645 # Since: 1.5
3646 ##
3647 { 'enum': 'X86CPURegister32',
3648   'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
3649
3650 ##
3651 # @X86CPUFeatureWordInfo
3652 #
3653 # Information about a X86 CPU feature word
3654 #
3655 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
3656 #
3657 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
3658 #                   feature word
3659 #
3660 # @cpuid-register: Output register containing the feature bits
3661 #
3662 # @features: value of output register, containing the feature bits
3663 #
3664 # Since: 1.5
3665 ##
3666 { 'struct': 'X86CPUFeatureWordInfo',
3667   'data': { 'cpuid-input-eax': 'int',
3668             '*cpuid-input-ecx': 'int',
3669             'cpuid-register': 'X86CPURegister32',
3670             'features': 'int' } }
3671
3672 ##
3673 # @DummyForceArrays
3674 #
3675 # Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
3676 #
3677 # Since 2.5
3678 ##
3679 { 'struct': 'DummyForceArrays',
3680   'data': { 'unused': ['X86CPUFeatureWordInfo'] } }
3681
3682
3683 ##
3684 # @RxState:
3685 #
3686 # Packets receiving state
3687 #
3688 # @normal: filter assigned packets according to the mac-table
3689 #
3690 # @none: don't receive any assigned packet
3691 #
3692 # @all: receive all assigned packets
3693 #
3694 # Since: 1.6
3695 ##
3696 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
3697
3698 ##
3699 # @RxFilterInfo:
3700 #
3701 # Rx-filter information for a NIC.
3702 #
3703 # @name: net client name
3704 #
3705 # @promiscuous: whether promiscuous mode is enabled
3706 #
3707 # @multicast: multicast receive state
3708 #
3709 # @unicast: unicast receive state
3710 #
3711 # @vlan: vlan receive state (Since 2.0)
3712 #
3713 # @broadcast-allowed: whether to receive broadcast
3714 #
3715 # @multicast-overflow: multicast table is overflowed or not
3716 #
3717 # @unicast-overflow: unicast table is overflowed or not
3718 #
3719 # @main-mac: the main macaddr string
3720 #
3721 # @vlan-table: a list of active vlan id
3722 #
3723 # @unicast-table: a list of unicast macaddr string
3724 #
3725 # @multicast-table: a list of multicast macaddr string
3726 #
3727 # Since 1.6
3728 ##
3729
3730 { 'struct': 'RxFilterInfo',
3731   'data': {
3732     'name':               'str',
3733     'promiscuous':        'bool',
3734     'multicast':          'RxState',
3735     'unicast':            'RxState',
3736     'vlan':               'RxState',
3737     'broadcast-allowed':  'bool',
3738     'multicast-overflow': 'bool',
3739     'unicast-overflow':   'bool',
3740     'main-mac':           'str',
3741     'vlan-table':         ['int'],
3742     'unicast-table':      ['str'],
3743     'multicast-table':    ['str'] }}
3744
3745 ##
3746 # @query-rx-filter:
3747 #
3748 # Return rx-filter information for all NICs (or for the given NIC).
3749 #
3750 # @name: #optional net client name
3751 #
3752 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
3753 #          Returns an error if the given @name doesn't exist, or given
3754 #          NIC doesn't support rx-filter querying, or given net client
3755 #          isn't a NIC.
3756 #
3757 # Since: 1.6
3758 ##
3759 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
3760   'returns': ['RxFilterInfo'] }
3761
3762 ##
3763 # @InputButton
3764 #
3765 # Button of a pointer input device (mouse, tablet).
3766 #
3767 # Since: 2.0
3768 ##
3769 { 'enum'  : 'InputButton',
3770   'data'  : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down' ] }
3771
3772 ##
3773 # @InputAxis
3774 #
3775 # Position axis of a pointer input device (mouse, tablet).
3776 #
3777 # Since: 2.0
3778 ##
3779 { 'enum'  : 'InputAxis',
3780   'data'  : [ 'x', 'y' ] }
3781
3782 ##
3783 # @InputKeyEvent
3784 #
3785 # Keyboard input event.
3786 #
3787 # @key:    Which key this event is for.
3788 # @down:   True for key-down and false for key-up events.
3789 #
3790 # Since: 2.0
3791 ##
3792 { 'struct'  : 'InputKeyEvent',
3793   'data'  : { 'key'     : 'KeyValue',
3794               'down'    : 'bool' } }
3795
3796 ##
3797 # @InputBtnEvent
3798 #
3799 # Pointer button input event.
3800 #
3801 # @button: Which button this event is for.
3802 # @down:   True for key-down and false for key-up events.
3803 #
3804 # Since: 2.0
3805 ##
3806 { 'struct'  : 'InputBtnEvent',
3807   'data'  : { 'button'  : 'InputButton',
3808               'down'    : 'bool' } }
3809
3810 ##
3811 # @InputMoveEvent
3812 #
3813 # Pointer motion input event.
3814 #
3815 # @axis:   Which axis is referenced by @value.
3816 # @value:  Pointer position.  For absolute coordinates the
3817 #          valid range is 0 -> 0x7ffff
3818 #
3819 # Since: 2.0
3820 ##
3821 { 'struct'  : 'InputMoveEvent',
3822   'data'  : { 'axis'    : 'InputAxis',
3823               'value'   : 'int' } }
3824
3825 ##
3826 # @InputEvent
3827 #
3828 # Input event union.
3829 #
3830 # @key: Input event of Keyboard
3831 # @btn: Input event of pointer buttons
3832 # @rel: Input event of relative pointer motion
3833 # @abs: Input event of absolute pointer motion
3834 #
3835 # Since: 2.0
3836 ##
3837 { 'union' : 'InputEvent',
3838   'data'  : { 'key'     : 'InputKeyEvent',
3839               'btn'     : 'InputBtnEvent',
3840               'rel'     : 'InputMoveEvent',
3841               'abs'     : 'InputMoveEvent' } }
3842
3843 ##
3844 # @input-send-event
3845 #
3846 # Send input event(s) to guest.
3847 #
3848 # @device: #optional display device to send event(s) to.
3849 # @head: #optional head to send event(s) to, in case the
3850 #        display device supports multiple scanouts.
3851 # @events: List of InputEvent union.
3852 #
3853 # Returns: Nothing on success.
3854 #
3855 # The @display and @head parameters can be used to send the input
3856 # event to specific input devices in case (a) multiple input devices
3857 # of the same kind are added to the virtual machine and (b) you have
3858 # configured input routing (see docs/multiseat.txt) for those input
3859 # devices.  The parameters work exactly like the device and head
3860 # properties of input devices.  If @device is missing, only devices
3861 # that have no input routing config are admissible.  If @device is
3862 # specified, both input devices with and without input routing config
3863 # are admissible, but devices with input routing config take
3864 # precedence.
3865 #
3866 # Since: 2.6
3867 ##
3868 { 'command': 'input-send-event',
3869   'data': { '*device': 'str',
3870             '*head'  : 'int',
3871             'events' : [ 'InputEvent' ] } }
3872
3873 ##
3874 # @NumaOptions
3875 #
3876 # A discriminated record of NUMA options. (for OptsVisitor)
3877 #
3878 # Since 2.1
3879 ##
3880 { 'union': 'NumaOptions',
3881   'data': {
3882     'node': 'NumaNodeOptions' }}
3883
3884 ##
3885 # @NumaNodeOptions
3886 #
3887 # Create a guest NUMA node. (for OptsVisitor)
3888 #
3889 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
3890 #
3891 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
3892 #         if omitted)
3893 #
3894 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
3895 #       Equally divide total memory among nodes if both @mem and @memdev are
3896 #       omitted.
3897 #
3898 # @memdev: #optional memory backend object.  If specified for one node,
3899 #          it must be specified for all nodes.
3900 #
3901 # Since: 2.1
3902 ##
3903 { 'struct': 'NumaNodeOptions',
3904   'data': {
3905    '*nodeid': 'uint16',
3906    '*cpus':   ['uint16'],
3907    '*mem':    'size',
3908    '*memdev': 'str' }}
3909
3910 ##
3911 # @HostMemPolicy
3912 #
3913 # Host memory policy types
3914 #
3915 # @default: restore default policy, remove any nondefault policy
3916 #
3917 # @preferred: set the preferred host nodes for allocation
3918 #
3919 # @bind: a strict policy that restricts memory allocation to the
3920 #        host nodes specified
3921 #
3922 # @interleave: memory allocations are interleaved across the set
3923 #              of host nodes specified
3924 #
3925 # Since 2.1
3926 ##
3927 { 'enum': 'HostMemPolicy',
3928   'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
3929
3930 ##
3931 # @Memdev:
3932 #
3933 # Information about memory backend
3934 #
3935 # @size: memory backend size
3936 #
3937 # @merge: enables or disables memory merge support
3938 #
3939 # @dump: includes memory backend's memory in a core dump or not
3940 #
3941 # @prealloc: enables or disables memory preallocation
3942 #
3943 # @host-nodes: host nodes for its memory policy
3944 #
3945 # @policy: memory policy of memory backend
3946 #
3947 # Since: 2.1
3948 ##
3949
3950 { 'struct': 'Memdev',
3951   'data': {
3952     'size':       'size',
3953     'merge':      'bool',
3954     'dump':       'bool',
3955     'prealloc':   'bool',
3956     'host-nodes': ['uint16'],
3957     'policy':     'HostMemPolicy' }}
3958
3959 ##
3960 # @query-memdev:
3961 #
3962 # Returns information for all memory backends.
3963 #
3964 # Returns: a list of @Memdev.
3965 #
3966 # Since: 2.1
3967 ##
3968 { 'command': 'query-memdev', 'returns': ['Memdev'] }
3969
3970 ##
3971 # @PCDIMMDeviceInfo:
3972 #
3973 # PCDIMMDevice state information
3974 #
3975 # @id: #optional device's ID
3976 #
3977 # @addr: physical address, where device is mapped
3978 #
3979 # @size: size of memory that the device provides
3980 #
3981 # @slot: slot number at which device is plugged in
3982 #
3983 # @node: NUMA node number where device is plugged in
3984 #
3985 # @memdev: memory backend linked with device
3986 #
3987 # @hotplugged: true if device was hotplugged
3988 #
3989 # @hotpluggable: true if device if could be added/removed while machine is running
3990 #
3991 # Since: 2.1
3992 ##
3993 { 'struct': 'PCDIMMDeviceInfo',
3994   'data': { '*id': 'str',
3995             'addr': 'int',
3996             'size': 'int',
3997             'slot': 'int',
3998             'node': 'int',
3999             'memdev': 'str',
4000             'hotplugged': 'bool',
4001             'hotpluggable': 'bool'
4002           }
4003 }
4004
4005 ##
4006 # @MemoryDeviceInfo:
4007 #
4008 # Union containing information about a memory device
4009 #
4010 # Since: 2.1
4011 ##
4012 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
4013
4014 ##
4015 # @query-memory-devices
4016 #
4017 # Lists available memory devices and their state
4018 #
4019 # Since: 2.1
4020 ##
4021 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
4022
4023 ## @ACPISlotType
4024 #
4025 # @DIMM: memory slot
4026 #
4027 { 'enum': 'ACPISlotType', 'data': [ 'DIMM' ] }
4028
4029 ## @ACPIOSTInfo
4030 #
4031 # OSPM Status Indication for a device
4032 # For description of possible values of @source and @status fields
4033 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
4034 #
4035 # @device: #optional device ID associated with slot
4036 #
4037 # @slot: slot ID, unique per slot of a given @slot-type
4038 #
4039 # @slot-type: type of the slot
4040 #
4041 # @source: an integer containing the source event
4042 #
4043 # @status: an integer containing the status code
4044 #
4045 # Since: 2.1
4046 ##
4047 { 'struct': 'ACPIOSTInfo',
4048   'data'  : { '*device': 'str',
4049               'slot': 'str',
4050               'slot-type': 'ACPISlotType',
4051               'source': 'int',
4052               'status': 'int' } }
4053
4054 ##
4055 # @query-acpi-ospm-status
4056 #
4057 # Lists ACPI OSPM status of ACPI device objects,
4058 # which might be reported via _OST method
4059 #
4060 # Since: 2.1
4061 ##
4062 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
4063
4064 ##
4065 # @WatchdogExpirationAction
4066 #
4067 # An enumeration of the actions taken when the watchdog device's timer is
4068 # expired
4069 #
4070 # @reset: system resets
4071 #
4072 # @shutdown: system shutdown, note that it is similar to @powerdown, which
4073 #            tries to set to system status and notify guest
4074 #
4075 # @poweroff: system poweroff, the emulator program exits
4076 #
4077 # @pause: system pauses, similar to @stop
4078 #
4079 # @debug: system enters debug state
4080 #
4081 # @none: nothing is done
4082 #
4083 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
4084 #              VCPUS on x86) (since 2.4)
4085 #
4086 # Since: 2.1
4087 ##
4088 { 'enum': 'WatchdogExpirationAction',
4089   'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
4090             'inject-nmi' ] }
4091
4092 ##
4093 # @IoOperationType
4094 #
4095 # An enumeration of the I/O operation types
4096 #
4097 # @read: read operation
4098 #
4099 # @write: write operation
4100 #
4101 # Since: 2.1
4102 ##
4103 { 'enum': 'IoOperationType',
4104   'data': [ 'read', 'write' ] }
4105
4106 ##
4107 # @GuestPanicAction
4108 #
4109 # An enumeration of the actions taken when guest OS panic is detected
4110 #
4111 # @pause: system pauses
4112 #
4113 # Since: 2.1
4114 ##
4115 { 'enum': 'GuestPanicAction',
4116   'data': [ 'pause' ] }
4117
4118 ##
4119 # @rtc-reset-reinjection
4120 #
4121 # This command will reset the RTC interrupt reinjection backlog.
4122 # Can be used if another mechanism to synchronize guest time
4123 # is in effect, for example QEMU guest agent's guest-set-time
4124 # command.
4125 #
4126 # Since: 2.1
4127 ##
4128 { 'command': 'rtc-reset-reinjection' }
4129
4130 # Rocker ethernet network switch
4131 { 'include': 'qapi/rocker.json' }
4132
4133 ##
4134 # ReplayMode:
4135 #
4136 # Mode of the replay subsystem.
4137 #
4138 # @none: normal execution mode. Replay or record are not enabled.
4139 #
4140 # @record: record mode. All non-deterministic data is written into the
4141 #          replay log.
4142 #
4143 # @play: replay mode. Non-deterministic data required for system execution
4144 #        is read from the log.
4145 #
4146 # Since: 2.5
4147 ##
4148 { 'enum': 'ReplayMode',
4149   'data': [ 'none', 'record', 'play' ] }
4150
4151 ##
4152 # @GICCapability:
4153 #
4154 # The struct describes capability for a specific GIC (Generic
4155 # Interrupt Controller) version. These bits are not only decided by
4156 # QEMU/KVM software version, but also decided by the hardware that
4157 # the program is running upon.
4158 #
4159 # @version:  version of GIC to be described. Currently, only 2 and 3
4160 #            are supported.
4161 #
4162 # @emulated: whether current QEMU/hardware supports emulated GIC
4163 #            device in user space.
4164 #
4165 # @kernel:   whether current QEMU/hardware supports hardware
4166 #            accelerated GIC device in kernel.
4167 #
4168 # Since: 2.6
4169 ##
4170 { 'struct': 'GICCapability',
4171   'data': { 'version': 'int',
4172             'emulated': 'bool',
4173             'kernel': 'bool' } }
4174
4175 ##
4176 # @query-gic-capabilities:
4177 #
4178 # This command is ARM-only. It will return a list of GICCapability