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