]>
Commit | Line | Data |
---|---|---|
c577ff62 | 1 | # -*- Mode: Python -*- |
f7160f32 | 2 | # vim: filetype=python |
c577ff62 MA |
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 | ||
8825587b | 7 | { 'include': 'authz.json' } |
381bd744 | 8 | { 'include': 'block-core.json' } |
913d9063 | 9 | { 'include': 'common.json' } |
39c4c27d | 10 | { 'include': 'crypto.json' } |
8825587b | 11 | |
c577ff62 MA |
12 | ## |
13 | # = QEMU Object Model (QOM) | |
14 | ## | |
15 | ||
16 | ## | |
17 | # @ObjectPropertyInfo: | |
18 | # | |
19 | # @name: the name of the property | |
20 | # | |
a937b6aa MA |
21 | # @type: the type of the property. This will typically come in one of |
22 | # four forms: | |
c577ff62 | 23 | # |
a937b6aa MA |
24 | # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or |
25 | # 'double'. These types are mapped to the appropriate JSON | |
26 | # type. | |
c577ff62 | 27 | # |
a937b6aa MA |
28 | # 2) A child type in the form 'child<subtype>' where subtype is a |
29 | # qdev device type name. Child properties create the | |
30 | # composition tree. | |
c577ff62 | 31 | # |
a937b6aa MA |
32 | # 3) A link type in the form 'link<subtype>' where subtype is a |
33 | # qdev device type name. Link properties form the device model | |
34 | # graph. | |
c577ff62 MA |
35 | # |
36 | # @description: if specified, the description of the property. | |
37 | # | |
1bb3d7d9 MAL |
38 | # @default-value: the default value, if any (since 5.0) |
39 | # | |
c577ff62 MA |
40 | # Since: 1.2 |
41 | ## | |
42 | { 'struct': 'ObjectPropertyInfo', | |
1bb3d7d9 MAL |
43 | 'data': { 'name': 'str', |
44 | 'type': 'str', | |
45 | '*description': 'str', | |
46 | '*default-value': 'any' } } | |
c577ff62 MA |
47 | |
48 | ## | |
49 | # @qom-list: | |
50 | # | |
a937b6aa MA |
51 | # This command will list any properties of a object given a path in |
52 | # the object model. | |
c577ff62 | 53 | # |
a937b6aa MA |
54 | # @path: the path within the object model. See @qom-get for a |
55 | # description of this parameter. | |
c577ff62 | 56 | # |
a937b6aa MA |
57 | # Returns: a list of @ObjectPropertyInfo that describe the properties |
58 | # of the object. | |
c577ff62 MA |
59 | # |
60 | # Since: 1.2 | |
61 | # | |
62 | # Example: | |
63 | # | |
64 | # -> { "execute": "qom-list", | |
65 | # "arguments": { "path": "/chardevs" } } | |
66 | # <- { "return": [ { "name": "type", "type": "string" }, | |
67 | # { "name": "parallel0", "type": "child<chardev-vc>" }, | |
68 | # { "name": "serial0", "type": "child<chardev-vc>" }, | |
69 | # { "name": "mon0", "type": "child<chardev-stdio>" } ] } | |
c577ff62 MA |
70 | ## |
71 | { 'command': 'qom-list', | |
72 | 'data': { 'path': 'str' }, | |
73 | 'returns': [ 'ObjectPropertyInfo' ], | |
74 | 'allow-preconfig': true } | |
75 | ||
76 | ## | |
77 | # @qom-get: | |
78 | # | |
a937b6aa MA |
79 | # This command will get a property from a object model path and return |
80 | # the value. | |
c577ff62 | 81 | # |
a937b6aa MA |
82 | # @path: The path within the object model. There are two forms of |
83 | # supported paths--absolute and partial paths. | |
c577ff62 | 84 | # |
a937b6aa MA |
85 | # Absolute paths are derived from the root object and can follow |
86 | # child<> or link<> properties. Since they can follow link<> | |
87 | # properties, they can be arbitrarily long. Absolute paths look | |
88 | # like absolute filenames and are prefixed with a leading slash. | |
c577ff62 | 89 | # |
a937b6aa MA |
90 | # Partial paths look like relative filenames. They do not begin |
91 | # with a prefix. The matching rules for partial paths are subtle | |
92 | # but designed to make specifying objects easy. At each level of | |
93 | # the composition tree, the partial path is matched as an absolute | |
94 | # path. The first match is not returned. At least two matches | |
95 | # are searched for. A successful result is only returned if only | |
96 | # one match is found. If more than one match is found, a flag is | |
97 | # return to indicate that the match was ambiguous. | |
c577ff62 MA |
98 | # |
99 | # @property: The property name to read | |
100 | # | |
a937b6aa MA |
101 | # Returns: The property value. The type depends on the property type. |
102 | # child<> and link<> properties are returned as #str pathnames. | |
103 | # All integer property types (u8, u16, etc) are returned as #int. | |
c577ff62 MA |
104 | # |
105 | # Since: 1.2 | |
106 | # | |
37fa48a4 | 107 | # Examples: |
c577ff62 MA |
108 | # |
109 | # 1. Use absolute path | |
110 | # | |
111 | # -> { "execute": "qom-get", | |
112 | # "arguments": { "path": "/machine/unattached/device[0]", | |
113 | # "property": "hotplugged" } } | |
114 | # <- { "return": false } | |
115 | # | |
116 | # 2. Use partial path | |
117 | # | |
118 | # -> { "execute": "qom-get", | |
119 | # "arguments": { "path": "unattached/sysbus", | |
120 | # "property": "type" } } | |
121 | # <- { "return": "System" } | |
c577ff62 MA |
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 | # | |
a937b6aa MA |
137 | # @value: a value who's type is appropriate for the property type. |
138 | # See @qom-get for a description of type mapping. | |
c577ff62 MA |
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": {} } | |
c577ff62 MA |
149 | ## |
150 | { 'command': 'qom-set', | |
151 | 'data': { 'path': 'str', 'property': 'str', 'value': 'any' }, | |
152 | 'allow-preconfig': true } | |
153 | ||
154 | ## | |
155 | # @ObjectTypeInfo: | |
156 | # | |
157 | # This structure describes a search result from @qom-list-types | |
158 | # | |
159 | # @name: the type name found in the search | |
160 | # | |
161 | # @abstract: the type is abstract and can't be directly instantiated. | |
a937b6aa | 162 | # Omitted if false. (since 2.10) |
c577ff62 MA |
163 | # |
164 | # @parent: Name of parent type, if any (since 2.10) | |
165 | # | |
166 | # Since: 1.1 | |
167 | ## | |
168 | { 'struct': 'ObjectTypeInfo', | |
169 | 'data': { 'name': 'str', '*abstract': 'bool', '*parent': 'str' } } | |
170 | ||
171 | ## | |
172 | # @qom-list-types: | |
173 | # | |
174 | # This command will return a list of types given search parameters | |
175 | # | |
a937b6aa MA |
176 | # @implements: if specified, only return types that implement this |
177 | # type name | |
c577ff62 MA |
178 | # |
179 | # @abstract: if true, include abstract types in the results | |
180 | # | |
a937b6aa MA |
181 | # Returns: a list of @ObjectTypeInfo or an empty list if no results |
182 | # are found | |
c577ff62 MA |
183 | # |
184 | # Since: 1.1 | |
185 | ## | |
186 | { 'command': 'qom-list-types', | |
187 | 'data': { '*implements': 'str', '*abstract': 'bool' }, | |
188 | 'returns': [ 'ObjectTypeInfo' ], | |
189 | 'allow-preconfig': true } | |
190 | ||
191 | ## | |
192 | # @qom-list-properties: | |
193 | # | |
194 | # List properties associated with a QOM object. | |
195 | # | |
196 | # @typename: the type name of an object | |
197 | # | |
a937b6aa MA |
198 | # Note: objects can create properties at runtime, for example to |
199 | # describe links between different devices and/or objects. These | |
200 | # properties are not included in the output of this command. | |
c577ff62 MA |
201 | # |
202 | # Returns: a list of ObjectPropertyInfo describing object properties | |
203 | # | |
204 | # Since: 2.12 | |
205 | ## | |
206 | { 'command': 'qom-list-properties', | |
207 | 'data': { 'typename': 'str'}, | |
208 | 'returns': [ 'ObjectPropertyInfo' ], | |
209 | 'allow-preconfig': true } | |
210 | ||
f3189b91 KW |
211 | ## |
212 | # @CanHostSocketcanProperties: | |
213 | # | |
214 | # Properties for can-host-socketcan objects. | |
215 | # | |
216 | # @if: interface name of the host system CAN bus to connect to | |
217 | # | |
a937b6aa MA |
218 | # @canbus: object ID of the can-bus object to connect to the host |
219 | # interface | |
f3189b91 KW |
220 | # |
221 | # Since: 2.12 | |
222 | ## | |
223 | { 'struct': 'CanHostSocketcanProperties', | |
224 | 'data': { 'if': 'str', | |
225 | 'canbus': 'str' } } | |
226 | ||
3d0d3c30 KW |
227 | ## |
228 | # @ColoCompareProperties: | |
229 | # | |
230 | # Properties for colo-compare objects. | |
231 | # | |
a937b6aa MA |
232 | # @primary_in: name of the character device backend to use for the |
233 | # primary input (incoming packets are redirected to @outdev) | |
3d0d3c30 | 234 | # |
a937b6aa MA |
235 | # @secondary_in: name of the character device backend to use for |
236 | # secondary input (incoming packets are only compared to the input | |
237 | # on @primary_in and then dropped) | |
3d0d3c30 KW |
238 | # |
239 | # @outdev: name of the character device backend to use for output | |
240 | # | |
241 | # @iothread: name of the iothread to run in | |
242 | # | |
a937b6aa MA |
243 | # @notify_dev: name of the character device backend to be used to |
244 | # communicate with the remote colo-frame (only for Xen COLO) | |
3d0d3c30 | 245 | # |
a937b6aa MA |
246 | # @compare_timeout: the maximum time to hold a packet from @primary_in |
247 | # for comparison with an incoming packet on @secondary_in in | |
248 | # milliseconds (default: 3000) | |
3d0d3c30 | 249 | # |
a937b6aa MA |
250 | # @expired_scan_cycle: the interval at which colo-compare checks |
251 | # whether packets from @primary have timed out, in milliseconds | |
252 | # (default: 3000) | |
3d0d3c30 | 253 | # |
a937b6aa MA |
254 | # @max_queue_size: the maximum number of packets to keep in the queue |
255 | # for comparing with incoming packets from @secondary_in. If the | |
256 | # queue is full and additional packets are received, the | |
257 | # additional packets are dropped. (default: 1024) | |
3d0d3c30 | 258 | # |
a937b6aa MA |
259 | # @vnet_hdr_support: if true, vnet header support is enabled |
260 | # (default: false) | |
3d0d3c30 KW |
261 | # |
262 | # Since: 2.8 | |
263 | ## | |
264 | { 'struct': 'ColoCompareProperties', | |
265 | 'data': { 'primary_in': 'str', | |
266 | 'secondary_in': 'str', | |
267 | 'outdev': 'str', | |
268 | 'iothread': 'str', | |
269 | '*notify_dev': 'str', | |
270 | '*compare_timeout': 'uint64', | |
271 | '*expired_scan_cycle': 'uint32', | |
272 | '*max_queue_size': 'uint32', | |
273 | '*vnet_hdr_support': 'bool' } } | |
274 | ||
a68d909e KW |
275 | ## |
276 | # @CryptodevBackendProperties: | |
277 | # | |
a937b6aa MA |
278 | # Properties for cryptodev-backend and cryptodev-backend-builtin |
279 | # objects. | |
a68d909e | 280 | # |
a937b6aa MA |
281 | # @queues: the number of queues for the cryptodev backend. Ignored |
282 | # for cryptodev-backend and must be 1 for | |
283 | # cryptodev-backend-builtin. (default: 1) | |
a68d909e | 284 | # |
2580b452 ZP |
285 | # @throttle-bps: limit total bytes per second (Since 8.0) |
286 | # | |
287 | # @throttle-ops: limit total operations per second (Since 8.0) | |
288 | # | |
a68d909e KW |
289 | # Since: 2.8 |
290 | ## | |
291 | { 'struct': 'CryptodevBackendProperties', | |
2580b452 ZP |
292 | 'data': { '*queues': 'uint32', |
293 | '*throttle-bps': 'uint64', | |
294 | '*throttle-ops': 'uint64' } } | |
a68d909e KW |
295 | |
296 | ## | |
297 | # @CryptodevVhostUserProperties: | |
298 | # | |
299 | # Properties for cryptodev-vhost-user objects. | |
300 | # | |
a937b6aa MA |
301 | # @chardev: the name of a Unix domain socket character device that |
302 | # connects to the vhost-user server | |
a68d909e KW |
303 | # |
304 | # Since: 2.12 | |
305 | ## | |
306 | { 'struct': 'CryptodevVhostUserProperties', | |
307 | 'base': 'CryptodevBackendProperties', | |
308 | 'data': { 'chardev': 'str' } } | |
309 | ||
d7ef29c4 KW |
310 | ## |
311 | # @DBusVMStateProperties: | |
312 | # | |
313 | # Properties for dbus-vmstate objects. | |
314 | # | |
315 | # @addr: the name of the DBus bus to connect to | |
316 | # | |
a937b6aa MA |
317 | # @id-list: a comma separated list of DBus IDs of helpers whose data |
318 | # should be included in the VM state on migration | |
d7ef29c4 KW |
319 | # |
320 | # Since: 5.0 | |
321 | ## | |
322 | { 'struct': 'DBusVMStateProperties', | |
323 | 'data': { 'addr': 'str' , | |
324 | '*id-list': 'str' } } | |
325 | ||
1156a675 KW |
326 | ## |
327 | # @NetfilterInsert: | |
328 | # | |
a937b6aa MA |
329 | # Indicates where to insert a netfilter relative to a given other |
330 | # filter. | |
1156a675 KW |
331 | # |
332 | # @before: insert before the specified filter | |
333 | # | |
334 | # @behind: insert behind the specified filter | |
335 | # | |
336 | # Since: 5.0 | |
337 | ## | |
338 | { 'enum': 'NetfilterInsert', | |
339 | 'data': [ 'before', 'behind' ] } | |
340 | ||
341 | ## | |
342 | # @NetfilterProperties: | |
343 | # | |
344 | # Properties for objects of classes derived from netfilter. | |
345 | # | |
346 | # @netdev: id of the network device backend to filter | |
347 | # | |
348 | # @queue: indicates which queue(s) to filter (default: all) | |
349 | # | |
a937b6aa MA |
350 | # @status: indicates whether the filter is enabled ("on") or disabled |
351 | # ("off") (default: "on") | |
1156a675 | 352 | # |
a937b6aa MA |
353 | # @position: specifies where the filter should be inserted in the |
354 | # filter list. "head" means the filter is inserted at the head of | |
355 | # the filter list, before any existing filters. "tail" means the | |
356 | # filter is inserted at the tail of the filter list, behind any | |
357 | # existing filters (default). "id=<id>" means the filter is | |
358 | # inserted before or behind the filter specified by <id>, | |
359 | # depending on the @insert property. (default: "tail") | |
1156a675 | 360 | # |
a937b6aa MA |
361 | # @insert: where to insert the filter relative to the filter given in |
362 | # @position. Ignored if @position is "head" or "tail". | |
363 | # (default: behind) | |
1156a675 KW |
364 | # |
365 | # Since: 2.5 | |
366 | ## | |
367 | { 'struct': 'NetfilterProperties', | |
368 | 'data': { 'netdev': 'str', | |
369 | '*queue': 'NetFilterDirection', | |
370 | '*status': 'str', | |
371 | '*position': 'str', | |
372 | '*insert': 'NetfilterInsert' } } | |
373 | ||
374 | ## | |
375 | # @FilterBufferProperties: | |
376 | # | |
377 | # Properties for filter-buffer objects. | |
378 | # | |
a937b6aa MA |
379 | # @interval: a non-zero interval in microseconds. All packets |
380 | # arriving in the given interval are delayed until the end of the | |
381 | # interval. | |
1156a675 KW |
382 | # |
383 | # Since: 2.5 | |
384 | ## | |
385 | { 'struct': 'FilterBufferProperties', | |
386 | 'base': 'NetfilterProperties', | |
387 | 'data': { 'interval': 'uint32' } } | |
388 | ||
389 | ## | |
390 | # @FilterDumpProperties: | |
391 | # | |
392 | # Properties for filter-dump objects. | |
393 | # | |
394 | # @file: the filename where the dumped packets should be stored | |
395 | # | |
a937b6aa MA |
396 | # @maxlen: maximum number of bytes in a packet that are stored |
397 | # (default: 65536) | |
1156a675 KW |
398 | # |
399 | # Since: 2.5 | |
400 | ## | |
401 | { 'struct': 'FilterDumpProperties', | |
402 | 'base': 'NetfilterProperties', | |
403 | 'data': { 'file': 'str', | |
404 | '*maxlen': 'uint32' } } | |
405 | ||
406 | ## | |
407 | # @FilterMirrorProperties: | |
408 | # | |
409 | # Properties for filter-mirror objects. | |
410 | # | |
a937b6aa MA |
411 | # @outdev: the name of a character device backend to which all |
412 | # incoming packets are mirrored | |
1156a675 | 413 | # |
a937b6aa MA |
414 | # @vnet_hdr_support: if true, vnet header support is enabled |
415 | # (default: false) | |
1156a675 KW |
416 | # |
417 | # Since: 2.6 | |
418 | ## | |
419 | { 'struct': 'FilterMirrorProperties', | |
420 | 'base': 'NetfilterProperties', | |
421 | 'data': { 'outdev': 'str', | |
422 | '*vnet_hdr_support': 'bool' } } | |
423 | ||
424 | ## | |
425 | # @FilterRedirectorProperties: | |
426 | # | |
427 | # Properties for filter-redirector objects. | |
428 | # | |
a937b6aa MA |
429 | # At least one of @indev or @outdev must be present. If both are |
430 | # present, they must not refer to the same character device backend. | |
1156a675 | 431 | # |
a937b6aa MA |
432 | # @indev: the name of a character device backend from which packets |
433 | # are received and redirected to the filtered network device | |
1156a675 | 434 | # |
a937b6aa MA |
435 | # @outdev: the name of a character device backend to which all |
436 | # incoming packets are redirected | |
1156a675 | 437 | # |
a937b6aa MA |
438 | # @vnet_hdr_support: if true, vnet header support is enabled |
439 | # (default: false) | |
1156a675 KW |
440 | # |
441 | # Since: 2.6 | |
442 | ## | |
443 | { 'struct': 'FilterRedirectorProperties', | |
444 | 'base': 'NetfilterProperties', | |
445 | 'data': { '*indev': 'str', | |
446 | '*outdev': 'str', | |
447 | '*vnet_hdr_support': 'bool' } } | |
448 | ||
449 | ## | |
450 | # @FilterRewriterProperties: | |
451 | # | |
452 | # Properties for filter-rewriter objects. | |
453 | # | |
a937b6aa MA |
454 | # @vnet_hdr_support: if true, vnet header support is enabled |
455 | # (default: false) | |
1156a675 KW |
456 | # |
457 | # Since: 2.8 | |
458 | ## | |
459 | { 'struct': 'FilterRewriterProperties', | |
460 | 'base': 'NetfilterProperties', | |
461 | 'data': { '*vnet_hdr_support': 'bool' } } | |
462 | ||
30e863e5 KW |
463 | ## |
464 | # @InputBarrierProperties: | |
465 | # | |
466 | # Properties for input-barrier objects. | |
467 | # | |
a937b6aa MA |
468 | # @name: the screen name as declared in the screens section of |
469 | # barrier.conf | |
30e863e5 KW |
470 | # |
471 | # @server: hostname of the Barrier server (default: "localhost") | |
472 | # | |
473 | # @port: TCP port of the Barrier server (default: "24800") | |
474 | # | |
475 | # @x-origin: x coordinate of the leftmost pixel on the guest screen | |
a937b6aa | 476 | # (default: "0") |
30e863e5 KW |
477 | # |
478 | # @y-origin: y coordinate of the topmost pixel on the guest screen | |
a937b6aa | 479 | # (default: "0") |
30e863e5 KW |
480 | # |
481 | # @width: the width of secondary screen in pixels (default: "1920") | |
482 | # | |
483 | # @height: the height of secondary screen in pixels (default: "1080") | |
484 | # | |
485 | # Since: 4.2 | |
486 | ## | |
487 | { 'struct': 'InputBarrierProperties', | |
488 | 'data': { 'name': 'str', | |
489 | '*server': 'str', | |
490 | '*port': 'str', | |
491 | '*x-origin': 'str', | |
492 | '*y-origin': 'str', | |
493 | '*width': 'str', | |
494 | '*height': 'str' } } | |
495 | ||
496 | ## | |
497 | # @InputLinuxProperties: | |
498 | # | |
499 | # Properties for input-linux objects. | |
500 | # | |
501 | # @evdev: the path of the host evdev device to use | |
502 | # | |
a937b6aa MA |
503 | # @grab_all: if true, grab is toggled for all devices (e.g. both |
504 | # keyboard and mouse) instead of just one device (default: false) | |
30e863e5 KW |
505 | # |
506 | # @repeat: enables auto-repeat events (default: false) | |
507 | # | |
508 | # @grab-toggle: the key or key combination that toggles device grab | |
a937b6aa | 509 | # (default: ctrl-ctrl) |
30e863e5 KW |
510 | # |
511 | # Since: 2.6 | |
512 | ## | |
513 | { 'struct': 'InputLinuxProperties', | |
514 | 'data': { 'evdev': 'str', | |
515 | '*grab_all': 'bool', | |
516 | '*repeat': 'bool', | |
517 | '*grab-toggle': 'GrabToggleKeys' } } | |
518 | ||
7d5983e3 NSJ |
519 | ## |
520 | # @EventLoopBaseProperties: | |
521 | # | |
522 | # Common properties for event loops | |
523 | # | |
a937b6aa MA |
524 | # @aio-max-batch: maximum number of requests in a batch for the AIO |
525 | # engine, 0 means that the engine will use its default. | |
526 | # (default: 0) | |
7d5983e3 | 527 | # |
a937b6aa MA |
528 | # @thread-pool-min: minimum number of threads reserved in the thread |
529 | # pool (default:0) | |
71ad4713 | 530 | # |
a937b6aa MA |
531 | # @thread-pool-max: maximum number of threads the thread pool can |
532 | # contain (default:64) | |
71ad4713 | 533 | # |
7d5983e3 NSJ |
534 | # Since: 7.1 |
535 | ## | |
536 | { 'struct': 'EventLoopBaseProperties', | |
71ad4713 NSJ |
537 | 'data': { '*aio-max-batch': 'int', |
538 | '*thread-pool-min': 'int', | |
539 | '*thread-pool-max': 'int' } } | |
7d5983e3 | 540 | |
2273b241 KW |
541 | ## |
542 | # @IothreadProperties: | |
543 | # | |
544 | # Properties for iothread objects. | |
545 | # | |
a937b6aa MA |
546 | # @poll-max-ns: the maximum number of nanoseconds to busy wait for |
547 | # events. 0 means polling is disabled (default: 32768 on POSIX | |
548 | # hosts, 0 otherwise) | |
2273b241 | 549 | # |
a937b6aa MA |
550 | # @poll-grow: the multiplier used to increase the polling time when |
551 | # the algorithm detects it is missing events due to not polling | |
552 | # long enough. 0 selects a default behaviour (default: 0) | |
2273b241 KW |
553 | # |
554 | # @poll-shrink: the divisor used to decrease the polling time when the | |
a937b6aa MA |
555 | # algorithm detects it is spending too long polling without |
556 | # encountering events. 0 selects a default behaviour (default: 0) | |
2273b241 | 557 | # |
7d5983e3 | 558 | # The @aio-max-batch option is available since 6.1. |
1793ad02 | 559 | # |
2273b241 KW |
560 | # Since: 2.0 |
561 | ## | |
562 | { 'struct': 'IothreadProperties', | |
7d5983e3 | 563 | 'base': 'EventLoopBaseProperties', |
2273b241 KW |
564 | 'data': { '*poll-max-ns': 'int', |
565 | '*poll-grow': 'int', | |
7d5983e3 | 566 | '*poll-shrink': 'int' } } |
2273b241 | 567 | |
70ac26b9 NSJ |
568 | ## |
569 | # @MainLoopProperties: | |
570 | # | |
571 | # Properties for the main-loop object. | |
572 | # | |
573 | # Since: 7.1 | |
574 | ## | |
575 | { 'struct': 'MainLoopProperties', | |
576 | 'base': 'EventLoopBaseProperties', | |
577 | 'data': {} } | |
578 | ||
913d9063 KW |
579 | ## |
580 | # @MemoryBackendProperties: | |
581 | # | |
582 | # Properties for objects of classes derived from memory-backend. | |
583 | # | |
a937b6aa MA |
584 | # @merge: if true, mark the memory as mergeable (default depends on |
585 | # the machine type) | |
913d9063 | 586 | # |
a937b6aa MA |
587 | # @dump: if true, include the memory in core dumps (default depends on |
588 | # the machine type) | |
913d9063 KW |
589 | # |
590 | # @host-nodes: the list of NUMA host nodes to bind the memory to | |
591 | # | |
592 | # @policy: the NUMA policy (default: 'default') | |
593 | # | |
594 | # @prealloc: if true, preallocate memory (default: false) | |
595 | # | |
a937b6aa MA |
596 | # @prealloc-threads: number of CPU threads to use for prealloc |
597 | # (default: 1) | |
913d9063 | 598 | # |
a937b6aa MA |
599 | # @prealloc-context: thread context to use for creation of |
600 | # preallocation threads (default: none) (since 7.2) | |
e6816458 | 601 | # |
a937b6aa MA |
602 | # @share: if false, the memory is private to QEMU; if true, it is |
603 | # shared (default: false) | |
913d9063 | 604 | # |
9181fb70 | 605 | # @reserve: if true, reserve swap space (or huge pages) if applicable |
a937b6aa | 606 | # (default: true) (since 6.1) |
9181fb70 | 607 | # |
913d9063 KW |
608 | # @size: size of the memory region in bytes |
609 | # | |
a937b6aa MA |
610 | # @x-use-canonical-path-for-ramblock-id: if true, the canonical path |
611 | # is used for ramblock-id. Disable this for 4.0 machine types or | |
612 | # older to allow migration with newer QEMU versions. | |
613 | # (default: false generally, but true for machine types <= 4.0) | |
913d9063 | 614 | # |
a937b6aa MA |
615 | # Note: prealloc=true and reserve=false cannot be set at the same |
616 | # time. With reserve=true, the behavior depends on the operating | |
617 | # system: for example, Linux will not reserve swap space for | |
618 | # shared file mappings -- "not applicable". In contrast, | |
619 | # reserve=false will bail out if it cannot be configured | |
620 | # accordingly. | |
9181fb70 | 621 | # |
913d9063 KW |
622 | # Since: 2.1 |
623 | ## | |
624 | { 'struct': 'MemoryBackendProperties', | |
625 | 'data': { '*dump': 'bool', | |
626 | '*host-nodes': ['uint16'], | |
627 | '*merge': 'bool', | |
628 | '*policy': 'HostMemPolicy', | |
629 | '*prealloc': 'bool', | |
630 | '*prealloc-threads': 'uint32', | |
e6816458 | 631 | '*prealloc-context': 'str', |
913d9063 | 632 | '*share': 'bool', |
9181fb70 | 633 | '*reserve': 'bool', |
913d9063 KW |
634 | 'size': 'size', |
635 | '*x-use-canonical-path-for-ramblock-id': 'bool' } } | |
636 | ||
637 | ## | |
638 | # @MemoryBackendFileProperties: | |
639 | # | |
640 | # Properties for memory-backend-file objects. | |
641 | # | |
a937b6aa MA |
642 | # @align: the base address alignment when QEMU mmap(2)s @mem-path. |
643 | # Some backend stores specified by @mem-path require an alignment | |
644 | # different than the default one used by QEMU, e.g. the device DAX | |
645 | # /dev/dax0.0 requires 2M alignment rather than 4K. In such cases, | |
646 | # users can specify the required alignment via this option. 0 | |
647 | # selects a default alignment (currently the page size). | |
648 | # (default: 0) | |
913d9063 | 649 | # |
9e272073 MA |
650 | # @offset: the offset into the target file that the region starts at. |
651 | # You can use this option to back multiple regions with a single | |
652 | # file. Must be a multiple of the page size. | |
653 | # (default: 0) (since 8.1) | |
4b870dc4 | 654 | # |
a937b6aa MA |
655 | # @discard-data: if true, the file contents can be destroyed when QEMU |
656 | # exits, to avoid unnecessarily flushing data to the backing file. | |
657 | # Note that @discard-data is only an optimization, and QEMU might | |
658 | # not discard file contents if it aborts unexpectedly or is | |
659 | # terminated using SIGKILL. (default: false) | |
913d9063 | 660 | # |
a937b6aa MA |
661 | # @mem-path: the path to either a shared memory or huge page |
662 | # filesystem mount | |
913d9063 | 663 | # |
a937b6aa MA |
664 | # @pmem: specifies whether the backing file specified by @mem-path is |
665 | # in host persistent memory that can be accessed using the SNIA | |
9e272073 | 666 | # NVM programming model (e.g. Intel NVDIMM). |
913d9063 | 667 | # |
a937b6aa MA |
668 | # @readonly: if true, the backing file is opened read-only; if false, |
669 | # it is opened read-write. (default: false) | |
913d9063 | 670 | # |
e92666b0 DH |
671 | # @rom: whether to create Read Only Memory (ROM) that cannot be modified |
672 | # by the VM. Any write attempts to such ROM will be denied. Most | |
673 | # use cases want writable RAM instead of ROM. However, selected use | |
674 | # cases, like R/O NVDIMMs, can benefit from ROM. If set to 'on', | |
675 | # create ROM; if set to 'off', create writable RAM; if set to | |
676 | # 'auto', the value of the @readonly property is used. This | |
677 | # property is primarily helpful when we want to have proper RAM in | |
678 | # configurations that would traditionally create ROM before this | |
679 | # property was introduced: VM templating, where we want to open a | |
680 | # file readonly (@readonly set to true) and mark the memory to be | |
681 | # private for QEMU (@share set to false). For this use case, we need | |
682 | # writable RAM instead of ROM, and want to set this property to 'off'. | |
683 | # (default: auto, since 8.2) | |
684 | # | |
913d9063 KW |
685 | # Since: 2.1 |
686 | ## | |
687 | { 'struct': 'MemoryBackendFileProperties', | |
688 | 'base': 'MemoryBackendProperties', | |
689 | 'data': { '*align': 'size', | |
4b870dc4 | 690 | '*offset': 'size', |
913d9063 KW |
691 | '*discard-data': 'bool', |
692 | 'mem-path': 'str', | |
8a9f1e1d | 693 | '*pmem': { 'type': 'bool', 'if': 'CONFIG_LIBPMEM' }, |
e92666b0 DH |
694 | '*readonly': 'bool', |
695 | '*rom': 'OnOffAuto' } } | |
913d9063 KW |
696 | |
697 | ## | |
698 | # @MemoryBackendMemfdProperties: | |
699 | # | |
700 | # Properties for memory-backend-memfd objects. | |
701 | # | |
702 | # The @share boolean option is true by default with memfd. | |
703 | # | |
a937b6aa MA |
704 | # @hugetlb: if true, the file to be created resides in the hugetlbfs |
705 | # filesystem (default: false) | |
913d9063 | 706 | # |
a937b6aa MA |
707 | # @hugetlbsize: the hugetlb page size on systems that support multiple |
708 | # hugetlb page sizes (it must be a power of 2 value supported by | |
709 | # the system). 0 selects a default page size. This option is | |
710 | # ignored if @hugetlb is false. (default: 0) | |
913d9063 | 711 | # |
a937b6aa MA |
712 | # @seal: if true, create a sealed-file, which will block further |
713 | # resizing of the memory (default: true) | |
913d9063 KW |
714 | # |
715 | # Since: 2.12 | |
716 | ## | |
717 | { 'struct': 'MemoryBackendMemfdProperties', | |
718 | 'base': 'MemoryBackendProperties', | |
719 | 'data': { '*hugetlb': 'bool', | |
720 | '*hugetlbsize': 'size', | |
721 | '*seal': 'bool' } } | |
722 | ||
46a1d21d YZ |
723 | ## |
724 | # @MemoryBackendEpcProperties: | |
725 | # | |
726 | # Properties for memory-backend-epc objects. | |
727 | # | |
728 | # The @share boolean option is true by default with epc | |
729 | # | |
730 | # The @merge boolean option is false by default with epc | |
731 | # | |
732 | # The @dump boolean option is false by default with epc | |
733 | # | |
734 | # Since: 6.2 | |
735 | ## | |
736 | { 'struct': 'MemoryBackendEpcProperties', | |
737 | 'base': 'MemoryBackendProperties', | |
738 | 'data': {} } | |
739 | ||
b9e479d0 KW |
740 | ## |
741 | # @PrManagerHelperProperties: | |
742 | # | |
743 | # Properties for pr-manager-helper objects. | |
744 | # | |
a937b6aa MA |
745 | # @path: the path to a Unix domain socket for connecting to the |
746 | # external helper | |
b9e479d0 KW |
747 | # |
748 | # Since: 2.11 | |
749 | ## | |
750 | { 'struct': 'PrManagerHelperProperties', | |
751 | 'data': { 'path': 'str' } } | |
752 | ||
6ba7ada3 PB |
753 | ## |
754 | # @QtestProperties: | |
755 | # | |
756 | # Properties for qtest objects. | |
757 | # | |
758 | # @chardev: the chardev to be used to receive qtest commands on. | |
759 | # | |
760 | # @log: the path to a log file | |
761 | # | |
762 | # Since: 6.0 | |
763 | ## | |
764 | { 'struct': 'QtestProperties', | |
765 | 'data': { 'chardev': 'str', | |
766 | '*log': 'str' } } | |
767 | ||
17422da0 KW |
768 | ## |
769 | # @RemoteObjectProperties: | |
770 | # | |
771 | # Properties for x-remote-object objects. | |
772 | # | |
773 | # @fd: file descriptor name previously passed via 'getfd' command | |
774 | # | |
a937b6aa MA |
775 | # @devid: the id of the device to be associated with the file |
776 | # descriptor | |
17422da0 KW |
777 | # |
778 | # Since: 6.0 | |
779 | ## | |
780 | { 'struct': 'RemoteObjectProperties', | |
781 | 'data': { 'fd': 'str', 'devid': 'str' } } | |
782 | ||
8f9a9259 JR |
783 | ## |
784 | # @VfioUserServerProperties: | |
785 | # | |
786 | # Properties for x-vfio-user-server objects. | |
787 | # | |
788 | # @socket: socket to be used by the libvfio-user library | |
789 | # | |
790 | # @device: the ID of the device to be emulated at the server | |
791 | # | |
792 | # Since: 7.1 | |
793 | ## | |
794 | { 'struct': 'VfioUserServerProperties', | |
795 | 'data': { 'socket': 'SocketAddress', 'device': 'str' } } | |
796 | ||
6815bc1d KW |
797 | ## |
798 | # @RngProperties: | |
799 | # | |
800 | # Properties for objects of classes derived from rng. | |
801 | # | |
a937b6aa MA |
802 | # @opened: if true, the device is opened immediately when applying |
803 | # this option and will probably fail when processing the next | |
804 | # option. Don't use; only provided for compatibility. | |
805 | # (default: false) | |
6815bc1d KW |
806 | # |
807 | # Features: | |
a937b6aa MA |
808 | # |
809 | # @deprecated: Member @opened is deprecated. Setting true doesn't | |
810 | # make sense, and false is already the default. | |
6815bc1d KW |
811 | # |
812 | # Since: 1.3 | |
813 | ## | |
814 | { 'struct': 'RngProperties', | |
815 | 'data': { '*opened': { 'type': 'bool', 'features': ['deprecated'] } } } | |
816 | ||
817 | ## | |
818 | # @RngEgdProperties: | |
819 | # | |
820 | # Properties for rng-egd objects. | |
821 | # | |
a937b6aa MA |
822 | # @chardev: the name of a character device backend that provides the |
823 | # connection to the RNG daemon | |
6815bc1d KW |
824 | # |
825 | # Since: 1.3 | |
826 | ## | |
827 | { 'struct': 'RngEgdProperties', | |
828 | 'base': 'RngProperties', | |
829 | 'data': { 'chardev': 'str' } } | |
830 | ||
831 | ## | |
832 | # @RngRandomProperties: | |
833 | # | |
834 | # Properties for rng-random objects. | |
835 | # | |
a937b6aa MA |
836 | # @filename: the filename of the device on the host to obtain entropy |
837 | # from (default: "/dev/urandom") | |
6815bc1d KW |
838 | # |
839 | # Since: 1.3 | |
840 | ## | |
841 | { 'struct': 'RngRandomProperties', | |
842 | 'base': 'RngProperties', | |
843 | 'data': { '*filename': 'str' } } | |
844 | ||
590466f0 KW |
845 | ## |
846 | # @SevGuestProperties: | |
847 | # | |
848 | # Properties for sev-guest objects. | |
849 | # | |
850 | # @sev-device: SEV device to use (default: "/dev/sev") | |
851 | # | |
852 | # @dh-cert-file: guest owners DH certificate (encoded with base64) | |
853 | # | |
854 | # @session-file: guest owners session parameters (encoded with base64) | |
855 | # | |
856 | # @policy: SEV policy value (default: 0x1) | |
857 | # | |
858 | # @handle: SEV firmware handle (default: 0) | |
859 | # | |
860 | # @cbitpos: C-bit location in page table entry (default: 0) | |
861 | # | |
862 | # @reduced-phys-bits: number of bits in physical addresses that become | |
a937b6aa | 863 | # unavailable when SEV is enabled |
590466f0 | 864 | # |
55cdf566 | 865 | # @kernel-hashes: if true, add hashes of kernel/initrd/cmdline to a |
a937b6aa MA |
866 | # designated guest firmware page for measured boot with -kernel |
867 | # (default: false) (since 6.2) | |
55cdf566 | 868 | # |
590466f0 KW |
869 | # Since: 2.12 |
870 | ## | |
871 | { 'struct': 'SevGuestProperties', | |
872 | 'data': { '*sev-device': 'str', | |
873 | '*dh-cert-file': 'str', | |
874 | '*session-file': 'str', | |
875 | '*policy': 'uint32', | |
876 | '*handle': 'uint32', | |
877 | '*cbitpos': 'uint32', | |
55cdf566 DM |
878 | 'reduced-phys-bits': 'uint32', |
879 | '*kernel-hashes': 'bool' } } | |
590466f0 | 880 | |
e2de2c49 DH |
881 | ## |
882 | # @ThreadContextProperties: | |
883 | # | |
884 | # Properties for thread context objects. | |
885 | # | |
a937b6aa MA |
886 | # @cpu-affinity: the list of host CPU numbers used as CPU affinity for |
887 | # all threads created in the thread context (default: QEMU main | |
888 | # thread CPU affinity) | |
e2de2c49 | 889 | # |
a937b6aa MA |
890 | # @node-affinity: the list of host node numbers that will be resolved |
891 | # to a list of host CPU numbers used as CPU affinity. This is a | |
892 | # shortcut for specifying the list of host CPU numbers belonging | |
893 | # to the host nodes manually by setting @cpu-affinity. | |
894 | # (default: QEMU main thread affinity) | |
10218ae6 | 895 | # |
e2de2c49 DH |
896 | # Since: 7.2 |
897 | ## | |
898 | { 'struct': 'ThreadContextProperties', | |
10218ae6 DH |
899 | 'data': { '*cpu-affinity': ['uint16'], |
900 | '*node-affinity': ['uint16'] } } | |
e2de2c49 DH |
901 | |
902 | ||
2273b241 KW |
903 | ## |
904 | # @ObjectType: | |
905 | # | |
9fb49daa | 906 | # Features: |
a937b6aa | 907 | # |
9fb49daa MA |
908 | # @unstable: Member @x-remote-object is experimental. |
909 | # | |
2273b241 KW |
910 | # Since: 6.0 |
911 | ## | |
912 | { 'enum': 'ObjectType', | |
913 | 'data': [ | |
8825587b KW |
914 | 'authz-list', |
915 | 'authz-listfile', | |
916 | 'authz-pam', | |
917 | 'authz-simple', | |
f3189b91 | 918 | 'can-bus', |
f1279fc1 TH |
919 | { 'name': 'can-host-socketcan', |
920 | 'if': 'CONFIG_LINUX' }, | |
3d0d3c30 | 921 | 'colo-compare', |
a68d909e KW |
922 | 'cryptodev-backend', |
923 | 'cryptodev-backend-builtin', | |
39fff6f3 | 924 | 'cryptodev-backend-lkcf', |
a68d909e | 925 | { 'name': 'cryptodev-vhost-user', |
8a9f1e1d | 926 | 'if': 'CONFIG_VHOST_CRYPTO' }, |
d7ef29c4 | 927 | 'dbus-vmstate', |
1156a675 KW |
928 | 'filter-buffer', |
929 | 'filter-dump', | |
930 | 'filter-mirror', | |
931 | 'filter-redirector', | |
932 | 'filter-replay', | |
933 | 'filter-rewriter', | |
30e863e5 | 934 | 'input-barrier', |
f1279fc1 TH |
935 | { 'name': 'input-linux', |
936 | 'if': 'CONFIG_LINUX' }, | |
913d9063 | 937 | 'iothread', |
70ac26b9 | 938 | 'main-loop', |
f1279fc1 TH |
939 | { 'name': 'memory-backend-epc', |
940 | 'if': 'CONFIG_LINUX' }, | |
913d9063 KW |
941 | 'memory-backend-file', |
942 | { 'name': 'memory-backend-memfd', | |
8a9f1e1d | 943 | 'if': 'CONFIG_LINUX' }, |
6815bc1d | 944 | 'memory-backend-ram', |
a061a71e | 945 | 'pef-guest', |
f1279fc1 TH |
946 | { 'name': 'pr-manager-helper', |
947 | 'if': 'CONFIG_LINUX' }, | |
6ba7ada3 | 948 | 'qtest', |
6815bc1d KW |
949 | 'rng-builtin', |
950 | 'rng-egd', | |
f1279fc1 TH |
951 | { 'name': 'rng-random', |
952 | 'if': 'CONFIG_POSIX' }, | |
39c4c27d | 953 | 'secret', |
f1279fc1 TH |
954 | { 'name': 'secret_keyring', |
955 | 'if': 'CONFIG_SECRET_KEYRING' }, | |
a061a71e | 956 | 'sev-guest', |
e2de2c49 | 957 | 'thread-context', |
590466f0 | 958 | 's390-pv-guest', |
d09e4937 KW |
959 | 'throttle-group', |
960 | 'tls-creds-anon', | |
961 | 'tls-creds-psk', | |
962 | 'tls-creds-x509', | |
17422da0 | 963 | 'tls-cipher-suites', |
8f9a9259 JR |
964 | { 'name': 'x-remote-object', 'features': [ 'unstable' ] }, |
965 | { 'name': 'x-vfio-user-server', 'features': [ 'unstable' ] } | |
2273b241 KW |
966 | ] } |
967 | ||
968 | ## | |
969 | # @ObjectOptions: | |
970 | # | |
971 | # Describes the options of a user creatable QOM object. | |
972 | # | |
973 | # @qom-type: the class name for the object to be created | |
974 | # | |
975 | # @id: the name of the new object | |
976 | # | |
977 | # Since: 6.0 | |
978 | ## | |
979 | { 'union': 'ObjectOptions', | |
980 | 'base': { 'qom-type': 'ObjectType', | |
981 | 'id': 'str' }, | |
982 | 'discriminator': 'qom-type', | |
983 | 'data': { | |
8825587b KW |
984 | 'authz-list': 'AuthZListProperties', |
985 | 'authz-listfile': 'AuthZListFileProperties', | |
986 | 'authz-pam': 'AuthZPAMProperties', | |
987 | 'authz-simple': 'AuthZSimpleProperties', | |
f1279fc1 TH |
988 | 'can-host-socketcan': { 'type': 'CanHostSocketcanProperties', |
989 | 'if': 'CONFIG_LINUX' }, | |
3d0d3c30 | 990 | 'colo-compare': 'ColoCompareProperties', |
a68d909e KW |
991 | 'cryptodev-backend': 'CryptodevBackendProperties', |
992 | 'cryptodev-backend-builtin': 'CryptodevBackendProperties', | |
39fff6f3 | 993 | 'cryptodev-backend-lkcf': 'CryptodevBackendProperties', |
a68d909e | 994 | 'cryptodev-vhost-user': { 'type': 'CryptodevVhostUserProperties', |
8a9f1e1d | 995 | 'if': 'CONFIG_VHOST_CRYPTO' }, |
d7ef29c4 | 996 | 'dbus-vmstate': 'DBusVMStateProperties', |
1156a675 KW |
997 | 'filter-buffer': 'FilterBufferProperties', |
998 | 'filter-dump': 'FilterDumpProperties', | |
999 | 'filter-mirror': 'FilterMirrorProperties', | |
1000 | 'filter-redirector': 'FilterRedirectorProperties', | |
1001 | 'filter-replay': 'NetfilterProperties', | |
1002 | 'filter-rewriter': 'FilterRewriterProperties', | |
30e863e5 | 1003 | 'input-barrier': 'InputBarrierProperties', |
f1279fc1 TH |
1004 | 'input-linux': { 'type': 'InputLinuxProperties', |
1005 | 'if': 'CONFIG_LINUX' }, | |
913d9063 | 1006 | 'iothread': 'IothreadProperties', |
70ac26b9 | 1007 | 'main-loop': 'MainLoopProperties', |
f1279fc1 TH |
1008 | 'memory-backend-epc': { 'type': 'MemoryBackendEpcProperties', |
1009 | 'if': 'CONFIG_LINUX' }, | |
913d9063 KW |
1010 | 'memory-backend-file': 'MemoryBackendFileProperties', |
1011 | 'memory-backend-memfd': { 'type': 'MemoryBackendMemfdProperties', | |
8a9f1e1d | 1012 | 'if': 'CONFIG_LINUX' }, |
6815bc1d | 1013 | 'memory-backend-ram': 'MemoryBackendProperties', |
f1279fc1 TH |
1014 | 'pr-manager-helper': { 'type': 'PrManagerHelperProperties', |
1015 | 'if': 'CONFIG_LINUX' }, | |
6ba7ada3 | 1016 | 'qtest': 'QtestProperties', |
6815bc1d KW |
1017 | 'rng-builtin': 'RngProperties', |
1018 | 'rng-egd': 'RngEgdProperties', | |
f1279fc1 TH |
1019 | 'rng-random': { 'type': 'RngRandomProperties', |
1020 | 'if': 'CONFIG_POSIX' }, | |
39c4c27d | 1021 | 'secret': 'SecretProperties', |
f1279fc1 TH |
1022 | 'secret_keyring': { 'type': 'SecretKeyringProperties', |
1023 | 'if': 'CONFIG_SECRET_KEYRING' }, | |
a061a71e | 1024 | 'sev-guest': 'SevGuestProperties', |
e2de2c49 | 1025 | 'thread-context': 'ThreadContextProperties', |
d09e4937 KW |
1026 | 'throttle-group': 'ThrottleGroupProperties', |
1027 | 'tls-creds-anon': 'TlsCredsAnonProperties', | |
1028 | 'tls-creds-psk': 'TlsCredsPskProperties', | |
1029 | 'tls-creds-x509': 'TlsCredsX509Properties', | |
17422da0 | 1030 | 'tls-cipher-suites': 'TlsCredsProperties', |
8f9a9259 JR |
1031 | 'x-remote-object': 'RemoteObjectProperties', |
1032 | 'x-vfio-user-server': 'VfioUserServerProperties' | |
2273b241 KW |
1033 | } } |
1034 | ||
c577ff62 MA |
1035 | ## |
1036 | # @object-add: | |
1037 | # | |
1038 | # Create a QOM object. | |
1039 | # | |
a937b6aa MA |
1040 | # Returns: Nothing on success Error if @qom-type is not a valid class |
1041 | # name | |
c577ff62 MA |
1042 | # |
1043 | # Since: 2.0 | |
1044 | # | |
1045 | # Example: | |
1046 | # | |
1047 | # -> { "execute": "object-add", | |
1048 | # "arguments": { "qom-type": "rng-random", "id": "rng1", | |
5f07c4d6 | 1049 | # "filename": "/dev/hwrng" } } |
c577ff62 | 1050 | # <- { "return": {} } |
c577ff62 | 1051 | ## |
9e33013b PB |
1052 | { 'command': 'object-add', 'data': 'ObjectOptions', 'boxed': true, |
1053 | 'allow-preconfig': true } | |
c577ff62 MA |
1054 | |
1055 | ## | |
1056 | # @object-del: | |
1057 | # | |
1058 | # Remove a QOM object. | |
1059 | # | |
1060 | # @id: the name of the QOM object to remove | |
1061 | # | |
a937b6aa MA |
1062 | # Returns: Nothing on success Error if @id is not a valid id for a QOM |
1063 | # object | |
c577ff62 MA |
1064 | # |
1065 | # Since: 2.0 | |
1066 | # | |
1067 | # Example: | |
1068 | # | |
1069 | # -> { "execute": "object-del", "arguments": { "id": "rng1" } } | |
1070 | # <- { "return": {} } | |
c577ff62 | 1071 | ## |
9e33013b PB |
1072 | { 'command': 'object-del', 'data': {'id': 'str'}, |
1073 | 'allow-preconfig': true } |