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