qapi-schema.json

   1 # -*- Mode: Python -*-
   2 #
   3 # QAPI Schema
   4
   5 ##
   6 # @NameInfo:
   7 #
   8 # Guest name information.
   9 #
  10 # @name: #optional The name of the guest
  11 #
  12 # Since 0.14.0
  13 ##
  14 { 'type': 'NameInfo', 'data': {'*name': 'str'} }
  15
  16 ##
  17 # @query-name:
  18 #
  19 # Return the name information of a guest.
  20 #
  21 # Returns: @NameInfo of the guest
  22 #
  23 # Since 0.14.0
  24 ##
  25 { 'command': 'query-name', 'returns': 'NameInfo' }
  26
  27 ##
  28 # @VersionInfo:
  29 #
  30 # A description of QEMU's version.
  31 #
  32 # @qemu.major:  The major version of QEMU
  33 #
  34 # @qemu.minor:  The minor version of QEMU
  35 #
  36 # @qemu.micro:  The micro version of QEMU.  By current convention, a micro
  37 #               version of 50 signifies a development branch.  A micro version
  38 #               greater than or equal to 90 signifies a release candidate for
  39 #               the next minor version.  A micro version of less than 50
  40 #               signifies a stable release.
  41 #
  42 # @package:     QEMU will always set this field to an empty string.  Downstream
  43 #               versions of QEMU should set this to a non-empty string.  The
  44 #               exact format depends on the downstream however it highly
  45 #               recommended that a unique name is used.
  46 #
  47 # Since: 0.14.0
  48 ##
  49 { 'type': 'VersionInfo',
  50   'data': {'qemu': {'major': 'int', 'minor': 'int', 'micro': 'int'},
  51            'package': 'str'} }
  52
  53 ##
  54 # @query-version:
  55 #
  56 # Returns the current version of QEMU.
  57 #
  58 # Returns:  A @VersionInfo object describing the current version of QEMU.
  59 #
  60 # Since: 0.14.0
  61 ##
  62 { 'command': 'query-version', 'returns': 'VersionInfo' }