1# -*- Mode: Python -*- 2# 3 4## 5# = Transactions 6## 7 8{ 'include': 'block.json' } 9 10## 11# @Abort: 12# 13# This action can be used to test transaction failure. 14# 15# Since: 1.6 16## 17{ 'struct': 'Abort', 18 'data': { } } 19 20## 21# @ActionCompletionMode: 22# 23# An enumeration of Transactional completion modes. 24# 25# @individual: Do not attempt to cancel any other Actions if any Actions fail 26# after the Transaction request succeeds. All Actions that 27# can complete successfully will do so without waiting on others. 28# This is the default. 29# 30# @grouped: If any Action fails after the Transaction succeeds, cancel all 31# Actions. Actions do not complete until all Actions are ready to 32# complete. May be rejected by Actions that do not support this 33# completion mode. 34# 35# Since: 2.5 36## 37{ 'enum': 'ActionCompletionMode', 38 'data': [ 'individual', 'grouped' ] } 39 40## 41# @TransactionAction: 42# 43# A discriminated record of operations that can be performed with 44# @transaction. Action @type can be: 45# 46# - @abort: since 1.6 47# - @block-dirty-bitmap-add: since 2.5 48# - @block-dirty-bitmap-clear: since 2.5 49# - @blockdev-backup: since 2.3 50# - @blockdev-snapshot: since 2.5 51# - @blockdev-snapshot-internal-sync: since 1.7 52# - @blockdev-snapshot-sync: since 1.1 53# - @drive-backup: since 1.6 54# 55# Since: 1.1 56## 57{ 'union': 'TransactionAction', 58 'data': { 59 'abort': 'Abort', 60 'block-dirty-bitmap-add': 'BlockDirtyBitmapAdd', 61 'block-dirty-bitmap-clear': 'BlockDirtyBitmap', 62 'blockdev-backup': 'BlockdevBackup', 63 'blockdev-snapshot': 'BlockdevSnapshot', 64 'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal', 65 'blockdev-snapshot-sync': 'BlockdevSnapshotSync', 66 'drive-backup': 'DriveBackup' 67 } } 68 69## 70# @TransactionProperties: 71# 72# Optional arguments to modify the behavior of a Transaction. 73# 74# @completion-mode: Controls how jobs launched asynchronously by 75# Actions will complete or fail as a group. 76# See @ActionCompletionMode for details. 77# 78# Since: 2.5 79## 80{ 'struct': 'TransactionProperties', 81 'data': { 82 '*completion-mode': 'ActionCompletionMode' 83 } 84} 85 86## 87# @transaction: 88# 89# Executes a number of transactionable QMP commands atomically. If any 90# operation fails, then the entire set of actions will be abandoned and the 91# appropriate error returned. 92# 93# For external snapshots, the dictionary contains the device, the file to use for 94# the new snapshot, and the format. The default format, if not specified, is 95# qcow2. 96# 97# Each new snapshot defaults to being created by QEMU (wiping any 98# contents if the file already exists), but it is also possible to reuse 99# an externally-created file. In the latter case, you should ensure that 100# the new image file has the same contents as the current one; QEMU cannot 101# perform any meaningful check. Typically this is achieved by using the 102# current image file as the backing file for the new image. 103# 104# On failure, the original disks pre-snapshot attempt will be used. 105# 106# For internal snapshots, the dictionary contains the device and the snapshot's 107# name. If an internal snapshot matching name already exists, the request will 108# be rejected. Only some image formats support it, for example, qcow2, rbd, 109# and sheepdog. 110# 111# On failure, qemu will try delete the newly created internal snapshot in the 112# transaction. When an I/O error occurs during deletion, the user needs to fix 113# it later with qemu-img or other command. 114# 115# @actions: List of @TransactionAction; 116# information needed for the respective operations. 117# 118# @properties: structure of additional options to control the 119# execution of the transaction. See @TransactionProperties 120# for additional detail. 121# 122# Returns: nothing on success 123# 124# Errors depend on the operations of the transaction 125# 126# Note: The transaction aborts on the first failure. Therefore, there will be 127# information on only one failed operation returned in an error condition, and 128# subsequent actions will not have been attempted. 129# 130# Since: 1.1 131# 132# Example: 133# 134# -> { "execute": "transaction", 135# "arguments": { "actions": [ 136# { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0", 137# "snapshot-file": "/some/place/my-image", 138# "format": "qcow2" } }, 139# { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile", 140# "snapshot-file": "/some/place/my-image2", 141# "snapshot-node-name": "node3432", 142# "mode": "existing", 143# "format": "qcow2" } }, 144# { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1", 145# "snapshot-file": "/some/place/my-image2", 146# "mode": "existing", 147# "format": "qcow2" } }, 148# { "type": "blockdev-snapshot-internal-sync", "data" : { 149# "device": "ide-hd2", 150# "name": "snapshot0" } } ] } } 151# <- { "return": {} } 152# 153## 154{ 'command': 'transaction', 155 'data': { 'actions': [ 'TransactionAction' ], 156 '*properties': 'TransactionProperties' 157 } 158} 159