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