Merge remote-tracking branch 'remotes/armbru/tags/pull-qapi-2021-09-25-v2' into staging
[qemu.git] / qapi / qom.json
1 # -*- Mode: Python -*-
2 # vim: filetype=python
3 #
4 # This work is licensed under the terms of the GNU GPL, version 2 or later.
5 # See the COPYING file in the top-level directory.
6
7 { 'include': 'authz.json' }
8 { 'include': 'block-core.json' }
9 { 'include': 'common.json' }
10 { 'include': 'crypto.json' }
11
12 ##
13 # = QEMU Object Model (QOM)
14 ##
15
16 ##
17 # @ObjectPropertyInfo:
18 #
19 # @name: the name of the property
20 #
21 # @type: the type of the property.  This will typically come in one of four
22 #        forms:
23 #
24 #        1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
25 #           These types are mapped to the appropriate JSON type.
26 #
27 #        2) A child type in the form 'child<subtype>' where subtype is a qdev
28 #           device type name.  Child properties create the composition tree.
29 #
30 #        3) A link type in the form 'link<subtype>' where subtype is a qdev
31 #           device type name.  Link properties form the device model graph.
32 #
33 # @description: if specified, the description of the property.
34 #
35 # @default-value: the default value, if any (since 5.0)
36 #
37 # Since: 1.2
38 ##
39 { 'struct': 'ObjectPropertyInfo',
40   'data': { 'name': 'str',
41             'type': 'str',
42             '*description': 'str',
43             '*default-value': 'any' } }
44
45 ##
46 # @qom-list:
47 #
48 # This command will list any properties of a object given a path in the object
49 # model.
50 #
51 # @path: the path within the object model.  See @qom-get for a description of
52 #        this parameter.
53 #
54 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
55 #          object.
56 #
57 # Since: 1.2
58 #
59 # Example:
60 #
61 # -> { "execute": "qom-list",
62 #      "arguments": { "path": "/chardevs" } }
63 # <- { "return": [ { "name": "type", "type": "string" },
64 #                  { "name": "parallel0", "type": "child<chardev-vc>" },
65 #                  { "name": "serial0", "type": "child<chardev-vc>" },
66 #                  { "name": "mon0", "type": "child<chardev-stdio>" } ] }
67 #
68 ##
69 { 'command': 'qom-list',
70   'data': { 'path': 'str' },
71   'returns': [ 'ObjectPropertyInfo' ],
72   'allow-preconfig': true }
73
74 ##
75 # @qom-get:
76 #
77 # This command will get a property from a object model path and return the
78 # value.
79 #
80 # @path: The path within the object model.  There are two forms of supported
81 #        paths--absolute and partial paths.
82 #
83 #        Absolute paths are derived from the root object and can follow child<>
84 #        or link<> properties.  Since they can follow link<> properties, they
85 #        can be arbitrarily long.  Absolute paths look like absolute filenames
86 #        and are prefixed  with a leading slash.
87 #
88 #        Partial paths look like relative filenames.  They do not begin
89 #        with a prefix.  The matching rules for partial paths are subtle but
90 #        designed to make specifying objects easy.  At each level of the
91 #        composition tree, the partial path is matched as an absolute path.
92 #        The first match is not returned.  At least two matches are searched
93 #        for.  A successful result is only returned if only one match is
94 #        found.  If more than one match is found, a flag is return to
95 #        indicate that the match was ambiguous.
96 #
97 # @property: The property name to read
98 #
99 # Returns: The property value.  The type depends on the property
100 #          type. child<> and link<> properties are returned as #str
101 #          pathnames.  All integer property types (u8, u16, etc) are
102 #          returned as #int.
103 #
104 # Since: 1.2
105 #
106 # Example:
107 #
108 # 1. Use absolute path
109 #
110 # -> { "execute": "qom-get",
111 #      "arguments": { "path": "/machine/unattached/device[0]",
112 #                     "property": "hotplugged" } }
113 # <- { "return": false }
114 #
115 # 2. Use partial path
116 #
117 # -> { "execute": "qom-get",
118 #      "arguments": { "path": "unattached/sysbus",
119 #                     "property": "type" } }
120 # <- { "return": "System" }
121 #
122 ##
123 { 'command': 'qom-get',
124   'data': { 'path': 'str', 'property': 'str' },
125   'returns': 'any',
126   'allow-preconfig': true }
127
128 ##
129 # @qom-set:
130 #
131 # This command will set a property from a object model path.
132 #
133 # @path: see @qom-get for a description of this parameter
134 #
135 # @property: the property name to set
136 #
137 # @value: a value who's type is appropriate for the property type.  See @qom-get
138 #         for a description of type mapping.
139 #
140 # Since: 1.2
141 #
142 # Example:
143 #
144 # -> { "execute": "qom-set",
145 #      "arguments": { "path": "/machine",
146 #                     "property": "graphics",
147 #                     "value": false } }
148 # <- { "return": {} }
149 #
150 ##
151 { 'command': 'qom-set',
152   'data': { 'path': 'str', 'property': 'str', 'value': 'any' },
153   'allow-preconfig': true }
154
155 ##
156 # @ObjectTypeInfo:
157 #
158 # This structure describes a search result from @qom-list-types
159 #
160 # @name: the type name found in the search
161 #
162 # @abstract: the type is abstract and can't be directly instantiated.
163 #            Omitted if false. (since 2.10)
164 #
165 # @parent: Name of parent type, if any (since 2.10)
166 #
167 # Since: 1.1
168 ##
169 { 'struct': 'ObjectTypeInfo',
170   'data': { 'name': 'str', '*abstract': 'bool', '*parent': 'str' } }
171
172 ##
173 # @qom-list-types:
174 #
175 # This command will return a list of types given search parameters
176 #
177 # @implements: if specified, only return types that implement this type name
178 #
179 # @abstract: if true, include abstract types in the results
180 #
181 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
182 #
183 # Since: 1.1
184 ##
185 { 'command': 'qom-list-types',
186   'data': { '*implements': 'str', '*abstract': 'bool' },
187   'returns': [ 'ObjectTypeInfo' ],
188   'allow-preconfig': true }
189
190 ##
191 # @qom-list-properties:
192 #
193 # List properties associated with a QOM object.
194 #
195 # @typename: the type name of an object
196 #
197 # Note: objects can create properties at runtime, for example to describe
198 #       links between different devices and/or objects. These properties
199 #       are not included in the output of this command.
200 #
201 # Returns: a list of ObjectPropertyInfo describing object properties
202 #
203 # Since: 2.12
204 ##
205 { 'command': 'qom-list-properties',
206   'data': { 'typename': 'str'},
207   'returns': [ 'ObjectPropertyInfo' ],
208   'allow-preconfig': true }
209
210 ##
211 # @CanHostSocketcanProperties:
212 #
213 # Properties for can-host-socketcan objects.
214 #
215 # @if: interface name of the host system CAN bus to connect to
216 #
217 # @canbus: object ID of the can-bus object to connect to the host interface
218 #
219 # Since: 2.12
220 ##
221 { 'struct': 'CanHostSocketcanProperties',
222   'data': { 'if': 'str',
223             'canbus': 'str' } }
224
225 ##
226 # @ColoCompareProperties:
227 #
228 # Properties for colo-compare objects.
229 #
230 # @primary_in: name of the character device backend to use for the primary
231 #              input (incoming packets are redirected to @outdev)
232 #
233 # @secondary_in: name of the character device backend to use for secondary
234 #                input (incoming packets are only compared to the input on
235 #                @primary_in and then dropped)
236 #
237 # @outdev: name of the character device backend to use for output
238 #
239 # @iothread: name of the iothread to run in
240 #
241 # @notify_dev: name of the character device backend to be used to communicate
242 #              with the remote colo-frame (only for Xen COLO)
243 #
244 # @compare_timeout: the maximum time to hold a packet from @primary_in for
245 #                   comparison with an incoming packet on @secondary_in in
246 #                   milliseconds (default: 3000)
247 #
248 # @expired_scan_cycle: the interval at which colo-compare checks whether
249 #                      packets from @primary have timed out, in milliseconds
250 #                      (default: 3000)
251 #
252 # @max_queue_size: the maximum number of packets to keep in the queue for
253 #                  comparing with incoming packets from @secondary_in.  If the
254 #                  queue is full and addtional packets are received, the
255 #                  addtional packets are dropped. (default: 1024)
256 #
257 # @vnet_hdr_support: if true, vnet header support is enabled (default: false)
258 #
259 # Since: 2.8
260 ##
261 { 'struct': 'ColoCompareProperties',
262   'data': { 'primary_in': 'str',
263             'secondary_in': 'str',
264             'outdev': 'str',
265             'iothread': 'str',
266             '*notify_dev': 'str',
267             '*compare_timeout': 'uint64',
268             '*expired_scan_cycle': 'uint32',
269             '*max_queue_size': 'uint32',
270             '*vnet_hdr_support': 'bool' } }
271
272 ##
273 # @CryptodevBackendProperties:
274 #
275 # Properties for cryptodev-backend and cryptodev-backend-builtin objects.
276 #
277 # @queues: the number of queues for the cryptodev backend. Ignored for
278 #          cryptodev-backend and must be 1 for cryptodev-backend-builtin.
279 #          (default: 1)
280 #
281 # Since: 2.8
282 ##
283 { 'struct': 'CryptodevBackendProperties',
284   'data': { '*queues': 'uint32' } }
285
286 ##
287 # @CryptodevVhostUserProperties:
288 #
289 # Properties for cryptodev-vhost-user objects.
290 #
291 # @chardev: the name of a Unix domain socket character device that connects to
292 #           the vhost-user server
293 #
294 # Since: 2.12
295 ##
296 { 'struct': 'CryptodevVhostUserProperties',
297   'base': 'CryptodevBackendProperties',
298   'data': { 'chardev': 'str' } }
299
300 ##
301 # @DBusVMStateProperties:
302 #
303 # Properties for dbus-vmstate objects.
304 #
305 # @addr: the name of the DBus bus to connect to
306 #
307 # @id-list: a comma separated list of DBus IDs of helpers whose data should be
308 #           included in the VM state on migration
309 #
310 # Since: 5.0
311 ##
312 { 'struct': 'DBusVMStateProperties',
313   'data': { 'addr': 'str' ,
314             '*id-list': 'str' } }
315
316 ##
317 # @NetfilterInsert:
318 #
319 # Indicates where to insert a netfilter relative to a given other filter.
320 #
321 # @before: insert before the specified filter
322 #
323 # @behind: insert behind the specified filter
324 #
325 # Since: 5.0
326 ##
327 { 'enum': 'NetfilterInsert',
328   'data': [ 'before', 'behind' ] }
329
330 ##
331 # @NetfilterProperties:
332 #
333 # Properties for objects of classes derived from netfilter.
334 #
335 # @netdev: id of the network device backend to filter
336 #
337 # @queue: indicates which queue(s) to filter (default: all)
338 #
339 # @status: indicates whether the filter is enabled ("on") or disabled ("off")
340 #          (default: "on")
341 #
342 # @position: specifies where the filter should be inserted in the filter list.
343 #            "head" means the filter is inserted at the head of the filter list,
344 #            before any existing filters.
345 #            "tail" means the filter is inserted at the tail of the filter list,
346 #            behind any existing filters (default).
347 #            "id=<id>" means the filter is inserted before or behind the filter
348 #            specified by <id>, depending on the @insert property.
349 #            (default: "tail")
350 #
351 # @insert: where to insert the filter relative to the filter given in @position.
352 #          Ignored if @position is "head" or "tail". (default: behind)
353 #
354 # Since: 2.5
355 ##
356 { 'struct': 'NetfilterProperties',
357   'data': { 'netdev': 'str',
358             '*queue': 'NetFilterDirection',
359             '*status': 'str',
360             '*position': 'str',
361             '*insert': 'NetfilterInsert' } }
362
363 ##
364 # @FilterBufferProperties:
365 #
366 # Properties for filter-buffer objects.
367 #
368 # @interval: a non-zero interval in microseconds.  All packets arriving in the
369 #            given interval are delayed until the end of the interval.
370 #
371 # Since: 2.5
372 ##
373 { 'struct': 'FilterBufferProperties',
374   'base': 'NetfilterProperties',
375   'data': { 'interval': 'uint32' } }
376
377 ##
378 # @FilterDumpProperties:
379 #
380 # Properties for filter-dump objects.
381 #
382 # @file: the filename where the dumped packets should be stored
383 #
384 # @maxlen: maximum number of bytes in a packet that are stored (default: 65536)
385 #
386 # Since: 2.5
387 ##
388 { 'struct': 'FilterDumpProperties',
389   'base': 'NetfilterProperties',
390   'data': { 'file': 'str',
391             '*maxlen': 'uint32' } }
392
393 ##
394 # @FilterMirrorProperties:
395 #
396 # Properties for filter-mirror objects.
397 #
398 # @outdev: the name of a character device backend to which all incoming packets
399 #          are mirrored
400 #
401 # @vnet_hdr_support: if true, vnet header support is enabled (default: false)
402 #
403 # Since: 2.6
404 ##
405 { 'struct': 'FilterMirrorProperties',
406   'base': 'NetfilterProperties',
407   'data': { 'outdev': 'str',
408             '*vnet_hdr_support': 'bool' } }
409
410 ##
411 # @FilterRedirectorProperties:
412 #
413 # Properties for filter-redirector objects.
414 #
415 # At least one of @indev or @outdev must be present.  If both are present, they
416 # must not refer to the same character device backend.
417 #
418 # @indev: the name of a character device backend from which packets are
419 #         received and redirected to the filtered network device
420 #
421 # @outdev: the name of a character device backend to which all incoming packets
422 #          are redirected
423 #
424 # @vnet_hdr_support: if true, vnet header support is enabled (default: false)
425 #
426 # Since: 2.6
427 ##
428 { 'struct': 'FilterRedirectorProperties',
429   'base': 'NetfilterProperties',
430   'data': { '*indev': 'str',
431             '*outdev': 'str',
432             '*vnet_hdr_support': 'bool' } }
433
434 ##
435 # @FilterRewriterProperties:
436 #
437 # Properties for filter-rewriter objects.
438 #
439 # @vnet_hdr_support: if true, vnet header support is enabled (default: false)
440 #
441 # Since: 2.8
442 ##
443 { 'struct': 'FilterRewriterProperties',
444   'base': 'NetfilterProperties',
445   'data': { '*vnet_hdr_support': 'bool' } }
446
447 ##
448 # @InputBarrierProperties:
449 #
450 # Properties for input-barrier objects.
451 #
452 # @name: the screen name as declared in the screens section of barrier.conf
453 #
454 # @server: hostname of the Barrier server (default: "localhost")
455 #
456 # @port: TCP port of the Barrier server (default: "24800")
457 #
458 # @x-origin: x coordinate of the leftmost pixel on the guest screen
459 #            (default: "0")
460 #
461 # @y-origin: y coordinate of the topmost pixel on the guest screen
462 #            (default: "0")
463 #
464 # @width: the width of secondary screen in pixels (default: "1920")
465 #
466 # @height: the height of secondary screen in pixels (default: "1080")
467 #
468 # Since: 4.2
469 ##
470 { 'struct': 'InputBarrierProperties',
471   'data': { 'name': 'str',
472             '*server': 'str',
473             '*port': 'str',
474             '*x-origin': 'str',
475             '*y-origin': 'str',
476             '*width': 'str',
477             '*height': 'str' } }
478
479 ##
480 # @InputLinuxProperties:
481 #
482 # Properties for input-linux objects.
483 #
484 # @evdev: the path of the host evdev device to use
485 #
486 # @grab_all: if true, grab is toggled for all devices (e.g. both keyboard and
487 #            mouse) instead of just one device (default: false)
488 #
489 # @repeat: enables auto-repeat events (default: false)
490 #
491 # @grab-toggle: the key or key combination that toggles device grab
492 #               (default: ctrl-ctrl)
493 #
494 # Since: 2.6
495 ##
496 { 'struct': 'InputLinuxProperties',
497   'data': { 'evdev': 'str',
498             '*grab_all': 'bool',
499             '*repeat': 'bool',
500             '*grab-toggle': 'GrabToggleKeys' } }
501
502 ##
503 # @IothreadProperties:
504 #
505 # Properties for iothread objects.
506 #
507 # @poll-max-ns: the maximum number of nanoseconds to busy wait for events.
508 #               0 means polling is disabled (default: 32768 on POSIX hosts,
509 #               0 otherwise)
510 #
511 # @poll-grow: the multiplier used to increase the polling time when the
512 #             algorithm detects it is missing events due to not polling long
513 #             enough. 0 selects a default behaviour (default: 0)
514 #
515 # @poll-shrink: the divisor used to decrease the polling time when the
516 #               algorithm detects it is spending too long polling without
517 #               encountering events. 0 selects a default behaviour (default: 0)
518 #
519 # Since: 2.0
520 ##
521 { 'struct': 'IothreadProperties',
522   'data': { '*poll-max-ns': 'int',
523             '*poll-grow': 'int',
524             '*poll-shrink': 'int' } }
525
526 ##
527 # @MemoryBackendProperties:
528 #
529 # Properties for objects of classes derived from memory-backend.
530 #
531 # @merge: if true, mark the memory as mergeable (default depends on the machine
532 #         type)
533 #
534 # @dump: if true, include the memory in core dumps (default depends on the
535 #        machine type)
536 #
537 # @host-nodes: the list of NUMA host nodes to bind the memory to
538 #
539 # @policy: the NUMA policy (default: 'default')
540 #
541 # @prealloc: if true, preallocate memory (default: false)
542 #
543 # @prealloc-threads: number of CPU threads to use for prealloc (default: 1)
544 #
545 # @share: if false, the memory is private to QEMU; if true, it is shared
546 #         (default: false)
547 #
548 # @size: size of the memory region in bytes
549 #
550 # @x-use-canonical-path-for-ramblock-id: if true, the canoncial path is used
551 #                                        for ramblock-id. Disable this for 4.0
552 #                                        machine types or older to allow
553 #                                        migration with newer QEMU versions.
554 #                                        This option is considered stable
555 #                                        despite the x- prefix. (default:
556 #                                        false generally, but true for machine
557 #                                        types <= 4.0)
558 #
559 # Since: 2.1
560 ##
561 { 'struct': 'MemoryBackendProperties',
562   'data': { '*dump': 'bool',
563             '*host-nodes': ['uint16'],
564             '*merge': 'bool',
565             '*policy': 'HostMemPolicy',
566             '*prealloc': 'bool',
567             '*prealloc-threads': 'uint32',
568             '*share': 'bool',
569             'size': 'size',
570             '*x-use-canonical-path-for-ramblock-id': 'bool' } }
571
572 ##
573 # @MemoryBackendFileProperties:
574 #
575 # Properties for memory-backend-file objects.
576 #
577 # @align: the base address alignment when QEMU mmap(2)s @mem-path. Some
578 #         backend stores specified by @mem-path require an alignment different
579 #         than the default one used by QEMU, e.g. the device DAX /dev/dax0.0
580 #         requires 2M alignment rather than 4K. In such cases, users can
581 #         specify the required alignment via this option.
582 #         0 selects a default alignment (currently the page size). (default: 0)
583 #
584 # @discard-data: if true, the file contents can be destroyed when QEMU exits,
585 #                to avoid unnecessarily flushing data to the backing file. Note
586 #                that ``discard-data`` is only an optimization, and QEMU might
587 #                not discard file contents if it aborts unexpectedly or is
588 #                terminated using SIGKILL. (default: false)
589 #
590 # @mem-path: the path to either a shared memory or huge page filesystem mount
591 #
592 # @pmem: specifies whether the backing file specified by @mem-path is in
593 #        host persistent memory that can be accessed using the SNIA NVM
594 #        programming model (e.g. Intel NVDIMM).
595 #
596 # @readonly: if true, the backing file is opened read-only; if false, it is
597 #            opened read-write. (default: false)
598 #
599 # Since: 2.1
600 ##
601 { 'struct': 'MemoryBackendFileProperties',
602   'base': 'MemoryBackendProperties',
603   'data': { '*align': 'size',
604             '*discard-data': 'bool',
605             'mem-path': 'str',
606             '*pmem': { 'type': 'bool', 'if': 'defined(CONFIG_LIBPMEM)' },
607             '*readonly': 'bool' } }
608
609 ##
610 # @MemoryBackendMemfdProperties:
611 #
612 # Properties for memory-backend-memfd objects.
613 #
614 # The @share boolean option is true by default with memfd.
615 #
616 # @hugetlb: if true, the file to be created resides in the hugetlbfs filesystem
617 #           (default: false)
618 #
619 # @hugetlbsize: the hugetlb page size on systems that support multiple hugetlb
620 #               page sizes (it must be a power of 2 value supported by the
621 #               system). 0 selects a default page size. This option is ignored
622 #               if @hugetlb is false. (default: 0)
623 #
624 # @seal: if true, create a sealed-file, which will block further resizing of
625 #        the memory (default: true)
626 #
627 # Since: 2.12
628 ##
629 { 'struct': 'MemoryBackendMemfdProperties',
630   'base': 'MemoryBackendProperties',
631   'data': { '*hugetlb': 'bool',
632             '*hugetlbsize': 'size',
633             '*seal': 'bool' } }
634
635 ##
636 # @PrManagerHelperProperties:
637 #
638 # Properties for pr-manager-helper objects.
639 #
640 # @path: the path to a Unix domain socket for connecting to the external helper
641 #
642 # Since: 2.11
643 ##
644 { 'struct': 'PrManagerHelperProperties',
645   'data': { 'path': 'str' } }
646
647 ##
648 # @RemoteObjectProperties:
649 #
650 # Properties for x-remote-object objects.
651 #
652 # @fd: file descriptor name previously passed via 'getfd' command
653 #
654 # @devid: the id of the device to be associated with the file descriptor
655 #
656 # Since: 6.0
657 ##
658 { 'struct': 'RemoteObjectProperties',
659   'data': { 'fd': 'str', 'devid': 'str' } }
660
661 ##
662 # @RngProperties:
663 #
664 # Properties for objects of classes derived from rng.
665 #
666 # @opened: if true, the device is opened immediately when applying this option
667 #          and will probably fail when processing the next option. Don't use;
668 #          only provided for compatibility. (default: false)
669 #
670 # Features:
671 # @deprecated: Member @opened is deprecated.  Setting true doesn't make sense,
672 #              and false is already the default.
673 #
674 # Since: 1.3
675 ##
676 { 'struct': 'RngProperties',
677   'data': { '*opened': { 'type': 'bool', 'features': ['deprecated'] } } }
678
679 ##
680 # @RngEgdProperties:
681 #
682 # Properties for rng-egd objects.
683 #
684 # @chardev: the name of a character device backend that provides the connection
685 #           to the RNG daemon
686 #
687 # Since: 1.3
688 ##
689 { 'struct': 'RngEgdProperties',
690   'base': 'RngProperties',
691   'data': { 'chardev': 'str' } }
692
693 ##
694 # @RngRandomProperties:
695 #
696 # Properties for rng-random objects.
697 #
698 # @filename: the filename of the device on the host to obtain entropy from
699 #            (default: "/dev/urandom")
700 #
701 # Since: 1.3
702 ##
703 { 'struct': 'RngRandomProperties',
704   'base': 'RngProperties',
705   'data': { '*filename': 'str' } }
706
707 ##
708 # @SevGuestProperties:
709 #
710 # Properties for sev-guest objects.
711 #
712 # @sev-device: SEV device to use (default: "/dev/sev")
713 #
714 # @dh-cert-file: guest owners DH certificate (encoded with base64)
715 #
716 # @session-file: guest owners session parameters (encoded with base64)
717 #
718 # @policy: SEV policy value (default: 0x1)
719 #
720 # @handle: SEV firmware handle (default: 0)
721 #
722 # @cbitpos: C-bit location in page table entry (default: 0)
723 #
724 # @reduced-phys-bits: number of bits in physical addresses that become
725 #                     unavailable when SEV is enabled
726 #
727 # Since: 2.12
728 ##
729 { 'struct': 'SevGuestProperties',
730   'data': { '*sev-device': 'str',
731             '*dh-cert-file': 'str',
732             '*session-file': 'str',
733             '*policy': 'uint32',
734             '*handle': 'uint32',
735             '*cbitpos': 'uint32',
736             'reduced-phys-bits': 'uint32' } }
737
738 ##
739 # @ObjectType:
740 #
741 # Since: 6.0
742 ##
743 { 'enum': 'ObjectType',
744   'data': [
745     'authz-list',
746     'authz-listfile',
747     'authz-pam',
748     'authz-simple',
749     'can-bus',
750     'can-host-socketcan',
751     'colo-compare',
752     'cryptodev-backend',
753     'cryptodev-backend-builtin',
754     { 'name': 'cryptodev-vhost-user',
755       'if': 'defined(CONFIG_VHOST_CRYPTO)' },
756     'dbus-vmstate',
757     'filter-buffer',
758     'filter-dump',
759     'filter-mirror',
760     'filter-redirector',
761     'filter-replay',
762     'filter-rewriter',
763     'input-barrier',
764     'input-linux',
765     'iothread',
766     'memory-backend-file',
767     { 'name': 'memory-backend-memfd',
768       'if': 'defined(CONFIG_LINUX)' },
769     'memory-backend-ram',
770     'pef-guest',
771     'pr-manager-helper',
772     'rng-builtin',
773     'rng-egd',
774     'rng-random',
775     'secret',
776     'secret_keyring',
777     'sev-guest',
778     's390-pv-guest',
779     'throttle-group',
780     'tls-creds-anon',
781     'tls-creds-psk',
782     'tls-creds-x509',
783     'tls-cipher-suites',
784     'x-remote-object'
785   ] }
786
787 ##
788 # @ObjectOptions:
789 #
790 # Describes the options of a user creatable QOM object.
791 #
792 # @qom-type: the class name for the object to be created
793 #
794 # @id: the name of the new object
795 #
796 # Since: 6.0
797 ##
798 { 'union': 'ObjectOptions',
799   'base': { 'qom-type': 'ObjectType',
800             'id': 'str' },
801   'discriminator': 'qom-type',
802   'data': {
803       'authz-list':                 'AuthZListProperties',
804       'authz-listfile':             'AuthZListFileProperties',
805       'authz-pam':                  'AuthZPAMProperties',
806       'authz-simple':               'AuthZSimpleProperties',
807       'can-host-socketcan':         'CanHostSocketcanProperties',
808       'colo-compare':               'ColoCompareProperties',
809       'cryptodev-backend':          'CryptodevBackendProperties',
810       'cryptodev-backend-builtin':  'CryptodevBackendProperties',
811       'cryptodev-vhost-user':       { 'type': 'CryptodevVhostUserProperties',
812                                       'if': 'defined(CONFIG_VHOST_CRYPTO)' },
813       'dbus-vmstate':               'DBusVMStateProperties',
814       'filter-buffer':              'FilterBufferProperties',
815       'filter-dump':                'FilterDumpProperties',
816       'filter-mirror':              'FilterMirrorProperties',
817       'filter-redirector':          'FilterRedirectorProperties',
818       'filter-replay':              'NetfilterProperties',
819       'filter-rewriter':            'FilterRewriterProperties',
820       'input-barrier':              'InputBarrierProperties',
821       'input-linux':                'InputLinuxProperties',
822       'iothread':                   'IothreadProperties',
823       'memory-backend-file':        'MemoryBackendFileProperties',
824       'memory-backend-memfd':       { 'type': 'MemoryBackendMemfdProperties',
825                                       'if': 'defined(CONFIG_LINUX)' },
826       'memory-backend-ram':         'MemoryBackendProperties',
827       'pr-manager-helper':          'PrManagerHelperProperties',
828       'rng-builtin':                'RngProperties',
829       'rng-egd':                    'RngEgdProperties',
830       'rng-random':                 'RngRandomProperties',
831       'secret':                     'SecretProperties',
832       'secret_keyring':             'SecretKeyringProperties',
833       'sev-guest':                  'SevGuestProperties',
834       'throttle-group':             'ThrottleGroupProperties',
835       'tls-creds-anon':             'TlsCredsAnonProperties',
836       'tls-creds-psk':              'TlsCredsPskProperties',
837       'tls-creds-x509':             'TlsCredsX509Properties',
838       'tls-cipher-suites':          'TlsCredsProperties',
839       'x-remote-object':            'RemoteObjectProperties'
840   } }
841
842 ##
843 # @object-add:
844 #
845 # Create a QOM object.
846 #
847 # Returns: Nothing on success
848 #          Error if @qom-type is not a valid class name
849 #
850 # Since: 2.0
851 #
852 # Example:
853 #
854 # -> { "execute": "object-add",
855 #      "arguments": { "qom-type": "rng-random", "id": "rng1",
856 #                     "filename": "/dev/hwrng" } }
857 # <- { "return": {} }
858 #
859 ##
860 { 'command': 'object-add', 'data': 'ObjectOptions', 'boxed': true }
861
862 ##
863 # @object-del:
864 #
865 # Remove a QOM object.
866 #
867 # @id: the name of the QOM object to remove
868 #
869 # Returns: Nothing on success
870 #          Error if @id is not a valid id for a QOM object
871 #
872 # Since: 2.0
873 #
874 # Example:
875 #
876 # -> { "execute": "object-del", "arguments": { "id": "rng1" } }
877 # <- { "return": {} }
878 #
879 ##
880 { 'command': 'object-del', 'data': {'id': 'str'} }