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