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