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