Debian Codegraph @

doc/html/gdbus-org.freedesktop.UDisks2.MDRaid.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>org.freedesktop.UDisks2.MDRaid: UDisks Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="UDisks Reference Manual">
8 <link rel="up" href="ch03.html" title="D-Bus Interfaces">
9 <link rel="prev" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html" title="org.freedesktop.UDisks2.Drive.Ata">
10 <link rel="next" href="gdbus-org.freedesktop.UDisks2.Block.html" title="org.freedesktop.UDisks2.Block">
11 <meta name="generator" content="GTK-Doc V1.35.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#gdbus-org.freedesktop.UDisks2.MDRaid.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
19 <a href="#gdbus-org.freedesktop.UDisks2.MDRaid.properties" class="shortcut">Properties</a></span>
20 </td>
21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22 <td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23 <td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.Drive.Ata.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24 <td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.Block.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25 </tr></table>
26 <div class="refentry">
27 <a name="gdbus-org.freedesktop.UDisks2.MDRaid"></a><div class="titlepage"></div>
28 <div class="refnamediv"><table width="100%"><tr>
29 <td valign="top">
30 <h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-MDRaid.top_of_page"></a>org.freedesktop.UDisks2.MDRaid</span></h2>
31 <p>org.freedesktop.UDisks2.MDRaid — Linux Software RAID</p>
32 </td>
33 <td class="gallery_image" valign="top" align="right"></td>
34 </tr></table></div>
35 <div class="refsynopsisdiv">
36 <h2>Methods</h2>
37 <pre class="synopsis">
38 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-method-org-freedesktop-UDisks2-MDRaid.Start" title="The Start() method">Start</a> (IN a{sv} options);
39 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-method-org-freedesktop-UDisks2-MDRaid.Stop" title="The Stop() method">Stop</a> (IN a{sv} options);
40 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-method-org-freedesktop-UDisks2-MDRaid.RemoveDevice" title="The RemoveDevice() method">RemoveDevice</a> (IN o device,
41 IN a{sv} options);
42 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-method-org-freedesktop-UDisks2-MDRaid.AddDevice" title="The AddDevice() method">AddDevice</a> (IN o device,
43 IN a{sv} options);
44 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-method-org-freedesktop-UDisks2-MDRaid.SetBitmapLocation" title="The SetBitmapLocation() method">SetBitmapLocation</a> (IN ay value,
45 IN a{sv} options);
46 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-method-org-freedesktop-UDisks2-MDRaid.RequestSyncAction" title="The RequestSyncAction() method">RequestSyncAction</a> (IN s sync_action,
47 IN a{sv} options);
48 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-method-org-freedesktop-UDisks2-MDRaid.Delete" title="The Delete() method">Delete</a> (IN a{sv} options);
49 </pre>
50 </div>
51 <div class="refsect1">
52 <a name="id-1.3.3.5.4"></a><h2>Properties</h2>
53 <pre class="synopsis">
54 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.UUID" title='The "UUID" property'>UUID</a> readable s
55 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.Name" title='The "Name" property'>Name</a> readable s
56 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.Level" title='The "Level" property'>Level</a> readable s
57 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.NumDevices" title='The "NumDevices" property'>NumDevices</a> readable u
58 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.Size" title='The "Size" property'>Size</a> readable t
59 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.SyncAction" title='The "SyncAction" property'>SyncAction</a> readable s
60 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.SyncCompleted" title='The "SyncCompleted" property'>SyncCompleted</a> readable d
61 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.SyncRate" title='The "SyncRate" property'>SyncRate</a> readable t
62 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.SyncRemainingTime" title='The "SyncRemainingTime" property'>SyncRemainingTime</a> readable t
63 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.Degraded" title='The "Degraded" property'>Degraded</a> readable u
64 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.ConsistencyPolicy" title='The "ConsistencyPolicy" property'>ConsistencyPolicy</a> readable s
65 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.BitmapLocation" title='The "BitmapLocation" property'>BitmapLocation</a> readable ay
66 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.ChunkSize" title='The "ChunkSize" property'>ChunkSize</a> readable t
67 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.ActiveDevices" title='The "ActiveDevices" property'>ActiveDevices</a> readable a(oiasta{sv})
68 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.ChildConfiguration" title='The "ChildConfiguration" property'>ChildConfiguration</a> readable a(sa{sv})
69 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.Running" title='The "Running" property'>Running</a> readable b
70 </pre>
71 </div>
72 <div class="refsect1">
73 <a name="gdbus-interface-org-freedesktop-UDisks2-MDRaid"></a><h2>Description</h2>
74 <p>
75 Objects implementing this interface represent
76 <a class="ulink" href="https://docs.kernel.org/admin-guide/md.html" target="_top">Linux Software RAID arrays</a>
77 detected on the system. Both running and not-running arrays are represented.
78 </p>
79 <p>
80 Block devices point to objects implementing this interface, see
81 the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.MDRaid" title='The "MDRaid" property'>"MDRaid"</a> and
82 <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.MDRaidMember" title='The "MDRaidMember" property'>"MDRaidMember"</a> properties on the
83 <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> D-Bus interface.
84 </p>
85 <p class="since">Since 2.0.0</p>
86 </div>
87 <div class="refsect1">
88 <a name="gdbus-methods-org.freedesktop.UDisks2.MDRaid"></a><h2>Method Details</h2>
89 <div class="refsect2">
90 <a name="gdbus-method-org-freedesktop-UDisks2-MDRaid.Start"></a><h3>The Start() method</h3>
91 <pre class="programlisting">
92 Start (IN a{sv} options);
93 </pre>
94 <p>
95 Starts the RAID array.
96 </p>
97 <p>
98 If the <em class="parameter"><code>option</code></em> parameter contains the key <em class="parameter"><code>start</code></em>-degraded with
99 the value <code class="constant">TRUE</code>, the array will be started even if some members
100 are missing.
101 </p>
102 <div class="variablelist"><table border="0" class="variablelist">
103 <colgroup>
104 <col align="left" valign="top">
105 <col>
106 </colgroup>
107 <tbody><tr>
108 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
109 <td><p>
110 Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>start-degraded</code></em> (of type 'b').
111 </p></td>
112 </tr></tbody>
113 </table></div>
114 <p class="since">Since 2.0.0</p>
115 </div>
116 <hr>
117 <div class="refsect2">
118 <a name="gdbus-method-org-freedesktop-UDisks2-MDRaid.Stop"></a><h3>The Stop() method</h3>
119 <pre class="programlisting">
120 Stop (IN a{sv} options);
121 </pre>
122 <p>
123 Stops the RAID array.
124 </p>
125 <div class="variablelist"><table border="0" class="variablelist">
126 <colgroup>
127 <col align="left" valign="top">
128 <col>
129 </colgroup>
130 <tbody><tr>
131 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
132 <td><p>
133 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
134 </p></td>
135 </tr></tbody>
136 </table></div>
137 <p class="since">Since 2.0.0</p>
138 </div>
139 <hr>
140 <div class="refsect2">
141 <a name="gdbus-method-org-freedesktop-UDisks2-MDRaid.RemoveDevice"></a><h3>The RemoveDevice() method</h3>
142 <pre class="programlisting">
143 RemoveDevice (IN o device,
144 IN a{sv} options);
145 </pre>
146 <p>
147 Removes <em class="parameter"><code>device</code></em> from the array.
148 </p>
149 <p>
150 For this to work <em class="parameter"><code>device</code></em> must already be associated with the
151 array, e.g. referenced in the
152 <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.ActiveDevices" title='The "ActiveDevices" property'>"ActiveDevices"</a> property.
153 </p>
154 <p>
155 If the <em class="parameter"><code>option</code></em> parameter contains the key <em class="parameter"><code>wipe</code></em> with the value
156 <code class="constant">TRUE</code>, all known filesystem signatures will be erased from the
157 <em class="parameter"><code>device</code></em> after removal.
158 </p>
159 <div class="variablelist"><table border="0" class="variablelist">
160 <colgroup>
161 <col align="left" valign="top">
162 <col>
163 </colgroup>
164 <tbody>
165 <tr>
166 <td><p><span class="term"><code class="literal">IN o <em class="parameter"><code>device</code></em></code>:</span></p></td>
167 <td><p>
168 An object path to an object implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> interface.
169 </p></td>
170 </tr>
171 <tr>
172 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
173 <td><p>
174 Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>wipe</code></em> (of type 'b').
175 </p></td>
176 </tr>
177 </tbody>
178 </table></div>
179 <p class="since">Since 2.0.0</p>
180 </div>
181 <hr>
182 <div class="refsect2">
183 <a name="gdbus-method-org-freedesktop-UDisks2-MDRaid.AddDevice"></a><h3>The AddDevice() method</h3>
184 <pre class="programlisting">
185 AddDevice (IN o device,
186 IN a{sv} options);
187 </pre>
188 <p>
189 Adds <em class="parameter"><code>device</code></em> to the array.
190 </p>
191 <div class="variablelist"><table border="0" class="variablelist">
192 <colgroup>
193 <col align="left" valign="top">
194 <col>
195 </colgroup>
196 <tbody>
197 <tr>
198 <td><p><span class="term"><code class="literal">IN o <em class="parameter"><code>device</code></em></code>:</span></p></td>
199 <td><p>
200 An object path to an object implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> interface.
201 </p></td>
202 </tr>
203 <tr>
204 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
205 <td><p>
206 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
207 </p></td>
208 </tr>
209 </tbody>
210 </table></div>
211 <p class="since">Since 2.0.0</p>
212 </div>
213 <hr>
214 <div class="refsect2">
215 <a name="gdbus-method-org-freedesktop-UDisks2-MDRaid.SetBitmapLocation"></a><h3>The SetBitmapLocation() method</h3>
216 <pre class="programlisting">
217 SetBitmapLocation (IN ay value,
218 IN a{sv} options);
219 </pre>
220 <p>
221 Sets whether the array has a write-intent bitmap.
222 </p>
223 <div class="variablelist"><table border="0" class="variablelist">
224 <colgroup>
225 <col align="left" valign="top">
226 <col>
227 </colgroup>
228 <tbody>
229 <tr>
230 <td><p><span class="term"><code class="literal">IN ay <em class="parameter"><code>value</code></em></code>:</span></p></td>
231 <td><p>
232 The value for the bitmap, currently only the values 'none' and 'internal' are supported.
233 </p></td>
234 </tr>
235 <tr>
236 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
237 <td><p>
238 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
239 </p></td>
240 </tr>
241 </tbody>
242 </table></div>
243 <p class="since">Since 2.0.0</p>
244 </div>
245 <hr>
246 <div class="refsect2">
247 <a name="gdbus-method-org-freedesktop-UDisks2-MDRaid.RequestSyncAction"></a><h3>The RequestSyncAction() method</h3>
248 <pre class="programlisting">
249 RequestSyncAction (IN s sync_action,
250 IN a{sv} options);
251 </pre>
252 <p>
253 This method call can be used to trigger and cancel data
254 redundancy checks and repairs. Currently only the values
255 <code class="literal">check</code>, <code class="literal">repair</code> and
256 <code class="literal">idle</code> can be used for <em class="parameter"><code>sync_action</code></em>.
257 </p>
258 <p>
259 See also the property <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.SyncAction" title='The "SyncAction" property'>"SyncAction"</a>.
260 </p>
261 <p>
262 This method call is similar to writing to the
263 <code class="literal">sync_action</code> sysfs file, see the
264 <code class="filename"><a class="ulink" href="https://www.kernel.org/doc/Documentation/admin-guide/md.rst" target="_top">Documentation/admin-guide/md.rst</a></code>
265 file shipped with the kernel sources.
266 </p>
267 <p>
268 If the <em class="parameter"><code>option</code></em> parameter contains the key <em class="parameter"><code>no</code></em>-inhibit-lock with the value
269 <code class="constant">TRUE</code>, no system inhibit lock is attempted to be acquired that would otherwise
270 prevent the system to shutdown, reboot, sleep or hibernate.
271 </p>
272 <div class="variablelist"><table border="0" class="variablelist">
273 <colgroup>
274 <col align="left" valign="top">
275 <col>
276 </colgroup>
277 <tbody>
278 <tr>
279 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>sync_action</code></em></code>:</span></p></td>
280 <td><p>
281 The action to request.
282 </p></td>
283 </tr>
284 <tr>
285 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
286 <td><p>
287 Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>no-inhibit-lock</code></em> (of type 'b').
288 </p></td>
289 </tr>
290 </tbody>
291 </table></div>
292 <p class="since">Since 2.0.0</p>
293 </div>
294 <hr>
295 <div class="refsect2">
296 <a name="gdbus-method-org-freedesktop-UDisks2-MDRaid.Delete"></a><h3>The Delete() method</h3>
297 <pre class="programlisting">
298 Delete (IN a{sv} options);
299 </pre>
300 <p>
301 </p>
302 <p>
303 <em class="parameter"><code>options</code></em>: Options.
304 </p>
305 <p>
306 Stops the RAID array and destroys all RAID metadata on member devices.
307 </p>
308 <p>
309 If the option <em class="parameter"><code>tear-down</code></em> is set to
310 <code class="constant">TRUE</code>, then the RAID array block device and all its children
311 will be cleaned up before stopping. This cleanup consists of
312 removing entries from /etc/fstab and /etc/crypttab, and
313 locking of encrypted block devices. Entries in /etc/fstab
314 and /etc/crypttab that have been created with the
315 'track-parents' options to AddConfigurationItem will be
316 removed even if their block device is currently unavailable.
317 </p>
318 <div class="variablelist"><table border="0" class="variablelist">
319 <colgroup>
320 <col align="left" valign="top">
321 <col>
322 </colgroup>
323 <tbody><tr>
324 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
325 <td>
326 <p>
327 </p>
328 <p>
329 </p>
330 </td>
331 </tr></tbody>
332 </table></div>
333 <p class="since">Since 2.0.0</p>
334 </div>
335 </div>
336 <div class="refsect1">
337 <a name="gdbus-properties-org.freedesktop.UDisks2.MDRaid"></a><h2>Property Details</h2>
338 <div class="refsect2">
339 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.UUID"></a><h3>The "UUID" property</h3>
340 <pre class="programlisting">
341 UUID readable s
342 </pre>
343 <p>
344 </p>
345 <p>
346 The UUID of the array.
347 </p>
348 <p class="since">Since 2.0.0</p>
349 </div>
350 <hr>
351 <div class="refsect2">
352 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.Name"></a><h3>The "Name" property</h3>
353 <pre class="programlisting">
354 Name readable s
355 </pre>
356 <p>
357 </p>
358 <p>
359 The name of the array (TODO: homehost etc).
360 </p>
361 <p class="since">Since 2.0.0</p>
362 </div>
363 <hr>
364 <div class="refsect2">
365 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.Level"></a><h3>The "Level" property</h3>
366 <pre class="programlisting">
367 Level readable s
368 </pre>
369 <p>
370 </p>
371 <p>
372 The RAID level.
373 </p>
374 <p>
375 Known values include <code class="literal">raid0</code>, <code class="literal">raid1</code>, <code class="literal">raid4</code>, <code class="literal">raid5</code>, <code class="literal">raid6</code> and <code class="literal">raid10</code>.
376 </p>
377 <p class="since">Since 2.0.0</p>
378 </div>
379 <hr>
380 <div class="refsect2">
381 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.NumDevices"></a><h3>The "NumDevices" property</h3>
382 <pre class="programlisting">
383 NumDevices readable u
384 </pre>
385 <p>
386 </p>
387 <p>
388 Number of devices that are part of the array.
389 </p>
390 <p class="since">Since 2.0.0</p>
391 </div>
392 <hr>
393 <div class="refsect2">
394 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.Size"></a><h3>The "Size" property</h3>
395 <pre class="programlisting">
396 Size readable t
397 </pre>
398 <p>
399 </p>
400 <p>
401 The size of the array or 0 if unknown.
402 </p>
403 <p>
404 This is the usable size, e.g. for a RAID-5 array backed by 4
405 1TB disks, this will be approximately 3 TB.
406 </p>
407 <p class="since">Since 2.0.0</p>
408 </div>
409 <hr>
410 <div class="refsect2">
411 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.SyncAction"></a><h3>The "SyncAction" property</h3>
412 <pre class="programlisting">
413 SyncAction readable s
414 </pre>
415 <p>
416 </p>
417 <p>
418 The current state of the array or empty if the array is not
419 running or if the array does not have any redundancy
420 (e.g. RAID-0 or linear).
421 </p>
422 <p>
423 Use the <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-method-org-freedesktop-UDisks2-MDRaid.RequestSyncAction" title="The RequestSyncAction() method">RequestSyncAction()</a>
424 method to change this.
425 </p>
426 <p>
427 This property corresponds to the
428 <code class="literal">sync_action</code> sysfs file, see the
429 <code class="filename"><a class="ulink" href="https://www.kernel.org/doc/Documentation/admin-guide/md.rst" target="_top">Documentation/admin-guide/md.rst</a></code>
430 file shipped with the kernel sources.
431 </p>
432 <p class="since">Since 2.0.0</p>
433 </div>
434 <hr>
435 <div class="refsect2">
436 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.SyncCompleted"></a><h3>The "SyncCompleted" property</h3>
437 <pre class="programlisting">
438 SyncCompleted readable d
439 </pre>
440 <p>
441 </p>
442 <p>
443 The fraction or sectors completed (always between <code class="constant">0.0</code> and <code class="constant">1.0</code>) in the sync operation or 0.0 if no operation is in progress.
444 </p>
445 <p>
446 This property corresponds to the
447 <code class="literal">sync_completed</code> sysfs file, see the
448 <code class="filename"><a class="ulink" href="https://www.kernel.org/doc/Documentation/admin-guide/md.rst" target="_top">Documentation/admin-guide/md.rst</a></code>
449 file shipped with the kernel sources.
450 </p>
451 <p class="since">Since 2.0.0</p>
452 </div>
453 <hr>
454 <div class="refsect2">
455 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.SyncRate"></a><h3>The "SyncRate" property</h3>
456 <pre class="programlisting">
457 SyncRate readable t
458 </pre>
459 <p>
460 </p>
461 <p>
462 The rate (or speed) at which the sync operation takes
463 place. It is averaged over the last 30 seconds and measured
464 in bytes per second.
465 </p>
466 <p>
467 If the rate is unknown or no operation is in progress, the
468 value of this property is 0.
469 </p>
470 <p>
471 This property corresponds to the
472 <code class="literal">sync_speed</code> sysfs file, see the
473 <code class="filename"><a class="ulink" href="https://www.kernel.org/doc/Documentation/admin-guide/md.rst" target="_top">Documentation/admin-guide/md.rst</a></code>
474 file shipped with the kernel sources.
475 </p>
476 <p class="since">Since 2.0.0</p>
477 </div>
478 <hr>
479 <div class="refsect2">
480 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.SyncRemainingTime"></a><h3>The "SyncRemainingTime" property</h3>
481 <pre class="programlisting">
482 SyncRemainingTime readable t
483 </pre>
484 <p>
485 </p>
486 <p>
487 The estimated number of micro-seconds until the operation is
488 finished
489 </p>
490 <p>
491 If the amount of remaining time is unknown or no operation is
492 in progress, the value of this property is 0.
493 </p>
494 <p>
495 This property is based on the value of the
496 <code class="literal">sync_speed</code> sysfs file, see the
497 <code class="filename"><a class="ulink" href="https://www.kernel.org/doc/Documentation/admin-guide/md.rst" target="_top">Documentation/admin-guide/md.rst</a></code>
498 file shipped with the kernel sources.
499 </p>
500 <p class="since">Since 2.0.0</p>
501 </div>
502 <hr>
503 <div class="refsect2">
504 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.Degraded"></a><h3>The "Degraded" property</h3>
505 <pre class="programlisting">
506 Degraded readable u
507 </pre>
508 <p>
509 </p>
510 <p>
511 Number of devices by which the array is degraded (0 if not degraded or not running).
512 </p>
513 <p>
514 This property corresponds to the
515 <code class="literal">degraded</code> sysfs file, see the
516 <code class="filename"><a class="ulink" href="https://www.kernel.org/doc/Documentation/admin-guide/md.rst" target="_top">Documentation/admin-guide/md.rst</a></code>
517 file shipped with the kernel sources.
518 </p>
519 <p class="since">Since 2.0.0</p>
520 </div>
521 <hr>
522 <div class="refsect2">
523 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.ConsistencyPolicy"></a><h3>The "ConsistencyPolicy" property</h3>
524 <pre class="programlisting">
525 ConsistencyPolicy readable s
526 </pre>
527 <p>
528 </p>
529 <p>
530 <em class="parameter"><code>since</code></em>: 2.11.0
531 The consistency policy of the array.
532 </p>
533 <p>
534 If the RAID array does not support consistency policies (for
535 example RAID-0 arrays), this is empty.
536 </p>
537 <p>
538 This property corresponds to the
539 <code class="literal">consistency_policy</code> sysfs file.
540 </p>
541 <p class="since">Since 2.0.0</p>
542 </div>
543 <hr>
544 <div class="refsect2">
545 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.BitmapLocation"></a><h3>The "BitmapLocation" property</h3>
546 <pre class="programlisting">
547 BitmapLocation readable ay
548 </pre>
549 <p>
550 </p>
551 <p>
552 The location of a write-intent bitmap (empty if the array is not running), if any.
553 </p>
554 <p>
555 If the RAID array does not support write-intent bitmaps (for
556 example RAID-0 arrays), this is empty.
557 </p>
558 <p>
559 This property corresponds to the
560 <code class="literal">bitmap/location</code> sysfs file, see the
561 <code class="filename"><a class="ulink" href="https://www.kernel.org/doc/Documentation/admin-guide/md.rst" target="_top">Documentation/admin-guide/md.rst</a></code>
562 file shipped with the kernel sources.
563 </p>
564 <p class="since">Since 2.0.0</p>
565 </div>
566 <hr>
567 <div class="refsect2">
568 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.ChunkSize"></a><h3>The "ChunkSize" property</h3>
569 <pre class="programlisting">
570 ChunkSize readable t
571 </pre>
572 <p>
573 </p>
574 <p>
575 The chunk size (0 if the array is not running or not using striping).
576 </p>
577 <p>
578 This property corresponds to the
579 <code class="literal">chunk_size</code> sysfs file, see the
580 <code class="filename"><a class="ulink" href="https://www.kernel.org/doc/Documentation/admin-guide/md.rst" target="_top">Documentation/admin-guide/md.rst</a></code>
581 file shipped with the kernel sources.
582 </p>
583 <p class="since">Since 2.0.0</p>
584 </div>
585 <hr>
586 <div class="refsect2">
587 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.ActiveDevices"></a><h3>The "ActiveDevices" property</h3>
588 <pre class="programlisting">
589 ActiveDevices readable a(oiasta{sv})
590 </pre>
591 <p>
592 </p>
593 <p>
594 This property is an array with block devices that are
595 currently associated with the with the array. It is empty if
596 the array is not running.
597 </p>
598 <p>
599 Each element of the array is a struct with the following members:
600 </p>
601 <div class="variablelist"><table border="0" class="variablelist">
602 <colgroup>
603 <col align="left" valign="top">
604 <col>
605 </colgroup>
606 <tbody>
607 <tr>
608 <td><p><span class="term">block (type 'o')</span></p></td>
609 <td><p>The object path for the underlying block device (guaranteed to implement the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> interface)</p></td>
610 </tr>
611 <tr>
612 <td><p><span class="term">slot (type 'i')</span></p></td>
613 <td><p>-1 if the device is not currently part of the array (ie. <code class="literal">spare</code> or <code class="literal">faulty</code>), otherwise the slot number the device currently fills (between 0 and <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-property-org-freedesktop-UDisks2-MDRaid.NumDevices" title='The "NumDevices" property'>"NumDevices"</a>)</p></td>
614 </tr>
615 <tr>
616 <td><p><span class="term">state (type 'as')</span></p></td>
617 <td><p>The state of the device - known elements include <code class="literal">faulty</code>, <code class="literal">in_sync</code>, <code class="literal">write_mostly</code>, <code class="literal">blocked</code> and <code class="literal">spare</code></p></td>
618 </tr>
619 <tr>
620 <td><p><span class="term">num_read_errors (type 't')</span></p></td>
621 <td><p>An ongoing count of read errors that have been detected on this device but have not caused the device to be evicted from the array</p></td>
622 </tr>
623 <tr>
624 <td><p><span class="term">expansion (type 'a{sv}')</span></p></td>
625 <td><p>Currently unused. Intended for future expansion.</p></td>
626 </tr>
627 </tbody>
628 </table></div>
629 <p>
630 This property correspond to the
631 <code class="filename">/sys/block/mdN/md/dev-*</code> directories in sysfs and the sysfs files in each directory.
632 See the
633 <code class="filename"><a class="ulink" href="https://www.kernel.org/doc/Documentation/admin-guide/md.rst" target="_top">Documentation/admin-guide/md.rst</a></code>
634 file shipped with the kernel sources.
635 </p>
636 <p class="since">Since 2.0.0</p>
637 </div>
638 <hr>
639 <div class="refsect2">
640 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.ChildConfiguration"></a><h3>The "ChildConfiguration" property</h3>
641 <pre class="programlisting">
642 ChildConfiguration readable a(sa{sv})
643 </pre>
644 <p>
645 Configuration items belonging to the
646 </p>
647 <p>
648 block devices of this array (recursively). This is also
649 valid when the array is stopped and there are no actual block
650 devices for it. It works via the 'track-parents' options of
651 <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem" title="The AddConfigurationItem() method">AddConfigurationItem()</a>, which
652 see.
653 </p>
654 <p class="since">Since 2.0.0</p>
655 </div>
656 <hr>
657 <div class="refsect2">
658 <a name="gdbus-property-org-freedesktop-UDisks2-MDRaid.Running"></a><h3>The "Running" property</h3>
659 <pre class="programlisting">
660 Running readable b
661 </pre>
662 <p>
663 Whether or not the array is considered running.
664 It is an error to call Start on a running array, and Stop on
665 a non-running array, for example.
666 </p>
667 <p class="since">Since 2.0.0</p>
668 </div>
669 </div>
670 </div>
671 <div class="footer">
672 <hr>Generated by GTK-Doc V1.35.1</div>
673 </body>
674 </html>