Debian Codegraph @

modules/btrfs/data/org.freedesktop.UDisks2.btrfs.xml

raw
1 <!DOCTYPE node PUBLIC
2 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
3 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
4 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
5
6 <!--
7 Copyright (C) 2015 Peter Hatina <[email protected]>
8
9 This library is free software; you can redistribute it and/or
10 modify it under the terms of the GNU Lesser General Public
11 License as published by the Free Software Foundation; either
12 version 2 of the License, or (at your option) any later version.
13
14 This library is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 Lesser General Public License for more details.
18
19 You should have received a copy of the GNU Lesser General
20 Public License along with this library; if not, write to the
21 Free Software Foundation, Inc., 59 Temple Place, Suite 330,
22 Boston, MA 02111-1307, USA.
23 -->
24
25 <!-- ********************************************************************** -->
26
27 <!--
28 org.freedesktop.UDisks2.Manager.BTRFS:
29 @short_description: BTRFS add-on to the manager singleton
30 @since: 2.1.3
31
32 Additional interface with BTRFS specifics for top-level manager
33 singleton object located at the object path
34 <literal>/org/freedesktop/UDisks2/Manager</literal>.
35 -->
36 <interface name="org.freedesktop.UDisks2.Manager.BTRFS">
37 <!-- prereq: org.freedesktop.UDisks2.Manager -->
38
39 <!--
40 CreateVolume:
41 @devices: An array of object paths to objects implementing the #org.freedesktop.UDisks2.Block interface.
42 @label: The label for the new volume.
43 @data_level: The RAID level for the new volume.
44 @md_level: The RAID level for metadata.
45 @options: Additional options.
46 @since: 2.3.0
47
48 Creates a new volume from @devices.
49
50 No additional options are currently defined.
51
52 <emphasis>Changed in version 2.7.0.</emphasis>
53 -->
54 <method name="CreateVolume">
55 <arg name="devices" type="ao" direction="in"/>
56 <arg name="label" type="s" direction="in"/>
57 <arg name="data_level" type="s" direction="in"/>
58 <arg name="md_level" type="s" direction="in"/>
59 <arg name="options" type="a{sv}" direction="in"/>
60 </method>
61
62 </interface>
63
64 <!-- ********************************************************************** -->
65
66 <!--
67 org.freedesktop.UDisks2.Filesystem.BTRFS:
68 @short_description: BTRFS filesystem interface exported on block objects
69 @since: 2.1.3
70
71 This interface is used for #org.freedesktop.UDisks2.Block devices that
72 has been filtered through BTRFS plugin.
73 -->
74 <interface name="org.freedesktop.UDisks2.Filesystem.BTRFS">
75 <!-- prereq: org.freedesktop.UDisks2.Filesystem -->
76
77 <!--
78 AddDevice:
79 @device: Object path of a device to be added to BTRFS volume.
80 @options: Additional options.
81 @since: 2.3.0
82
83 Adds the @device to the volume.
84
85 No additional options are currently defined.
86
87 <emphasis>Changed in version 2.7.0.</emphasis>
88 -->
89 <method name="AddDevice">
90 <arg name="device" type="o" direction="in"/>
91 <arg name="options" type="a{sv}" direction="in"/>
92 </method>
93
94 <!--
95 RemoveDevice:
96 @device: Object path of a device to be removed from BTRFS volume.
97 @options: Additional options.
98 @since: 2.3.0
99
100 Removes the @device from the volume.
101
102 No additional options are currently defined.
103
104 <emphasis>Changed in version 2.7.0.</emphasis>
105 -->
106 <method name="RemoveDevice">
107 <arg name="device" type="o" direction="in"/>
108 <arg name="options" type="a{sv}" direction="in"/>
109 </method>
110
111 <!--
112 CreateSubvolume:
113 @name: Name of a new subvolume.
114 @options: Additional options.
115 @since: 2.1.3
116
117 Creates a new subvolume.
118
119 No additional options are currently defined.
120 -->
121 <method name="CreateSubvolume">
122 <arg name="name" direction="in" type="s"/>
123 <arg name="options" type="a{sv}" direction="in"/>
124 </method>
125
126 <!--
127 RemoveSubvolume:
128 @name: Name of the subvolume to be deleted.
129 @options: Additional options.
130 @since: 2.1.3
131
132 Deletes a subvolume.
133
134 No additional options are currently defined.
135 -->
136 <method name="RemoveSubvolume">
137 <arg name="name" direction="in" type="s"/>
138 <arg name="options" type="a{sv}" direction="in"/>
139 </method>
140
141 <!--
142 GetSubvolumes:
143 @snapshots_only: True if to list only snapshot subvolumes; False otherwise.
144 @subvolumes: Structure containing subvolume id, parent_id and path.
145 @subvolumes_cnt: The number of returned elements.
146 @options: Additional options.
147 @since: 2.1.3
148
149 Returns a list of subvolumes.
150
151 No additional options are currently defined.
152 -->
153 <method name="GetSubvolumes">
154 <arg name="snapshots_only" direction="in" type="b"/>
155 <arg name="subvolumes" direction="out" type="a(tts)"/>
156 <arg name="subvolumes_cnt" direction="out" type="i"/>
157 <arg name="options" type="a{sv}" direction="in"/>
158 </method>
159
160 <!--
161 CreateSnapshot:
162 @source: Name of the source subvolume.
163 @dest: Name for the new snapshot volume.
164 @ro: True if the snapshot should be read-only; False otherwise.
165 @options: Additional options.
166 @since: 2.1.3
167
168 Creates a snapshot.
169
170 No additional options are currently defined.
171 -->
172 <method name="CreateSnapshot">
173 <arg name="source" direction="in" type="s"/>
174 <arg name="dest" direction="in" type="s"/>
175 <arg name="ro" direction="in" type="b"/>
176 <arg name="options" type="a{sv}" direction="in"/>
177 </method>
178
179 <!--
180 Repair:
181 @options: Additional options.
182 @since: 2.3.0
183
184 Checks and repairs btrfs volume.
185
186 No additional options are currently defined.
187 -->
188 <method name="Repair">
189 <arg name="options" type="a{sv}" direction="in"/>
190 </method>
191
192 <!--
193 Resize:
194 @size: Requested new size in Bytes.
195 @options: Additional options.
196 @since: 2.3.0
197
198 Resizes the volume.
199
200 No additional options are currently defined.
201 -->
202 <method name="Resize">
203 <arg name="size" type="t" direction="in"/>
204 <arg name="options" type="a{sv}" direction="in"/>
205 </method>
206
207 <!--
208 SetLabel:
209 @label: New label.
210 @options: Additional options.
211 @since: 2.1.3
212
213 Sets a new label for the given volume.
214
215 No additional options are currently defined.
216 -->
217 <method name="SetLabel">
218 <arg name="label" direction="in" type="s"/>
219 <arg name="options" type="a{sv}" direction="in"/>
220 </method>
221
222 <!--
223 GetDefaultSubvolumeID:
224 @options: Additional options.
225 @since: 2.11.0
226
227 Returns the default subvolume id.
228
229 No additional options are currently defined.
230 -->
231 <method name="GetDefaultSubvolumeID">
232 <arg name="id" direction="out" type="u"/>
233 <arg name="options" type="a{sv}" direction="in"/>
234 </method>
235
236 <!--
237 SetDefaultSubvolumeID:
238 @id: New default subvolume id.
239 @options: Additional options.
240 @since: 2.11.0
241
242 Sets the default subvolume id.
243
244 No additional options are currently defined.
245 -->
246 <method name="SetDefaultSubvolumeID">
247 <arg name="id" direction="in" type="u"/>
248 <arg name="options" type="a{sv}" direction="in"/>
249 </method>
250
251 <property name="label" type="s" access="read"/>
252 <property name="uuid" type="s" access="read"/>
253 <property name="num_devices" type="t" access="read"/>
254 <property name="used" type="t" access="read"/>
255 </interface>
256 </node>