~ubuntu-branches/ubuntu/lucid/devicekit-disks/lucid
» Revision
18
: data/org.freedesktop.DeviceKit.Disks.Device.xml
« back to all changes in this revision
Viewing changes to data/org.freedesktop.DeviceKit.Disks.Device.xml
- browse files at revision 18
- compare with another revision
- download diff
- download tarball
- view history from revision 18
- Committer: Bazaar Package Importer
- Author(s): Martin Pitt
- Date: 2009-09-19 16:51:16 UTC
- mfrom: (1.1.5 upstream)
- Revision ID: james.westby@ubuntu.com-20090919165116-qywy5go6o82fkws4
Tags: 007-0ubuntu1
* New upstream release:
- Bug 23761 – Some leaks
- Bug 23541 – PartitionTableCreate method times out
- Bug 22914 – Require password to eject a CD or DVD mounted by the same user
- Rework ATA SMART handling
- Also be paranoid about the UUID containing '/' characters
- Use WindowsStyleCaps for property names
- Bug 23829 – Undefined value in partutil.c
- Bug 23828 – Undefined value in umount-devkit.c
- Bug 23827 – Undefined value
- Bug 23826 – NULL dereference
- Bug 23825 – Leak in update_info_mount_state
- Bug 23824 – Unused variable
- Bug 23823 – NULL dereference
- Bug 23764 – Small leak in update_drive_properties_from_sysfs
- Bug 23762 – Fix typo
- Bug 23579 – Must allow DBus Properties interface for g-d-u to work
- Bug 23926 – Error creating partition
* Drop all our patches, all applied upstream.
* debian/control: Drop libsqlite3-dev build dependency, not needed any more.
* debian/control: Bump Standards-Version to 3.8.3 (no changes needed).
* debian/control: Add Breaks to GDU libraries << 2.28, since the D-BUS API
changed.
- Bug 23761 – Some leaks
- Bug 23541 – PartitionTableCreate method times out
- Bug 22914 – Require password to eject a CD or DVD mounted by the same user
- Rework ATA SMART handling
- Also be paranoid about the UUID containing '/' characters
- Use WindowsStyleCaps for property names
- Bug 23829 – Undefined value in partutil.c
- Bug 23828 – Undefined value in umount-devkit.c
- Bug 23827 – Undefined value
- Bug 23826 – NULL dereference
- Bug 23825 – Leak in update_info_mount_state
- Bug 23824 – Unused variable
- Bug 23823 – NULL dereference
- Bug 23764 – Small leak in update_drive_properties_from_sysfs
- Bug 23762 – Fix typo
- Bug 23579 – Must allow DBus Properties interface for g-d-u to work
- Bug 23926 – Error creating partition
* Drop all our patches, all applied upstream.
* debian/control: Drop libsqlite3-dev build dependency, not needed any more.
* debian/control: Bump Standards-Version to 3.8.3 (no changes needed).
* debian/control: Add Breaks to GDU libraries << 2.28, since the D-BUS API
changed.
- files removed:
- debian/patches
- files modified:
- Makefile.in
added
removed
data/org.freedesktop.DeviceKit.Disks.Device.xml
42
42
hardware and operating system capabilities evolve. Care
43
43
has been taken to namespace values so applications can
44
44
properly fall back (see e.g.
45
<doc:ref type="property" to="Device:drive-media-compatibility">drive-media-compatibility</doc:ref>)
45
<doc:ref type="property" to="Device:DriveMediaCompatibility">DriveMediaCompatibility</doc:ref>)
46
46
and export both general and specific properties (such as
47
<doc:ref type="property" to="Device:id-usage">id-usage</doc:ref>
47
<doc:ref type="property" to="Device:IdUsage">IdUsage</doc:ref>
48
48
vs.
49
<doc:ref type="property" to="Device:id-type">id-type</doc:ref>).
49
<doc:ref type="property" to="Device:IdType">IdType</doc:ref>).
50
50
In general an empty string in a property means not
51
51
set. Since the empty string is not a valid object path we
52
52
use the "/" to mean "not set" for object paths.
136
136
<doc:item>
137
137
<doc:term>org.freedesktop.devicekit.disks.change</doc:term>
138
138
<doc:definition>If the operation is on a
139
<doc:ref type="property" to="Device:device-is-system-internal">non-system-internal</doc:ref>
139
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
140
140
device</doc:definition>
141
141
</doc:item>
142
142
<doc:item>
143
143
<doc:term>org.freedesktop.devicekit.disks.change-system-internal</doc:term>
144
144
<doc:definition>If the operation is on a
145
<doc:ref type="property" to="Device:device-is-system-internal">system-internal</doc:ref>
145
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
146
146
device</doc:definition>
147
147
</doc:item>
148
148
</doc:list>
176
176
<doc:item>
177
177
<doc:term>org.freedesktop.devicekit.disks.change</doc:term>
178
178
<doc:definition>If the operation is on a
179
<doc:ref type="property" to="Device:device-is-system-internal">non-system-internal</doc:ref>
179
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
180
180
device</doc:definition>
181
181
</doc:item>
182
182
<doc:item>
183
183
<doc:term>org.freedesktop.devicekit.disks.change-system-internal</doc:term>
184
184
<doc:definition>If the operation is on a
185
<doc:ref type="property" to="Device:device-is-system-internal">system-internal</doc:ref>
185
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
186
186
device</doc:definition>
187
187
</doc:item>
188
188
</doc:list>
315
315
<doc:item>
316
316
<doc:term>org.freedesktop.devicekit.disks.change</doc:term>
317
317
<doc:definition>If the operation is on a
318
<doc:ref type="property" to="Device:device-is-system-internal">non-system-internal</doc:ref>
318
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
319
319
device</doc:definition>
320
320
</doc:item>
321
321
<doc:item>
322
322
<doc:term>org.freedesktop.devicekit.disks.change-system-internal</doc:term>
323
323
<doc:definition>If the operation is on a
324
<doc:ref type="property" to="Device:device-is-system-internal">system-internal</doc:ref>
324
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
325
325
device</doc:definition>
326
326
</doc:item>
327
327
</doc:list>
375
375
<doc:item>
376
376
<doc:term>org.freedesktop.devicekit.disks.change</doc:term>
377
377
<doc:definition>If the operation is on a
378
<doc:ref type="property" to="Device:device-is-system-internal">non-system-internal</doc:ref>
378
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
379
379
device</doc:definition>
380
380
</doc:item>
381
381
<doc:item>
440
440
<doc:item>
441
441
<doc:term>org.freedesktop.devicekit.disks.change</doc:term>
442
442
<doc:definition>If the operation is on a
443
<doc:ref type="property" to="Device:device-is-system-internal">non-system-internal</doc:ref>
443
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
444
444
device</doc:definition>
445
445
</doc:item>
446
446
<doc:item>
485
485
<doc:item>
486
486
<doc:term>org.freedesktop.devicekit.disks.change</doc:term>
487
487
<doc:definition>If the operation is on a
488
<doc:ref type="property" to="Device:device-is-system-internal">non-system-internal</doc:ref>
488
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
489
489
device</doc:definition>
490
490
</doc:item>
491
491
<doc:item>
492
492
<doc:term>org.freedesktop.devicekit.disks.change-system-internal</doc:term>
493
493
<doc:definition>If the operation is on a
494
<doc:ref type="property" to="Device:device-is-system-internal">system-internal</doc:ref>
494
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
495
495
device</doc:definition>
496
496
</doc:item>
497
497
</doc:list>
536
536
<doc:item>
537
537
<doc:term>org.freedesktop.devicekit.disks.filesystem-mount</doc:term>
538
538
<doc:definition>If the operation is on a
539
<doc:ref type="property" to="Device:device-is-system-internal">non-system-internal</doc:ref>
539
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
540
540
device</doc:definition>
541
541
</doc:item>
542
542
<doc:item>
543
543
<doc:term>org.freedesktop.devicekit.disks.filesystem-mount-system-internal</doc:term>
544
544
<doc:definition>If the operation is on a
545
<doc:ref type="property" to="Device:device-is-system-internal">system-internal</doc:ref>
545
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
546
546
device</doc:definition>
547
547
</doc:item>
548
548
</doc:list>
618
618
<doc:item>
619
619
<doc:term>org.freedesktop.devicekit.disks.filesystem-check</doc:term>
620
620
<doc:definition>To check a file system on a
621
<doc:ref type="property" to="Device:device-is-system-internal">non-system-internal</doc:ref>
621
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
622
622
device.</doc:definition>
623
623
</doc:item>
624
624
<doc:item>
625
625
<doc:term>org.freedesktop.devicekit.disks.filesystem-check-system-internal</doc:term>
626
626
<doc:definition>To check a file system on a
627
<doc:ref type="property" to="Device:device-is-system-internal">system-internal</doc:ref>
627
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
628
628
device.</doc:definition>
629
629
</doc:item>
630
630
</doc:list>
662
662
<doc:item>
663
663
<doc:term>org.freedesktop.devicekit.disks.filesystem-lsof</doc:term>
664
664
<doc:definition>To check a file system on a
665
<doc:ref type="property" to="Device:device-is-system-internal">non-system-internal</doc:ref>
665
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
666
666
device.</doc:definition>
667
667
</doc:item>
668
668
<doc:item>
669
669
<doc:term>org.freedesktop.devicekit.disks.filesystem-lsof-system-internal</doc:term>
670
670
<doc:definition>To check a file system on a
671
<doc:ref type="property" to="Device:device-is-system-internal">system-internal</doc:ref>
671
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
672
672
device.</doc:definition>
673
673
</doc:item>
674
674
</doc:list>
777
777
<doc:item>
778
778
<doc:term>org.freedesktop.devicekit.disks.change</doc:term>
779
779
<doc:definition>If the operation is on a
780
<doc:ref type="property" to="Device:device-is-system-internal">non-system-internal</doc:ref>
780
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
781
781
device</doc:definition>
782
782
</doc:item>
783
783
<doc:item>
784
784
<doc:term>org.freedesktop.devicekit.disks.change-system-internal</doc:term>
785
785
<doc:definition>If the operation is on a
786
<doc:ref type="property" to="Device:device-is-system-internal">system-internal</doc:ref>
786
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
787
787
device</doc:definition>
788
788
</doc:item>
789
789
</doc:list>
929
929
Checks a Linux md RAID array and returns the number of
930
930
sectors/page with errors found/fixed. This can only be done if the
931
931
property
932
<doc:ref type="property" to="Device:linux-md-sync-action">linux-md-sync-action</doc:ref>
932
<doc:ref type="property" to="Device:LinuxMdSyncAction">LinuxMdSyncAction</doc:ref>
933
933
is <quote>idle</quote>.
934
934
</doc:para>
935
935
</doc:description>
1024
1024
<doc:description>
1025
1025
<doc:para>
1026
1026
Polls the drive for media. This is typically only useful when the
1027
<doc:ref type="property" to="Device:device-is-media-change-detected">device-is-media-change-detected</doc:ref> property
1027
<doc:ref type="property" to="Device:DeviceIsMediaChangeDetected">DeviceIsMediaChangeDetected</doc:ref> property
1028
1028
is FALSE.
1029
1029
</doc:para>
1030
1030
</doc:description>
1090
1090
Detachs the device by e.g. powering down the physical port
1091
1091
it is connected to. Note that not all devices or ports are
1092
1092
capable of this. Check the
1093
<doc:ref type="property" to="Device:drive-can-detach">drive-can-detach</doc:ref>
1093
<doc:ref type="property" to="Device:DriveCanDetach">DriveCanDetach</doc:ref>
1094
1094
property before attempting to invoke this method.
1095
1095
</doc:para>
1096
1096
</doc:description>
1142
1142
<doc:para>
1143
1143
Configures spindown timeout for the drive.
1144
1144
Check the
1145
<doc:ref type="property" to="Device:drive-can-spindown">drive-can-spindown</doc:ref>
1145
<doc:ref type="property" to="Device:DriveCanSpindown">DriveCanSpindown</doc:ref>
1146
1146
property before attempting to invoke this method.
1147
1147
Caution should be exercised when using this method, see
1148
1148
the SPINNING DOWN DISKS section in the
1240
1240
1241
1241
<!-- ************************************************************ -->
1242
1242
1243
<method name="DriveAtaSmartGetHistoricalData">
1244
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
1245
<arg name="since" direction="in" type="t">
1246
<doc:doc><doc:summary>
1247
Don't fetch data collected earlier than this point
1248
in time (seconds since the Epoch Jan 1, 1970 0:00 UTC).
1249
</doc:summary></doc:doc>
1250
</arg>
1251
<arg name="until" direction="in" type="t">
1252
<doc:doc><doc:summary>
1253
Don't fetch data collected later than this point in
1254
time (seconds since the Epoch Jan 1, 1970 0:00 UTC). If 0 is
1255
passed the current time will be used.
1256
</doc:summary></doc:doc>
1257
</arg>
1258
<arg name="spacing" direction="in" type="t">
1259
<doc:doc><doc:summary>
1260
The minimum spacing (in seconds) between two data points or 0
1261
to get all data points between @since and @until.
1262
</doc:summary></doc:doc>
1263
</arg>
1264
<arg name="data" direction="out" type="a(tbbbbdta(usubbybybybbbutay))">
1265
<doc:doc><doc:summary>
1266
An array of historical data sorted by collection date. Each element contains
1267
the following members (TODO).
1268
</doc:summary></doc:doc>
1269
</arg>
1270
<doc:doc>
1271
<doc:description>
1272
<doc:para>
1273
Retrieves historical ATA SMART data from the drive in the
1274
given time interval. Note that this is data collected and
1275
stored by the host as ATA SMART capable devices cannot
1276
store or return historical data by themselves.
1277
</doc:para>
1278
</doc:description>
1279
<doc:permission>
1280
The caller will need one of the following PolicyKit authorizations:
1281
<doc:list>
1282
<doc:item>
1283
<doc:term>org.freedesktop.devicekit.disks.drive-ata-smart-retrieve-historical-data</doc:term>
1284
<doc:definition>To retrieve historical ATA SMART data</doc:definition>
1285
</doc:item>
1286
</doc:list>
1287
</doc:permission>
1288
<doc:errors>
1289
<doc:error name="&ERROR_NOT_AUTHORIZED;">if the caller lacks the appropriate PolicyKit authorization</doc:error>
1290
<doc:error name="&ERROR_FAILED;">if the operation failed</doc:error>
1291
<doc:error name="&ERROR_CANCELLED;">if the job was cancelled</doc:error>
1292
</doc:errors>
1293
</doc:doc>
1294
</method>
1295
1296
<!-- ************************************************************ -->
1297
1298
1243
<method name="DriveAtaSmartInitiateSelftest">
1299
1244
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
1300
1245
1378
1323
1379
1324
<!-- ************************************************************ -->
1380
1325
1381
<property name="native-path" type="s" access="read">
1326
<property name="NativePath" type="s" access="read">
1382
1327
<doc:doc><doc:description><doc:para>
1383
1328
OS specific native path of the device. On Linux this is the sysfs path, for example <doc:tt>/sys/devices/pci0000:00/0000:00:1f.2/host2/target2:0:1/2:0:1:0/block/sda</doc:tt>.
1384
1329
</doc:para></doc:description></doc:doc>
1385
1330
</property>
1386
<property name="device-detection-time" type="t" access="read">
1331
<property name="DeviceDetectionTime" type="t" access="read">
1387
1332
<doc:doc><doc:description><doc:para>
1388
1333
The point in time (seconds since the Epoch Jan 1, 1970 0:00 UTC) when the device
1389
1334
was detected by the daemon.
1390
1335
</doc:para></doc:description></doc:doc>
1391
1336
</property>
1392
<property name="device-media-detection-time" type="t" access="read">
1337
<property name="DeviceMediaDetectionTime" type="t" access="read">
1393
1338
<doc:doc><doc:description><doc:para>
1394
1339
The point in time (seconds since the Epoch Jan 1, 1970 0:00 UTC) when the
1395
1340
media currently in the device was detected by the daemon or 0 if the
1396
1341
device has no media.
1397
1342
</doc:para></doc:description></doc:doc>
1398
1343
</property>
1399
<property name="device-major" type="x" access="read">
1400
<doc:doc><doc:description><doc:para>
1401
Major for the device or -1 if not set.
1402
</doc:para></doc:description></doc:doc>
1403
</property>
1404
<property name="device-minor" type="x" access="read">
1405
<doc:doc><doc:description><doc:para>
1406
Major for the device or -1 if not set.
1407
</doc:para></doc:description></doc:doc>
1408
</property>
1409
<property name="device-file" type="s" access="read">
1344
<property name="DeviceMajor" type="x" access="read">
1345
<doc:doc><doc:description><doc:para>
1346
Major for the device or -1 if not set.
1347
</doc:para></doc:description></doc:doc>
1348
</property>
1349
<property name="DeviceMinor" type="x" access="read">
1350
<doc:doc><doc:description><doc:para>
1351
Major for the device or -1 if not set.
1352
</doc:para></doc:description></doc:doc>
1353
</property>
1354
<property name="DeviceFile" type="s" access="read">
1410
1355
<doc:doc><doc:description><doc:para>
1411
1356
UNIX special device file for device. Example: <doc:tt>/dev/sda</doc:tt>.
1412
1357
</doc:para></doc:description></doc:doc>
1413
1358
</property>
1414
<property name="device-file-by-id" type="as" access="read">
1359
<property name="DeviceFileById" type="as" access="read">
1415
1360
<doc:doc><doc:description><doc:para>
1416
1361
Symlinks to UNIX special device file that are stable and uniquely identifies the device.
1417
1362
Example: <doc:tt>/dev/disk/by-id/scsi-SATA_ST910021AS_3MH05AVA</doc:tt>,
1418
1363
<doc:tt>/dev/disk/by-id/ata-ST910021AS_3MH05AVA</doc:tt>.
1419
1364
</doc:para></doc:description></doc:doc>
1420
1365
</property>
1421
<property name="device-file-by-path" type="as" access="read">
1366
<property name="DeviceFileByPath" type="as" access="read">
1422
1367
<doc:doc><doc:description><doc:para>
1423
1368
Symlinks to UNIX special device file that uniquely identifies the port/partition the device
1424
1369
is plugged into. Example: <doc:tt>/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:1:0</doc:tt>
1425
1370
</doc:para></doc:description></doc:doc>
1426
1371
</property>
1427
<property name="device-is-system-internal" type="b" access="read">
1372
<property name="DeviceIsSystemInternal" type="b" access="read">
1428
1373
<doc:doc><doc:description><doc:para>
1429
1374
TRUE if the device is considered system internal. Typically, system internal devices
1430
1375
include non-removable internal hard disks and other drives that are not easily added/removed
1432
1377
and devices connected via Firewire, USB, eSATA and SDIO are considered external.
1433
1378
</doc:para></doc:description></doc:doc>
1434
1379
</property>
1435
<property name="device-is-partition" type="b" access="read">
1380
<property name="DeviceIsPartition" type="b" access="read">
1436
1381
<doc:doc><doc:description><doc:para>
1437
1382
TRUE if the device is a partition. See the properties starting with partition- for details.
1438
1383
</doc:para></doc:description></doc:doc>
1439
1384
</property>
1440
<property name="device-is-partition-table" type="b" access="read">
1385
<property name="DeviceIsPartitionTable" type="b" access="read">
1441
1386
<doc:doc><doc:description><doc:para>
1442
1387
TRUE if the device contains a partition table. See partition- properties for details.
1443
1388
</doc:para></doc:description></doc:doc>
1444
1389
</property>
1445
<property name="device-is-removable" type="b" access="read">
1390
<property name="DeviceIsRemovable" type="b" access="read">
1446
1391
<doc:doc><doc:description><doc:para>
1447
1392
TRUE if the device contains removable media.
1448
1393
</doc:para></doc:description></doc:doc>
1449
1394
</property>
1450
<property name="device-is-media-available" type="b" access="read">
1395
<property name="DeviceIsMediaAvailable" type="b" access="read">
1451
1396
<doc:doc><doc:description><doc:para>
1452
1397
TRUE if media is available in the device.
1453
1398
</doc:para></doc:description></doc:doc>
1454
1399
</property>
1455
<property name="device-is-media-change-detected" type="b" access="read">
1400
<property name="DeviceIsMediaChangeDetected" type="b" access="read">
1456
1401
<doc:doc><doc:description><doc:para>
1457
1402
TRUE if media changes are detected.
1458
1403
</doc:para></doc:description></doc:doc>
1459
1404
</property>
1460
<property name="device-is-media-change-detection-polling" type="b" access="read">
1405
<property name="DeviceIsMediaChangeDetectionPolling" type="b" access="read">
1461
1406
<doc:doc><doc:description><doc:para>
1462
1407
TRUE if media changes are detected through the host
1463
1408
polling the device, e.g. waking up every two seconds to
1467
1412
polling.
1468
1413
</doc:para></doc:description></doc:doc>
1469
1414
</property>
1470
<property name="device-is-media-change-detection-inhibitable" type="b" access="read">
1415
<property name="DeviceIsMediaChangeDetectionInhibitable" type="b" access="read">
1471
1416
<doc:doc><doc:description><doc:para>
1472
1417
TRUE if it is possible to inhibit media detection on the device (to avoid keeping the device in a high power state and waking up the host).
1473
1418
</doc:para></doc:description></doc:doc>
1474
1419
</property>
1475
<property name="device-is-media-change-detection-inhibited" type="b" access="read">
1420
<property name="DeviceIsMediaChangeDetectionInhibited" type="b" access="read">
1476
1421
<doc:doc><doc:description><doc:para>
1477
1422
TRUE if media detection is inhibited (to avoid keeping the device in a high power state and waking up the host).
1478
1423
</doc:para></doc:description></doc:doc>
1479
1424
</property>
1480
<property name="device-is-read-only" type="b" access="read">
1425
<property name="DeviceIsReadOnly" type="b" access="read">
1481
1426
<doc:doc><doc:description><doc:para>
1482
1427
TRUE if the device read-only.
1483
1428
</doc:para></doc:description></doc:doc>
1484
1429
</property>
1485
<property name="device-is-drive" type="b" access="read">
1430
<property name="DeviceIsDrive" type="b" access="read">
1486
1431
<doc:doc><doc:description><doc:para>
1487
1432
TRUE if the device is a drive.
1488
1433
See the drive- properties for details.
1489
1434
</doc:para></doc:description></doc:doc>
1490
1435
</property>
1491
<property name="device-is-optical-disc" type="b" access="read">
1436
<property name="DeviceIsOpticalDisc" type="b" access="read">
1492
1437
<doc:doc><doc:description><doc:para>
1493
1438
TRUE if the device is an optical drive and an optical disc is inserted.
1494
1439
See the optical-disc- properties for details.
1495
1440
</doc:para></doc:description></doc:doc>
1496
1441
</property>
1497
<property name="device-is-mounted" type="b" access="read">
1442
<property name="DeviceIsMounted" type="b" access="read">
1498
1443
<doc:doc><doc:description><doc:para>
1499
1444
TRUE if the device is mounted.
1500
1445
</doc:para></doc:description></doc:doc>
1501
1446
</property>
1502
<property name="device-mount-paths" type="as" access="read">
1447
<property name="DeviceMountPaths" type="as" access="read">
1503
1448
<doc:doc><doc:description><doc:para>
1504
1449
A list of paths in the root namespace where the root of the device is mounted.
1505
1450
This property is only valid if
1506
<doc:ref type="property" to="Device:device-is-mounted">device-is-mounted</doc:ref>
1451
<doc:ref type="property" to="Device:DeviceIsMounted">DeviceIsMounted</doc:ref>
1507
1452
is TRUE.
1508
1453
</doc:para></doc:description></doc:doc>
1509
1454
</property>
1510
<property name="device-mounted-by-uid" type="u" access="read">
1455
<property name="DeviceMountedByUid" type="u" access="read">
1511
1456
<doc:doc><doc:description><doc:para>
1512
1457
The UNIX user id of the user who mounted the device. Set to 0 if
1513
1458
not mounted by DeviceKit-disks.
1514
1459
This property is only valid if
1515
<doc:ref type="property" to="Device:device-is-mounted">device-is-mounted</doc:ref>
1460
<doc:ref type="property" to="Device:DeviceIsMounted">DeviceIsMounted</doc:ref>
1516
1461
is TRUE.
1517
1462
</doc:para></doc:description></doc:doc>
1518
1463
</property>
1519
<property name="device-is-luks" type="b" access="read">
1520
<doc:doc><doc:description><doc:para>
1521
TRUE if device is an LUKS encrypted device. See luks- properties for details.
1522
</doc:para></doc:description></doc:doc>
1523
</property>
1524
<property name="device-is-luks-cleartext" type="b" access="read">
1525
<doc:doc><doc:description><doc:para>
1526
TRUE if device is a cleartext device backed by a LUKS encrypted device. See luks-cleartext- properties for details.
1527
</doc:para></doc:description></doc:doc>
1528
</property>
1529
<property name="device-is-linux-md-component" type="b" access="read">
1530
<doc:doc><doc:description><doc:para>
1531
TRUE if the device is a Linux md RAID component. See linux-md-component- properties for details.
1532
</doc:para></doc:description></doc:doc>
1533
</property>
1534
<property name="device-is-linux-md" type="b" access="read">
1535
<doc:doc><doc:description><doc:para>
1536
TRUE if the device is a Linux md RAID array. See linux-md- properties for details.
1537
</doc:para></doc:description></doc:doc>
1538
</property>
1539
<property name="device-size" type="t" access="read">
1464
<property name="DeviceIsLuks" type="b" access="read">
1465
<doc:doc><doc:description><doc:para>
1466
TRUE if device is an LUKS encrypted device. See Lucks properties for details.
1467
</doc:para></doc:description></doc:doc>
1468
</property>
1469
<property name="DeviceIsLuksCleartext" type="b" access="read">
1470
<doc:doc><doc:description><doc:para>
1471
TRUE if device is a cleartext device backed by a LUKS encrypted device. See LucksCleartext properties for details.
1472
</doc:para></doc:description></doc:doc>
1473
</property>
1474
<property name="DeviceIsLinuxMdComponent" type="b" access="read">
1475
<doc:doc><doc:description><doc:para>
1476
TRUE if the device is a Linux md RAID component. See LinuxMdComponent properties for details.
1477
</doc:para></doc:description></doc:doc>
1478
</property>
1479
<property name="DeviceIsLinuxMd" type="b" access="read">
1480
<doc:doc><doc:description><doc:para>
1481
TRUE if the device is a Linux md RAID array. See LinuxMd properties for details.
1482
</doc:para></doc:description></doc:doc>
1483
</property>
1484
<property name="DeviceSize" type="t" access="read">
1540
1485
<doc:doc><doc:description><doc:para>
1541
1486
The size of the device in bytes.
1542
1487
</doc:para></doc:description></doc:doc>
1543
1488
</property>
1544
<property name="device-block-size" type="t" access="read">
1489
<property name="DeviceBlockSize" type="t" access="read">
1545
1490
<doc:doc><doc:description><doc:para>
1546
1491
The block size of the device in bytes.
1547
1492
</doc:para></doc:description></doc:doc>
1548
1493
</property>
1549
<property name="device-presentation-hide" type="b" access="read">
1494
<property name="DevicePresentationHide" type="b" access="read">
1550
1495
<doc:doc><doc:description><doc:para>
1551
1496
A hint if the device should be hidden from the user interface.
1552
1497
</doc:para></doc:description></doc:doc>
1553
1498
</property>
1554
<property name="device-presentation-nopolicy" type="b" access="read">
1499
<property name="DevicePresentationNopolicy" type="b" access="read">
1555
1500
<doc:doc><doc:description><doc:para>
1556
1501
A hint if the device (or e.g. the multi-disk device that the device is
1557
1502
part of) shouldn't be automatically mounted / assembled.
1558
1503
</doc:para></doc:description></doc:doc>
1559
1504
</property>
1560
<property name="device-presentation-name" type="s" access="read">
1505
<property name="DevicePresentationName" type="s" access="read">
1561
1506
<doc:doc><doc:description><doc:para>
1562
1507
The name to use when presenting the device to an end user.
1563
1508
</doc:para></doc:description></doc:doc>
1564
1509
</property>
1565
<property name="device-presentation-icon-name" type="s" access="read">
1510
<property name="DevicePresentationIconName" type="s" access="read">
1566
1511
<doc:doc><doc:description><doc:para>
1567
1512
The icon to use when presenting the device to an end user. If set, must be a name
1568
1513
following the freedesktop.org icon theme specification.
1569
1514
</doc:para></doc:description></doc:doc>
1570
1515
</property>
1571
1516
1572
<property name="job-in-progress" type="b" access="read">
1517
<property name="JobInProgress" type="b" access="read">
1573
1518
<doc:doc><doc:description><doc:para>
1574
1519
The job properties specify if a job initiated via the
1575
1520
DeviceKit-disks daemon is currently in progress.
1576
1521
</doc:para></doc:description></doc:doc>
1577
1522
</property>
1578
<property name="job-id" type="s" access="read">
1523
<property name="JobId" type="s" access="read">
1579
1524
<doc:doc><doc:description><doc:para>
1580
1525
This property is used to identify the job and maps 1-1
1581
1526
with the names of the method calls on this interface,
1582
1527
e.g. 'FilesystemCreate' and so on.
1583
1528
</doc:para></doc:description></doc:doc>
1584
1529
</property>
1585
<property name="job-initiated-by-uid" type="u" access="read">
1530
<property name="JobInitiatedByUid" type="u" access="read">
1586
1531
<doc:doc><doc:description><doc:para>
1587
1532
The UNIX user id of the user who initiated the job.
1588
1533
</doc:para></doc:description></doc:doc>
1589
1534
</property>
1590
<property name="job-is-cancellable" type="b" access="read">
1535
<property name="JobIsCancellable" type="b" access="read">
1591
1536
<doc:doc><doc:description><doc:para>
1592
1537
Whether the job can be cancelled
1593
1538
using <doc:ref type="method"
1594
1539
to="Device.JobCancel">JobCancel()</doc:ref> method.
1595
1540
</doc:para></doc:description></doc:doc>
1596
1541
</property>
1597
<property name="job-percentage" type="d" access="read">
1542
<property name="JobPercentage" type="d" access="read">
1598
1543
<doc:doc><doc:description><doc:para>
1599
1544
Percentage completed of the job (between 0 and 100, negative if unknown).
1600
1545
</doc:para></doc:description></doc:doc>
1601
1546
</property>
1602
1547
1603
<property name="id-usage" type="s" access="read">
1548
<property name="IdUsage" type="s" access="read">
1604
1549
<doc:doc><doc:description><doc:para>
1605
1550
A result of probing for signatures on the block device;
1606
1551
known values are:
1632
1577
was detected.
1633
1578
</doc:para></doc:description></doc:doc>
1634
1579
</property>
1635
<property name="id-type" type="s" access="read">
1580
<property name="IdType" type="s" access="read">
1636
1581
<doc:doc><doc:description><doc:para>
1637
1582
This property contains more information about the result
1638
1583
of probing the block device. It's value depends of the
1639
1584
value the
1640
<doc:ref type="property" to="Device:id-usage">id-usage</doc:ref>
1585
<doc:ref type="property" to="Device:IdUsage">IdUsage</doc:ref>
1641
1586
property:
1642
1587
<doc:list>
1643
1588
<doc:item>
1683
1628
</doc:list>
1684
1629
</doc:para></doc:description></doc:doc>
1685
1630
</property>
1686
<property name="id-version" type="s" access="read">
1631
<property name="IdVersion" type="s" access="read">
1687
1632
<doc:doc><doc:description><doc:para>
1688
1633
The version of the
1689
1634
detected file system (or other identified data structure) identified by the
1690
<doc:ref type="property" to="Device:id-usage">id-usage</doc:ref>
1635
<doc:ref type="property" to="Device:IdUsage">IdUsage</doc:ref>
1691
1636
and
1692
<doc:ref type="property" to="Device:id-usage">id-type</doc:ref>
1637
<doc:ref type="property" to="Device:IdType">IdType</doc:ref>
1693
1638
properties.
1694
1639
</doc:para></doc:description></doc:doc>
1695
1640
</property>
1696
<property name="id-uuid" type="s" access="read">
1641
<property name="IdUuid" type="s" access="read">
1697
1642
<doc:doc><doc:description><doc:para>
1698
1643
The UUID (universally unique identifier) of the
1699
1644
detected file system (or other identified data structure) identified by the
1700
<doc:ref type="property" to="Device:id-usage">id-usage</doc:ref>
1645
<doc:ref type="property" to="Device:IdUsage">IdUsage</doc:ref>
1701
1646
and
1702
<doc:ref type="property" to="Device:id-usage">id-type</doc:ref>
1647
<doc:ref type="property" to="Device:IdUsage">IdType</doc:ref>
1703
1648
properties.
1704
1649
</doc:para></doc:description></doc:doc>
1705
1650
</property>
1706
<property name="id-label" type="s" access="read">
1651
<property name="IdLabel" type="s" access="read">
1707
1652
<doc:doc><doc:description><doc:para>
1708
1653
The user-visible label of the
1709
1654
detected file system (or other identified data structure) identified by the
1710
<doc:ref type="property" to="Device:id-usage">id-usage</doc:ref>
1655
<doc:ref type="property" to="Device:IdUsage">IdUsage</doc:ref>
1711
1656
and
1712
<doc:ref type="property" to="Device:id-usage">id-type</doc:ref>
1657
<doc:ref type="property" to="Device:IdUsage">IdType</doc:ref>
1713
1658
properties.
1714
1659
</doc:para></doc:description></doc:doc>
1715
1660
</property>
1716
1661
1717
<property name="luks-holder" type="o" access="read">
1662
<property name="LuksHolder" type="o" access="read">
1718
1663
<doc:doc><doc:description><doc:para>
1719
1664
The cleartext device that is using the LUKS device.
1720
1665
This property is only valid if
1721
<doc:ref type="property" to="Device:device-is-luks-cleartext">device-is-luks</doc:ref>
1666
<doc:ref type="property" to="Device:DeviceIsLuksCleartext">DeviceIsLuks</doc:ref>
1722
1667
is TRUE.
1723
1668
</doc:para></doc:description></doc:doc>
1724
1669
</property>
1725
1670
1726
<property name="luks-cleartext-slave" type="o" access="read">
1671
<property name="LuksCleartextSlave" type="o" access="read">
1727
1672
<doc:doc><doc:description><doc:para>
1728
1673
The encrypted LUKS device backing a crypto cleartext device.
1729
1674
This property is only valid if
1730
<doc:ref type="property" to="Device:device-is-luks-cleartext">device-is-luks-cleartext</doc:ref>
1675
<doc:ref type="property" to="Device:DeviceIsLuksCleartext">DeviceIsLuksCleartext</doc:ref>
1731
1676
is TRUE.
1732
1677
</doc:para></doc:description></doc:doc>
1733
1678
</property>
1734
<property name="luks-cleartext-unlocked-by-uid" type="u" access="read">
1679
<property name="LuksCleartextUnlockedByUid" type="u" access="read">
1735
1680
<doc:doc><doc:description><doc:para>
1736
1681
The UNIX user id of the user who unlocked the LUKS device. Set to 0 if
1737
1682
not unlocked by DeviceKit-disks.
1738
1683
This property is only valid if
1739
<doc:ref type="property" to="Device:device-is-luks-cleartext">device-is-luks-cleartext</doc:ref>
1684
<doc:ref type="property" to="Device:DeviceIsLuksCleartext">DeviceIsLuksCleartext</doc:ref>
1740
1685
is TRUE.
1741
1686
</doc:para></doc:description></doc:doc>
1742
1687
</property>
1743
1688
1744
<property name="partition-slave" type="o" access="read">
1689
<property name="PartitionSlave" type="o" access="read">
1745
1690
<doc:doc><doc:description><doc:para>
1746
1691
The object path of the partition table the partition is part of.
1747
1692
This property is only valid if
1748
<doc:ref type="property" to="Device:device-is-partition">device-is-partition</doc:ref>
1693
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
1749
1694
is TRUE.
1750
1695
</doc:para></doc:description></doc:doc>
1751
1696
</property>
1752
<property name="partition-scheme" type="s" access="read">
1697
<property name="PartitionScheme" type="s" access="read">
1753
1698
<doc:doc><doc:description><doc:para>
1754
1699
The scheme of the partition table this partition is part of.
1755
1700
See the <doc:tt>scheme</doc:tt> parameter of the
1756
1701
<doc:ref type="method" to="Device.PartitionTableCreate">PartitionTableCreate()</doc:ref> method
1757
1702
for details on known partitioning schemes.
1758
1703
This property is only valid if
1759
<doc:ref type="property" to="Device:device-is-partition">device-is-partition</doc:ref>
1704
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
1760
1705
is TRUE.
1761
1706
</doc:para></doc:description></doc:doc>
1762
1707
</property>
1763
<property name="partition-type" type="s" access="read">
1708
<property name="PartitionType" type="s" access="read">
1764
1709
<doc:doc><doc:description><doc:para>
1765
1710
The type of the partition.
1766
1711
See the <doc:tt>type</doc:tt> parameter of the
1767
1712
<doc:ref type="method" to="Device.PartitionCreate">PartitionCreate()</doc:ref> method
1768
1713
for details on known partitioning types.
1769
1714
This property is only valid if
1770
<doc:ref type="property" to="Device:device-is-partition">device-is-partition</doc:ref>
1715
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
1771
1716
is TRUE.
1772
1717
</doc:para></doc:description></doc:doc>
1773
1718
</property>
1774
<property name="partition-label" type="s" access="read">
1719
<property name="PartitionLabel" type="s" access="read">
1775
1720
<doc:doc><doc:description><doc:para>
1776
1721
The label of the partition.
1777
1722
See the <doc:tt>label</doc:tt> parameter of the
1778
1723
<doc:ref type="method" to="Device.PartitionCreate">PartitionCreate()</doc:ref> method
1779
1724
for details on partition labels.
1780
1725
This property is only valid if
1781
<doc:ref type="property" to="Device:device-is-partition">device-is-partition</doc:ref>
1726
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
1782
1727
is TRUE.
1783
1728
</doc:para></doc:description></doc:doc>
1784
1729
</property>
1785
<property name="partition-uuid" type="s" access="read">
1730
<property name="PartitionUuid" type="s" access="read">
1786
1731
<doc:doc><doc:description><doc:para>
1787
1732
The UUID of the partition.
1788
1733
See the <doc:tt>uuid</doc:tt> parameter of the
1789
1734
<doc:ref type="method" to="Device.PartitionCreate">PartitionCreate()</doc:ref> method
1790
1735
for details on partition UUID's.
1791
1736
This property is only valid if
1792
<doc:ref type="property" to="Device:device-is-partition">device-is-partition</doc:ref>
1737
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
1793
1738
is TRUE.
1794
1739
</doc:para></doc:description></doc:doc>
1795
1740
</property>
1796
<property name="partition-flags" type="as" access="read">
1741
<property name="PartitionFlags" type="as" access="read">
1797
1742
<doc:doc><doc:description><doc:para>
1798
1743
Partition flags.
1799
1744
See the <doc:tt>flags</doc:tt> parameter of the
1800
1745
<doc:ref type="method" to="Device.PartitionCreate">PartitionCreate()</doc:ref> method
1801
1746
for details on partition flags.
1802
1747
This property is only valid if
1803
<doc:ref type="property" to="Device:device-is-partition">device-is-partition</doc:ref>
1748
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
1804
1749
is TRUE.
1805
1750
</doc:para></doc:description></doc:doc>
1806
1751
</property>
1807
<property name="partition-number" type="i" access="read">
1752
<property name="PartitionNumber" type="i" access="read">
1808
1753
<doc:doc><doc:description><doc:para>
1809
1754
Number of the partition. Typically partition numbers start at 1 and are identical
1810
1755
to the numbers used by the kernel. Note that partitions may not be sequentially
1811
1756
numbered.
1812
1757
This property is only valid if
1813
<doc:ref type="property" to="Device:device-is-partition">device-is-partition</doc:ref>
1758
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
1814
1759
is TRUE.
1815
1760
</doc:para></doc:description></doc:doc>
1816
1761
</property>
1817
<property name="partition-offset" type="t" access="read">
1762
<property name="PartitionOffset" type="t" access="read">
1818
1763
<doc:doc><doc:description><doc:para>
1819
1764
Offset in bytes where the partition is located on the enclosing partition table device (see
1820
<doc:ref type="property" to="Device:device-is-partition">partition-slave</doc:ref>).
1765
<doc:ref type="property" to="Device:DeviceIsPartition">PartitionSlave</doc:ref>).
1821
1766
This property is only valid if
1822
<doc:ref type="property" to="Device:device-is-partition">device-is-partition</doc:ref>
1767
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
1823
1768
is TRUE.
1824
1769
</doc:para></doc:description></doc:doc>
1825
1770
</property>
1826
<property name="partition-size" type="t" access="read">
1771
<property name="PartitionSize" type="t" access="read">
1827
1772
<doc:doc><doc:description><doc:para>
1828
1773
Size of the partition in bytes.
1829
1774
This property is only valid if
1830
<doc:ref type="property" to="Device:device-is-partition">device-is-partition</doc:ref>
1775
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
1831
1776
is TRUE.
1832
1777
</doc:para></doc:description></doc:doc>
1833
1778
</property>
1834
1779
1835
<property name="partition-table-scheme" type="s" access="read">
1780
<property name="PartitionTableScheme" type="s" access="read">
1836
1781
<doc:doc><doc:description><doc:para>
1837
1782
The scheme of the partition table.
1838
1783
See the <doc:tt>scheme</doc:tt> parameter of the
1839
1784
<doc:ref type="method" to="Device.PartitionTableCreate">PartitionTableCreate()</doc:ref> method
1840
1785
for details on known partitioning schemes.
1841
1786
This property is only valid if
1842
<doc:ref type="property" to="Device:device-is-partition-table">device-is-partition-table</doc:ref>
1787
<doc:ref type="property" to="Device:DeviceIsPartitionTable">DeviceIsPartitionTable</doc:ref>
1843
1788
is TRUE.
1844
1789
</doc:para></doc:description></doc:doc>
1845
1790
</property>
1846
<property name="partition-table-count" type="i" access="read">
1791
<property name="PartitionTableCount" type="i" access="read">
1847
1792
<doc:doc><doc:description><doc:para>
1848
1793
Number of partitions in the partition table.
1849
1794
This property is only valid if
1850
<doc:ref type="property" to="Device:device-is-partition-table">device-is-partition-table</doc:ref>
1795
<doc:ref type="property" to="Device:DeviceIsPartitionTable">DeviceIsPartitionTable</doc:ref>
1851
1796
is TRUE.
1852
1797
</doc:para></doc:description></doc:doc>
1853
1798
</property>
1854
1799
1855
<property name="drive-vendor" type="s" access="read">
1800
<property name="DriveVendor" type="s" access="read">
1856
1801
<doc:doc><doc:description><doc:para>
1857
1802
Name of the vendor of the drive, for example <doc:tt>MATSHITA</doc:tt> or <doc:tt>BELKIN</doc:tt>.
1858
1803
This property is only valid if
1859
<doc:ref type="property" to="Device:device-is-drive">device-is-drive</doc:ref>
1804
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
1860
1805
is TRUE.
1861
1806
</doc:para></doc:description></doc:doc>
1862
1807
</property>
1863
<property name="drive-model" type="s" access="read">
1808
<property name="DriveModel" type="s" access="read">
1864
1809
<doc:doc><doc:description><doc:para>
1865
1810
Name of the model of the drive, for example <doc:tt>ST910021AS</doc:tt> or <doc:tt>USB 2 HS-CF</doc:tt>.
1866
1811
This property is only valid if
1867
<doc:ref type="property" to="Device:device-is-drive">device-is-drive</doc:ref>
1812
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
1868
1813
is TRUE.
1869
1814
</doc:para></doc:description></doc:doc>
1870
1815
</property>
1871
<property name="drive-revision" type="s" access="read">
1816
<property name="DriveRevision" type="s" access="read">
1872
1817
<doc:doc><doc:description><doc:para>
1873
1818
Revision of the drive, for example <doc:tt>3.07</doc:tt> or <doc:tt>1.95</doc:tt>.
1874
1819
This property is only valid if
1875
<doc:ref type="property" to="Device:device-is-drive">device-is-drive</doc:ref>
1820
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
1876
1821
is TRUE.
1877
1822
</doc:para></doc:description></doc:doc>
1878
1823
</property>
1879
<property name="drive-serial" type="s" access="read">
1824
<property name="DriveSerial" type="s" access="read">
1880
1825
<doc:doc><doc:description><doc:para>
1881
1826
The serial number of the drive or blank if unknown.
1882
1827
Examples: <doc:tt>3MH05AVA</doc:tt>, <doc:tt>A0000001B900</doc:tt>.
1883
1828
This property is only valid if
1884
<doc:ref type="property" to="Device:device-is-drive">device-is-drive</doc:ref>
1829
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
1885
1830
is TRUE.
1886
1831
</doc:para></doc:description></doc:doc>
1887
1832
</property>
1888
<property name="drive-connection-interface" type="s" access="read">
1833
<property name="DriveConnectionInterface" type="s" access="read">
1889
1834
<doc:doc><doc:description><doc:para>
1890
1835
The interface through which the drive is connected. Known values include:
1891
1836
1932
1877
</doc:item>
1933
1878
</doc:list>
1934
1879
This property is only valid if
1935
<doc:ref type="property" to="Device:device-is-drive">device-is-drive</doc:ref>
1880
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
1936
1881
is TRUE.
1937
1882
</doc:para></doc:description></doc:doc>
1938
1883
</property>
1939
<property name="drive-connection-speed" type="t" access="read">
1884
<property name="DriveConnectionSpeed" type="t" access="read">
1940
1885
<doc:doc><doc:description><doc:para>
1941
1886
The nominal speed of the connection interface in bits per
1942
1887
second. If unknown this property is set to 0.
1943
1888
This property is only valid if
1944
<doc:ref type="property" to="Device:device-is-drive">device-is-drive</doc:ref>
1889
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
1945
1890
is TRUE.
1946
1891
</doc:para></doc:description></doc:doc>
1947
1892
</property>
1948
<property name="drive-media-compatibility" type="as" access="read">
1893
<property name="DriveMediaCompatibility" type="as" access="read">
1949
1894
<doc:doc><doc:description><doc:para>
1950
1895
An array of media types that can be used in the
1951
1896
drive. This property is sometimes set using quirk files if
2079
2024
</doc:list>
2080
2025
</doc:para><doc:para>
2081
2026
This property is only valid if
2082
<doc:ref type="property" to="Device:device-is-drive">device-is-drive</doc:ref>
2027
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
2083
2028
is TRUE.
2084
2029
</doc:para></doc:description></doc:doc>
2085
2030
</property>
2086
<property name="drive-media" type="s" access="read">
2031
<property name="DriveMedia" type="s" access="read">
2087
2032
<doc:doc><doc:description><doc:para>
2088
2033
The type of media currently in the drive (blank if no media is available). Known
2089
2034
values include the ones listed for the
2090
<doc:ref type="property" to="Device:drive-media-compatibility">drive-media-compatibility</doc:ref>
2035
<doc:ref type="property" to="Device:DriveMediaCompatibility">DriveMediaCompatibility</doc:ref>
2091
2036
property.
2092
2037
This property is only valid if
2093
<doc:ref type="property" to="Device:device-is-drive">device-is-drive</doc:ref>
2038
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
2094
2039
is TRUE.
2095
2040
</doc:para></doc:description></doc:doc>
2096
2041
</property>
2097
<property name="drive-is-media-ejectable" type="b" access="read">
2042
<property name="DriveIsMediaEjectable" type="b" access="read">
2098
2043
<doc:doc><doc:description><doc:para>
2099
2044
TRUE only if the media can be physically ejected by issuing a command
2100
2045
from the host to the drive (e.g. optical and Zip drives).
2101
2046
This property is only valid if
2102
<doc:ref type="property" to="Device:device-is-drive">device-is-drive</doc:ref>
2047
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
2103
2048
is TRUE.
2104
2049
</doc:para></doc:description></doc:doc>
2105
2050
</property>
2106
<property name="drive-can-detach" type="b" access="read">
2051
<property name="DriveCanDetach" type="b" access="read">
2107
2052
<doc:doc><doc:description><doc:para>
2108
2053
TRUE only if the drive is capable of being detached by
2109
2054
e.g. powering down the port it is connected to.
2110
2055
This property is only valid if
2111
<doc:ref type="property" to="Device:device-is-drive">device-is-drive</doc:ref>
2056
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
2112
2057
is TRUE.
2113
2058
</doc:para></doc:description></doc:doc>
2114
2059
</property>
2115
<property name="drive-can-spindown" type="b" access="read">
2060
<property name="DriveCanSpindown" type="b" access="read">
2116
2061
<doc:doc><doc:description><doc:para>
2117
2062
TRUE only if the drive is capable of being put into
2118
2063
a standby mode (typically powering down the spindle motor).
2119
2064
This property is only valid if
2120
<doc:ref type="property" to="Device:device-is-drive">device-is-drive</doc:ref>
2065
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
2121
2066
is TRUE.
2122
2067
</doc:para></doc:description></doc:doc>
2123
2068
</property>
2124
<property name="drive-is-rotational" type="b" access="read">
2069
<property name="DriveIsRotational" type="b" access="read">
2125
2070
<doc:doc><doc:description><doc:para>
2126
2071
TRUE if the disk uses rotational media, such as a hard disk.
2127
2072
This property is only valid if
2128
<doc:ref type="property" to="Device:device-is-drive">device-is-drive</doc:ref>
2073
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
2129
2074
is TRUE.
2130
2075
</doc:para></doc:description></doc:doc>
2131
2076
</property>
2132
2077
2133
<property name="optical-disc-is-blank" type="b" access="read">
2134
<doc:doc><doc:description><doc:para>
2135
TRUE only if the disc is appendable.
2136
This property is only valid if
2137
<doc:ref type="property" to="Device:device-is-optical-disc">device-is-optical-disc</doc:ref>
2138
is TRUE.
2139
</doc:para></doc:description></doc:doc>
2140
</property>
2141
<property name="optical-disc-is-appendable" type="b" access="read">
2142
<doc:doc><doc:description><doc:para>
2143
TRUE only if the disc is appendable.
2144
This property is only valid if
2145
<doc:ref type="property" to="Device:device-is-optical-disc">device-is-optical-disc</doc:ref>
2146
is TRUE.
2147
</doc:para></doc:description></doc:doc>
2148
</property>
2149
<property name="optical-disc-is-closed" type="b" access="read">
2150
<doc:doc><doc:description><doc:para>
2151
TRUE only if the disc is appendable.
2152
This property is only valid if
2153
<doc:ref type="property" to="Device:device-is-optical-disc">device-is-optical-disc</doc:ref>
2154
is TRUE.
2155
</doc:para></doc:description></doc:doc>
2156
</property>
2157
<property name="optical-disc-num-tracks" type="u" access="read">
2078
<property name="OpticalDiscIsBlank" type="b" access="read">
2079
<doc:doc><doc:description><doc:para>
2080
TRUE only if the disc is appendable.
2081
This property is only valid if
2082
<doc:ref type="property" to="Device:DeviceIsOpticalDisc">DeviceIsOpticalDisc</doc:ref>
2083
is TRUE.
2084
</doc:para></doc:description></doc:doc>
2085
</property>
2086
<property name="OpticalDiscIsAppendable" type="b" access="read">
2087
<doc:doc><doc:description><doc:para>
2088
TRUE only if the disc is appendable.
2089
This property is only valid if
2090
<doc:ref type="property" to="Device:DeviceIsOpticalDisc">DeviceIsOpticalDisc</doc:ref>
2091
is TRUE.
2092
</doc:para></doc:description></doc:doc>
2093
</property>
2094
<property name="OpticalDiscIsClosed" type="b" access="read">
2095
<doc:doc><doc:description><doc:para>
2096
TRUE only if the disc is appendable.
2097
This property is only valid if
2098
<doc:ref type="property" to="Device:DeviceIsOpticalDisc">DeviceIsOpticalDisc</doc:ref>
2099
is TRUE.
2100
</doc:para></doc:description></doc:doc>
2101
</property>
2102
<property name="OpticalDiscNumTracks" type="u" access="read">
2158
2103
<doc:doc><doc:description><doc:para>
2159
2104
Number of tracks on the disc.
2160
2105
This property is only valid if
2161
<doc:ref type="property" to="Device:device-is-optical-disc">device-is-optical-disc</doc:ref>
2106
<doc:ref type="property" to="Device:DeviceIsOpticalDisc">DeviceIsOpticalDisc</doc:ref>
2162
2107
is TRUE.
2163
2108
</doc:para></doc:description></doc:doc>
2164
2109
</property>
2165
<property name="optical-disc-num-audio-tracks" type="u" access="read">
2110
<property name="OpticalDiscNumAudioTracks" type="u" access="read">
2166
2111
<doc:doc><doc:description><doc:para>
2167
2112
Number of audio tracks on the disc.
2168
2113
This property is only valid if
2169
<doc:ref type="property" to="Device:device-is-optical-disc">device-is-optical-disc</doc:ref>
2114
<doc:ref type="property" to="Device:DeviceIsOpticalDisc">DeviceIsOpticalDisc</doc:ref>
2170
2115
is TRUE.
2171
2116
</doc:para></doc:description></doc:doc>
2172
2117
</property>
2173
<property name="optical-disc-num-sessions" type="u" access="read">
2118
<property name="OpticalDiscNumSessions" type="u" access="read">
2174
2119
<doc:doc><doc:description><doc:para>
2175
2120
Number of sessions on the disc.
2176
2121
This property is only valid if
2177
<doc:ref type="property" to="Device:device-is-optical-disc">device-is-optical-disc</doc:ref>
2122
<doc:ref type="property" to="Device:DeviceIsOpticalDisc">DeviceIsOpticalDisc</doc:ref>
2178
2123
is TRUE.
2179
2124
</doc:para></doc:description></doc:doc>
2180
2125
</property>
2181
2126
2182
2127
<!-- **************************************************************************************************** -->
2183
2128
2184
<property name="drive-ata-smart-is-available" type="b" access="read">
2185
<doc:doc><doc:description><doc:para>
2186
TRUE only if drive is capable of reporting
2187
<doc:ulink url="http://en.wikipedia.org/wiki/S.M.A.R.T">ATA SMART</doc:ulink>
2188
data.
2189
</doc:para></doc:description></doc:doc>
2190
</property>
2191
<property name="drive-ata-smart-is-failing" type="b" access="read">
2192
<doc:doc><doc:description><doc:para>
2193
Set to TRUE if ATA SMART indicates that the disk is failing, TRUE otherwise.
2194
This property is only valid if
2195
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2196
is greater than zero and the property
2197
<doc:ref type="property" to="Device:drive-ata-smart-status-valid">drive-ata-smart-status-valid</doc:ref>
2198
is TRUE.
2199
</doc:para></doc:description></doc:doc>
2200
</property>
2201
<property name="drive-ata-smart-is-failing-valid" type="b" access="read">
2202
<doc:doc><doc:description><doc:para>
2203
Set to TRUE only if the property
2204
<doc:ref type="property" to="Device:drive-ata-smart-status">drive-ata-smart-status</doc:ref>
2205
is valid.
2206
This property is only valid if
2207
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2208
is greater than zero.
2209
</doc:para></doc:description></doc:doc>
2210
</property>
2211
<property name="drive-ata-smart-has-bad-sectors" type="b" access="read">
2212
<doc:doc><doc:description><doc:para>
2213
Set to TRUE if ATA SMART indicates that one or more sectors are bad, TRUE otherwise.
2214
This property is only valid if
2215
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2216
is greater than zero.
2217
</doc:para></doc:description></doc:doc>
2218
</property>
2219
<property name="drive-ata-smart-has-bad-attributes" type="b" access="read">
2220
<doc:doc><doc:description><doc:para>
2221
Set to TRUE if ATA SMART indicates that one or more attributes are exceeding their threshold, TRUE otherwise.
2222
This property is only valid if
2223
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2224
is greater than zero.
2225
</doc:para></doc:description></doc:doc>
2226
</property>
2227
<property name="drive-ata-smart-temperature-kelvin" type="d" access="read">
2228
<doc:doc><doc:description><doc:para>
2229
Temperature of the drive in kelvin or 0 if unknown.
2230
This property is only valid if
2231
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2232
is greater than zero.
2233
</doc:para></doc:description></doc:doc>
2234
</property>
2235
<property name="drive-ata-smart-power-on-seconds" type="t" access="read">
2236
<doc:doc><doc:description><doc:para>
2237
Seconds the drive has been powered on or 0 if unknown.
2238
This property is only valid if
2239
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2240
is greater than zero.
2241
</doc:para></doc:description></doc:doc>
2242
</property>
2243
<property name="drive-ata-smart-time-collected" type="t" access="read">
2129
<property name="DriveAtaSmartIsAvailable" type="b" access="read">
2130
<doc:doc><doc:description><doc:para>
2131
TRUE if the disk is capable of reporting SMART data, FALSE otherwise.
2132
</doc:para></doc:description></doc:doc>
2133
</property>
2134
<property name="DriveAtaSmartTimeCollected" type="t" access="read">
2244
2135
<doc:doc><doc:description><doc:para>
2245
2136
The point in time (seconds since the Epoch Jan 1, 1970
2246
0:00 UTC) when ATA SMART data was collected. If data
2247
was never collected, this property will assume the value
2248
0. This property is only valid if
2249
<doc:ref type="property" to="Device:drive-ata-smart-is-available">drive-ata-smart-is-available</doc:ref>
2250
is TRUE.
2251
</doc:para></doc:description></doc:doc>
2252
</property>
2253
<property name="drive-ata-smart-offline-data-collection-status" type="u" access="read">
2254
<doc:doc><doc:description><doc:para>
2255
Offline data collection status (TODO: specify values).
2256
This property is only valid if
2257
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2258
is greater than zero.
2259
</doc:para></doc:description></doc:doc>
2260
</property>
2261
<property name="drive-ata-smart-offline-data-collection-seconds" type="u" access="read">
2262
<doc:doc><doc:description><doc:para>
2263
Number of seconds needed to perform offline data collection status.
2264
This property is only valid if
2265
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2266
is greater than zero.
2267
</doc:para></doc:description></doc:doc>
2268
</property>
2269
<property name="drive-ata-smart-self-test-execution-status" type="u" access="read">
2270
<doc:doc><doc:description><doc:para>
2271
Current status of self test (TODO: specify values).
2272
This property is only valid if
2273
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2274
is greater than zero.
2275
</doc:para></doc:description></doc:doc>
2276
</property>
2277
<property name="drive-ata-smart-self-test-execution-percent-remaining" type="u" access="read">
2278
<doc:doc><doc:description><doc:para>
2279
The progress of an ongoing self test or 0 if no self test is in progress.
2280
This property is only valid if
2281
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2282
is greater than zero.
2283
</doc:para></doc:description></doc:doc>
2284
</property>
2285
<property name="drive-ata-smart-short-and-extended-self-test-available" type="b" access="read">
2286
<doc:doc><doc:description><doc:para>
2287
Whether the short and extended self-tests are available.
2288
This property is only valid if
2289
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2290
is greater than zero.
2291
</doc:para></doc:description></doc:doc>
2292
</property>
2293
<property name="drive-ata-smart-conveyance-self-test-available" type="b" access="read">
2294
<doc:doc><doc:description><doc:para>
2295
Whether the conveyance self-test is available.
2296
This property is only valid if
2297
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2298
is greater than zero.
2299
</doc:para></doc:description></doc:doc>
2300
</property>
2301
<property name="drive-ata-smart-start-self-test-available" type="b" access="read">
2302
<doc:doc><doc:description><doc:para>
2303
Whether the start self-test is available.
2304
This property is only valid if
2305
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2306
is greater than zero.
2307
</doc:para></doc:description></doc:doc>
2308
</property>
2309
<property name="drive-ata-smart-abort-self-test-available" type="b" access="read">
2310
<doc:doc><doc:description><doc:para>
2311
Whether the abort self-test is available.
2312
This property is only valid if
2313
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2314
is greater than zero.
2315
</doc:para></doc:description></doc:doc>
2316
</property>
2317
2318
<property name="drive-ata-smart-short-self-test-polling-minutes" type="u" access="read">
2319
<doc:doc><doc:description><doc:para>
2320
Recommended polling time in minutes for short self-test.
2321
This property is only valid if
2322
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2323
is greater than zero.
2324
</doc:para></doc:description></doc:doc>
2325
</property>
2326
<property name="drive-ata-smart-extended-self-test-polling-minutes" type="u" access="read">
2327
<doc:doc><doc:description><doc:para>
2328
Recommended polling time in minutes for extended self-test.
2329
This property is only valid if
2330
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2331
is greater than zero.
2332
</doc:para></doc:description></doc:doc>
2333
</property>
2334
<property name="drive-ata-smart-conveyance-self-test-polling-minutes" type="u" access="read">
2335
<doc:doc><doc:description><doc:para>
2336
Recommended polling time in minutes for conveyance self-test.
2337
This property is only valid if
2338
<doc:ref type="property" to="Device:drive-ata-smart-time-collected">drive-ata-smart-time-collected</doc:ref>
2339
is greater than zero.
2340
</doc:para></doc:description></doc:doc>
2341
</property>
2342
<property name="drive-ata-smart-attributes" type="a(usubbybybybbbutay)" access="read">
2343
<doc:doc><doc:description><doc:para>
2344
An array of ATA SMART attributes. Each element contains the following members (TODO).
2345
This property is only valid if
2346
<doc:ref type="property" to="Device:drive-smart-time-collected">drive-smart-time-collected</doc:ref>
2137
0:00 UTC) when ATA SMART data was collected.
2138
This property is only valid if
2139
<doc:ref type="property" to="Device:DriveAtaSmartTimeCollected">DriveAtaSmartTimeCollected</doc:ref>
2140
is greater than zero.
2141
</doc:para></doc:description></doc:doc>
2142
</property>
2143
<property name="DriveAtaSmartStatus" type="s" access="read">
2144
<doc:doc><doc:description><doc:para>
2145
The overall assessment for the disk. Is one of the following strings
2146
<quote>GOOD</quote>,
2147
<quote>BAD_ATTRIBUTES_IN_THE_PAST</quote> (At least one pre-fail attribute is exceeded its threshold in the past),
2148
<quote>BAD_SECTOR</quote> (At least one bad sector),
2149
<quote>BAD_ATTRIBUTE_NOW</quote> (At least one pre-fail attribute is exceeding its threshold now),
2150
<quote>BAD_SECTOR_MANY</quote> (Many bad sectors)),
2151
<quote>BAD_STATUS</quote> (Smart Self Assessment negative)
2152
or empty if some error occured trying to determine the result.
2153
This property is only valid if
2154
<doc:ref type="property" to="Device:DriveAtaSmartTimeCollected">DriveAtaSmartTimeCollected</doc:ref>
2155
is greater than zero.
2156
</doc:para></doc:description></doc:doc>
2157
</property>
2158
<property name="DriveAtaSmartBlob" type="ay" access="read">
2159
<doc:doc><doc:description><doc:para>
2160
A blob containing the ATA SMART data. This blob can be used with libatasmart to get
2161
more information.
2162
This property is only valid if
2163
<doc:ref type="property" to="Device:DriveAtaSmartTimeCollected">DriveAtaSmartTimeCollected</doc:ref>
2347
2164
is greater than zero.
2348
2165
</doc:para></doc:description></doc:doc>
2349
2166
</property>
2350
2167
2351
2168
<!-- **************************************************************************************************** -->
2352
2169
2353
<property name="linux-md-component-level" type="s" access="read">
2170
<property name="LinuxMdComponentLevel" type="s" access="read">
2354
2171
<doc:doc><doc:description><doc:para>
2355
2172
The RAID level of the array the component is part of. Known values include
2356
2173
<doc:list>
2380
2197
</doc:item>
2381
2198
</doc:list>
2382
2199
This property is only valid if
2383
<doc:ref type="property" to="Device:device-is-linux-md-component">device-is-linux-md-component</doc:ref>
2200
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
2384
2201
is TRUE.
2385
2202
</doc:para></doc:description></doc:doc>
2386
2203
</property>
2387
<property name="linux-md-component-num-raid-devices" type="i" access="read">
2204
<property name="LinuxMdComponentNumRaidDevices" type="i" access="read">
2388
2205
<doc:doc><doc:description><doc:para>
2389
2206
The number of component devices in the array the component is part of.
2390
2207
This property is only valid if
2391
<doc:ref type="property" to="Device:device-is-linux-md-component">device-is-linux-md-component</doc:ref>
2208
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
2392
2209
is TRUE.
2393
2210
</doc:para></doc:description></doc:doc>
2394
2211
</property>
2395
<property name="linux-md-component-uuid" type="s" access="read">
2212
<property name="LinuxMdComponentUuid" type="s" access="read">
2396
2213
<doc:doc><doc:description><doc:para>
2397
2214
The UUID of the array the component is part of.
2398
2215
This property is only valid if
2399
<doc:ref type="property" to="Device:device-is-linux-md-component">device-is-linux-md-component</doc:ref>
2216
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
2400
2217
is TRUE.
2401
2218
</doc:para></doc:description></doc:doc>
2402
2219
</property>
2403
<property name="linux-md-component-name" type="s" access="read">
2220
<property name="LinuxMdComponentName" type="s" access="read">
2404
2221
<doc:doc><doc:description><doc:para>
2405
2222
The name of the array the component is part of. Blank if the array
2406
2223
doesn't have a name (e.g. pre-1.0 meta data).
2407
2224
This property is only valid if
2408
<doc:ref type="property" to="Device:device-is-linux-md-component">device-is-linux-md-component</doc:ref>
2225
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
2409
2226
is TRUE.
2410
2227
</doc:para></doc:description></doc:doc>
2411
2228
</property>
2412
<property name="linux-md-component-home-host" type="s" access="read">
2229
<property name="LinuxMdComponentHomeHost" type="s" access="read">
2413
2230
<doc:doc><doc:description><doc:para>
2414
2231
The home host of the array the component is part of, e.g. where it was created. Blank if the array
2415
2232
has pre-1.0 meta data.
2416
2233
This property is only valid if
2417
<doc:ref type="property" to="Device:device-is-linux-md-component">device-is-linux-md-component</doc:ref>
2234
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
2418
2235
is TRUE.
2419
2236
</doc:para></doc:description></doc:doc>
2420
2237
</property>
2421
<property name="linux-md-component-version" type="s" access="read">
2238
<property name="LinuxMdComponentVersion" type="s" access="read">
2422
2239
<doc:doc><doc:description><doc:para>
2423
2240
The version of superblock of the component.
2424
2241
This property is only valid if
2425
<doc:ref type="property" to="Device:device-is-linux-md-component">device-is-linux-md-component</doc:ref>
2242
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
2426
2243
is TRUE.
2427
2244
</doc:para></doc:description></doc:doc>
2428
2245
</property>
2429
<property name="linux-md-component-holder" type="o" access="read">
2246
<property name="LinuxMdComponentHolder" type="o" access="read">
2430
2247
<doc:doc><doc:description><doc:para>
2431
2248
The holder of the component or "/" if the component isn't claimed by any array.
2432
2249
This property is only valid if
2433
<doc:ref type="property" to="Device:device-is-linux-md-component">device-is-linux-md-component</doc:ref>
2250
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
2434
2251
is TRUE.
2435
2252
</doc:para></doc:description></doc:doc>
2436
2253
</property>
2437
<property name="linux-md-component-state" type="as" access="read">
2254
<property name="LinuxMdComponentState" type="as" access="read">
2438
2255
<doc:doc><doc:description><doc:para>
2439
2256
The state of the component (contents of <literal>md/dev-XXX/state</literal> file).
2440
2257
This property is only valid if
2441
<doc:ref type="property" to="Device:device-is-linux-md-component">device-is-linux-md-component</doc:ref>
2258
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
2442
2259
is TRUE and
2443
<doc:ref type="property" to="Device:device-is-linux-md-component-holder">device-is-linux-md-component-holder</doc:ref>
2260
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponentHolder">DeviceIsLinuxMdComponentHolder</doc:ref>
2444
2261
is non-empty.
2445
2262
</doc:para></doc:description></doc:doc>
2446
2263
</property>
2447
2264
2448
<property name="linux-md-state" type="s" access="read">
2265
<property name="LinuxMdState" type="s" access="read">
2449
2266
<doc:doc><doc:description><doc:para>
2450
2267
The state of the array (contents of the <literal>md/array_state</literal> file).
2451
2268
This property is only valid if
2452
<doc:ref type="property" to="Device:device-is-linux-md">device-is-linux-md</doc:ref>
2269
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
2453
2270
is TRUE.
2454
2271
</doc:para></doc:description></doc:doc>
2455
2272
</property>
2456
<property name="linux-md-level" type="s" access="read">
2273
<property name="LinuxMdLevel" type="s" access="read">
2457
2274
<doc:doc><doc:description><doc:para>
2458
2275
The RAID level of the array. For known values see the
2459
<doc:ref type="property" to="Device:linux-md-component-level">linux-md-component-level</doc:ref>
2276
<doc:ref type="property" to="Device:LinuxMdComponentLevel">LinuxMdComponentLevel</doc:ref>
2460
2277
property.
2461
2278
This property is only valid if
2462
<doc:ref type="property" to="Device:device-is-linux-md">device-is-linux-md</doc:ref>
2279
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
2463
2280
is TRUE.
2464
2281
</doc:para></doc:description></doc:doc>
2465
2282
</property>
2466
<property name="linux-md-uuid" type="s" access="read">
2283
<property name="LinuxMdUuid" type="s" access="read">
2467
2284
<doc:doc><doc:description><doc:para>
2468
2285
The UUID of the array.
2469
2286
This property is only valid if
2470
<doc:ref type="property" to="Device:device-is-linux-md">device-is-linux-md</doc:ref>
2287
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
2471
2288
is TRUE.
2472
2289
</doc:para></doc:description></doc:doc>
2473
2290
</property>
2474
<property name="linux-md-home-host" type="s" access="read">
2291
<property name="LinuxMdHomeHost" type="s" access="read">
2475
2292
<doc:doc><doc:description><doc:para>
2476
2293
The home host of the array, e.g. where if was created. Blank if the array
2477
2294
has pre-1.0 meta data.
2478
<doc:ref type="property" to="Device:device-is-linux-md">device-is-linux-md</doc:ref>
2295
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
2479
2296
is TRUE.
2480
2297
</doc:para></doc:description></doc:doc>
2481
2298
</property>
2482
<property name="linux-md-name" type="s" access="read">
2299
<property name="LinuxMdName" type="s" access="read">
2483
2300
<doc:doc><doc:description><doc:para>
2484
2301
The name of the array. Blank if the array
2485
2302
doesn't have a name (e.g. pre-1.0 meta data).
2486
<doc:ref type="property" to="Device:device-is-linux-md">device-is-linux-md</doc:ref>
2303
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
2487
2304
is TRUE.
2488
2305
</doc:para></doc:description></doc:doc>
2489
2306
</property>
2490
<property name="linux-md-num-raid-devices" type="i" access="read">
2307
<property name="LinuxMdNumRaidDevices" type="i" access="read">
2491
2308
<doc:doc><doc:description><doc:para>
2492
2309
Number of component devices in the array.
2493
2310
This property is only valid if
2494
<doc:ref type="property" to="Device:device-is-linux-md">device-is-linux-md</doc:ref>
2311
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
2495
2312
is TRUE.
2496
2313
</doc:para></doc:description></doc:doc>
2497
2314
</property>
2498
<property name="linux-md-version" type="s" access="read">
2315
<property name="LinuxMdVersion" type="s" access="read">
2499
2316
<doc:doc><doc:description><doc:para>
2500
2317
Metadata version used in the components.
2501
2318
This property is only valid if
2502
<doc:ref type="property" to="Device:device-is-linux-md">device-is-linux-md</doc:ref>
2319
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
2503
2320
is TRUE.
2504
2321
</doc:para></doc:description></doc:doc>
2505
2322
</property>
2506
<property name="linux-md-slaves" type="ao" access="read">
2323
<property name="LinuxMdSlaves" type="ao" access="read">
2507
2324
<doc:doc><doc:description><doc:para>
2508
2325
An array of object paths for components currently part of the array.
2509
2326
This property is only valid if
2510
<doc:ref type="property" to="Device:device-is-linux-md">device-is-linux-md</doc:ref>
2327
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
2511
2328
is TRUE.
2512
2329
</doc:para></doc:description></doc:doc>
2513
2330
</property>
2514
<property name="linux-md-is-degraded" type="b" access="read">
2331
<property name="LinuxMdIsDegraded" type="b" access="read">
2515
2332
<doc:doc><doc:description><doc:para>
2516
2333
TRUE only if the array is running in degraded mode.
2517
2334
This property is only valid if
2518
<doc:ref type="property" to="Device:device-is-linux-md">device-is-linux-md</doc:ref>
2335
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
2519
2336
is TRUE.
2520
2337
</doc:para></doc:description></doc:doc>
2521
2338
</property>
2522
<property name="linux-md-sync-action" type="s" access="read">
2339
<property name="LinuxMdSyncAction" type="s" access="read">
2523
2340
<doc:doc><doc:description><doc:para>
2524
2341
The operation currently pending on the array. Known values
2525
2342
include
2546
2363
</doc:item>
2547
2364
</doc:list>
2548
2365
This property is only valid if
2549
<doc:ref type="property" to="Device:device-is-linux-md">device-is-linux-md</doc:ref>
2366
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
2550
2367
is TRUE.
2551
2368
</doc:para></doc:description></doc:doc>
2552
2369
</property>
2553
<property name="linux-md-sync-percentage" type="d" access="read">
2370
<property name="LinuxMdSyncPercentage" type="d" access="read">
2554
2371
<doc:doc><doc:description><doc:para>
2555
2372
The progress of the current sync operation.
2556
2373
This property is only valid if
2557
<doc:ref type="property" to="Device:device-is-linux-md">device-is-linux-md</doc:ref>
2374
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
2558
2375
is TRUE and the value of the property
2559
<doc:ref type="property" to="Device:linux-md-sync-action">linux-md-sync-action</doc:ref>
2376
<doc:ref type="property" to="Device:LinuxMdSyncAction">LinuxMdSyncAction</doc:ref>
2560
2377
is not <doc:tt>idle</doc:tt>.
2561
2378
</doc:para></doc:description></doc:doc>
2562
2379
</property>
2563
<property name="linux-md-sync-speed" type="t" access="read">
2380
<property name="LinuxMdSyncSpeed" type="t" access="read">
2564
2381
<doc:doc><doc:description><doc:para>
2565
2382
The speed of the sync operation in bytes per second.
2566
2383
This property is only valid if
2567
<doc:ref type="property" to="Device:device-is-linux-md">device-is-linux-md</doc:ref>
2384
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
2568
2385
is TRUE and the value of the property
2569
<doc:ref type="property" to="Device:linux-md-sync-action">linux-md-sync-action</doc:ref>
2386
<doc:ref type="property" to="Device:LinuxMdSyncAction">LinuxMdSyncAction</doc:ref>
2570
2387
is not <doc:tt>idle</doc:tt>.
2571
2388
</doc:para></doc:description></doc:doc>
2572
2389
</property>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1