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