qapi-schema.json 103.5 KB
Newer Older
1 2 3
# -*- Mode: Python -*-
#
# QAPI Schema
A
Anthony Liguori 已提交
4

5 6
# QAPI common definitions
{ 'include': 'qapi/common.json' }
7

8 9 10
# QAPI crypto definitions
{ 'include': 'qapi/crypto.json' }

11 12 13
# QAPI block definitions
{ 'include': 'qapi/block.json' }

W
Wenchao Xia 已提交
14 15 16
# QAPI event definitions
{ 'include': 'qapi/event.json' }

17 18 19
# Tracing commands
{ 'include': 'qapi/trace.json' }

20 21 22
# QAPI introspection
{ 'include': 'qapi/introspect.json' }

23
##
M
Marc-André Lureau 已提交
24
# @LostTickPolicy:
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
#
# Policy for handling lost ticks in timer devices.
#
# @discard: throw away the missed tick(s) and continue with future injection
#           normally.  Guest time may be delayed, unless the OS has explicit
#           handling of lost ticks
#
# @delay: continue to deliver ticks at the normal rate.  Guest time will be
#         delayed due to the late tick
#
# @merge: merge the missed tick(s) into one tick and inject.  Guest time
#         may be delayed, depending on how the OS reacts to the merging
#         of ticks
#
# @slew: deliver ticks at a higher rate to catch up with the missed tick. The
#        guest time should not be delayed once catchup is complete.
#
# Since: 2.0
##
{ 'enum': 'LostTickPolicy',
  'data': ['discard', 'delay', 'merge', 'slew' ] }

L
Luiz Capitulino 已提交
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
# @add_client
#
# Allow client connections for VNC, Spice and socket based
# character devices to be passed in to QEMU via SCM_RIGHTS.
#
# @protocol: protocol name. Valid names are "vnc", "spice" or the
#            name of a character device (eg. from -chardev id=XXXX)
#
# @fdname: file descriptor name previously passed via 'getfd' command
#
# @skipauth: #optional whether to skip authentication. Only applies
#            to "vnc" and "spice" protocols
#
# @tls: #optional whether to perform TLS. Only applies to the "spice"
#       protocol
#
# Returns: nothing on success.
#
# Since: 0.14.0
##
{ 'command': 'add_client',
  'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
            '*tls': 'bool' } }

A
Anthony Liguori 已提交
71 72 73 74 75 76 77 78 79
##
# @NameInfo:
#
# Guest name information.
#
# @name: #optional The name of the guest
#
# Since 0.14.0
##
80
{ 'struct': 'NameInfo', 'data': {'*name': 'str'} }
A
Anthony Liguori 已提交
81 82 83 84 85 86 87 88 89 90 91

##
# @query-name:
#
# Return the name information of a guest.
#
# Returns: @NameInfo of the guest
#
# Since 0.14.0
##
{ 'command': 'query-name', 'returns': 'NameInfo' }
L
Luiz Capitulino 已提交
92

L
Luiz Capitulino 已提交
93 94 95 96 97 98 99 100 101 102 103
##
# @KvmInfo:
#
# Information about support for KVM acceleration
#
# @enabled: true if KVM acceleration is active
#
# @present: true if KVM acceleration is built into this executable
#
# Since: 0.14.0
##
104
{ 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
L
Luiz Capitulino 已提交
105 106 107 108 109 110 111 112 113 114 115 116

##
# @query-kvm:
#
# Returns information about KVM acceleration
#
# Returns: @KvmInfo
#
# Since: 0.14.0
##
{ 'command': 'query-kvm', 'returns': 'KvmInfo' }

L
Luiz Capitulino 已提交
117 118 119
##
# @RunState
#
L
Lei Li 已提交
120
# An enumeration of VM run states.
L
Luiz Capitulino 已提交
121 122 123
#
# @debug: QEMU is running on a debugger
#
124 125
# @finish-migrate: guest is paused to finish the migration process
#
126 127 128 129 130
# @inmigrate: guest is paused waiting for an incoming migration.  Note
# that this state does not tell whether the machine will start at the
# end of the migration.  This depends on the command-line -S option and
# any invocation of 'stop' or 'cont' that has happened since QEMU was
# started.
L
Luiz Capitulino 已提交
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
#
# @internal-error: An internal error that prevents further guest execution
# has occurred
#
# @io-error: the last IOP has failed and the device is configured to pause
# on I/O errors
#
# @paused: guest has been paused via the 'stop' command
#
# @postmigrate: guest is paused following a successful 'migrate'
#
# @prelaunch: QEMU was started with -S and guest has not started
#
# @restore-vm: guest is paused to restore VM state
#
# @running: guest is actively running
#
# @save-vm: guest is paused to save the VM state
#
# @shutdown: guest is shut down (and -no-shutdown is in use)
#
152 153
# @suspended: guest is suspended (ACPI S3)
#
L
Luiz Capitulino 已提交
154
# @watchdog: the watchdog action is configured to pause and has been triggered
155 156
#
# @guest-panicked: guest has been panicked as a result of guest OS panic
L
Luiz Capitulino 已提交
157 158 159 160
##
{ 'enum': 'RunState',
  'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
            'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
161 162
            'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
            'guest-panicked' ] }
L
Luiz Capitulino 已提交
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

##
# @StatusInfo:
#
# Information about VCPU run state
#
# @running: true if all VCPUs are runnable, false if not runnable
#
# @singlestep: true if VCPUs are in single-step mode
#
# @status: the virtual machine @RunState
#
# Since:  0.14.0
#
# Notes: @singlestep is enabled through the GDB stub
##
179
{ 'struct': 'StatusInfo',
L
Luiz Capitulino 已提交
180 181 182 183 184 185 186 187 188 189 190 191 192
  'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }

##
# @query-status:
#
# Query the run status of all VCPUs
#
# Returns: @StatusInfo reflecting all VCPUs
#
# Since:  0.14.0
##
{ 'command': 'query-status', 'returns': 'StatusInfo' }

L
Luiz Capitulino 已提交
193 194 195 196 197 198 199 200 201 202 203
##
# @UuidInfo:
#
# Guest UUID information.
#
# @UUID: the UUID of the guest
#
# Since: 0.14.0
#
# Notes: If no UUID was specified for the guest, a null UUID is returned.
##
204
{ 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
L
Luiz Capitulino 已提交
205 206 207 208 209 210 211 212 213 214 215 216

##
# @query-uuid:
#
# Query the guest UUID information.
#
# Returns: The @UuidInfo for the guest
#
# Since 0.14.0
##
{ 'command': 'query-uuid', 'returns': 'UuidInfo' }

L
Luiz Capitulino 已提交
217 218 219 220 221 222 223 224 225
##
# @ChardevInfo:
#
# Information about a character device.
#
# @label: the label of the character device
#
# @filename: the filename of the character device
#
226 227 228 229
# @frontend-open: shows whether the frontend device attached to this backend
#                 (eg. with the chardev=... option) is in open or closed state
#                 (since 2.1)
#
L
Luiz Capitulino 已提交
230 231 232 233 234
# Notes: @filename is encoded using the QEMU command line character device
#        encoding.  See the QEMU man page for details.
#
# Since: 0.14.0
##
235
{ 'struct': 'ChardevInfo', 'data': {'label': 'str',
236 237
                                  'filename': 'str',
                                  'frontend-open': 'bool'} }
L
Luiz Capitulino 已提交
238 239 240 241 242 243 244 245 246 247 248

##
# @query-chardev:
#
# Returns information about current character devices.
#
# Returns: a list of @ChardevInfo
#
# Since: 0.14.0
##
{ 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
L
Luiz Capitulino 已提交
249

250 251 252 253 254 255 256 257 258
##
# @ChardevBackendInfo:
#
# Information about a character device backend
#
# @name: The backend name
#
# Since: 2.0
##
259
{ 'struct': 'ChardevBackendInfo', 'data': {'name': 'str'} }
260 261 262 263 264 265 266 267 268 269 270 271

##
# @query-chardev-backends:
#
# Returns information about character device backends.
#
# Returns: a list of @ChardevBackendInfo
#
# Since: 2.0
##
{ 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }

272 273 274 275 276
##
# @DataFormat:
#
# An enumeration of data format.
#
277
# @utf8: Data is a UTF-8 string (RFC 3629)
278
#
279
# @base64: Data is Base64 encoded binary (RFC 3548)
280 281 282
#
# Since: 1.4
##
A
Amos Kong 已提交
283
{ 'enum': 'DataFormat',
284 285 286
  'data': [ 'utf8', 'base64' ] }

##
287
# @ringbuf-write:
288
#
289
# Write to a ring buffer character device.
290
#
291
# @device: the ring buffer character device name
292
#
293
# @data: data to write
294
#
295 296 297 298 299 300
# @format: #optional data encoding (default 'utf8').
#          - base64: data must be base64 encoded text.  Its binary
#            decoding gets written.
#          - utf8: data's UTF-8 encoding is written
#          - data itself is always Unicode regardless of format, like
#            any other string.
301 302 303 304 305
#
# Returns: Nothing on success
#
# Since: 1.4
##
306
{ 'command': 'ringbuf-write',
307
  'data': {'device': 'str', 'data': 'str',
308 309
           '*format': 'DataFormat'} }

310
##
311
# @ringbuf-read:
312
#
313
# Read from a ring buffer character device.
314
#
315
# @device: the ring buffer character device name
316
#
317
# @size: how many bytes to read at most
318
#
319 320 321 322 323 324 325 326 327
# @format: #optional data encoding (default 'utf8').
#          - base64: the data read is returned in base64 encoding.
#          - utf8: the data read is interpreted as UTF-8.
#            Bug: can screw up when the buffer contains invalid UTF-8
#            sequences, NUL characters, after the ring buffer lost
#            data, and when reading stops because the size limit is
#            reached.
#          - The return value is always Unicode regardless of format,
#            like any other string.
328
#
329
# Returns: data read from the device
330 331 332
#
# Since: 1.4
##
333
{ 'command': 'ringbuf-read',
334
  'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
335
  'returns': 'str' }
336

337 338 339 340 341 342 343 344 345
##
# @EventInfo:
#
# Information about a QMP event
#
# @name: The event name
#
# Since: 1.2.0
##
346
{ 'struct': 'EventInfo', 'data': {'name': 'str'} }
347 348 349 350 351 352 353 354 355 356 357 358

##
# @query-events:
#
# Return a list of supported QMP events by this server
#
# Returns: A list of @EventInfo for all supported events
#
# Since: 1.2.0
##
{ 'command': 'query-events', 'returns': ['EventInfo'] }

L
Luiz Capitulino 已提交
359 360 361 362 363 364 365 366 367 368 369
##
# @MigrationStats
#
# Detailed migration status.
#
# @transferred: amount of bytes already transferred to the target VM
#
# @remaining: amount of bytes remaining to be transferred to the target VM
#
# @total: total amount of bytes involved in the migration process
#
370 371 372
# @duplicate: number of duplicate (zero) pages (since 1.2)
#
# @skipped: number of skipped zero pages (since 1.5)
373 374 375
#
# @normal : number of normal pages (since 1.2)
#
376 377 378 379
# @normal-bytes: number of normal bytes sent (since 1.2)
#
# @dirty-pages-rate: number of pages dirtied by second by the
#        guest (since 1.3)
380
#
381 382
# @mbps: throughput in megabits/sec. (since 1.6)
#
383 384
# @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
#
385
# Since: 0.14.0
L
Luiz Capitulino 已提交
386
##
387
{ 'struct': 'MigrationStats',
J
Juan Quintela 已提交
388
  'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
389
           'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
390
           'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
391
           'mbps' : 'number', 'dirty-sync-count' : 'int' } }
L
Luiz Capitulino 已提交
392

O
Orit Wasserman 已提交
393 394 395 396 397 398 399 400 401 402 403 404 405
##
# @XBZRLECacheStats
#
# Detailed XBZRLE migration cache statistics
#
# @cache-size: XBZRLE cache size
#
# @bytes: amount of bytes already transferred to the target VM
#
# @pages: amount of pages transferred to the target VM
#
# @cache-miss: number of cache miss
#
406 407
# @cache-miss-rate: rate of cache miss (since 2.1)
#
O
Orit Wasserman 已提交
408 409 410 411
# @overflow: number of overflows
#
# Since: 1.2
##
412
{ 'struct': 'XBZRLECacheStats',
O
Orit Wasserman 已提交
413
  'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
414 415
           'cache-miss': 'int', 'cache-miss-rate': 'number',
           'overflow': 'int' } }
O
Orit Wasserman 已提交
416

417 418 419 420 421 422 423 424 425 426 427 428 429 430
# @MigrationStatus:
#
# An enumeration of migration status.
#
# @none: no migration has ever happened.
#
# @setup: migration process has been initiated.
#
# @cancelling: in the process of cancelling migration.
#
# @cancelled: cancelling migration is finished.
#
# @active: in the process of doing migration.
#
431 432
# @postcopy-active: like active, but now in postcopy mode. (since 2.5)
#
433 434 435 436 437 438 439 440 441
# @completed: migration is finished.
#
# @failed: some error occurred during migration process.
#
# Since: 2.3
#
##
{ 'enum': 'MigrationStatus',
  'data': [ 'none', 'setup', 'cancelling', 'cancelled',
442
            'active', 'postcopy-active', 'completed', 'failed' ] }
443

L
Luiz Capitulino 已提交
444 445 446 447 448
##
# @MigrationInfo
#
# Information about current migration process.
#
449 450
# @status: #optional @MigrationStatus describing the current migration status.
#          If this field is not returned, no migration process
L
Luiz Capitulino 已提交
451 452
#          has been initiated
#
J
Juan Quintela 已提交
453 454
# @ram: #optional @MigrationStats containing detailed migration
#       status, only returned if status is 'active' or
455
#       'completed'(since 1.2)
L
Luiz Capitulino 已提交
456 457 458 459 460
#
# @disk: #optional @MigrationStats containing detailed disk migration
#        status, only returned if status is 'active' and it is a block
#        migration
#
O
Orit Wasserman 已提交
461 462 463 464
# @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
#                migration statistics, only returned if XBZRLE feature is on and
#                status is 'active' or 'completed' (since 1.2)
#
465 466 467 468
# @total-time: #optional total amount of milliseconds since migration started.
#        If migration has ended, it returns the total migration
#        time. (since 1.2)
#
469 470 471 472
# @downtime: #optional only present when migration finishes correctly
#        total downtime in milliseconds for the guest.
#        (since 1.3)
#
473 474 475 476
# @expected-downtime: #optional only present while migration is active
#        expected downtime in milliseconds for the guest in last walk
#        of the dirty bitmap. (since 1.3)
#
477 478 479 480 481 482
# @setup-time: #optional amount of setup time in milliseconds _before_ the
#        iterations begin but _after_ the QMP command is issued. This is designed
#        to provide an accounting of any activities (such as RDMA pinning) which
#        may be expensive, but do not actually occur during the iterative
#        migration rounds themselves. (since 1.6)
#
483 484 485 486
# @x-cpu-throttle-percentage: #optional percentage of time guest cpus are being
#       throttled during auto-converge. This is only present when auto-converge
#       has started throttling guest cpus. (Since 2.5)
#
L
Luiz Capitulino 已提交
487 488
# Since: 0.14.0
##
489
{ 'struct': 'MigrationInfo',
490
  'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
O
Orit Wasserman 已提交
491
           '*disk': 'MigrationStats',
492
           '*xbzrle-cache': 'XBZRLECacheStats',
493
           '*total-time': 'int',
494
           '*expected-downtime': 'int',
495
           '*downtime': 'int',
496 497
           '*setup-time': 'int',
           '*x-cpu-throttle-percentage': 'int'} }
