hw/ppc: Remove unused ppcuic_init()
[qemu/ar7.git] / qapi / yank.json
blob167a775594ec626d27b264f9cbb966fe45c07325
1 # -*- Mode: Python -*-
2 # vim: filetype=python
5 ##
6 # = Yank feature
7 ##
9 ##
10 # @YankInstanceType:
12 # An enumeration of yank instance types. See @YankInstance for more
13 # information.
15 # Since: 6.0
17 { 'enum': 'YankInstanceType',
18   'data': [ 'block-node', 'chardev', 'migration' ] }
21 # @YankInstanceBlockNode:
23 # Specifies which block graph node to yank. See @YankInstance for more
24 # information.
26 # @node-name: the name of the block graph node
28 # Since: 6.0
30 { 'struct': 'YankInstanceBlockNode',
31   'data': { 'node-name': 'str' } }
34 # @YankInstanceChardev:
36 # Specifies which character device to yank. See @YankInstance for more
37 # information.
39 # @id: the chardev's ID
41 # Since: 6.0
43 { 'struct': 'YankInstanceChardev',
44   'data': { 'id': 'str' } }
47 # @YankInstance:
49 # A yank instance can be yanked with the @yank qmp command to recover from a
50 # hanging QEMU.
52 # Currently implemented yank instances:
53 #  - nbd block device:
54 #    Yanking it will shut down the connection to the nbd server without
55 #    attempting to reconnect.
56 #  - socket chardev:
57 #    Yanking it will shut down the connected socket.
58 #  - migration:
59 #    Yanking it will shut down all migration connections. Unlike
60 #    @migrate_cancel, it will not notify the migration process, so migration
61 #    will go into @failed state, instead of @cancelled state. @yank should be
62 #    used to recover from hangs.
64 # Since: 6.0
66 { 'union': 'YankInstance',
67   'base': { 'type': 'YankInstanceType' },
68   'discriminator': 'type',
69   'data': {
70       'block-node': 'YankInstanceBlockNode',
71       'chardev': 'YankInstanceChardev' } }
74 # @yank:
76 # Try to recover from hanging QEMU by yanking the specified instances. See
77 # @YankInstance for more information.
79 # Takes a list of @YankInstance as argument.
81 # Returns: - Nothing on success
82 #          - @DeviceNotFound error, if any of the YankInstances doesn't exist
84 # Example:
86 # -> { "execute": "yank",
87 #      "arguments": {
88 #          "instances": [
89 #               { "type": "block-node",
90 #                 "node-name": "nbd0" }
91 #          ] } }
92 # <- { "return": {} }
94 # Since: 6.0
96 { 'command': 'yank',
97   'data': { 'instances': ['YankInstance'] },
98   'allow-oob': true }
101 # @query-yank:
103 # Query yank instances. See @YankInstance for more information.
105 # Returns: list of @YankInstance
107 # Example:
109 # -> { "execute": "query-yank" }
110 # <- { "return": [
111 #          { "type": "block-node",
112 #            "node-name": "nbd0" }
113 #      ] }
115 # Since: 6.0
117 { 'command': 'query-yank',
118   'returns': ['YankInstance'],
119   'allow-oob': true }