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