L
Luiz Capitulino 已提交
498 499 500 501 502 503 504 505 506 507 508 509

##
# @query-migrate
#
# Returns information about current migration process.
#
# Returns: @MigrationInfo
#
# Since: 0.14.0
##
{ 'command': 'query-migrate', 'returns': 'MigrationInfo' }

O
Orit Wasserman 已提交
510 511 512 513 514 515 516 517 518
##
# @MigrationCapability
#
# Migration capabilities enumeration
#
# @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
#          This feature allows us to minimize migration traffic for certain work
#          loads, by sending compressed difference of the pages
#
519
# @rdma-pin-all: Controls whether or not the entire VM memory footprint is
520
#          mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
521
#          Disabled by default. (since 2.0)
522
#
523 524 525 526 527 528
# @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
#          essentially saves 1MB of zeroes per block on the wire. Enabling requires
#          source and target VM to support this feature. To enable it is sufficient
#          to enable the capability on the source VM. The feature is disabled by
#          default. (since 1.6)
#
529 530 531 532 533 534 535 536
# @compress: Use multiple compression threads to accelerate live migration.
#          This feature can help to reduce the migration traffic, by sending
#          compressed pages. Please note that if compress and xbzrle are both
#          on, compress only takes effect in the ram bulk stage, after that,
#          it will be disabled and only xbzrle takes effect, this can help to
#          minimize migration traffic. The feature is disabled by default.
#          (since 2.4 )
#
537 538 539
# @events: generate events for each migration state change
#          (since 2.4 )
#
540 541 542
# @auto-converge: If enabled, QEMU will automatically throttle down the guest
#          to speed up convergence of RAM migration. (since 1.6)
#
D
Dr. David Alan Gilbert 已提交
543
# @postcopy-ram: Start executing on the migration target before all of RAM has
544
#          been migrated, pulling the remaining pages along as needed. NOTE: If
D
Dr. David Alan Gilbert 已提交
545
#          the migration fails during postcopy the VM will fail.  (since 2.6)
546
#
O
Orit Wasserman 已提交
547 548 549
# Since: 1.2
##
{ 'enum': 'MigrationCapability',
550
  'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
D
Dr. David Alan Gilbert 已提交
551
           'compress', 'events', 'postcopy-ram'] }
O
Orit Wasserman 已提交
552 553 554 555 556 557 558 559 560 561 562 563

##
# @MigrationCapabilityStatus
#
# Migration capability information
#
# @capability: capability enum
#
# @state: capability state bool
#
# Since: 1.2
##
564
{ 'struct': 'MigrationCapabilityStatus',
O
Orit Wasserman 已提交
565 566 567
  'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }

##
O
Orit Wasserman 已提交
568 569 570 571 572 573 574 575 576 577 578 579
# @migrate-set-capabilities
#
# Enable/Disable the following migration capabilities (like xbzrle)
#
# @capabilities: json array of capability modifications to make
#
# Since: 1.2
##
{ 'command': 'migrate-set-capabilities',
  'data': { 'capabilities': ['MigrationCapabilityStatus'] } }

##
O
Orit Wasserman 已提交
580 581 582 583 584 585 586 587 588 589
# @query-migrate-capabilities
#
# Returns information about the current migration capabilities status
#
# Returns: @MigrationCapabilitiesStatus
#
# Since: 1.2
##
{ 'command': 'query-migrate-capabilities', 'returns':   ['MigrationCapabilityStatus']}

590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
# @MigrationParameter
#
# Migration parameters enumeration
#
# @compress-level: Set the compression level to be used in live migration,
#          the compression level is an integer between 0 and 9, where 0 means
#          no compression, 1 means the best compression speed, and 9 means best
#          compression ratio which will consume more CPU.
#
# @compress-threads: Set compression thread count to be used in live migration,
#          the compression thread count is an integer between 1 and 255.
#
# @decompress-threads: Set decompression thread count to be used in live
#          migration, the decompression thread count is an integer between 1
#          and 255. Usually, decompression is at least 4 times as fast as
#          compression, so set the decompress-threads to the number about 1/4
#          of compress-threads is adequate.
#
608 609 610 611 612 613 614
# @x-cpu-throttle-initial: Initial percentage of time guest cpus are throttled
#                          when migration auto-converge is activated. The
#                          default value is 20. (Since 2.5)
#
# @x-cpu-throttle-increment: throttle percentage increase each time
#                            auto-converge detects that migration is not making
#                            progress. The default value is 10. (Since 2.5)
615 616 617
# Since: 2.4
##
{ 'enum': 'MigrationParameter',
618 619
  'data': ['compress-level', 'compress-threads', 'decompress-threads',
           'x-cpu-throttle-initial', 'x-cpu-throttle-increment'] }
620

621 622 623 624 625 626 627 628 629 630 631
#
# @migrate-set-parameters
#
# Set the following migration parameters
#
# @compress-level: compression level
#
# @compress-threads: compression thread count
#
# @decompress-threads: decompression thread count
#
632 633 634 635 636 637 638
# @x-cpu-throttle-initial: Initial percentage of time guest cpus are throttled
#                          when migration auto-converge is activated. The
#                          default value is 20. (Since 2.5)
#
# @x-cpu-throttle-increment: throttle percentage increase each time
#                            auto-converge detects that migration is not making
#                            progress. The default value is 10. (Since 2.5)
639 640 641 642 643
# Since: 2.4
##
{ 'command': 'migrate-set-parameters',
  'data': { '*compress-level': 'int',
            '*compress-threads': 'int',
644 645 646
            '*decompress-threads': 'int',
            '*x-cpu-throttle-initial': 'int',
            '*x-cpu-throttle-increment': 'int'} }
647 648 649 650 651 652 653 654 655 656

#
# @MigrationParameters
#
# @compress-level: compression level
#
# @compress-threads: compression thread count
#
# @decompress-threads: decompression thread count
#
657 658 659 660 661 662 663 664
# @x-cpu-throttle-initial: Initial percentage of time guest cpus are throttled
#                          when migration auto-converge is activated. The
#                          default value is 20. (Since 2.5)
#
# @x-cpu-throttle-increment: throttle percentage increase each time
#                            auto-converge detects that migration is not making
#                            progress. The default value is 10. (Since 2.5)
#
665 666 667 668 669
# Since: 2.4
##
{ 'struct': 'MigrationParameters',
  'data': { 'compress-level': 'int',
            'compress-threads': 'int',
670 671 672
            'decompress-threads': 'int',
            'x-cpu-throttle-initial': 'int',
            'x-cpu-throttle-increment': 'int'} }
673 674 675 676 677 678 679 680 681 682 683 684
##
# @query-migrate-parameters
#
# Returns information about the current migration parameters
#
# Returns: @MigrationParameters
#
# Since: 2.4
##
{ 'command': 'query-migrate-parameters',
  'returns': 'MigrationParameters' }

685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
##
# @client_migrate_info
#
# Set migration information for remote display.  This makes the server
# ask the client to automatically reconnect using the new parameters
# once migration finished successfully.  Only implemented for SPICE.
#
# @protocol:     must be "spice"
# @hostname:     migration target hostname
# @port:         #optional spice tcp port for plaintext channels
# @tls-port:     #optional spice tcp port for tls-secured channels
# @cert-subject: #optional server certificate subject
#
# Since: 0.14.0
##
{ 'command': 'client_migrate_info',
  'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
            '*tls-port': 'int', '*cert-subject': 'str' } }

704 705 706
##
# @migrate-start-postcopy
#
707
# Followup to a migration command to switch the migration to postcopy mode.
D
Dr. David Alan Gilbert 已提交
708
# The postcopy-ram capability must be set before the original migration
709
# command.
710 711 712 713
#
# Since: 2.5
{ 'command': 'migrate-start-postcopy' }

L
Luiz Capitulino 已提交
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
##
# @MouseInfo:
#
# Information about a mouse device.
#
# @name: the name of the mouse device
#
# @index: the index of the mouse device
#
# @current: true if this device is currently receiving mouse events
#
# @absolute: true if this device supports absolute coordinates as input
#
# Since: 0.14.0
##
729
{ 'struct': 'MouseInfo',
L
Luiz Capitulino 已提交
730 731 732 733 734 735 736 737 738 739 740 741 742 743
  'data': {'name': 'str', 'index': 'int', 'current': 'bool',
           'absolute': 'bool'} }

##
# @query-mice:
#
# Returns information about each active mouse device
#
# Returns: a list of @MouseInfo for each device
#
# Since: 0.14.0
##
{ 'command': 'query-mice', 'returns': ['MouseInfo'] }

L
Luiz Capitulino 已提交
744
##
E
Eric Blake 已提交
745
# @CpuInfoArch:
L
Luiz Capitulino 已提交
746
#
E
Eric Blake 已提交
747 748 749 750 751 752 753 754 755 756 757 758
# An enumeration of cpu types that enable additional information during
# @query-cpus.
#
# Since: 2.6
##
{ 'enum': 'CpuInfoArch',
  'data': ['x86', 'sparc', 'ppc', 'mips', 'tricore', 'other' ] }

##
# @CpuInfoBase:
#
# Common information about a virtual CPU
L
Luiz Capitulino 已提交
759 760 761
#
# @CPU: the index of the virtual CPU
#
E
Eric Blake 已提交
762
# @current: this only exists for backwards compatibility and should be ignored
763
#
L
Luiz Capitulino 已提交
764 765 766
# @halted: true if the virtual CPU is in the halt state.  Halt usually refers
#          to a processor specific low power mode.
#
767 768
# @qom_path: path to the CPU object in the QOM tree (since 2.4)
#
L
Luiz Capitulino 已提交
769 770
# @thread_id: ID of the underlying host thread
#
E
Eric Blake 已提交
771 772 773
# @arch: architecture of the cpu, which determines which additional fields
#        will be listed (since 2.6)
#
L
Luiz Capitulino 已提交
774 775 776 777 778
# Since: 0.14.0
#
# Notes: @halted is a transient state that changes frequently.  By the time the
#        data is sent to the client, the guest may no longer be halted.
##
E
Eric Blake 已提交
779
{ 'struct': 'CpuInfoBase',
780
  'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
E
Eric Blake 已提交
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
           'qom_path': 'str', 'thread_id': 'int', 'arch': 'CpuInfoArch' } }

##
# @CpuInfo:
#
# Information about a virtual CPU
#
# Since: 0.14.0
##
{ 'union': 'CpuInfo', 'base': 'CpuInfoBase', 'discriminator': 'arch',
  'data': { 'x86': 'CpuInfoX86',
            'sparc': 'CpuInfoSPARC',
            'ppc': 'CpuInfoPPC',
            'mips': 'CpuInfoMIPS',
            'tricore': 'CpuInfoTricore',
            'other': 'CpuInfoOther' } }

##
# @CpuInfoX86:
#
# Additional information about a virtual i386 or x86_64 CPU
#
# @pc: the 64-bit instruction pointer
#
# Since 2.6
##
{ 'struct': 'CpuInfoX86', 'data': { 'pc': 'int' } }

##
# @CpuInfoSPARC:
#
# Additional information about a virtual SPARC CPU
#
# @pc: the PC component of the instruction pointer
#
# @npc: the NPC component of the instruction pointer
#
# Since 2.6
##
{ 'struct': 'CpuInfoSPARC', 'data': { 'pc': 'int', 'npc': 'int' } }

##
# @CpuInfoPPC:
#
# Additional information about a virtual PPC CPU
#
# @nip: the instruction pointer
#
# Since 2.6
##
{ 'struct': 'CpuInfoPPC', 'data': { 'nip': 'int' } }

##
# @CpuInfoMIPS:
#
# Additional information about a virtual MIPS CPU
#
# @PC: the instruction pointer
#
# Since 2.6
##
{ 'struct': 'CpuInfoMIPS', 'data': { 'PC': 'int' } }

##
# @CpuInfoTricore:
#
# Additional information about a virtual Tricore CPU
#
# @PC: the instruction pointer
#
# Since 2.6
##
{ 'struct': 'CpuInfoTricore', 'data': { 'PC': 'int' } }

##
# @CpuInfoOther:
#
# No additional information is available about the virtual CPU
#
# Since 2.6
#
##
{ 'struct': 'CpuInfoOther', 'data': { } }
L
Luiz Capitulino 已提交
864 865 866 867 868 869 870 871 872 873 874 875

##
# @query-cpus:
#
# Returns a list of information about each virtual CPU.
#
# Returns: a list of @CpuInfo for each virtual CPU
#
# Since: 0.14.0
##
{ 'command': 'query-cpus', 'returns': ['CpuInfo'] }

876 877 878 879 880 881 882 883 884 885 886
##
# @IOThreadInfo:
#
# Information about an iothread
#
# @id: the identifier of the iothread
#
# @thread-id: ID of the underlying host thread
#
# Since: 2.0
##
887
{ 'struct': 'IOThreadInfo',
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
  'data': {'id': 'str', 'thread-id': 'int'} }

##
# @query-iothreads:
#
# Returns a list of information about each iothread.
#
# Note this list excludes the QEMU main loop thread, which is not declared
# using the -object iothread command-line option.  It is always the main thread
# of the process.
#
# Returns: a list of @IOThreadInfo for each iothread
#
# Since: 2.0
##
{ 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }

L
Luiz Capitulino 已提交
905
##
W
Wenchao Xia 已提交
906
# @NetworkAddressFamily
L
Luiz Capitulino 已提交
907
#
W
Wenchao Xia 已提交
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
# The network address family
#
# @ipv4: IPV4 family
#
# @ipv6: IPV6 family
#
# @unix: unix socket
#
# @unknown: otherwise
#
# Since: 2.1
##
{ 'enum': 'NetworkAddressFamily',
  'data': [ 'ipv4', 'ipv6', 'unix', 'unknown' ] }

##
# @VncBasicInfo
L
Luiz Capitulino 已提交
925
#
W
Wenchao Xia 已提交
926
# The basic information for vnc network connection
L
Luiz Capitulino 已提交
927
#
W
Wenchao Xia 已提交
928
# @host: IP address
L
Luiz Capitulino 已提交
929
#
W
Wenchao Xia 已提交
930 931 932
# @service: The service name of the vnc port. This may depend on the host
#           system's service database so symbolic names should not be relied
#           on.
W
Wenchao Xia 已提交
933 934 935
#
# @family: address family
#
G
Gerd Hoffmann 已提交
936 937
# @websocket: true in case the socket is a websocket (since 2.3).
#
W
Wenchao Xia 已提交
938 939
# Since: 2.1
##
940
{ 'struct': 'VncBasicInfo',
W
Wenchao Xia 已提交
941 942
  'data': { 'host': 'str',
            'service': 'str',
G
Gerd Hoffmann 已提交
943 944
            'family': 'NetworkAddressFamily',
            'websocket': 'bool' } }
W
Wenchao Xia 已提交
945 946 947

##
# @VncServerInfo
L
Luiz Capitulino 已提交
948
#
W
Wenchao Xia 已提交
949
# The network connection information for server
L
Luiz Capitulino 已提交
950
#
W
Wenchao Xia 已提交
951
# @auth: #optional, authentication method
L
Luiz Capitulino 已提交
952
#
W
Wenchao Xia 已提交
953 954
# Since: 2.1
##
955
{ 'struct': 'VncServerInfo',
W
Wenchao Xia 已提交
956 957 958 959 960 961 962
  'base': 'VncBasicInfo',
  'data': { '*auth': 'str' } }

