hyper-v: introduce Hyper-V support infrastructure.
[qemu.git] / qapi-schema.json
1 # -*- Mode: Python -*-
2 #
3 # QAPI Schema
4
5 ##
6 # @NameInfo:
7 #
8 # Guest name information.
9 #
10 # @name: #optional The name of the guest
11 #
12 # Since 0.14.0
13 ##
14 { 'type': 'NameInfo', 'data': {'*name': 'str'} }
15
16 ##
17 # @query-name:
18 #
19 # Return the name information of a guest.
20 #
21 # Returns: @NameInfo of the guest
22 #
23 # Since 0.14.0
24 ##
25 { 'command': 'query-name', 'returns': 'NameInfo' }
26
27 ##
28 # @VersionInfo:
29 #
30 # A description of QEMU's version.
31 #
32 # @qemu.major:  The major version of QEMU
33 #
34 # @qemu.minor:  The minor version of QEMU
35 #
36 # @qemu.micro:  The micro version of QEMU.  By current convention, a micro
37 #               version of 50 signifies a development branch.  A micro version
38 #               greater than or equal to 90 signifies a release candidate for
39 #               the next minor version.  A micro version of less than 50
40 #               signifies a stable release.
41 #
42 # @package:     QEMU will always set this field to an empty string.  Downstream
43 #               versions of QEMU should set this to a non-empty string.  The
44 #               exact format depends on the downstream however it highly
45 #               recommended that a unique name is used.
46 #
47 # Since: 0.14.0
48 ##
49 { 'type': 'VersionInfo',
50   'data': {'qemu': {'major': 'int', 'minor': 'int', 'micro': 'int'},
51            'package': 'str'} }
52
53 ##
54 # @query-version:
55 #
56 # Returns the current version of QEMU.
57 #
58 # Returns:  A @VersionInfo object describing the current version of QEMU.
59 #
60 # Since: 0.14.0
61 ##
62 { 'command': 'query-version', 'returns': 'VersionInfo' }
63
64 ##
65 # @KvmInfo:
66 #
67 # Information about support for KVM acceleration
68 #
69 # @enabled: true if KVM acceleration is active
70 #
71 # @present: true if KVM acceleration is built into this executable
72 #
73 # Since: 0.14.0
74 ##
75 { 'type': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
76
77 ##
78 # @query-kvm:
79 #
80 # Returns information about KVM acceleration
81 #
82 # Returns: @KvmInfo
83 #
84 # Since: 0.14.0
85 ##
86 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
87
88 ##
89 # @RunState
90 #
91 # An enumation of VM run states.
92 #
93 # @debug: QEMU is running on a debugger
94 #
95 # @inmigrate: guest is paused waiting for an incoming migration
96 #
97 # @internal-error: An internal error that prevents further guest execution
98 # has occurred
99 #
100 # @io-error: the last IOP has failed and the device is configured to pause
101 # on I/O errors
102 #
103 # @paused: guest has been paused via the 'stop' command
104 #
105 # @postmigrate: guest is paused following a successful 'migrate'
106 #
107 # @prelaunch: QEMU was started with -S and guest has not started
108 #
109 # @finish-migrate: guest is paused to finish the migration process
110 #
111 # @restore-vm: guest is paused to restore VM state
112 #
113 # @running: guest is actively running
114 #
115 # @save-vm: guest is paused to save the VM state
116 #
117 # @shutdown: guest is shut down (and -no-shutdown is in use)
118 #
119 # @watchdog: the watchdog action is configured to pause and has been triggered
120 ##
121 { 'enum': 'RunState',
122   'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
123             'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
124             'running', 'save-vm', 'shutdown', 'watchdog' ] }
125
126 ##
127 # @StatusInfo:
128 #
129 # Information about VCPU run state
130 #
131 # @running: true if all VCPUs are runnable, false if not runnable
132 #
133 # @singlestep: true if VCPUs are in single-step mode
134 #
135 # @status: the virtual machine @RunState
136 #
137 # Since:  0.14.0
138 #
139 # Notes: @singlestep is enabled through the GDB stub
140 ##
141 { 'type': 'StatusInfo',
142   'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
143
144 ##
145 # @query-status:
146 #
147 # Query the run status of all VCPUs
148 #
149 # Returns: @StatusInfo reflecting all VCPUs
150 #
151 # Since:  0.14.0
152 ##
153 { 'command': 'query-status', 'returns': 'StatusInfo' }
154
155 ##
156 # @UuidInfo:
157 #
158 # Guest UUID information.
159 #
160 # @UUID: the UUID of the guest
161 #
162 # Since: 0.14.0
163 #
164 # Notes: If no UUID was specified for the guest, a null UUID is returned.
165 ##
166 { 'type': 'UuidInfo', 'data': {'UUID': 'str'} }
167
168 ##
169 # @query-uuid:
170 #
171 # Query the guest UUID information.
172 #
173 # Returns: The @UuidInfo for the guest
174 #
175 # Since 0.14.0
176 ##
177 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
178
179 ##
180 # @ChardevInfo:
181 #
182 # Information about a character device.
183 #
184 # @label: the label of the character device
185 #
186 # @filename: the filename of the character device
187 #
188 # Notes: @filename is encoded using the QEMU command line character device
189 #        encoding.  See the QEMU man page for details.
190 #
191 # Since: 0.14.0
192 ##
193 { 'type': 'ChardevInfo', 'data': {'label': 'str', 'filename': 'str'} }
194
195 ##
196 # @query-chardev:
197 #
198 # Returns information about current character devices.
199 #
200 # Returns: a list of @ChardevInfo
201 #
202 # Since: 0.14.0
203 ##
204 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
205
206 ##
207 # @CommandInfo:
208 #
209 # Information about a QMP command
210 #
211 # @name: The command name
212 #
213 # Since: 0.14.0
214 ##
215 { 'type': 'CommandInfo', 'data': {'name': 'str'} }
216
217 ##
218 # @query-commands:
219 #
220 # Return a list of supported QMP commands by this server
221 #
222 # Returns: A list of @CommandInfo for all supported commands
223 #
224 # Since: 0.14.0
225 ##
226 { 'command': 'query-commands', 'returns': ['CommandInfo'] }
227
228 ##
229 # @MigrationStats
230 #
231 # Detailed migration status.
232 #
233 # @transferred: amount of bytes already transferred to the target VM
234 #
235 # @remaining: amount of bytes remaining to be transferred to the target VM
236 #
237 # @total: total amount of bytes involved in the migration process
238 #
239 # Since: 0.14.0.
240 ##
241 { 'type': 'MigrationStats',
242   'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' } }
243
244 ##
245 # @MigrationInfo
246 #
247 # Information about current migration process.
248 #
249 # @status: #optional string describing the current migration status.
250 #          As of 0.14.0 this can be 'active', 'completed', 'failed' or
251 #          'cancelled'. If this field is not returned, no migration process
252 #          has been initiated
253 #
254 # @ram: #optional @MigrationStats containing detailed migration status,
255 #       only returned if status is 'active'
256 #
257 # @disk: #optional @MigrationStats containing detailed disk migration
258 #        status, only returned if status is 'active' and it is a block
259 #        migration
260 #
261 # Since: 0.14.0
262 ##
263 { 'type': 'MigrationInfo',
264   'data': {'*status': 'str', '*ram': 'MigrationStats',
265            '*disk': 'MigrationStats'} }
266
267 ##
268 # @query-migrate
269 #
270 # Returns information about current migration process.
271 #
272 # Returns: @MigrationInfo
273 #
274 # Since: 0.14.0
275 ##
276 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
277
278 ##
279 # @MouseInfo:
280 #
281 # Information about a mouse device.
282 #
283 # @name: the name of the mouse device
284 #
285 # @index: the index of the mouse device
286 #
287 # @current: true if this device is currently receiving mouse events
288 #
289 # @absolute: true if this device supports absolute coordinates as input
290 #
291 # Since: 0.14.0
292 ##
293 { 'type': 'MouseInfo',
294   'data': {'name': 'str', 'index': 'int', 'current': 'bool',
295            'absolute': 'bool'} }
296
297 ##
298 # @query-mice:
299 #
300 # Returns information about each active mouse device
301 #
302 # Returns: a list of @MouseInfo for each device
303 #
304 # Since: 0.14.0
305 ##
306 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
307
308 ##
309 # @CpuInfo:
310 #
311 # Information about a virtual CPU
312 #
313 # @CPU: the index of the virtual CPU
314 #
315 # @current: this only exists for backwards compatible and should be ignored
316
317 # @halted: true if the virtual CPU is in the halt state.  Halt usually refers
318 #          to a processor specific low power mode.
319 #
320 # @pc: #optional If the target is i386 or x86_64, this is the 64-bit instruction
321 #                pointer.
322 #                If the target is Sparc, this is the PC component of the
323 #                instruction pointer.
324 #
325 # @nip: #optional If the target is PPC, the instruction pointer
326 #
327 # @npc: #optional If the target is Sparc, the NPC component of the instruction
328 #                 pointer
329 #
330 # @PC: #optional If the target is MIPS, the instruction pointer
331 #
332 # @thread_id: ID of the underlying host thread
333 #
334 # Since: 0.14.0
335 #
336 # Notes: @halted is a transient state that changes frequently.  By the time the
337 #        data is sent to the client, the guest may no longer be halted.
338 ##
339 { 'type': 'CpuInfo',
340   'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool', '*pc': 'int',
341            '*nip': 'int', '*npc': 'int', '*PC': 'int', 'thread_id': 'int'} }
342
343 ##
344 # @query-cpus:
345 #
346 # Returns a list of information about each virtual CPU.
347 #
348 # Returns: a list of @CpuInfo for each virtual CPU
349 #
350 # Since: 0.14.0
351 ##
352 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
353
354 ##
355 # @BlockDeviceInfo:
356 #
357 # Information about the backing device for a block device.
358 #
359 # @file: the filename of the backing device
360 #
361 # @ro: true if the backing device was open read-only
362 #
363 # @drv: the name of the block format used to open the backing device. As of
364 #       0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
365 #       'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
366 #       'host_floppy', 'http', 'https', 'nbd', 'parallels', 'qcow',
367 #       'qcow2', 'raw', 'tftp', 'vdi', 'vmdk', 'vpc', 'vvfat'
368 #
369 # @backing_file: #optional the name of the backing file (for copy-on-write)
370 #
371 # @encrypted: true if the backing device is encrypted
372 #
373 # @bps: total throughput limit in bytes per second is specified
374 #
375 # @bps_rd: read throughput limit in bytes per second is specified
376 #
377 # @bps_wr: write throughput limit in bytes per second is specified
378 #
379 # @iops: total I/O operations per second is specified
380 #
381 # @iops_rd: read I/O operations per second is specified
382 #
383 # @iops_wr: write I/O operations per second is specified
384 #
385 # Since: 0.14.0
386 #
387 # Notes: This interface is only found in @BlockInfo.
388 ##
389 { 'type': 'BlockDeviceInfo',
390   'data': { 'file': 'str', 'ro': 'bool', 'drv': 'str',
391             '*backing_file': 'str', 'encrypted': 'bool',
392             'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
393             'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int'} }
394
395 ##
396 # @BlockDeviceIoStatus:
397 #
398 # An enumeration of block device I/O status.
399 #
400 # @ok: The last I/O operation has succeeded
401 #
402 # @failed: The last I/O operation has failed
403 #
404 # @nospace: The last I/O operation has failed due to a no-space condition
405 #
406 # Since: 1.0
407 ##
408 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
409
410 ##
411 # @BlockInfo:
412 #
413 # Block device information.  This structure describes a virtual device and
414 # the backing device associated with it.
415 #
416 # @device: The device name associated with the virtual device.
417 #
418 # @type: This field is returned only for compatibility reasons, it should
419 #        not be used (always returns 'unknown')
420 #
421 # @removable: True if the device supports removable media.
422 #
423 # @locked: True if the guest has locked this device from having its media
424 #          removed
425 #
426 # @tray_open: #optional True if the device has a tray and it is open
427 #             (only present if removable is true)
428 #
429 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
430 #             supports it and the VM is configured to stop on errors
431 #
432 # @inserted: #optional @BlockDeviceInfo describing the device if media is
433 #            present
434 #
435 # Since:  0.14.0
436 ##
437 { 'type': 'BlockInfo',
438   'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
439            'locked': 'bool', '*inserted': 'BlockDeviceInfo',
440            '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus'} }
441
442 ##
443 # @query-block:
444 #
445 # Get a list of BlockInfo for all virtual block devices.
446 #
447 # Returns: a list of @BlockInfo describing each virtual block device
448 #
449 # Since: 0.14.0
450 ##
451 { 'command': 'query-block', 'returns': ['BlockInfo'] }
452
453 ##
454 # @BlockDeviceStats:
455 #
456 # Statistics of a virtual block device or a block backing device.
457 #
458 # @rd_bytes:      The number of bytes read by the device.
459 #
460 # @wr_bytes:      The number of bytes written by the device.
461 #
462 # @rd_operations: The number of read operations performed by the device.
463 #
464 # @wr_operations: The number of write operations performed by the device.
465 #
466 # @flush_operations: The number of cache flush operations performed by the
467 #                    device (since 0.15.0)
468 #
469 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
470 #                       (since 0.15.0).
471 #
472 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
473 #
474 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
475 #
476 # @wr_highest_offset: The offset after the greatest byte written to the
477 #                     device.  The intended use of this information is for
478 #                     growable sparse files (like qcow2) that are used on top
479 #                     of a physical device.
480 #
481 # Since: 0.14.0
482 ##
483 { 'type': 'BlockDeviceStats',
484   'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
485            'wr_operations': 'int', 'flush_operations': 'int',
486            'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
487            'rd_total_time_ns': 'int', 'wr_highest_offset': 'int' } }
488
489 ##
490 # @BlockStats:
491 #
492 # Statistics of a virtual block device or a block backing device.
493 #
494 # @device: #optional If the stats are for a virtual block device, the name
495 #          corresponding to the virtual block device.
496 #
497 # @stats:  A @BlockDeviceStats for the device.
498 #
499 # @parent: #optional This may point to the backing block device if this is a
500 #          a virtual block device.  If it's a backing block, this will point
501 #          to the backing file is one is present.
502 #
503 # Since: 0.14.0
504 ##
505 { 'type': 'BlockStats',
506   'data': {'*device': 'str', 'stats': 'BlockDeviceStats',
507            '*parent': 'BlockStats'} }
508
509 ##
510 # @query-blockstats:
511 #
512 # Query the @BlockStats for all virtual block devices.
513 #
514 # Returns: A list of @BlockStats for each virtual block devices.
515 #
516 # Since: 0.14.0
517 ##
518 { 'command': 'query-blockstats', 'returns': ['BlockStats'] }
519
520 ##
521 # @VncClientInfo:
522 #
523 # Information about a connected VNC client.
524 #
525 # @host: The host name of the client.  QEMU tries to resolve this to a DNS name
526 #        when possible.
527 #
528 # @family: 'ipv6' if the client is connected via IPv6 and TCP
529 #          'ipv4' if the client is connected via IPv4 and TCP
530 #          'unix' if the client is connected via a unix domain socket
531 #          'unknown' otherwise
532 #
533 # @service: The service name of the client's port.  This may depends on the
534 #           host system's service database so symbolic names should not be
535 #           relied on.
536 #
537 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
538 #              Name of the client.
539 #
540 # @sasl_username: #optional If SASL authentication is in use, the SASL username
541 #                 used for authentication.
542 #
543 # Since: 0.14.0
544 ##
545 { 'type': 'VncClientInfo',
546   'data': {'host': 'str', 'family': 'str', 'service': 'str',
547            '*x509_dname': 'str', '*sasl_username': 'str'} }
548
549 ##
550 # @VncInfo:
551 #
552 # Information about the VNC session.
553 #
554 # @enabled: true if the VNC server is enabled, false otherwise
555 #
556 # @host: #optional The hostname the VNC server is bound to.  This depends on
557 #        the name resolution on the host and may be an IP address.
558 #
559 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
560 #                    'ipv4' if the host is listening for IPv4 connections
561 #                    'unix' if the host is listening on a unix domain socket
562 #                    'unknown' otherwise
563 #
564 # @service: #optional The service name of the server's port.  This may depends
565 #           on the host system's service database so symbolic names should not
566 #           be relied on.
567 #
568 # @auth: #optional the current authentication type used by the server
569 #        'none' if no authentication is being used
570 #        'vnc' if VNC authentication is being used
571 #        'vencrypt+plain' if VEncrypt is used with plain text authentication
572 #        'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
573 #        'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
574 #        'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
575 #        'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
576 #        'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
577 #        'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
578 #        'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
579 #        'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
580 #
581 # @clients: a list of @VncClientInfo of all currently connected clients
582 #
583 # Since: 0.14.0
584 ##
585 { 'type': 'VncInfo',
586   'data': {'enabled': 'bool', '*host': 'str', '*family': 'str',
587            '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
588
589 ##
590 # @query-vnc:
591 #
592 # Returns information about the current VNC server
593 #
594 # Returns: @VncInfo
595 #          If VNC support is not compiled in, FeatureDisabled
596 #
597 # Since: 0.14.0
598 ##
599 { 'command': 'query-vnc', 'returns': 'VncInfo' }
600
601 ##
602 # @SpiceChannel
603 #
604 # Information about a SPICE client channel.
605 #
606 # @host: The host name of the client.  QEMU tries to resolve this to a DNS name
607 #        when possible.
608 #
609 # @family: 'ipv6' if the client is connected via IPv6 and TCP
610 #          'ipv4' if the client is connected via IPv4 and TCP
611 #          'unix' if the client is connected via a unix domain socket
612 #          'unknown' otherwise
613 #
614 # @port: The client's port number.
615 #
616 # @connection-id: SPICE connection id number.  All channels with the same id
617 #                 belong to the same SPICE session.
618 #
619 # @connection-type: SPICE channel type number.  "1" is the main control channel,
620 #                   filter for this one if you want track spice sessions only
621 #
622 # @channel-id: SPICE channel ID number.  Usually "0", might be different needed
623 #              when multiple channels of the same type exist, such as multiple
624 #              display channels in a multihead setup
625 #
626 # @tls: true if the channel is encrypted, false otherwise.
627 #
628 # Since: 0.14.0
629 ##
630 { 'type': 'SpiceChannel',
631   'data': {'host': 'str', 'family': 'str', 'port': 'str',
632            'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
633            'tls': 'bool'} }
634
635 ##
636 # @SpiceInfo
637 #
638 # Information about the SPICE session.
639
640 # @enabled: true if the SPICE server is enabled, false otherwise
641 #
642 # @host: #optional The hostname the SPICE server is bound to.  This depends on
643 #        the name resolution on the host and may be an IP address.
644 #
645 # @port: #optional The SPICE server's port number.
646 #
647 # @compiled-version: #optional SPICE server version.
648 #
649 # @tls-port: #optional The SPICE server's TLS port number.
650 #
651 # @auth: #optional the current authentication type used by the server
652 #        'none' if no authentication is being used
653 #        'spice' (TODO: describe)
654 #
655 # @channels: a list of @SpiceChannel for each active spice channel
656 #
657 # Since: 0.14.0
658 ##
659 { 'type': 'SpiceInfo',
660   'data': {'enabled': 'bool', '*host': 'str', '*port': 'int',
661            '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
662            '*channels': ['SpiceChannel']} }
663
664 ##
665 # @query-spice
666 #
667 # Returns information about the current SPICE server
668 #
669 # Returns: @SpiceInfo
670 #
671 # Since: 0.14.0
672 ##
673 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
674
675 ##
676 # @BalloonInfo:
677 #
678 # Information about the guest balloon device.
679 #
680 # @actual: the number of bytes the balloon currently contains
681 #
682 # @mem_swapped_in: #optional number of pages swapped in within the guest
683 #
684 # @mem_swapped_out: #optional number of pages swapped out within the guest
685 #
686 # @major_page_faults: #optional number of major page faults within the guest
687 #
688 # @minor_page_faults: #optional number of minor page faults within the guest
689 #
690 # @free_mem: #optional amount of memory (in bytes) free in the guest
691 #
692 # @total_mem: #optional amount of memory (in bytes) visible to the guest
693 #
694 # Since: 0.14.0
695 #
696 # Notes: all current versions of QEMU do not fill out optional information in
697 #        this structure.
698 ##
699 { 'type': 'BalloonInfo',
700   'data': {'actual': 'int', '*mem_swapped_in': 'int',
701            '*mem_swapped_out': 'int', '*major_page_faults': 'int',
702            '*minor_page_faults': 'int', '*free_mem': 'int',
703            '*total_mem': 'int'} }
704
705 ##
706 # @query-balloon:
707 #
708 # Return information about the balloon device.
709 #
710 # Returns: @BalloonInfo on success
711 #          If the balloon driver is enabled but not functional because the KVM
712 #          kernel module cannot support it, KvmMissingCap
713 #          If no balloon device is present, DeviceNotActive
714 #
715 # Since: 0.14.0
716 ##
717 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
718
719 ##
720 # @PciMemoryRange:
721 #
722 # A PCI device memory region
723 #
724 # @base: the starting address (guest physical)
725 #
726 # @limit: the ending address (guest physical)
727 #
728 # Since: 0.14.0
729 ##
730 { 'type': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
731
732 ##
733 # @PciMemoryRegion
734 #
735 # Information about a PCI device I/O region.
736 #
737 # @bar: the index of the Base Address Register for this region
738 #
739 # @type: 'io' if the region is a PIO region
740 #        'memory' if the region is a MMIO region
741 #
742 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
743 #
744 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
745 #
746 # Since: 0.14.0
747 ##
748 { 'type': 'PciMemoryRegion',
749   'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
750            '*prefetch': 'bool', '*mem_type_64': 'bool' } }
751
752 ##
753 # @PciBridgeInfo:
754 #
755 # Information about a PCI Bridge device
756 #
757 # @bus.number: primary bus interface number.  This should be the number of the
758 #              bus the device resides on.
759 #
760 # @bus.secondary: secondary bus interface number.  This is the number of the
761 #                 main bus for the bridge
762 #
763 # @bus.subordinate: This is the highest number bus that resides below the
764 #                   bridge.
765 #
766 # @bus.io_range: The PIO range for all devices on this bridge
767 #
768 # @bus.memory_range: The MMIO range for all devices on this bridge
769 #
770 # @bus.prefetchable_range: The range of prefetchable MMIO for all devices on
771 #                          this bridge
772 #
773 # @devices: a list of @PciDeviceInfo for each device on this bridge
774 #
775 # Since: 0.14.0
776 ##
777 { 'type': 'PciBridgeInfo',
778   'data': {'bus': { 'number': 'int', 'secondary': 'int', 'subordinate': 'int',
779                     'io_range': 'PciMemoryRange',
780                     'memory_range': 'PciMemoryRange',
781                     'prefetchable_range': 'PciMemoryRange' },
782            '*devices': ['PciDeviceInfo']} }
783
784 ##
785 # @PciDeviceInfo:
786 #
787 # Information about a PCI device
788 #
789 # @bus: the bus number of the device
790 #
791 # @slot: the slot the device is located in
792 #
793 # @function: the function of the slot used by the device
794 #
795 # @class_info.desc: #optional a string description of the device's class
796 #
797 # @class_info.class: the class code of the device
798 #
799 # @id.device: the PCI device id
800 #
801 # @id.vendor: the PCI vendor id
802 #
803 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
804 #
805 # @qdev_id: the device name of the PCI device
806 #
807 # @pci_bridge: if the device is a PCI bridge, the bridge information
808 #
809 # @regions: a list of the PCI I/O regions associated with the device
810 #
811 # Notes: the contents of @class_info.desc are not stable and should only be
812 #        treated as informational.
813 #
814 # Since: 0.14.0
815 ##
816 { 'type': 'PciDeviceInfo',
817   'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
818            'class_info': {'*desc': 'str', 'class': 'int'},
819            'id': {'device': 'int', 'vendor': 'int'},
820            '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
821            'regions': ['PciMemoryRegion']} }
822
823 ##
824 # @PciInfo:
825 #
826 # Information about a PCI bus
827 #
828 # @bus: the bus index
829 #
830 # @devices: a list of devices on this bus
831 #
832 # Since: 0.14.0
833 ##
834 { 'type': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
835
836 ##
837 # @query-pci:
838 #
839 # Return information about the PCI bus topology of the guest.
840 #
841 # Returns: a list of @PciInfo for each PCI bus
842 #
843 # Since: 0.14.0
844 ##
845 { 'command': 'query-pci', 'returns': ['PciInfo'] }
846
847 ##
848 # @quit:
849 #
850 # This command will cause the QEMU process to exit gracefully.  While every
851 # attempt is made to send the QMP response before terminating, this is not
852 # guaranteed.  When using this interface, a premature EOF would not be
853 # unexpected.
854 #
855 # Since: 0.14.0
856 ##
857 { 'command': 'quit' }
858
859 ##
860 # @stop:
861 #
862 # Stop all guest VCPU execution.
863 #
864 # Since:  0.14.0
865 #
866 # Notes:  This function will succeed even if the guest is already in the stopped
867 #         state
868 ##
869 { 'command': 'stop' }
870
871 ##
872 # @system_reset:
873 #
874 # Performs a hard reset of a guest.
875 #
876 # Since: 0.14.0
877 ##
878 { 'command': 'system_reset' }
879
880 ##
881 # @system_powerdown:
882 #
883 # Requests that a guest perform a powerdown operation.
884 #
885 # Since: 0.14.0
886 #
887 # Notes: A guest may or may not respond to this command.  This command
888 #        returning does not indicate that a guest has accepted the request or
889 #        that it has shut down.  Many guests will respond to this command by
890 #        prompting the user in some way.
891 ##
892 { 'command': 'system_powerdown' }
893
894 ##
895 # @cpu:
896 #
897 # This command is a nop that is only provided for the purposes of compatibility.
898 #
899 # Since: 0.14.0
900 #
901 # Notes: Do not use this command.
902 ##
903 { 'command': 'cpu', 'data': {'index': 'int'} }
904
905 ##
906 # @memsave:
907 #
908 # Save a portion of guest memory to a file.
909 #
910 # @val: the virtual address of the guest to start from
911 #
912 # @size: the size of memory region to save
913 #
914 # @filename: the file to save the memory to as binary data
915 #
916 # @cpu-index: #optional the index of the virtual CPU to use for translating the
917 #                       virtual address (defaults to CPU 0)
918 #
919 # Returns: Nothing on success
920 #          If @cpu is not a valid VCPU, InvalidParameterValue
921 #          If @filename cannot be opened, OpenFileFailed
922 #          If an I/O error occurs while writing the file, IOError
923 #
924 # Since: 0.14.0
925 #
926 # Notes: Errors were not reliably returned until 1.1
927 ##
928 { 'command': 'memsave',
929   'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
930
931 ##
932 # @pmemsave:
933 #
934 # Save a portion of guest physical memory to a file.
935 #
936 # @val: the physical address of the guest to start from
937 #
938 # @size: the size of memory region to save
939 #
940 # @filename: the file to save the memory to as binary data
941 #
942 # Returns: Nothing on success
943 #          If @filename cannot be opened, OpenFileFailed
944 #          If an I/O error occurs while writing the file, IOError
945 #
946 # Since: 0.14.0
947 #
948 # Notes: Errors were not reliably returned until 1.1
949 ##
950 { 'command': 'pmemsave',
951   'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
952
953 ##
954 # @cont:
955 #
956 # Resume guest VCPU execution.
957 #
958 # Since:  0.14.0
959 #
960 # Returns:  If successful, nothing
961 #           If the QEMU is waiting for an incoming migration, MigrationExpected
962 #           If QEMU was started with an encrypted block device and a key has
963 #              not yet been set, DeviceEncrypted.
964 #
965 # Notes:  This command will succeed if the guest is currently running.
966 ##
967 { 'command': 'cont' }
968
969 ##
970 # @inject-nmi:
971 #
972 # Injects an Non-Maskable Interrupt into all guest's VCPUs.
973 #
974 # Returns:  If successful, nothing
975 #           If the Virtual Machine doesn't support NMI injection, Unsupported
976 #
977 # Since:  0.14.0
978 #
979 # Notes: Only x86 Virtual Machines support this command.
980 ##
981 { 'command': 'inject-nmi' }
982
983 ##
984 # @set_link:
985 #
986 # Sets the link status of a virtual network adapter.
987 #
988 # @name: the device name of the virtual network adapter
989 #
990 # @up: true to set the link status to be up
991 #
992 # Returns: Nothing on success
993 #          If @name is not a valid network device, DeviceNotFound
994 #
995 # Since: 0.14.0
996 #
997 # Notes: Not all network adapters support setting link status.  This command
998 #        will succeed even if the network adapter does not support link status
999 #        notification.
1000 ##
1001 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1002
1003 ##
1004 # @block_passwd:
1005 #
1006 # This command sets the password of a block device that has not been open
1007 # with a password and requires one.
1008 #
1009 # The two cases where this can happen are a block device is created through
1010 # QEMU's initial command line or a block device is changed through the legacy
1011 # @change interface.
1012 #
1013 # In the event that the block device is created through the initial command
1014 # line, the VM will start in the stopped state regardless of whether '-S' is
1015 # used.  The intention is for a management tool to query the block devices to
1016 # determine which ones are encrypted, set the passwords with this command, and
1017 # then start the guest with the @cont command.
1018 #
1019 # @device:   the name of the device to set the password on
1020 #
1021 # @password: the password to use for the device
1022 #
1023 # Returns: nothing on success
1024 #          If @device is not a valid block device, DeviceNotFound
1025 #          If @device is not encrypted, DeviceNotEncrypted
1026 #          If @password is not valid for this device, InvalidPassword
1027 #
1028 # Notes:  Not all block formats support encryption and some that do are not
1029 #         able to validate that a password is correct.  Disk corruption may
1030 #         occur if an invalid password is specified.
1031 #
1032 # Since: 0.14.0
1033 ##
1034 { 'command': 'block_passwd', 'data': {'device': 'str', 'password': 'str'} }
1035
1036 ##
1037 # @balloon:
1038 #
1039 # Request the balloon driver to change its balloon size.
1040 #
1041 # @value: the target size of the balloon in bytes
1042 #
1043 # Returns: Nothing on success
1044 #          If the balloon driver is enabled but not functional because the KVM
1045 #            kernel module cannot support it, KvmMissingCap
1046 #          If no balloon device is present, DeviceNotActive
1047 #
1048 # Notes: This command just issues a request to the guest.  When it returns,
1049 #        the balloon size may not have changed.  A guest can change the balloon
1050 #        size independent of this command.
1051 #
1052 # Since: 0.14.0
1053 ##
1054 { 'command': 'balloon', 'data': {'value': 'int'} }
1055
1056 ##
1057 # @block_resize
1058 #
1059 # Resize a block image while a guest is running.
1060 #
1061 # @device:  the name of the device to get the image resized
1062 #
1063 # @size:  new image size in bytes
1064 #
1065 # Returns: nothing on success
1066 #          If @device is not a valid block device, DeviceNotFound
1067 #
1068 # Notes: This command returns UndefinedError in a number of error conditions.
1069 #
1070 # Since: 0.14.0
1071 ##
1072 { 'command': 'block_resize', 'data': { 'device': 'str', 'size': 'int' }}
1073
1074 ##
1075 # @blockdev-snapshot-sync
1076 #
1077 # Generates a synchronous snapshot of a block device.
1078 #
1079 # @device:  the name of the device to generate the snapshot from.
1080 #
1081 # @snapshot-file: the target of the new image. If the file exists, or if it
1082 #                 is a device, the snapshot will be created in the existing
1083 #                 file/device. If does not exist, a new file will be created.
1084 #
1085 # @format: #optional the format of the snapshot image, default is 'qcow2'.
1086 #
1087 # Returns: nothing on success
1088 #          If @device is not a valid block device, DeviceNotFound
1089 #          If @snapshot-file can't be opened, OpenFileFailed
1090 #          If @format is invalid, InvalidBlockFormat
1091 #
1092 # Notes: One of the last steps taken by this command is to close the current
1093 #        image being used by @device and open the @snapshot-file one. If that
1094 #        fails, the command will try to reopen the original image file. If
1095 #        that also fails OpenFileFailed will be returned and the guest may get
1096 #        unexpected errors.
1097 #
1098 # Since 0.14.0
1099 ##
1100 { 'command': 'blockdev-snapshot-sync',
1101   'data': { 'device': 'str', 'snapshot-file': 'str', '*format': 'str' } }
1102
1103 ##
1104 # @human-monitor-command:
1105 #
1106 # Execute a command on the human monitor and return the output.
1107 #
1108 # @command-line: the command to execute in the human monitor
1109 #
1110 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1111 #
1112 # Returns: the output of the command as a string
1113 #
1114 # Since: 0.14.0
1115 #
1116 # Notes: This command only exists as a stop-gap.  It's use is highly
1117 #        discouraged.  The semantics of this command are not guaranteed.
1118 #
1119 #        Known limitations:
1120 #
1121 #        o This command is stateless, this means that commands that depend
1122 #          on state information (such as getfd) might not work
1123 #
1124 #       o Commands that prompt the user for data (eg. 'cont' when the block
1125 #         device is encrypted) don't currently work
1126 ##
1127 { 'command': 'human-monitor-command',
1128   'data': {'command-line': 'str', '*cpu-index': 'int'},
1129   'returns': 'str' } 
1130
1131 ##
1132 # @migrate_cancel
1133 #
1134 # Cancel the current executing migration process.
1135 #
1136 # Returns: nothing on success
1137 #
1138 # Notes: This command succeeds even if there is no migration process running.
1139 #
1140 # Since: 0.14.0
1141 ##
1142 { 'command': 'migrate_cancel' }
1143
1144 ##
1145 # @migrate_set_downtime
1146 #
1147 # Set maximum tolerated downtime for migration.
1148 #
1149 # @value: maximum downtime in seconds
1150 #
1151 # Returns: nothing on success
1152 #
1153 # Since: 0.14.0
1154 ##
1155 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1156
1157 ##
1158 # @migrate_set_speed
1159 #
1160 # Set maximum speed for migration.
1161 #
1162 # @value: maximum speed in bytes.
1163 #
1164 # Returns: nothing on success
1165 #
1166 # Notes: A value lesser than zero will be automatically round up to zero.
1167 #
1168 # Since: 0.14.0
1169 ##
1170 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1171
1172 ##
1173 # @DevicePropertyInfo:
1174 #
1175 # @name: the name of the property
1176 #
1177 # @type: the type of the property.  This will typically come in one of four
1178 #        forms:
1179 #
1180 #        1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1181 #           These types are mapped to the appropriate JSON type.
1182 #
1183 #        2) A legacy type in the form 'legacy<subtype>' where subtype is the
1184 #           legacy qdev typename.  These types are always treated as strings.
1185 #
1186 #        3) A child type in the form 'child<subtype>' where subtype is a qdev
1187 #           device type name.  Child properties create the composition tree.
1188 #
1189 #        4) A link type in the form 'link<subtype>' where subtype is a qdev
1190 #           device type name.  Link properties form the device model graph.
1191 #
1192 # Since: 1.1
1193 #
1194 # Notes: This type is experimental.  Its syntax may change in future releases.
1195 ##
1196 { 'type': 'DevicePropertyInfo',
1197   'data': { 'name': 'str', 'type': 'str' } }
1198
1199 ##
1200 # @qom-list:
1201 #
1202 # This command will list any properties of a device given a path in the device
1203 # model.
1204 #
1205 # @path: the path within the device model.  See @qom-get for a description of
1206 #        this parameter.
1207 #
1208 # Returns: a list of @DevicePropertyInfo that describe the properties of the
1209 #          device.
1210 #
1211 # Since: 1.1
1212 #
1213 # Notes: This command is experimental.  It's syntax may change in future
1214 #        releases.
1215 ##
1216 { 'command': 'qom-list',
1217   'data': { 'path': 'str' },
1218   'returns': [ 'DevicePropertyInfo' ] }
1219
1220 ##
1221 # @qom-get:
1222 #
1223 # This command will get a property from a device model path and return the
1224 # value.
1225 #
1226 # @path: The path within the device model.  There are two forms of supported
1227 #        paths--absolute and partial paths.
1228 #
1229 #        Absolute paths are derived from the root device and can follow child<>
1230 #        or link<> properties.  Since they can follow link<> properties, they
1231 #        can be arbitrarily long.  Absolute paths look like absolute filenames
1232 #        and are prefixed  with a leading slash.
1233 #
1234 #        Partial paths look like relative filenames.  They do not begin
1235 #        with a prefix.  The matching rules for partial paths are subtle but
1236 #        designed to make specifying devices easy.  At each level of the
1237 #        composition tree, the partial path is matched as an absolute path.
1238 #        The first match is not returned.  At least two matches are searched
1239 #        for.  A successful result is only returned if only one match is
1240 #        found.  If more than one match is found, a flag is return to
1241 #        indicate that the match was ambiguous.
1242 #
1243 # @property: The property name to read
1244 #
1245 # Returns: The property value.  The type depends on the property type.  legacy<>
1246 #          properties are returned as #str.  child<> and link<> properties are
1247 #          returns as #str pathnames.  All integer property types (u8, u16, etc)
1248 #          are returned as #int.
1249 #
1250 # Since: 1.1
1251 #
1252 # Notes: This command is experimental and may change syntax in future releases.
1253 ##
1254 { 'command': 'qom-get',
1255   'data': { 'path': 'str', 'property': 'str' },
1256   'returns': 'visitor',
1257   'gen': 'no' }
1258
1259 ##
1260 # @qom-set:
1261 #
1262 # This command will set a property from a device model path.
1263 #
1264 # @path: see @qom-get for a description of this parameter
1265 #
1266 # @property: the property name to set
1267 #
1268 # @value: a value who's type is appropriate for the property type.  See @qom-get
1269 #         for a description of type mapping.
1270 #
1271 # Since: 1.1
1272 #
1273 # Notes: This command is experimental and may change syntax in future releases.
1274 ##
1275 { 'command': 'qom-set',
1276   'data': { 'path': 'str', 'property': 'str', 'value': 'visitor' },
1277   'gen': 'no' }