← Back to branch summary

~pmdj/ubuntu/trusty/qemu/2.9+applesmc+fadtv3

« back to all changes in this revision

Viewing changes to qapi/block.json

  • Committer: Phil Dennis-Jordan
  • Date: 2017-07-21 08:03:43 UTC
  • mfrom: (1.1.1)
  • Revision ID: phil@philjordan.eu-20170721080343-2yr2vdj7713czahv
New upstream release 2.9.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qapi/block.json
1
1
# -*- Mode: Python -*-
2
 
#
3
 
# QAPI block definitions (vm related)
 
2
 
 
3
##
 
4
# = QAPI block definitions
 
5
##
4
6
 
5
7
# QAPI block core definitions
6
8
{ 'include': 'block-core.json' }
7
9
 
8
10
##
 
11
# == QAPI block definitions (vm unrelated)
 
12
##
 
13
 
 
14
##
9
15
# @BiosAtaTranslation:
10
16
#
11
17
# Policy that BIOS should use to interpret cylinder/head/sector
75
81
##
76
82
# @blockdev-snapshot-internal-sync:
77
83
#
78
 
# Synchronously take an internal snapshot of a block device, when the format
79
 
# of the image used supports it.
 
84
# Synchronously take an internal snapshot of a block device, when the
 
85
# format of the image used supports it. If the name is an empty
 
86
# string, or a snapshot with name already exists, the operation will
 
87
# fail.
80
88
#
81
89
# For the arguments, see the documentation of BlockdevSnapshotInternal.
82
90
#
83
91
# Returns: nothing on success
 
92
#
84
93
#          If @device is not a valid block device, GenericError
 
94
#
85
95
#          If any snapshot matching @name exists, or @name is empty,
86
96
#          GenericError
 
97
#
87
98
#          If the format of the image used does not support it,
88
99
#          BlockFormatFeatureNotSupported
89
100
#
90
101
# Since: 1.7
 
102
#
 
103
# Example:
 
104
#
 
105
# -> { "execute": "blockdev-snapshot-internal-sync",
 
106
#      "arguments": { "device": "ide-hd0",
 
107
#                     "name": "snapshot0" }
 
108
#    }
 
109
# <- { "return": {} }
 
110
#
91
111
##
92
112
{ 'command': 'blockdev-snapshot-internal-sync',
93
113
  'data': 'BlockdevSnapshotInternal' }
115
135
#          If @id and @name are both not specified, GenericError
116
136
#
117
137
# Since: 1.7
 
138
#
 
139
# Example:
 
140
#
 
141
# -> { "execute": "blockdev-snapshot-delete-internal-sync",
 
142
#      "arguments": { "device": "ide-hd0",
 
143
#                     "name": "snapshot0" }
 
144
#    }
 
145
# <- { "return": {
 
146
#                    "id": "1",
 
147
#                    "name": "snapshot0",
 
148
#                    "vm-state-size": 0,
 
149
#                    "date-sec": 1000012,
 
150
#                    "date-nsec": 10,
 
151
#                    "vm-clock-sec": 100,
 
152
#                    "vm-clock-nsec": 20
 
153
#      }
 
154
#    }
 
155
#
118
156
##
119
157
{ 'command': 'blockdev-snapshot-delete-internal-sync',
120
158
  'data': { 'device': 'str', '*id': 'str', '*name': 'str'},
125
163
#
126
164
# Ejects a device from a removable drive.
127
165
#
128
 
# @device:  #optional Block device name (deprecated, use @id instead)
129
 
#
130
 
# @id:      #optional The name or QOM path of the guest device (since: 2.8)
131
 
#
132
 
# @force:   @optional If true, eject regardless of whether the drive is locked.
 
166
# @device:  Block device name (deprecated, use @id instead)
 
167
#
 
168
# @id:      The name or QOM path of the guest device (since: 2.8)
 
169
#
 
170
# @force:   If true, eject regardless of whether the drive is locked.
133
171
#           If not specified, the default value is false.
134
172
#
135
173
# Returns:  Nothing on success
 
174
#
136
175
#           If @device is not a valid block device, DeviceNotFound
137
176
#
138
 
# Notes:    Ejecting a device will no media results in success
 
177
# Notes:    Ejecting a device with no media results in success
139
178
#
140
179
# Since: 0.14.0
 
180
#
 
181
# Example:
 
182
#
 
183
# -> { "execute": "eject", "arguments": { "device": "ide1-0-1" } }
 
184
# <- { "return": {} }
141
185
##
142
186
{ 'command': 'eject',
143
187
  'data': { '*device': 'str',
171
215
# @device: The device name or node name of the node to be exported
172
216
#
173
217
# @writable: Whether clients should be able to write to the device via the
174
 
#     NBD connection (default false). #optional
 
218
#     NBD connection (default false).
175
219
#
176
220
# Returns: error if the device is already marked for export.
177
221
#
204
248
# @tray-open: true if the tray has been opened or false if it has been closed
205
249
#
206
250
# Since: 1.1
 
251
#
 
252
# Example:
 
253
#
 
254
# <- { "event": "DEVICE_TRAY_MOVED",
 
255
#      "data": { "device": "ide1-cd0",
 
256
#                "id": "/machine/unattached/device[22]",
 
257
#                "tray-open": true
 
258
#      },
 
259
#      "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
 
260
#
207
261
##
208
262
{ 'event': 'DEVICE_TRAY_MOVED',
209
263
  'data': { 'device': 'str', 'id': 'str', 'tray-open': 'bool' } }