##
# @VncClientInfo:
#
# Information about a connected VNC client.
L
Luiz Capitulino 已提交
963 964 965 966 967 968 969 970 971
#
# @x509_dname: #optional If x509 authentication is in use, the Distinguished
#              Name of the client.
#
# @sasl_username: #optional If SASL authentication is in use, the SASL username
#                 used for authentication.
#
# Since: 0.14.0
##
972
{ 'struct': 'VncClientInfo',
W
Wenchao Xia 已提交
973
  'base': 'VncBasicInfo',
W
Wenchao Xia 已提交
974
  'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
L
Luiz Capitulino 已提交
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011

##
# @VncInfo:
#
# Information about the VNC session.
#
# @enabled: true if the VNC server is enabled, false otherwise
#
# @host: #optional The hostname the VNC server is bound to.  This depends on
#        the name resolution on the host and may be an IP address.
#
# @family: #optional 'ipv6' if the host is listening for IPv6 connections
#                    'ipv4' if the host is listening for IPv4 connections
#                    'unix' if the host is listening on a unix domain socket
#                    'unknown' otherwise
#
# @service: #optional The service name of the server's port.  This may depends
#           on the host system's service database so symbolic names should not
#           be relied on.
#
# @auth: #optional the current authentication type used by the server
#        'none' if no authentication is being used
#        'vnc' if VNC authentication is being used
#        'vencrypt+plain' if VEncrypt is used with plain text authentication
#        'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
#        'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
#        'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
#        'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
#        'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
#        'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
#        'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
#        'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
#
# @clients: a list of @VncClientInfo of all currently connected clients
#
# Since: 0.14.0
##
1012
{ 'struct': 'VncInfo',
W
Wenchao Xia 已提交
1013 1014
  'data': {'enabled': 'bool', '*host': 'str',
           '*family': 'NetworkAddressFamily',
L
Luiz Capitulino 已提交
1015 1016
           '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }

1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
##
# @VncPriAuth:
#
# vnc primary authentication method.
#
# Since: 2.3
##
{ 'enum': 'VncPrimaryAuth',
  'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
            'tls', 'vencrypt', 'sasl' ] }

##
# @VncVencryptSubAuth:
#
# vnc sub authentication method with vencrypt.
#
# Since: 2.3
##
{ 'enum': 'VncVencryptSubAuth',
  'data': [ 'plain',
            'tls-none',  'x509-none',
            'tls-vnc',   'x509-vnc',
            'tls-plain', 'x509-plain',
            'tls-sasl',  'x509-sasl' ] }

##
# @VncInfo2:
#
# Information about a vnc server
#
# @id: vnc server name.
#
# @server: A list of @VncBasincInfo describing all listening sockets.
#          The list can be empty (in case the vnc server is disabled).
#          It also may have multiple entries: normal + websocket,
#          possibly also ipv4 + ipv6 in the future.
#
# @clients: A list of @VncClientInfo of all currently connected clients.
#           The list can be empty, for obvious reasons.
#
# @auth: The current authentication type used by the server
#
# @vencrypt: #optional The vencrypt sub authentication type used by the server,
#            only specified in case auth == vencrypt.
#
# @display: #optional The display device the vnc server is linked to.
#
# Since: 2.3
##
1066
{ 'struct': 'VncInfo2',
1067 1068 1069 1070 1071 1072 1073
  'data': { 'id'        : 'str',
            'server'    : ['VncBasicInfo'],
            'clients'   : ['VncClientInfo'],
            'auth'      : 'VncPrimaryAuth',
            '*vencrypt' : 'VncVencryptSubAuth',
            '*display'  : 'str' } }

L
Luiz Capitulino 已提交
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
##
# @query-vnc:
#
# Returns information about the current VNC server
#
# Returns: @VncInfo
#
# Since: 0.14.0
##
{ 'command': 'query-vnc', 'returns': 'VncInfo' }

1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
##
# @query-vnc-servers:
#
# Returns a list of vnc servers.  The list can be empty.
#
# Returns: a list of @VncInfo2
#
# Since: 2.3
##
{ 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }

L
Luiz Capitulino 已提交
1096
##
W
Wenchao Xia 已提交
1097
# @SpiceBasicInfo
L
Luiz Capitulino 已提交
1098
#
W
Wenchao Xia 已提交
1099 1100 1101
# The basic information for SPICE network connection
#
# @host: IP address
L
Luiz Capitulino 已提交
1102
#
W
Wenchao Xia 已提交
1103
# @port: port number
L
Luiz Capitulino 已提交
1104
#
W
Wenchao Xia 已提交
1105
# @family: address family
L
Luiz Capitulino 已提交
1106
#
W
Wenchao Xia 已提交
1107 1108
# Since: 2.1
##
1109
{ 'struct': 'SpiceBasicInfo',
W
Wenchao Xia 已提交
1110 1111 1112 1113 1114 1115
  'data': { 'host': 'str',
            'port': 'str',
            'family': 'NetworkAddressFamily' } }

##
# @SpiceServerInfo
L
Luiz Capitulino 已提交
1116
#
W
Wenchao Xia 已提交
1117
# Information about a SPICE server
L
Luiz Capitulino 已提交
1118
#
W
Wenchao Xia 已提交
1119
# @auth: #optional, authentication method
L
Luiz Capitulino 已提交
1120
#
W
Wenchao Xia 已提交
1121 1122
# Since: 2.1
##
1123
{ 'struct': 'SpiceServerInfo',
W
Wenchao Xia 已提交
1124 1125 1126 1127 1128 1129 1130
  'base': 'SpiceBasicInfo',
  'data': { '*auth': 'str' } }

##
# @SpiceChannel
#
# Information about a SPICE client channel.
L
Luiz Capitulino 已提交
1131 1132 1133 1134
#
# @connection-id: SPICE connection id number.  All channels with the same id
#                 belong to the same SPICE session.
#
1135 1136 1137
# @channel-type: SPICE channel type number.  "1" is the main control
#                channel, filter for this one if you want to track spice
#                sessions only
L
Luiz Capitulino 已提交
1138
#
1139 1140
# @channel-id: SPICE channel ID number.  Usually "0", might be different when
#              multiple channels of the same type exist, such as multiple
L
Luiz Capitulino 已提交
1141 1142 1143 1144 1145 1146
#              display channels in a multihead setup
#
# @tls: true if the channel is encrypted, false otherwise.
#
# Since: 0.14.0
##
1147
{ 'struct': 'SpiceChannel',
W
Wenchao Xia 已提交
1148 1149
  'base': 'SpiceBasicInfo',
  'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
L
Luiz Capitulino 已提交
1150 1151
           'tls': 'bool'} }

A
Alon Levy 已提交
1152 1153 1154
##
# @SpiceQueryMouseMode
#
L
Lei Li 已提交
1155
# An enumeration of Spice mouse states.
A
Alon Levy 已提交
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
#
# @client: Mouse cursor position is determined by the client.
#
# @server: Mouse cursor position is determined by the server.
#
# @unknown: No information is available about mouse mode used by
#           the spice server.
#
# Note: spice/enums.h has a SpiceMouseMode already, hence the name.
#
# Since: 1.1
##
{ 'enum': 'SpiceQueryMouseMode',
  'data': [ 'client', 'server', 'unknown' ] }

L
Luiz Capitulino 已提交
1171 1172 1173 1174
##
# @SpiceInfo
#
# Information about the SPICE session.
1175
#
L
Luiz Capitulino 已提交
1176 1177
# @enabled: true if the SPICE server is enabled, false otherwise
#
1178 1179 1180
# @migrated: true if the last guest migration completed and spice
#            migration had completed as well. false otherwise.
#
L
Luiz Capitulino 已提交
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
# @host: #optional The hostname the SPICE server is bound to.  This depends on
#        the name resolution on the host and may be an IP address.
#
# @port: #optional The SPICE server's port number.
#
# @compiled-version: #optional SPICE server version.
#
# @tls-port: #optional The SPICE server's TLS port number.
#
# @auth: #optional the current authentication type used by the server
1191 1192 1193
#        'none'  if no authentication is being used
#        'spice' uses SASL or direct TLS authentication, depending on command
#                line options
L
Luiz Capitulino 已提交
1194
#
A
Alon Levy 已提交
1195 1196 1197 1198 1199 1200
# @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
#              be determined by the client or the server, or unknown if spice
#              server doesn't provide this information.
#
#              Since: 1.1
#
L
Luiz Capitulino 已提交
1201 1202 1203 1204
# @channels: a list of @SpiceChannel for each active spice channel
#
# Since: 0.14.0
##
1205
{ 'struct': 'SpiceInfo',
1206
  'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
L
Luiz Capitulino 已提交
1207
           '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
A
Alon Levy 已提交
1208
           'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
L
Luiz Capitulino 已提交
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220

##
# @query-spice
#
# Returns information about the current SPICE server
#
# Returns: @SpiceInfo
#
# Since: 0.14.0
##
{ 'command': 'query-spice', 'returns': 'SpiceInfo' }

L
Luiz Capitulino 已提交
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
##
# @BalloonInfo:
#
# Information about the guest balloon device.
#
# @actual: the number of bytes the balloon currently contains
#
# Since: 0.14.0
#
##
1231
{ 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
L
Luiz Capitulino 已提交
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246

##
# @query-balloon:
#
# Return information about the balloon device.
#
# Returns: @BalloonInfo on success
#          If the balloon driver is enabled but not functional because the KVM
#          kernel module cannot support it, KvmMissingCap
#          If no balloon device is present, DeviceNotActive
#
# Since: 0.14.0
##
{ 'command': 'query-balloon', 'returns': 'BalloonInfo' }

L
Luiz Capitulino 已提交
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
##
# @PciMemoryRange:
#
# A PCI device memory region
#
# @base: the starting address (guest physical)
#
# @limit: the ending address (guest physical)
#
# Since: 0.14.0
##
1258
{ 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
L
Luiz Capitulino 已提交
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275

##
# @PciMemoryRegion
#
# Information about a PCI device I/O region.
#
# @bar: the index of the Base Address Register for this region
#
# @type: 'io' if the region is a PIO region
#        'memory' if the region is a MMIO region
#
# @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
#
# @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
#
# Since: 0.14.0
##
1276
{ 'struct': 'PciMemoryRegion',
L
Luiz Capitulino 已提交
1277 1278 1279 1280
  'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
           '*prefetch': 'bool', '*mem_type_64': 'bool' } }

##
1281
# @PciBusInfo:
L
Luiz Capitulino 已提交
1282
#
1283
# Information about a bus of a PCI Bridge device
L
Luiz Capitulino 已提交
1284
#
1285 1286
# @number: primary bus interface number.  This should be the number of the
#          bus the device resides on.
L
Luiz Capitulino 已提交
1287
#
1288 1289
# @secondary: secondary bus interface number.  This is the number of the
#             main bus for the bridge
L
Luiz Capitulino 已提交
1290
#
1291 1292
# @subordinate: This is the highest number bus that resides below the
#               bridge.
L
Luiz Capitulino 已提交
1293
#
1294
# @io_range: The PIO range for all devices on this bridge
L
Luiz Capitulino 已提交
1295
#
1296
# @memory_range: The MMIO range for all devices on this bridge
L
Luiz Capitulino 已提交
1297
#
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
# @prefetchable_range: The range of prefetchable MMIO for all devices on
#                      this bridge
#
# Since: 2.4
##
{ 'struct': 'PciBusInfo',
  'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
           'io_range': 'PciMemoryRange',
           'memory_range': 'PciMemoryRange',
           'prefetchable_range': 'PciMemoryRange' } }

##
# @PciBridgeInfo:
#
# Information about a PCI Bridge device
#
# @bus: information about the bus the device resides on
L
Luiz Capitulino 已提交
1315 1316 1317 1318 1319
#
# @devices: a list of @PciDeviceInfo for each device on this bridge
#
# Since: 0.14.0
##
1320
{ 'struct': 'PciBridgeInfo',
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
  'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }

##
# @PciDeviceClass:
#
# Information about the Class of a PCI device
#
# @desc: #optional a string description of the device's class
#
# @class: the class code of the device
#
# Since: 2.4
##
{ 'struct': 'PciDeviceClass',
  'data': {'*desc': 'str', 'class': 'int'} }

##
# @PciDeviceId:
#
# Information about the Id of a PCI device
#
# @device: the PCI device id
#
# @vendor: the PCI vendor id
#
# Since: 2.4
##
{ 'struct': 'PciDeviceId',
  'data': {'device': 'int', 'vendor': 'int'} }
L
Luiz Capitulino 已提交
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361

##
# @PciDeviceInfo:
#
# Information about a PCI device
#
# @bus: the bus number of the device
#
# @slot: the slot the device is located in
#
# @function: the function of the slot used by the device
#
1362
# @class_info: the class of the device
L
Luiz Capitulino 已提交
1363
#
1364
# @id: the PCI device id
L
Luiz Capitulino 已提交
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
#
# @irq: #optional if an IRQ is assigned to the device, the IRQ number
#
# @qdev_id: the device name of the PCI device
#
# @pci_bridge: if the device is a PCI bridge, the bridge information
#
# @regions: a list of the PCI I/O regions associated with the device
#
# Notes: the contents of @class_info.desc are not stable and should only be
#        treated as informational.
#
# Since: 0.14.0
##
1379
{ 'struct': 'PciDeviceInfo',
L
Luiz Capitulino 已提交
1380
  'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1381
           'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
L
Luiz Capitulino 已提交
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
           '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
           'regions': ['PciMemoryRegion']} }

##
# @PciInfo:
#
# Information about a PCI bus
#
# @bus: the bus index
#
# @devices: a list of devices on this bus
#
# Since: 0.14.0
##
1396
{ 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
L
Luiz Capitulino 已提交
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408

##
# @query-pci:
#
# Return information about the PCI bus topology of the guest.
#
# Returns: a list of @PciInfo for each PCI bus
#
# Since: 0.14.0
##
{ 'command': 'query-pci', 'returns': ['PciInfo'] }

L
Luiz Capitulino 已提交
1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
##
# @quit:
#
# This command will cause the QEMU process to exit gracefully.  While every
# attempt is made to send the QMP response before terminating, this is not
# guaranteed.  When using this interface, a premature EOF would not be
# unexpected.
#
# Since: 0.14.0
##
{ 'command': 'quit' }
L
Luiz Capitulino 已提交
1420 1421 1422 1423 1424 1425 1426 1427 1428

##
# @stop:
#
# Stop all guest VCPU execution.
#
# Since:  0.14.0
#
# Notes:  This function will succeed even if the guest is already in the stopped
1429 1430 1431
#         state.  In "inmigrate" state, it will ensure that the guest
#         remains paused once migration finishes, as if the -S option was
#         passed on the command line.
L
Luiz Capitulino 已提交
1432 1433
##
{ 'command': 'stop' }
L
Luiz Capitulino 已提交
1434 1435 1436 1437 1438 1439 1440 1441 1442

##
# @system_reset:
#
# Performs a hard reset of a guest.
#
# Since: 0.14.0
##
{ 'command': 'system_reset' }
L
Luiz Capitulino 已提交
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456

##
# @system_powerdown:
#
# Requests that a guest perform a powerdown operation.
#
# Since: 0.14.0
#
# Notes: A guest may or may not respond to this command.  This command
#        returning does not indicate that a guest has accepted the request or
#        that it has shut down.  Many guests will respond to this command by
#        prompting the user in some way.
##
{ 'command': 'system_powerdown' }
L
Luiz Capitulino 已提交
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467

##
# @cpu:
#
# This command is a nop that is only provided for the purposes of compatibility.
#
# Since: 0.14.0
#
# Notes: Do not use this command.
##
{ 'command': 'cpu', 'data': {'index': 'int'} }
L
Luiz Capitulino 已提交
1468

I
Igor Mammedov 已提交
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
##
# @cpu-add
#
# Adds CPU with specified ID
#
# @id: ID of CPU to be created, valid values [0..max_cpus)
#
# Returns: Nothing on success
#
# Since 1.5
##
{ 'command': 'cpu-add', 'data': {'id': 'int'} }

L
Luiz Capitulino 已提交
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503
##
# @memsave:
#
# Save a portion of guest memory to a file.
#
# @val: the virtual address of the guest to start from
#
# @size: the size of memory region to save
#
# @filename: the file to save the memory to as binary data
#
# @cpu-index: #optional the index of the virtual CPU to use for translating the
#                       virtual address (defaults to CPU 0)
#
# Returns: Nothing on success
#
# Since: 0.14.0
#
# Notes: Errors were not reliably returned until 1.1
##
{ 'command': 'memsave',
  'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
L
Luiz Capitulino 已提交
1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523

##
# @pmemsave:
#
# Save a portion of guest physical memory to a file.
#
# @val: the physical address of the guest to start from
#
# @size: the size of memory region to save
#
# @filename: the file to save the memory to as binary data
#
# Returns: Nothing on success
#
# Since: 0.14.0
#
# Notes: Errors were not reliably returned until 1.1
##
{ 'command': 'pmemsave',
  'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
L
Luiz Capitulino 已提交
1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535

##
# @cont:
#
# Resume guest VCPU execution.
#
# Since:  0.14.0
#
# Returns:  If successful, nothing
#           If QEMU was started with an encrypted block device and a key has
#              not yet been set, DeviceEncrypted.
#
1536 1537 1538 1539 1540
# Notes:  This command will succeed if the guest is currently running.  It
#         will also succeed if the guest is in the "inmigrate" state; in
#         this case, the effect of the command is to make sure the guest
#         starts once migration finishes, removing the effect of the -S
#         command line option if it was passed.
L
Luiz Capitulino 已提交
1541 1542 1543
##
{ 'command': 'cont' }

1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554
##
# @system_wakeup:
#
# Wakeup guest from suspend.  Does nothing in case the guest isn't suspended.
#
# Since:  1.1
#
# Returns:  nothing.
##
{ 'command': 'system_wakeup' }

L
Luiz Capitulino 已提交
1555 1556 1557
##
# @inject-nmi:
#
1558
# Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
L
Luiz Capitulino 已提交
1559 1560 1561 1562 1563
#
# Returns:  If successful, nothing
#
# Since:  0.14.0
#
1564
# Note: prior to 2.1, this command was only supported for x86 and s390 VMs
L
Luiz Capitulino 已提交
1565 1566
##
{ 'command': 'inject-nmi' }
L
Luiz Capitulino 已提交
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586

##
# @set_link:
#
# Sets the link status of a virtual network adapter.
#
# @name: the device name of the virtual network adapter
#
# @up: true to set the link status to be up
#
# Returns: Nothing on success
#          If @name is not a valid network device, DeviceNotFound
#
# Since: 0.14.0
#
# Notes: Not all network adapters support setting link status.  This command
#        will succeed even if the network adapter does not support link status
#        notification.
##
{ 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
L
Luiz Capitulino 已提交
1587

L
Luiz Capitulino 已提交
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
##
# @balloon:
#
# Request the balloon driver to change its balloon size.
#
# @value: the target size of the balloon in bytes
#
# Returns: Nothing on success
#          If the balloon driver is enabled but not functional because the KVM
#            kernel module cannot support it, KvmMissingCap
#          If no balloon device is present, DeviceNotActive
#
# Notes: This command just issues a request to the guest.  When it returns,
#        the balloon size may not have changed.  A guest can change the balloon
#        size independent of this command.
#
# Since: 0.14.0
##
{ 'command': 'balloon', 'data': {'value': 'int'} }
L
Luiz Capitulino 已提交
1607

1608 1609 1610 1611 1612 1613 1614
##
# @Abort
#
# This action can be used to test transaction failure.
#
# Since: 1.6
###
1615
{ 'struct': 'Abort',
1616 1617
  'data': { } }

J
John Snow 已提交
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637
##
# @ActionCompletionMode
#
# An enumeration of Transactional completion modes.
#
# @individual: Do not attempt to cancel any other Actions if any Actions fail
#              after the Transaction request succeeds. All Actions that
#              can complete successfully will do so without waiting on others.
#              This is the default.
#
# @grouped: If any Action fails after the Transaction succeeds, cancel all
#           Actions. Actions do not complete until all Actions are ready to
#           complete. May be rejected by Actions that do not support this
#           completion mode.
#
# Since: 2.5
##
{ 'enum': 'ActionCompletionMode',
  'data': [ 'individual', 'grouped' ] }

1638
##
1639
# @TransactionAction
1640
#
1641 1642
# A discriminated record of operations that can be performed with
# @transaction.
1643 1644 1645 1646 1647 1648
#
# Since 1.1
#
# drive-backup since 1.6
# abort since 1.6
# blockdev-snapshot-internal-sync since 1.7
1649
# blockdev-backup since 2.3
1650
# blockdev-snapshot since 2.5
F
Fam Zheng 已提交
1651 1652
# block-dirty-bitmap-add since 2.5
# block-dirty-bitmap-clear since 2.5
1653
##
1654
{ 'union': 'TransactionAction',
1655
  'data': {
1656
       'blockdev-snapshot': 'BlockdevSnapshot',
1657
       'blockdev-snapshot-sync': 'BlockdevSnapshotSync',
1658
       'drive-backup': 'DriveBackup',
1659
       'blockdev-backup': 'BlockdevBackup',
1660
       'abort': 'Abort',
F
Fam Zheng 已提交
1661 1662 1663
       'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal',
       'block-dirty-bitmap-add': 'BlockDirtyBitmapAdd',
       'block-dirty-bitmap-clear': 'BlockDirtyBitmap'
1664
   } }
1665

J
John Snow 已提交
1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682
##
# @TransactionProperties
#
# Optional arguments to modify the behavior of a Transaction.
#
# @completion-mode: #optional Controls how jobs launched asynchronously by
#                   Actions will complete or fail as a group.
#                   See @ActionCompletionMode for details.
#
# Since: 2.5
##
{ 'struct': 'TransactionProperties',
  'data': {
       '*completion-mode': 'ActionCompletionMode'
  }
}

1683
##
1684
# @transaction
1685
#
1686 1687 1688
# Executes a number of transactionable QMP commands atomically. If any
# operation fails, then the entire set of actions will be abandoned and the
# appropriate error returned.
1689
#
J
John Snow 已提交
1690 1691 1692 1693 1694 1695
# @actions: List of @TransactionAction;
#           information needed for the respective operations.
#
# @properties: #optional structure of additional options to control the
#              execution of the transaction. See @TransactionProperties
#              for additional detail.
1696 1697
#
# Returns: nothing on success
1698
#          Errors depend on the operations of the transaction
1699
#
1700 1701
# Note: The transaction aborts on the first failure.  Therefore, there will be
# information on only one failed operation returned in an error condition, and
1702 1703 1704
# subsequent actions will not have been attempted.
#
# Since 1.1
1705
##
1706
{ 'command': 'transaction',
J
John Snow 已提交
1707 1708 1709 1710
  'data': { 'actions': [ 'TransactionAction' ],
            '*properties': 'TransactionProperties'
          }
}
1711

1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722
##
# @human-monitor-command:
#
# Execute a command on the human monitor and return the output.
#
# @command-line: the command to execute in the human monitor
#
# @cpu-index: #optional The CPU to use for commands that require an implicit CPU
#
# Returns: the output of the command as a string
#
1723
# Since: 0.14.0
1724
#
1725 1726
# Notes: This command only exists as a stop-gap.  Its use is highly
#        discouraged.  The semantics of this command are not guaranteed.
1727
#
1728
#        Known limitations:
1729
#
1730 1731
#        o This command is stateless, this means that commands that depend
#          on state information (such as getfd) might not work
P
Paolo Bonzini 已提交
1732
#
1733 1734
#       o Commands that prompt the user for data (eg. 'cont' when the block
#         device is encrypted) don't currently work
P
Paolo Bonzini 已提交
1735
##
1736 1737 1738
{ 'command': 'human-monitor-command',
  'data': {'command-line': 'str', '*cpu-index': 'int'},
  'returns': 'str' }
P
Paolo Bonzini 已提交
1739 1740

##
L
Luiz Capitulino 已提交
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751
# @migrate_cancel
#
# Cancel the current executing migration process.
#
# Returns: nothing on success
#
# Notes: This command succeeds even if there is no migration process running.
#
# Since: 0.14.0
##
{ 'command': 'migrate_cancel' }
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764

##
# @migrate_set_downtime
#
# Set maximum tolerated downtime for migration.
#
# @value: maximum downtime in seconds
#
# Returns: nothing on success
#
# Since: 0.14.0
##
{ 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
L
Luiz Capitulino 已提交
1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779

##
# @migrate_set_speed
#
# Set maximum speed for migration.
#
# @value: maximum speed in bytes.
#
# Returns: nothing on success
#
# Notes: A value lesser than zero will be automatically round up to zero.
#
# Since: 0.14.0
##
{ 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
A
Anthony Liguori 已提交
1780

1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807
##
# @migrate-set-cache-size
#
# Set XBZRLE cache size
#
# @value: cache size in bytes
#
# The size will be rounded down to the nearest power of 2.
# The cache size can be modified before and during ongoing migration
#
# Returns: nothing on success
#
# Since: 1.2
##
{ 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }

##
# @query-migrate-cache-size
#
# query XBZRLE cache size
#
# Returns: XBZRLE cache size in bytes
#
# Since: 1.2
##
{ 'command': 'query-migrate-cache-size', 'returns': 'int' }

A
Anthony Liguori 已提交
1808
##
1809
# @ObjectPropertyInfo:
A
Anthony Liguori 已提交
1810 1811 1812 1813 1814 1815 1816 1817 1818
#
# @name: the name of the property
#
# @type: the type of the property.  This will typically come in one of four
#        forms:
#
#        1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
#           These types are mapped to the appropriate JSON type.
#
1819
#        2) A child type in the form 'child<subtype>' where subtype is a qdev
A
Anthony Liguori 已提交
1820 1821
#           device type name.  Child properties create the composition tree.
#
1822
#        3) A link type in the form 'link<subtype>' where subtype is a qdev
A
Anthony Liguori 已提交
1823 1824
#           device type name.  Link properties form the device model graph.
#
A
Anthony Liguori 已提交
1825
# Since: 1.2
A
Anthony Liguori 已提交
1826
##
1827
{ 'struct': 'ObjectPropertyInfo',
A
Anthony Liguori 已提交
1828 1829 1830 1831 1832
  'data': { 'name': 'str', 'type': 'str' } }

##
# @qom-list:
#
1833
# This command will list any properties of a object given a path in the object
A
Anthony Liguori 已提交
1834 1835
# model.
#
1836
# @path: the path within the object model.  See @qom-get for a description of
A
Anthony Liguori 已提交
1837 1838
#        this parameter.
#
1839 1840
# Returns: a list of @ObjectPropertyInfo that describe the properties of the
#          object.
A
Anthony Liguori 已提交
1841
#
A
Anthony Liguori 已提交
1842
# Since: 1.2
A
Anthony Liguori 已提交
1843 1844 1845
##
{ 'command': 'qom-list',
  'data': { 'path': 'str' },
1846
  'returns': [ 'ObjectPropertyInfo' ] }
1847 1848 1849 1850

##
# @qom-get:
#
1851
# This command will get a property from a object model path and return the
1852 1853
# value.
#
1854
# @path: The path within the object model.  There are two forms of supported
1855 1856
#        paths--absolute and partial paths.
#
1857
#        Absolute paths are derived from the root object and can follow child<>
1858 1859 1860 1861 1862 1863
#        or link<> properties.  Since they can follow link<> properties, they
#        can be arbitrarily long.  Absolute paths look like absolute filenames
#        and are prefixed  with a leading slash.
#
#        Partial paths look like relative filenames.  They do not begin
#        with a prefix.  The matching rules for partial paths are subtle but
1864
#        designed to make specifying objects easy.  At each level of the
1865 1866 1867 1868 1869 1870 1871 1872
#        composition tree, the partial path is matched as an absolute path.
#        The first match is not returned.  At least two matches are searched
#        for.  A successful result is only returned if only one match is
#        found.  If more than one match is found, a flag is return to
#        indicate that the match was ambiguous.
#
# @property: The property name to read
#
1873 1874 1875 1876
# Returns: The property value.  The type depends on the property
#          type. child<> and link<> properties are returned as #str
#          pathnames.  All integer property types (u8, u16, etc) are
#          returned as #int.
1877
#
A
Anthony Liguori 已提交
1878
# Since: 1.2
1879 1880 1881
##
{ 'command': 'qom-get',
  'data': { 'path': 'str', 'property': 'str' },
1882
  'returns': 'any' }
1883 1884 1885 1886

##
# @qom-set:
#
1887
# This command will set a property from a object model path.
1888 1889 1890 1891 1892 1893 1894 1895
#
# @path: see @qom-get for a description of this parameter
#
# @property: the property name to set
#
# @value: a value who's type is appropriate for the property type.  See @qom-get
#         for a description of type mapping.
#
A
Anthony Liguori 已提交
1896
# Since: 1.2
1897 1898
##
{ 'command': 'qom-set',
1899
  'data': { 'path': 'str', 'property': 'str', 'value': 'any' } }
L
Luiz Capitulino 已提交
1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911

##
# @set_password:
#
# Sets the password of a remote display session.
#
# @protocol: `vnc' to modify the VNC server password
#            `spice' to modify the Spice server password
#
# @password: the new password
#
# @connected: #optional how to handle existing clients when changing the
1912
#                       password.  If nothing is specified, defaults to `keep'
L
Luiz Capitulino 已提交
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923
#                       `fail' to fail the command if clients are connected
#                       `disconnect' to disconnect existing clients
#                       `keep' to maintain existing clients
#
# Returns: Nothing on success
#          If Spice is not enabled, DeviceNotFound
#
# Since: 0.14.0
##
{ 'command': 'set_password',
  'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
L
Luiz Capitulino 已提交
1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948

##
# @expire_password:
#
# Expire the password of a remote display server.
#
# @protocol: the name of the remote display protocol `vnc' or `spice'
#
# @time: when to expire the password.
#        `now' to expire the password immediately
#        `never' to cancel password expiration
#        `+INT' where INT is the number of seconds from now (integer)
#        `INT' where INT is the absolute time in seconds
#
# Returns: Nothing on success
#          If @protocol is `spice' and Spice is not active, DeviceNotFound
#
# Since: 0.14.0
#
# Notes: Time is relative to the server and currently there is no way to
#        coordinate server time with client time.  It is not recommended to
#        use the absolute time version of the @time parameter unless you're
#        sure you are on the same machine as the QEMU instance.
##
{ 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
L
Luiz Capitulino 已提交
1949

1950 1951 1952 1953 1954
##
# @change-vnc-password:
#
# Change the VNC server password.
#
1955
# @password:  the new password to use with VNC authentication
1956 1957 1958 1959 1960 1961 1962
#
# Since: 1.1
#
# Notes:  An empty password in this command will set the password to the empty
#         string.  Existing clients are unaffected by executing this command.
##
{ 'command': 'change-vnc-password', 'data': {'password': 'str'} }
L
Luiz Capitulino 已提交
1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990

##
# @change:
#
# This command is multiple commands multiplexed together.
#
# @device: This is normally the name of a block device but it may also be 'vnc'.
#          when it's 'vnc', then sub command depends on @target
#
# @target: If @device is a block device, then this is the new filename.
#          If @device is 'vnc', then if the value 'password' selects the vnc
#          change password command.   Otherwise, this specifies a new server URI
#          address to listen to for VNC connections.
#
# @arg:    If @device is a block device, then this is an optional format to open
#          the device with.
#          If @device is 'vnc' and @target is 'password', this is the new VNC
#          password to set.  If this argument is an empty string, then no future
#          logins will be allowed.
#
# Returns: Nothing on success.
#          If @device is not a valid block device, DeviceNotFound
#          If the new block device is encrypted, DeviceEncrypted.  Note that
#          if this error is returned, the device has been opened successfully
#          and an additional call to @block_passwd is required to set the
#          device's password.  The behavior of reads and writes to the block
#          device between when these calls are executed is undefined.
#
M
Max Reitz 已提交
1991 1992 1993 1994
# Notes:  This interface is deprecated, and it is strongly recommended that you
#         avoid using it.  For changing block devices, use
#         blockdev-change-medium; for changing VNC parameters, use
#         change-vnc-password.
L
Luiz Capitulino 已提交
1995 1996 1997 1998 1999
#
# Since: 0.14.0
##
{ 'command': 'change',
  'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
2000

2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011
##
# @ObjectTypeInfo:
#
# This structure describes a search result from @qom-list-types
#
# @name: the type name found in the search
#
# Since: 1.1
#
# Notes: This command is experimental and may change syntax in future releases.
##
2012
{ 'struct': 'ObjectTypeInfo',
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030
  'data': { 'name': 'str' } }

##
# @qom-list-types:
#
# This command will return a list of types given search parameters
#
# @implements: if specified, only return types that implement this type name
#
# @abstract: if true, include abstract types in the results
#
# Returns: a list of @ObjectTypeInfo or an empty list if no results are found
#
# Since: 1.1
##
{ 'command': 'qom-list-types',
  'data': { '*implements': 'str', '*abstract': 'bool' },
  'returns': [ 'ObjectTypeInfo' ] }
L
Luiz Capitulino 已提交
2031

2032 2033 2034 2035 2036 2037 2038
##
# @DevicePropertyInfo:
#
# Information about device properties.
#
# @name: the name of the property
# @type: the typename of the property
2039 2040
# @description: #optional if specified, the description of the property.
#               (since 2.2)
2041 2042 2043
#
# Since: 1.2
##
2044
{ 'struct': 'DevicePropertyInfo',
2045
  'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061

##
# @device-list-properties:
#
# List properties associated with a device.
#
# @typename: the type name of a device
#
# Returns: a list of DevicePropertyInfo describing a devices properties
#
# Since: 1.2
##
{ 'command': 'device-list-properties',
  'data': { 'typename': 'str'},
  'returns': [ 'DevicePropertyInfo' ] }

L
Luiz Capitulino 已提交
2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081
##
# @migrate
#
# Migrates the current running guest to another Virtual Machine.
#
# @uri: the Uniform Resource Identifier of the destination VM
#
# @blk: #optional do block migration (full disk copy)
#
# @inc: #optional incremental disk copy migration
#
# @detach: this argument exists only for compatibility reasons and
#          is ignored by QEMU
#
# Returns: nothing on success
#
# Since: 0.14.0
##
{ 'command': 'migrate',
  'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
2082

D
Dr. David Alan Gilbert 已提交
2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094
##
# @migrate-incoming
#
# Start an incoming migration, the qemu must have been started
# with -incoming defer
#
# @uri: The Uniform Resource Identifier identifying the source or
#       address to listen on
#
# Returns: nothing on success
#
# Since: 2.3
2095 2096 2097
# Note: It's a bad idea to use a string for the uri, but it needs to stay
# compatible with -incoming and the format of the uri is already exposed
# above libvirt
D
Dr. David Alan Gilbert 已提交
2098 2099 2100
##
{ 'command': 'migrate-incoming', 'data': {'uri': 'str' } }

2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114
# @xen-save-devices-state:
#
# Save the state of all devices to file. The RAM and the block devices
# of the VM are not saved by this command.
#
# @filename: the file to save the state of the devices to as binary
# data. See xen-save-devices-state.txt for a description of the binary
# format.
#
# Returns: Nothing on success
#
# Since: 1.1
##
{ 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
L
Luiz Capitulino 已提交
2115

2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128
##
# @xen-set-global-dirty-log
#
# Enable or disable the global dirty log mode.
#
# @enable: true to enable, false to disable.
#
# Returns: nothing
#
# Since: 1.3
##
{ 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }

L
Luiz Capitulino 已提交
2129 2130 2131 2132 2133
##
# @device_del:
#
# Remove a device from a guest
#
2134
# @id: the name or QOM path of the device
L
Luiz Capitulino 已提交
2135 2136 2137 2138 2139 2140 2141
#
# Returns: Nothing on success
#          If @id is not a valid device, DeviceNotFound
#
# Notes: When this command completes, the device may not be removed from the
#        guest.  Hot removal is an operation that requires guest cooperation.
#        This command merely requests that the guest begin the hot removal
M
Michael S. Tsirkin 已提交
2142 2143 2144
#        process.  Completion of the device removal process is signaled with a
#        DEVICE_DELETED event. Guest reset will automatically complete removal
#        for all devices.
L
Luiz Capitulino 已提交
2145 2146 2147 2148
#
# Since: 0.14.0
##
{ 'command': 'device_del', 'data': {'id': 'str'} }
2149

2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
##
# @DumpGuestMemoryFormat:
#
# An enumeration of guest-memory-dump's format.
#
# @elf: elf format
#
# @kdump-zlib: kdump-compressed format with zlib-compressed
#
# @kdump-lzo: kdump-compressed format with lzo-compressed
#
# @kdump-snappy: kdump-compressed format with snappy-compressed
#
# Since: 2.0
##
{ 'enum': 'DumpGuestMemoryFormat',
  'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }

2168 2169 2170 2171
##
# @dump-guest-memory
#
# Dump guest's memory to vmcore. It is a synchronous operation that can take
2172
# very long depending on the amount of guest memory.
2173 2174
#
# @paging: if true, do paging to get guest's memory mapping. This allows
2175
#          using gdb to process the core file.
2176
#
2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187
#          IMPORTANT: this option can make QEMU allocate several gigabytes
#                     of RAM. This can happen for a large guest, or a
#                     malicious guest pretending to be large.
#
#          Also, paging=true has the following limitations:
#
#             1. The guest may be in a catastrophic state or can have corrupted
#                memory, which cannot be trusted
#             2. The guest can be in real-mode even if paging is enabled. For
#                example, the guest uses ACPI to sleep, and ACPI sleep state
#                goes in real-mode
2188
#             3. Currently only supported on i386 and x86_64.
2189
#
2190
# @protocol: the filename or file descriptor of the vmcore. The supported
2191
#            protocols are:
2192
#
2193 2194 2195 2196
#            1. file: the protocol starts with "file:", and the following
#               string is the file's path.
#            2. fd: the protocol starts with "fd:", and the following string
#               is the fd's name.
2197
#
2198
# @detach: #optional if true, QMP will return immediately rather than
P
Peter Xu 已提交
2199 2200
#          waiting for the dump to finish. The user can track progress
#          using "query-dump". (since 2.6).
2201
#
2202
# @begin: #optional if specified, the starting physical address.
2203
#
2204
# @length: #optional if specified, the memory size, in bytes. If you don't
2205 2206
#          want to dump all guest's memory, please specify the start @begin
#          and @length
2207
#
2208 2209 2210 2211 2212
# @format: #optional if specified, the format of guest memory dump. But non-elf
#          format is conflict with paging and filter, ie. @paging, @begin and
#          @length is not allowed to be specified with non-elf @format at the
#          same time (since 2.0)
#
2213 2214 2215 2216 2217
# Returns: nothing on success
#
# Since: 1.2
##
{ 'command': 'dump-guest-memory',
2218 2219 2220
  'data': { 'paging': 'bool', 'protocol': 'str', '*detach': 'bool',
            '*begin': 'int', '*length': 'int',
            '*format': 'DumpGuestMemoryFormat'} }
2221

2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239
##
# @DumpStatus
#
# Describe the status of a long-running background guest memory dump.
#
# @none: no dump-guest-memory has started yet.
#
# @active: there is one dump running in background.
#
# @completed: the last dump has finished successfully.
#
# @failed: the last dump has failed.
#
# Since 2.6
##
{ 'enum': 'DumpStatus',
  'data': [ 'none', 'active', 'completed', 'failed' ] }

P
Peter Xu 已提交
2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268
##
# @DumpQueryResult
#
# The result format for 'query-dump'.
#
# @status: enum of @DumpStatus, which shows current dump status
#
# @completed: bytes written in latest dump (uncompressed)
#
# @total: total bytes to be written in latest dump (uncompressed)
#
# Since 2.6
##
{ 'struct': 'DumpQueryResult',
  'data': { 'status': 'DumpStatus',
            'completed': 'int',
            'total': 'int' } }

##
# @query-dump
#
# Query latest dump status.
#
# Returns: A @DumpStatus object showing the dump status.
#
# Since: 2.6
##
{ 'command': 'query-dump', 'returns': 'DumpQueryResult' }

2269 2270 2271 2272 2273 2274 2275
##
# @DumpGuestMemoryCapability:
#
# A list of the available formats for dump-guest-memory
#
# Since: 2.0
##
2276
{ 'struct': 'DumpGuestMemoryCapability',
2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291
  'data': {
      'formats': ['DumpGuestMemoryFormat'] } }

##
# @query-dump-guest-memory-capability:
#
# Returns the available formats for dump-guest-memory
#
# Returns:  A @DumpGuestMemoryCapability object listing available formats for
#           dump-guest-memory
#
# Since: 2.0
##
{ 'command': 'query-dump-guest-memory-capability',
  'returns': 'DumpGuestMemoryCapability' }
2292

2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306
##
# @dump-skeys
#
# Dump guest's storage keys
#
# @filename: the path to the file to dump to
#
# This command is only supported on s390 architecture.
#
# Since: 2.5
##
{ 'command': 'dump-skeys',
  'data': { 'filename': 'str' } }

L
Luiz Capitulino 已提交
2307 2308 2309 2310 2311 2312 2313 2314 2315 2316
##
# @netdev_add:
#
# Add a network backend.
#
# @type: the type of network backend.  Current valid values are 'user', 'tap',
#        'vde', 'socket', 'dump' and 'bridge'
#
# @id: the name of the new network backend
#
2317
# Additional arguments depend on the type.
L
Luiz Capitulino 已提交
2318
#
2319 2320 2321 2322
# TODO This command effectively bypasses QAPI completely due to its
# "additional arguments" business.  It shouldn't have been added to
# the schema in this form.  It should be qapified properly, or
# replaced by a properly qapified command.
L
Luiz Capitulino 已提交
2323 2324 2325 2326 2327 2328 2329
#
# Since: 0.14.0
#
# Returns: Nothing on success
#          If @type is not a valid network backend, DeviceNotFound
##
{ 'command': 'netdev_add',
2330 2331
  'data': {'type': 'str', 'id': 'str'},
  'gen': false }                # so we can get the additional arguments
L
Luiz Capitulino 已提交
2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345

##
# @netdev_del:
#
# Remove a network backend.
#
# @id: the name of the network backend to remove
#
# Returns: Nothing on success
#          If @id is not a valid network backend, DeviceNotFound
#
# Since: 0.14.0
##
{ 'command': 'netdev_del', 'data': {'id': 'str'} }
C
Corey Bryant 已提交
2346

2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363
##
# @object-add:
#
# Create a QOM object.
#
# @qom-type: the class name for the object to be created
#
# @id: the name of the new object
#
# @props: #optional a dictionary of properties to be passed to the backend
#
# Returns: Nothing on success
#          Error if @qom-type is not a valid class name
#
# Since: 2.0
##
{ 'command': 'object-add',
2364
  'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} }
2365

2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379
##
# @object-del:
#
# Remove a QOM object.
#
# @id: the name of the QOM object to remove
#
# Returns: Nothing on success
#          Error if @id is not a valid id for a QOM object
#
# Since: 2.0
##
{ 'command': 'object-del', 'data': {'id': 'str'} }

L
Laszlo Ersek 已提交
2380 2381 2382 2383 2384 2385 2386
##
# @NetdevNoneOptions
#
# Use it alone to have zero network devices.
#
# Since 1.2
##
2387
{ 'struct': 'NetdevNoneOptions',
L
Laszlo Ersek 已提交
2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406
  'data': { } }

##
# @NetLegacyNicOptions
#
# Create a new Network Interface Card.
#
# @netdev: #optional id of -netdev to connect to
#
# @macaddr: #optional MAC address
#
# @model: #optional device model (e1000, rtl8139, virtio etc.)
#
# @addr: #optional PCI device address
#
# @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
#
# Since 1.2
##
2407
{ 'struct': 'NetLegacyNicOptions',
L
Laszlo Ersek 已提交
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421
  'data': {
    '*netdev':  'str',
    '*macaddr': 'str',
    '*model':   'str',
    '*addr':    'str',
    '*vectors': 'uint32' } }

##
# @String
#
# A fat type wrapping 'str', to be embedded in lists.
#
# Since 1.2
##
2422
{ 'struct': 'String',
L
Laszlo Ersek 已提交
2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450
  'data': {
    'str': 'str' } }

##
# @NetdevUserOptions
#
# Use the user mode network stack which requires no administrator privilege to
# run.
#
# @hostname: #optional client hostname reported by the builtin DHCP server
#
# @restrict: #optional isolate the guest from the host
#
# @ip: #optional legacy parameter, use net= instead
#
# @net: #optional IP address and optional netmask
#
# @host: #optional guest-visible address of the host
#
# @tftp: #optional root directory of the built-in TFTP server
#
# @bootfile: #optional BOOTP filename, for use with tftp=
#
# @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
#             assign
#
# @dns: #optional guest-visible address of the virtual nameserver
#
2451 2452 2453
# @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
#             to the guest
#
L
Laszlo Ersek 已提交
2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464
# @smb: #optional root directory of the built-in SMB server
#
# @smbserver: #optional IP address of the built-in SMB server
#
# @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
#           endpoints
#
# @guestfwd: #optional forward guest TCP connections
#
# Since 1.2
##
2465
{ 'struct': 'NetdevUserOptions',
L
Laszlo Ersek 已提交
2466 2467 2468 2469 2470 2471 2472 2473 2474 2475
  'data': {
    '*hostname':  'str',
    '*restrict':  'bool',
    '*ip':        'str',
    '*net':       'str',
    '*host':      'str',
    '*tftp':      'str',
    '*bootfile':  'str',
    '*dhcpstart': 'str',
    '*dns':       'str',
2476
    '*dnssearch': ['String'],
L
Laszlo Ersek 已提交
2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490
    '*smb':       'str',
    '*smbserver': 'str',
    '*hostfwd':   ['String'],
    '*guestfwd':  ['String'] } }

##
# @NetdevTapOptions
#
# Connect the host TAP network interface name to the VLAN.
#
# @ifname: #optional interface name
#
# @fd: #optional file descriptor of an already opened tap
#
2491 2492 2493
# @fds: #optional multiple file descriptors of already opened multiqueue capable
# tap
#
L
Laszlo Ersek 已提交
2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507
# @script: #optional script to initialize the interface
#
# @downscript: #optional script to shut down the interface
#
# @helper: #optional command to execute to configure bridge
#
# @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
#
# @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
#
# @vhost: #optional enable vhost-net network accelerator
#
# @vhostfd: #optional file descriptor of an already opened vhost net device
#
2508 2509 2510
# @vhostfds: #optional file descriptors of multiple already opened vhost net
# devices
#
L
Laszlo Ersek 已提交
2511 2512
# @vhostforce: #optional vhost on for non-MSIX virtio guests
#
2513 2514
# @queues: #optional number of queues to be created for multiqueue capable tap
#
L
Laszlo Ersek 已提交
2515 2516
# Since 1.2
##
2517
{ 'struct': 'NetdevTapOptions',
L
Laszlo Ersek 已提交
2518 2519 2520
  'data': {
    '*ifname':     'str',
    '*fd':         'str',
J
Jason Wang 已提交
2521
    '*fds':        'str',
L
Laszlo Ersek 已提交
2522 2523 2524 2525 2526 2527 2528
    '*script':     'str',
    '*downscript': 'str',
    '*helper':     'str',
    '*sndbuf':     'size',
    '*vnet_hdr':   'bool',
    '*vhost':      'bool',
    '*vhostfd':    'str',
J
Jason Wang 已提交
2529 2530 2531
    '*vhostfds':   'str',
    '*vhostforce': 'bool',
    '*queues':     'uint32'} }
L
Laszlo Ersek 已提交
2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552

##
# @NetdevSocketOptions
#
# Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
# socket connection.
#
# @fd: #optional file descriptor of an already opened socket
#
# @listen: #optional port number, and optional hostname, to listen on
#
# @connect: #optional port number, and optional hostname, to connect to
#
# @mcast: #optional UDP multicast address and port number
#
# @localaddr: #optional source address and port for multicast and udp packets
#
# @udp: #optional UDP unicast address and port number
#
# Since 1.2
##
2553
{ 'struct': 'NetdevSocketOptions',
L
Laszlo Ersek 已提交
2554 2555 2556 2557 2558 2559 2560 2561
  'data': {
    '*fd':        'str',
    '*listen':    'str',
    '*connect':   'str',
    '*mcast':     'str',
    '*localaddr': 'str',
    '*udp':       'str' } }

A
Anton Ivanov 已提交
2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600
##
# @NetdevL2TPv3Options
#
# Connect the VLAN to Ethernet over L2TPv3 Static tunnel
#
# @src: source address
#
# @dst: destination address
#
# @srcport: #optional source port - mandatory for udp, optional for ip
#
# @dstport: #optional destination port - mandatory for udp, optional for ip
#
# @ipv6: #optional - force the use of ipv6
#
# @udp: #optional - use the udp version of l2tpv3 encapsulation
#
# @cookie64: #optional - use 64 bit coookies
#
# @counter: #optional have sequence counter
#
# @pincounter: #optional pin sequence counter to zero -
#              workaround for buggy implementations or
#              networks with packet reorder
#
# @txcookie: #optional 32 or 64 bit transmit cookie
#
# @rxcookie: #optional 32 or 64 bit receive cookie
#
# @txsession: 32 bit transmit session
#
# @rxsession: #optional 32 bit receive session - if not specified
#             set to the same value as transmit
#
# @offset: #optional additional offset - allows the insertion of
#          additional application-specific data before the packet payload
#
# Since 2.1
##
2601
{ 'struct': 'NetdevL2TPv3Options',
A
Anton Ivanov 已提交
2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617
  'data': {
    'src':          'str',
    'dst':          'str',
    '*srcport':     'str',
    '*dstport':     'str',
    '*ipv6':        'bool',
    '*udp':         'bool',
    '*cookie64':    'bool',
    '*counter':     'bool',
    '*pincounter':  'bool',
    '*txcookie':    'uint64',
    '*rxcookie':    'uint64',
    'txsession':    'uint32',
    '*rxsession':   'uint32',
    '*offset':      'uint32' } }

L
Laszlo Ersek 已提交
2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632
##
# @NetdevVdeOptions
#
# Connect the VLAN to a vde switch running on the host.
#
# @sock: #optional socket path
#
# @port: #optional port number
#
# @group: #optional group owner of socket
#
# @mode: #optional permissions for socket
#
# Since 1.2
##
2633
{ 'struct': 'NetdevVdeOptions',
L
Laszlo Ersek 已提交
2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651
  'data': {
    '*sock':  'str',
    '*port':  'uint16',
    '*group': 'str',
    '*mode':  'uint16' } }

##
# @NetdevDumpOptions
#
# Dump VLAN network traffic to a file.
#
# @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
# suffixes.
#
# @file: #optional dump file path (default is qemu-vlan0.pcap)
#
# Since 1.2
##
2652
{ 'struct': 'NetdevDumpOptions',
L
Laszlo Ersek 已提交
2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667
  'data': {
    '*len':  'size',
    '*file': 'str' } }

##
# @NetdevBridgeOptions
#
# Connect a host TAP network interface to a host bridge device.
#
# @br: #optional bridge name
#
# @helper: #optional command to execute to configure bridge
#
# Since 1.2
##
2668
{ 'struct': 'NetdevBridgeOptions',
L
Laszlo Ersek 已提交
2669 2670 2671 2672
  'data': {
    '*br':     'str',
    '*helper': 'str' } }

S
Stefan Hajnoczi 已提交
2673 2674 2675 2676 2677 2678 2679 2680 2681
##
# @NetdevHubPortOptions
#
# Connect two or more net clients through a software hub.
#
# @hubid: hub identifier number
#
# Since 1.2
##
2682
{ 'struct': 'NetdevHubPortOptions',
S
Stefan Hajnoczi 已提交
2683 2684 2685
  'data': {
    'hubid':     'int32' } }

2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699
##
# @NetdevNetmapOptions
#
# Connect a client to a netmap-enabled NIC or to a VALE switch port
#
# @ifname: Either the name of an existing network interface supported by
#          netmap, or the name of a VALE port (created on the fly).
#          A VALE port name is in the form 'valeXXX:YYY', where XXX and
#          YYY are non-negative integers. XXX identifies a switch and
#          YYY identifies a port of the switch. VALE ports having the
#          same XXX are therefore connected to the same switch.
#
# @devname: #optional path of the netmap device (default: '/dev/netmap').
#
2700
# Since 2.0
2701
##
2702
{ 'struct': 'NetdevNetmapOptions',
2703 2704 2705 2706
  'data': {
    'ifname':     'str',
    '*devname':    'str' } }

2707 2708 2709 2710 2711 2712 2713 2714 2715
##
# @NetdevVhostUserOptions
#
# Vhost-user network backend
#
# @chardev: name of a unix socket chardev
#
# @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
#
2716 2717 2718
# @queues: #optional number of queues to be created for multiqueue vhost-user
#          (default: 1) (Since 2.5)
#
2719 2720
# Since 2.1
##
2721
{ 'struct': 'NetdevVhostUserOptions',
2722 2723
  'data': {
    'chardev':        'str',
2724 2725
    '*vhostforce':    'bool',
    '*queues':        'int' } }
2726

L
Laszlo Ersek 已提交
2727 2728 2729 2730 2731 2732
##
# @NetClientOptions
#
# A discriminated record of network device traits.
#
# Since 1.2
A
Anton Ivanov 已提交
2733 2734 2735
#
# 'l2tpv3' - since 2.1
#
L
Laszlo Ersek 已提交
2736 2737 2738
##
{ 'union': 'NetClientOptions',
  'data': {
S
Stefan Hajnoczi 已提交
2739 2740 2741 2742
    'none':     'NetdevNoneOptions',
    'nic':      'NetLegacyNicOptions',
    'user':     'NetdevUserOptions',
    'tap':      'NetdevTapOptions',
A
Anton Ivanov 已提交
2743
    'l2tpv3':   'NetdevL2TPv3Options',
S
Stefan Hajnoczi 已提交
2744 2745 2746 2747
    'socket':   'NetdevSocketOptions',
    'vde':      'NetdevVdeOptions',
    'dump':     'NetdevDumpOptions',
    'bridge':   'NetdevBridgeOptions',
2748
    'hubport':  'NetdevHubPortOptions',
2749 2750
    'netmap':   'NetdevNetmapOptions',
    'vhost-user': 'NetdevVhostUserOptions' } }
L
Laszlo Ersek 已提交
2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766

##
# @NetLegacy
#
# Captures the configuration of a network device; legacy.
#
# @vlan: #optional vlan number
#
# @id: #optional identifier for monitor commands
#
# @name: #optional identifier for monitor commands, ignored if @id is present
#
# @opts: device type specific properties (legacy)
#
# Since 1.2
##
2767
{ 'struct': 'NetLegacy',
L
Laszlo Ersek 已提交
2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784
  'data': {
    '*vlan': 'int32',
    '*id':   'str',
    '*name': 'str',
    'opts':  'NetClientOptions' } }

##
# @Netdev
#
# Captures the configuration of a network device.
#
# @id: identifier for monitor commands.
#
# @opts: device type specific properties
#
# Since 1.2
##
2785
{ 'struct': 'Netdev',
L
Laszlo Ersek 已提交
2786 2787 2788 2789
  'data': {
    'id':   'str',
    'opts': 'NetClientOptions' } }

Y
Yang Hongyang 已提交
2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809
##
# @NetFilterDirection
#
# Indicates whether a netfilter is attached to a netdev's transmit queue or
# receive queue or both.
#
# @all: the filter is attached both to the receive and the transmit
#       queue of the netdev (default).
#
# @rx: the filter is attached to the receive queue of the netdev,
#      where it will receive packets sent to the netdev.
#
# @tx: the filter is attached to the transmit queue of the netdev,
#      where it will receive packets sent by the netdev.
#
# Since 2.5
##
{ 'enum': 'NetFilterDirection',
  'data': [ 'all', 'rx', 'tx' ] }

P
Paolo Bonzini 已提交
2810 2811 2812 2813 2814 2815 2816
##
# @InetSocketAddress
#
# Captures a socket address or address range in the Internet namespace.
#
# @host: host part of the address
#
2817
# @port: port part of the address, or lowest port if @to is present
P
Paolo Bonzini 已提交
2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828
#
# @to: highest port to try
#
# @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
#        #optional
#
# @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
#        #optional
#
# Since 1.3
##
2829
{ 'struct': 'InetSocketAddress',
P
Paolo Bonzini 已提交
2830 2831
  'data': {
    'host': 'str',
2832
    'port': 'str',
P
Paolo Bonzini 已提交
2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845
    '*to': 'uint16',
    '*ipv4': 'bool',
    '*ipv6': 'bool' } }

##
# @UnixSocketAddress
#
# Captures a socket address in the local ("Unix socket") namespace.
#
# @path: filesystem path to use
#
# Since 1.3
##
2846
{ 'struct': 'UnixSocketAddress',
P
Paolo Bonzini 已提交
2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862
  'data': {
    'path': 'str' } }

##
# @SocketAddress
#
# Captures the address of a socket, which could also be a named file descriptor
#
# Since 1.3
##
{ 'union': 'SocketAddress',
  'data': {
    'inet': 'InetSocketAddress',
    'unix': 'UnixSocketAddress',
    'fd': 'String' } }

C
Corey Bryant 已提交
2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893
##
# @getfd:
#
# Receive a file descriptor via SCM rights and assign it a name
#
# @fdname: file descriptor name
#
# Returns: Nothing on success
#
# Since: 0.14.0
#
# Notes: If @fdname already exists, the file descriptor assigned to
#        it will be closed and replaced by the received file
#        descriptor.
#        The 'closefd' command can be used to explicitly close the
#        file descriptor when it is no longer needed.
##
{ 'command': 'getfd', 'data': {'fdname': 'str'} }

##
# @closefd:
#
# Close a file descriptor previously passed via SCM rights
#
# @fdname: file descriptor name
#
# Returns: Nothing on success
#
# Since: 0.14.0
##
{ 'command': 'closefd', 'data': {'fdname': 'str'} }
2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905

##
# @MachineInfo:
#
# Information describing a machine.
#
# @name: the name of the machine
#
# @alias: #optional an alias for the machine name
#
# @default: #optional whether the machine is default
#
2906 2907 2908
# @cpu-max: maximum number of CPUs supported by the machine type
#           (since 1.5.0)
#
2909 2910
# Since: 1.2.0
##
2911
{ 'struct': 'MachineInfo',
2912
  'data': { 'name': 'str', '*alias': 'str',
2913
            '*is-default': 'bool', 'cpu-max': 'int' } }
2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924

##
# @query-machines:
#
# Return a list of supported machines
#
# Returns: a list of MachineInfo
#
# Since: 1.2.0
##
{ 'command': 'query-machines', 'returns': ['MachineInfo'] }
2925 2926 2927 2928 2929 2930 2931 2932 2933 2934

##
# @CpuDefinitionInfo:
#
# Virtual CPU definition.
#
# @name: the name of the CPU definition
#
# Since: 1.2.0
##
2935
{ 'struct': 'CpuDefinitionInfo',
2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947
  'data': { 'name': 'str' } }

##
# @query-cpu-definitions:
#
# Return a list of supported virtual CPU definitions
#
# Returns: a list of CpuDefInfo
#
# Since: 1.2.0
##
{ 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959

# @AddfdInfo:
#
# Information about a file descriptor that was added to an fd set.
#
# @fdset-id: The ID of the fd set that @fd was added to.
#
# @fd: The file descriptor that was received via SCM rights and
#      added to the fd set.
#
# Since: 1.2.0
##
2960
{ 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972

##
# @add-fd:
#
# Add a file descriptor, that was passed via SCM rights, to an fd set.
#
# @fdset-id: #optional The ID of the fd set to add the file descriptor to.
#
# @opaque: #optional A free-form string that can be used to describe the fd.
#
# Returns: @AddfdInfo on success
#          If file descriptor was not received, FdNotSupplied
2973
#          If @fdset-id is a negative value, InvalidParameterValue
2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015
#
# Notes: The list of fd sets is shared by all monitor connections.
#
#        If @fdset-id is not specified, a new fd set will be created.
#
# Since: 1.2.0
##
{ 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
  'returns': 'AddfdInfo' }

##
# @remove-fd:
#
# Remove a file descriptor from an fd set.
#
# @fdset-id: The ID of the fd set that the file descriptor belongs to.
#
# @fd: #optional The file descriptor that is to be removed.
#
# Returns: Nothing on success
#          If @fdset-id or @fd is not found, FdNotFound
#
# Since: 1.2.0
#
# Notes: The list of fd sets is shared by all monitor connections.
#
#        If @fd is not specified, all file descriptors in @fdset-id
#        will be removed.
##
{ 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }

##
# @FdsetFdInfo:
#
# Information about a file descriptor that belongs to an fd set.
#
# @fd: The file descriptor value.
#
# @opaque: #optional A free-form string that can be used to describe the fd.
#
# Since: 1.2.0
##
3016
{ 'struct': 'FdsetFdInfo',
3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029
  'data': {'fd': 'int', '*opaque': 'str'} }

##
# @FdsetInfo:
#
# Information about an fd set.
#
# @fdset-id: The ID of the fd set.
#
# @fds: A list of file descriptors that belong to this fd set.
#
# Since: 1.2.0
##
3030
{ 'struct': 'FdsetInfo',
3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045
  'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }

##
# @query-fdsets:
#
# Return information describing all fd sets.
#
# Returns: A list of @FdsetInfo
#
# Since: 1.2.0
#
# Note: The list of fd sets is shared by all monitor connections.
#
##
{ 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055

##
# @TargetInfo:
#
# Information describing the QEMU target.
#
# @arch: the target architecture (eg "x86_64", "i386", etc)
#
# Since: 1.2.0
##
3056
{ 'struct': 'TargetInfo',
P
Paolo Bonzini 已提交
3057
  'data': { 'arch': 'str' } }
3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068

##
# @query-target:
#
# Return information about the target for this QEMU
#
# Returns: TargetInfo
#
# Since: 1.2.0
##
{ 'command': 'query-target', 'returns': 'TargetInfo' }
A
Amos Kong 已提交
3069 3070 3071 3072 3073 3074 3075 3076 3077

##
# @QKeyCode:
#
# An enumeration of key name.
#
# This is used by the send-key command.
#
# Since: 1.3.0
G
Gerd Hoffmann 已提交
3078
#
G
Gerd Hoffmann 已提交
3079
# 'unmapped' and 'pause' since 2.0
G
Gerd Hoffmann 已提交
3080
# 'ro' and 'kp_comma' since 2.4
A
Amos Kong 已提交
3081 3082
##
{ 'enum': 'QKeyCode',
G
Gerd Hoffmann 已提交
3083 3084
  'data': [ 'unmapped',
            'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
A
Amos Kong 已提交
3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097
            'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
            '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
            'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
            'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
            'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
            'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
            'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
            'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
            'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
            'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
            'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
            'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
            'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
G
Gerd Hoffmann 已提交
3098 3099
            'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause', 'ro',
            'kp_comma' ] }
A
Amos Kong 已提交
3100

3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112
##
# @KeyValue
#
# Represents a keyboard key.
#
# Since: 1.3.0
##
{ 'union': 'KeyValue',
  'data': {
    'number': 'int',
    'qcode': 'QKeyCode' } }

A
Amos Kong 已提交
3113 3114 3115 3116 3117
##
# @send-key:
#
# Send keys to guest.
#
3118 3119 3120 3121
# @keys: An array of @KeyValue elements. All @KeyValues in this array are
#        simultaneously sent to the guest. A @KeyValue.number value is sent
#        directly to the guest, while @KeyValue.qcode must be a valid
#        @QKeyCode value
A
Amos Kong 已提交
3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132
#
# @hold-time: #optional time to delay key up events, milliseconds. Defaults
#             to 100
#
# Returns: Nothing on success
#          If key is unknown or redundant, InvalidParameter
#
# Since: 1.3.0
#
##
{ 'command': 'send-key',
3133
  'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
L
Luiz Capitulino 已提交
3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146

##
# @screendump:
#
# Write a PPM of the VGA screen to a file.
#
# @filename: the path of a new PPM file to store the image
#
# Returns: Nothing on success
#
# Since: 0.14.0
##
{ 'command': 'screendump', 'data': {'filename': 'str'} }
P
Paolo Bonzini 已提交
3147

3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162

##
# @ChardevCommon:
#
# Configuration shared across all chardev backends
#
# @logfile: #optional The name of a logfile to save output
# @logappend: #optional true to append instead of truncate
#             (default to false to truncate)
#
# Since: 2.6
##
{ 'struct': 'ChardevCommon', 'data': { '*logfile': 'str',
                                       '*logappend': 'bool' } }

3163 3164 3165 3166 3167 3168 3169
##
# @ChardevFile:
#
# Configuration info for file chardevs.
#
# @in:  #optional The name of the input file
# @out: The name of the output file
3170 3171
# @append: #optional Open the file in append mode (default false to
#          truncate) (Since 2.6)
3172 3173 3174
#
# Since: 1.4
##
3175
{ 'struct': 'ChardevFile', 'data': { '*in' : 'str',
3176
                                   'out' : 'str',
3177 3178
                                   '*append': 'bool' },
  'base': 'ChardevCommon' }
3179

3180
##
3181
# @ChardevHostdev:
3182
#
3183
# Configuration info for device and pipe chardevs.
3184 3185 3186 3187 3188 3189 3190
#
# @device: The name of the special file for the device,
#          i.e. /dev/ttyS0 on Unix or COM1: on Windows
# @type: What kind of device this is.
#
# Since: 1.4
##
3191 3192
{ 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' },
  'base': 'ChardevCommon' }
3193

3194 3195 3196
##
# @ChardevSocket:
#
G
Gerd Hoffmann 已提交
3197
# Configuration info for (stream) socket chardevs.
3198 3199 3200
#
# @addr: socket address to listen on (server=true)
#        or connect to (server=false)
3201
# @tls-creds: #optional the ID of the TLS credentials object (since 2.6)
3202
# @server: #optional create server socket (default: true)
3203 3204
# @wait: #optional wait for incoming connection on server
#        sockets (default: false).
3205
# @nodelay: #optional set TCP_NODELAY socket option (default: false)
3206 3207
# @telnet: #optional enable telnet protocol on server
#          sockets (default: false)
3208 3209 3210 3211
# @reconnect: #optional For a client socket, if a socket is disconnected,
#          then attempt a reconnect after the given number of seconds.
#          Setting this to zero disables this function. (default: 0)
#          (Since: 2.2)
3212 3213 3214
#
# Since: 1.4
##
3215
{ 'struct': 'ChardevSocket', 'data': { 'addr'       : 'SocketAddress',
3216
                                     '*tls-creds'  : 'str',
3217 3218 3219 3220
                                     '*server'    : 'bool',
                                     '*wait'      : 'bool',
                                     '*nodelay'   : 'bool',
                                     '*telnet'    : 'bool',
3221 3222
                                     '*reconnect' : 'int' },
  'base': 'ChardevCommon' }
3223

G
Gerd Hoffmann 已提交
3224
##
3225
# @ChardevUdp:
G
Gerd Hoffmann 已提交
3226 3227 3228 3229 3230 3231 3232 3233
#
# Configuration info for datagram socket chardevs.
#
# @remote: remote address
# @local: #optional local address
#
# Since: 1.5
##
3234
{ 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
3235 3236
                                  '*local' : 'SocketAddress' },
  'base': 'ChardevCommon' }
G
Gerd Hoffmann 已提交
3237

3238 3239 3240 3241 3242 3243 3244 3245 3246
##
# @ChardevMux:
#
# Configuration info for mux chardevs.
#
# @chardev: name of the base chardev.
#
# Since: 1.5
##
3247 3248
{ 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' },
  'base': 'ChardevCommon' }
3249

3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260
##
# @ChardevStdio:
#
# Configuration info for stdio chardevs.
#
# @signal: #optional Allow signals (such as SIGINT triggered by ^C)
#          be delivered to qemu.  Default: true in -nographic mode,
#          false otherwise.
#
# Since: 1.5
##
3261 3262 3263
{ 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' },
  'base': 'ChardevCommon' }

3264

3265 3266 3267 3268 3269 3270 3271 3272 3273
##
# @ChardevSpiceChannel:
#
# Configuration info for spice vm channel chardevs.
#
# @type: kind of channel (for example vdagent).
#
# Since: 1.5
##
3274 3275
{ 'struct': 'ChardevSpiceChannel', 'data': { 'type'  : 'str' },
  'base': 'ChardevCommon' }
3276 3277 3278 3279 3280 3281 3282 3283 3284 3285

##
# @ChardevSpicePort:
#
# Configuration info for spice port chardevs.
#
# @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
#
# Since: 1.5
##
3286 3287
{ 'struct': 'ChardevSpicePort', 'data': { 'fqdn'  : 'str' },
  'base': 'ChardevCommon' }
3288

G
Gerd Hoffmann 已提交
3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300
##
# @ChardevVC:
#
# Configuration info for virtual console chardevs.
#
# @width:  console width,  in pixels
# @height: console height, in pixels
# @cols:   console width,  in chars
# @rows:   console height, in chars
#
# Since: 1.5
##
3301
{ 'struct': 'ChardevVC', 'data': { '*width'  : 'int',
G
Gerd Hoffmann 已提交
3302 3303
                                 '*height' : 'int',
                                 '*cols'   : 'int',
3304 3305
                                 '*rows'   : 'int' },
  'base': 'ChardevCommon' }
G
Gerd Hoffmann 已提交
3306

3307
##
3308
# @ChardevRingbuf:
3309
#
3310
# Configuration info for ring buffer chardevs.
3311
#
3312
# @size: #optional ring buffer size, must be power of two, default is 65536
3313 3314 3315
#
# Since: 1.5
##
3316 3317
{ 'struct': 'ChardevRingbuf', 'data': { '*size'  : 'int' },
  'base': 'ChardevCommon' }
3318

3319 3320 3321 3322 3323
##
# @ChardevBackend:
#
# Configuration info for the new chardev backend.
#
P
Paolo Bonzini 已提交
3324
# Since: 1.4 (testdev since 2.2)
3325
##
3326
{ 'union': 'ChardevBackend', 'data': { 'file'   : 'ChardevFile',
3327 3328
                                       'serial' : 'ChardevHostdev',
                                       'parallel': 'ChardevHostdev',
3329
                                       'pipe'   : 'ChardevHostdev',
3330
                                       'socket' : 'ChardevSocket',
3331
                                       'udp'    : 'ChardevUdp',
3332 3333
                                       'pty'    : 'ChardevCommon',
                                       'null'   : 'ChardevCommon',
3334
                                       'mux'    : 'ChardevMux',
3335 3336 3337
                                       'msmouse': 'ChardevCommon',
                                       'braille': 'ChardevCommon',
                                       'testdev': 'ChardevCommon',
3338
                                       'stdio'  : 'ChardevStdio',
3339
                                       'console': 'ChardevCommon',
3340
                                       'spicevmc' : 'ChardevSpiceChannel',
G
Gerd Hoffmann 已提交
3341
                                       'spiceport' : 'ChardevSpicePort',
3342
                                       'vc'     : 'ChardevVC',
3343 3344
                                       'ringbuf': 'ChardevRingbuf',
                                       # next one is just for compatibility
3345
                                       'memory' : 'ChardevRingbuf' } }
3346 3347 3348 3349 3350 3351

##
# @ChardevReturn:
#
# Return info about the chardev backend just created.
#
3352 3353 3354
# @pty: #optional name of the slave pseudoterminal device, present if
#       and only if a chardev of type 'pty' was created
#
3355 3356
# Since: 1.4
##
3357
{ 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
3358 3359 3360 3361

##
# @chardev-add:
#
3362
# Add a character device backend
3363 3364 3365 3366
#
# @id: the chardev's ID, must be unique
# @backend: backend type and parameters
#
3367
# Returns: ChardevReturn.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377
#
# Since: 1.4
##
{ 'command': 'chardev-add', 'data': {'id'      : 'str',
                                     'backend' : 'ChardevBackend' },
  'returns': 'ChardevReturn' }

##
# @chardev-remove:
#
3378
# Remove a character device backend
3379 3380 3381 3382 3383 3384 3385 3386
#
# @id: the chardev's ID, must exist and not be in use
#
# Returns: Nothing on success
#
# Since: 1.4
##
{ 'command': 'chardev-remove', 'data': {'id': 'str'} }
3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443

##
# @TpmModel:
#
# An enumeration of TPM models
#
# @tpm-tis: TPM TIS model
#
# Since: 1.5
##
{ 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }

##
# @query-tpm-models:
#
# Return a list of supported TPM models
#
# Returns: a list of TpmModel
#
# Since: 1.5
##
{ 'command': 'query-tpm-models', 'returns': ['TpmModel'] }

##
# @TpmType:
#
# An enumeration of TPM types
#
# @passthrough: TPM passthrough type
#
# Since: 1.5
##
{ 'enum': 'TpmType', 'data': [ 'passthrough' ] }

##
# @query-tpm-types:
#
# Return a list of supported TPM types
#
# Returns: a list of TpmType
#
# Since: 1.5
##
{ 'command': 'query-tpm-types', 'returns': ['TpmType'] }

##
# @TPMPassthroughOptions:
#
# Information about the TPM passthrough type
#
# @path: #optional string describing the path used for accessing the TPM device
#
# @cancel-path: #optional string showing the TPM's sysfs cancel file
#               for cancellation of TPM commands while they are executing
#
# Since: 1.5
##
3444
{ 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
3445 3446 3447 3448 3449 3450 3451
                                             '*cancel-path' : 'str'} }

##
# @TpmTypeOptions:
#
# A union referencing different TPM backend types' configuration options
#
3452
# @passthrough: The configuration options for the TPM passthrough type
3453 3454 3455 3456
#
# Since: 1.5
##
{ 'union': 'TpmTypeOptions',
3457
   'data': { 'passthrough' : 'TPMPassthroughOptions' } }
3458 3459 3460 3461 3462 3463 3464 3465 3466 3467

##
# @TpmInfo:
#
# Information about the TPM
#
# @id: The Id of the TPM
#
# @model: The TPM frontend model
#
3468
# @options: The TPM (backend) type configuration options
3469 3470 3471
#
# Since: 1.5
##
3472
{ 'struct': 'TPMInfo',
3473 3474
  'data': {'id': 'str',
           'model': 'TpmModel',
3475
           'options': 'TpmTypeOptions' } }
3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486

##
# @query-tpm:
#
# Return information about the TPM device
#
# Returns: @TPMInfo on success
#
# Since: 1.5
##
{ 'command': 'query-tpm', 'returns': ['TPMInfo'] }
L
Laszlo Ersek 已提交
3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533

##
# @AcpiTableOptions
#
# Specify an ACPI table on the command line to load.
#
# At most one of @file and @data can be specified. The list of files specified
# by any one of them is loaded and concatenated in order. If both are omitted,
# @data is implied.
#
# Other fields / optargs can be used to override fields of the generic ACPI
# table header; refer to the ACPI specification 5.0, section 5.2.6 System
# Description Table Header. If a header field is not overridden, then the
# corresponding value from the concatenated blob is used (in case of @file), or
# it is filled in with a hard-coded value (in case of @data).
#
# String fields are copied into the matching ACPI member from lowest address
# upwards, and silently truncated / NUL-padded to length.
#
# @sig: #optional table signature / identifier (4 bytes)
#
# @rev: #optional table revision number (dependent on signature, 1 byte)
#
# @oem_id: #optional OEM identifier (6 bytes)
#
# @oem_table_id: #optional OEM table identifier (8 bytes)
#
# @oem_rev: #optional OEM-supplied revision number (4 bytes)
#
# @asl_compiler_id: #optional identifier of the utility that created the table
#                   (4 bytes)
#
# @asl_compiler_rev: #optional revision number of the utility that created the
#                    table (4 bytes)
#
# @file: #optional colon (:) separated list of pathnames to load and
#        concatenate as table data. The resultant binary blob is expected to
#        have an ACPI table header. At least one file is required. This field
#        excludes @data.
#
# @data: #optional colon (:) separated list of pathnames to load and
#        concatenate as table data. The resultant binary blob must not have an
#        ACPI table header. At least one file is required. This field excludes
#        @file.
#
# Since 1.5
##
3534
{ 'struct': 'AcpiTableOptions',
L
Laszlo Ersek 已提交
3535 3536 3537 3538 3539 3540 3541 3542 3543 3544
  'data': {
    '*sig':               'str',
    '*rev':               'uint8',
    '*oem_id':            'str',
    '*oem_table_id':      'str',
    '*oem_rev':           'uint32',
    '*asl_compiler_id':   'str',
    '*asl_compiler_rev':  'uint32',
    '*file':              'str',
    '*data':              'str' }}
3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575

##
# @CommandLineParameterType:
#
# Possible types for an option parameter.
#
# @string: accepts a character string
#
# @boolean: accepts "on" or "off"
#
# @number: accepts a number
#
# @size: accepts a number followed by an optional suffix (K)ilo,
#        (M)ega, (G)iga, (T)era
#
# Since 1.5
##
{ 'enum': 'CommandLineParameterType',
  'data': ['string', 'boolean', 'number', 'size'] }

##
# @CommandLineParameterInfo:
#
# Details about a single parameter of a command line option.
#
# @name: parameter name
#
# @type: parameter @CommandLineParameterType
#
# @help: #optional human readable text string, not suitable for parsing.
#
3576 3577
# @default: #optional default value string (since 2.1)
#
3578 3579
# Since 1.5
##
3580
{ 'struct': 'CommandLineParameterInfo',
3581 3582
  'data': { 'name': 'str',
            'type': 'CommandLineParameterType',
3583 3584
            '*help': 'str',
            '*default': 'str' } }
3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596

##
# @CommandLineOptionInfo:
#
# Details about a command line option, including its list of parameter details
#
# @option: option name
#
# @parameters: an array of @CommandLineParameterInfo
#
# Since 1.5
##
3597
{ 'struct': 'CommandLineOptionInfo',
3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613
  'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }

##
# @query-command-line-options:
#
# Query command line option schema.
#
# @option: #optional option name
#
# Returns: list of @CommandLineOptionInfo for all options (or for the given
#          @option).  Returns an error if the given @option doesn't exist.
#
# Since 1.5
##
{'command': 'query-command-line-options', 'data': { '*option': 'str' },
 'returns': ['CommandLineOptionInfo'] }
3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640

##
# @X86CPURegister32
#
# A X86 32-bit register
#
# Since: 1.5
##
{ 'enum': 'X86CPURegister32',
  'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }

##
# @X86CPUFeatureWordInfo
#
# Information about a X86 CPU feature word
#
# @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
#
# @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
#                   feature word
#
# @cpuid-register: Output register containing the feature bits
#
# @features: value of output register, containing the feature bits
#
# Since: 1.5
##
3641
{ 'struct': 'X86CPUFeatureWordInfo',
3642 3643 3644 3645
  'data': { 'cpuid-input-eax': 'int',
            '*cpuid-input-ecx': 'int',
            'cpuid-register': 'X86CPURegister32',
            'features': 'int' } }
3646

E
Eric Blake 已提交
3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657
##
# @DummyForceArrays
#
# Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
#
# Since 2.5
##
{ 'struct': 'DummyForceArrays',
  'data': { 'unused': ['X86CPUFeatureWordInfo'] } }


3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685
##
# @RxState:
#
# Packets receiving state
#
# @normal: filter assigned packets according to the mac-table
#
# @none: don't receive any assigned packet
#
# @all: receive all assigned packets
#
# Since: 1.6
##
{ 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }

##
# @RxFilterInfo:
#
# Rx-filter information for a NIC.
#
# @name: net client name
#
# @promiscuous: whether promiscuous mode is enabled
#
# @multicast: multicast receive state
#
# @unicast: unicast receive state
#
3686 3687
# @vlan: vlan receive state (Since 2.0)
#
3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704
# @broadcast-allowed: whether to receive broadcast
#
# @multicast-overflow: multicast table is overflowed or not
#
# @unicast-overflow: unicast table is overflowed or not
#
# @main-mac: the main macaddr string
#
# @vlan-table: a list of active vlan id
#
# @unicast-table: a list of unicast macaddr string
#
# @multicast-table: a list of multicast macaddr string
#
# Since 1.6
##

3705
{ 'struct': 'RxFilterInfo',
3706 3707 3708 3709 3710
  'data': {
    'name':               'str',
    'promiscuous':        'bool',
    'multicast':          'RxState',
    'unicast':            'RxState',
3711
    'vlan':               'RxState',
3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735
    'broadcast-allowed':  'bool',
    'multicast-overflow': 'bool',
    'unicast-overflow':   'bool',
    'main-mac':           'str',
    'vlan-table':         ['int'],
    'unicast-table':      ['str'],
    'multicast-table':    ['str'] }}

##
# @query-rx-filter:
#
# Return rx-filter information for all NICs (or for the given NIC).
#
# @name: #optional net client name
#
# Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
#          Returns an error if the given @name doesn't exist, or given
#          NIC doesn't support rx-filter querying, or given net client
#          isn't a NIC.
#
# Since: 1.6
##
{ 'command': 'query-rx-filter', 'data': { '*name': 'str' },
  'returns': ['RxFilterInfo'] }
K
Kevin Wolf 已提交
3736

G
Gerd Hoffmann 已提交
3737 3738 3739 3740 3741 3742 3743 3744
##
# @InputButton
#
# Button of a pointer input device (mouse, tablet).
#
# Since: 2.0
##
{ 'enum'  : 'InputButton',
G
Gerd Hoffmann 已提交
3745
  'data'  : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down' ] }
G
Gerd Hoffmann 已提交
3746 3747

##
3748
# @InputAxis
G
Gerd Hoffmann 已提交
3749 3750 3751 3752 3753 3754
#
# Position axis of a pointer input device (mouse, tablet).
#
# Since: 2.0
##
{ 'enum'  : 'InputAxis',
G
Gerd Hoffmann 已提交
3755
  'data'  : [ 'x', 'y' ] }
G
Gerd Hoffmann 已提交
3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766

##
# @InputKeyEvent
#
# Keyboard input event.
#
# @key:    Which key this event is for.
# @down:   True for key-down and false for key-up events.
#
# Since: 2.0
##
3767
{ 'struct'  : 'InputKeyEvent',
G
Gerd Hoffmann 已提交
3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780
  'data'  : { 'key'     : 'KeyValue',
              'down'    : 'bool' } }

##
# @InputBtnEvent
#
# Pointer button input event.
#
# @button: Which button this event is for.
# @down:   True for key-down and false for key-up events.
#
# Since: 2.0
##
3781
{ 'struct'  : 'InputBtnEvent',
G
Gerd Hoffmann 已提交
3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795
  'data'  : { 'button'  : 'InputButton',
              'down'    : 'bool' } }

##
# @InputMoveEvent
#
# Pointer motion input event.
#
# @axis:   Which axis is referenced by @value.
# @value:  Pointer position.  For absolute coordinates the
#          valid range is 0 -> 0x7ffff
#
# Since: 2.0
##
3796
{ 'struct'  : 'InputMoveEvent',
G
Gerd Hoffmann 已提交
3797 3798 3799 3800 3801 3802 3803 3804
  'data'  : { 'axis'    : 'InputAxis',
              'value'   : 'int' } }

##
# @InputEvent
#
# Input event union.
#
3805 3806 3807 3808 3809
# @key: Input event of Keyboard
# @btn: Input event of pointer buttons
# @rel: Input event of relative pointer motion
# @abs: Input event of absolute pointer motion
#
G
Gerd Hoffmann 已提交
3810 3811 3812 3813 3814 3815 3816
# Since: 2.0
##
{ 'union' : 'InputEvent',
  'data'  : { 'key'     : 'InputKeyEvent',
              'btn'     : 'InputBtnEvent',
              'rel'     : 'InputMoveEvent',
              'abs'     : 'InputMoveEvent' } }
3817

M
Marcelo Tosatti 已提交
3818
##
3819
# @input-send-event
M
Marcelo Tosatti 已提交
3820 3821 3822
#
# Send input event(s) to guest.
#
3823 3824 3825
# @device: #optional display device to send event(s) to.
# @head: #optional head to send event(s) to, in case the
#        display device supports multiple scanouts.
M
Marcelo Tosatti 已提交
3826 3827 3828 3829
# @events: List of InputEvent union.
#
# Returns: Nothing on success.
#
3830 3831 3832 3833 3834 3835 3836 3837 3838 3839
# The @display and @head parameters can be used to send the input
# event to specific input devices in case (a) multiple input devices
# of the same kind are added to the virtual machine and (b) you have
# configured input routing (see docs/multiseat.txt) for those input
# devices.  The parameters work exactly like the device and head
# properties of input devices.  If @device is missing, only devices
# that have no input routing config are admissible.  If @device is
# specified, both input devices with and without input routing config
# are admissible, but devices with input routing config take
# precedence.
3840
#
3841
# Since: 2.6
M
Marcelo Tosatti 已提交
3842
##
3843
{ 'command': 'input-send-event',
3844 3845 3846
  'data': { '*device': 'str',
            '*head'  : 'int',
            'events' : [ 'InputEvent' ] } }
M
Marcelo Tosatti 已提交
3847

3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868
##
# @NumaOptions
#
# A discriminated record of NUMA options. (for OptsVisitor)
#
# Since 2.1
##
{ 'union': 'NumaOptions',
  'data': {
    'node': 'NumaNodeOptions' }}

##
# @NumaNodeOptions
#
# Create a guest NUMA node. (for OptsVisitor)
#
# @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
#
# @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
#         if omitted)
#
3869 3870 3871 3872 3873 3874
# @mem: #optional memory size of this node; mutually exclusive with @memdev.
#       Equally divide total memory among nodes if both @mem and @memdev are
#       omitted.
#
# @memdev: #optional memory backend object.  If specified for one node,
#          it must be specified for all nodes.
3875 3876 3877
#
# Since: 2.1
##
3878
{ 'struct': 'NumaNodeOptions',
3879 3880 3881
  'data': {
   '*nodeid': 'uint16',
   '*cpus':   ['uint16'],
3882 3883
   '*mem':    'size',
   '*memdev': 'str' }}
3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903

##
# @HostMemPolicy
#
# Host memory policy types
#
# @default: restore default policy, remove any nondefault policy
#
# @preferred: set the preferred host nodes for allocation
#
# @bind: a strict policy that restricts memory allocation to the
#        host nodes specified
#
# @interleave: memory allocations are interleaved across the set
#              of host nodes specified
#
# Since 2.1
##
{ 'enum': 'HostMemPolicy',
  'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
H
Hu Tao 已提交
3904 3905 3906 3907

##
# @Memdev:
#
3908
# Information about memory backend
H
Hu Tao 已提交
3909
#
3910
# @size: memory backend size
H
Hu Tao 已提交
3911 3912 3913
#
# @merge: enables or disables memory merge support
#
3914
# @dump: includes memory backend's memory in a core dump or not
H
Hu Tao 已提交
3915 3916 3917 3918 3919
#
# @prealloc: enables or disables memory preallocation
#
# @host-nodes: host nodes for its memory policy
#
3920
# @policy: memory policy of memory backend
H
Hu Tao 已提交
3921 3922 3923 3924
#
# Since: 2.1
##

3925
{ 'struct': 'Memdev',
H
Hu Tao 已提交
3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936
  'data': {
    'size':       'size',
    'merge':      'bool',
    'dump':       'bool',
    'prealloc':   'bool',
    'host-nodes': ['uint16'],
    'policy':     'HostMemPolicy' }}

##
# @query-memdev:
#
3937
# Returns information for all memory backends.
H
Hu Tao 已提交
3938 3939 3940 3941 3942 3943
#
# Returns: a list of @Memdev.
#
# Since: 2.1
##
{ 'command': 'query-memdev', 'returns': ['Memdev'] }
3944 3945

##
3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967
# @PCDIMMDeviceInfo:
#
# PCDIMMDevice state information
#
# @id: #optional device's ID
#
# @addr: physical address, where device is mapped
#
# @size: size of memory that the device provides
#
# @slot: slot number at which device is plugged in
#
# @node: NUMA node number where device is plugged in
#
# @memdev: memory backend linked with device
#
# @hotplugged: true if device was hotplugged
#
# @hotpluggable: true if device if could be added/removed while machine is running
#
# Since: 2.1
##
3968
{ 'struct': 'PCDIMMDeviceInfo',
3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996
  'data': { '*id': 'str',
            'addr': 'int',
            'size': 'int',
            'slot': 'int',
            'node': 'int',
            'memdev': 'str',
            'hotplugged': 'bool',
            'hotpluggable': 'bool'
          }
}

##
# @MemoryDeviceInfo:
#
# Union containing information about a memory device
#
# Since: 2.1
##
{ 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }

##
# @query-memory-devices
#
# Lists available memory devices and their state
#
# Since: 2.1
##
{ 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021

## @ACPISlotType
#
# @DIMM: memory slot
#
{ 'enum': 'ACPISlotType', 'data': [ 'DIMM' ] }

## @ACPIOSTInfo
#
# OSPM Status Indication for a device
# For description of possible values of @source and @status fields
# see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
#
# @device: #optional device ID associated with slot
#
# @slot: slot ID, unique per slot of a given @slot-type
#
# @slot-type: type of the slot
#
# @source: an integer containing the source event
#
# @status: an integer containing the status code
#
# Since: 2.1
##
4022
{ 'struct': 'ACPIOSTInfo',
4023 4024 4025 4026 4027
  'data'  : { '*device': 'str',
              'slot': 'str',
              'slot-type': 'ACPISlotType',
              'source': 'int',
              'status': 'int' } }
4028 4029 4030 4031 4032 4033 4034 4035 4036 4037

##
# @query-acpi-ospm-status
#
# Lists ACPI OSPM status of ACPI device objects,
# which might be reported via _OST method
#
# Since: 2.1
##
{ 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
4038

W
Wenchao Xia 已提交
4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057
##
# @WatchdogExpirationAction
#
# An enumeration of the actions taken when the watchdog device's timer is
# expired
#
# @reset: system resets
#
# @shutdown: system shutdown, note that it is similar to @powerdown, which
#            tries to set to system status and notify guest
#
# @poweroff: system poweroff, the emulator program exits
#
# @pause: system pauses, similar to @stop
#
# @debug: system enters debug state
#
# @none: nothing is done
#
4058 4059 4060
# @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
#              VCPUS on x86) (since 2.4)
#
W
Wenchao Xia 已提交
4061 4062 4063
# Since: 2.1
##
{ 'enum': 'WatchdogExpirationAction',
4064 4065
  'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
            'inject-nmi' ] }
W
Wenchao Xia 已提交
4066

4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080
##
# @IoOperationType
#
# An enumeration of the I/O operation types
#
# @read: read operation
#
# @write: write operation
#
# Since: 2.1
##
{ 'enum': 'IoOperationType',
  'data': [ 'read', 'write' ] }

W
Wenchao Xia 已提交
4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091
##
# @GuestPanicAction
#
# An enumeration of the actions taken when guest OS panic is detected
#
# @pause: system pauses
#
# Since: 2.1
##
{ 'enum': 'GuestPanicAction',
  'data': [ 'pause' ] }
4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103

##
# @rtc-reset-reinjection
#
# This command will reset the RTC interrupt reinjection backlog.
# Can be used if another mechanism to synchronize guest time
# is in effect, for example QEMU guest agent's guest-set-time
# command.
#
# Since: 2.1
##
{ 'command': 'rtc-reset-reinjection' }
4104 4105 4106

# Rocker ethernet network switch
{ 'include': 'qapi/rocker.json' }
4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124

##
# ReplayMode:
#
# Mode of the replay subsystem.
#
# @none: normal execution mode. Replay or record are not enabled.
#
# @record: record mode. All non-deterministic data is written into the
#          replay log.
#
# @play: replay mode. Non-deterministic data required for system execution
#        is read from the log.
#
# Since: 2.5
##
{ 'enum': 'ReplayMode',
  'data': [ 'none', 'record', 'play' ] }