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