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