/usr/share/dbus-1/interfaces/org.freedesktop.UDisks.Device.xml is in udisks 1.0.4-5ubuntu2.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 | <!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name="org.freedesktop.UDisks.Device">
<doc:doc>
<doc:description>
<doc:para>
This interface provides information about a block device on
a UNIX-like system. In addition to just providing
information, methods can be invoked to perform operations on
the block device. Objects implementing this interface have
object paths prefixed with <doc:tt>/devices/</doc:tt>
followed by a sanitized representation of the base name of
their native path. As the D-Bus specification greatly limits
what characters can be used in object paths, this doesn't
necessarily map one to one with the native basename; for
example the native
path <doc:tt>/sys/devices/virtual/block/dm-0</doc:tt> will
be represented as <doc:tt>/devices/dm_0</doc:tt>.
</doc:para>
<doc:para>
Most methods on this interface take an array of strings
for options that can affect what the method does. Some of
these options are literal strings (such
as <doc:tt>noatime</doc:tt>) while some are encoded in the
form of a key/value pair (such
as <doc:tt>label=</doc:tt>).
</doc:para>
<doc:para>
A general note about properties: the set of values
returned can be expected to grow in the future as both
hardware and operating system capabilities evolve. Care
has been taken to namespace values so applications can
properly fall back (see e.g.
<doc:ref type="property" to="Device:DriveMediaCompatibility">DriveMediaCompatibility</doc:ref>)
and export both general and specific properties (such as
<doc:ref type="property" to="Device:IdUsage">IdUsage</doc:ref>
vs.
<doc:ref type="property" to="Device:IdType">IdType</doc:ref>).
In general an empty string in a property means not
set. Since the empty string is not a valid object path we
use the "/" to mean "not set" for object paths.
</doc:para>
</doc:description>
</doc:doc>
<!-- ************************************************************ -->
<method name="JobCancel">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Cancels a job in progress.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.cancel-job-others</doc:term>
<doc:definition>To cancel a job initiated by another user</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="PartitionTableCreate">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="scheme" direction="in" type="s">
<doc:doc><doc:summary>
The scheme of the partition table to create.
</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>No options are currently supported.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Creates a new partition table. The following partition table schemes are supported:
<doc:list>
<doc:item>
<doc:term>none</doc:term>
<doc:definition>To zero out existing partition tables signatures.</doc:definition>
</doc:item>
<doc:item>
<doc:term>mbr</doc:term>
<doc:definition>
Use the
<doc:ulink url="http://en.wikipedia.org/wiki/Master_Boot_Record">Master Boot Record</doc:ulink>
partitioning scheme.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>gpt</doc:term>
<doc:definition>
Use the
<doc:ulink url="http://en.wikipedia.org/wiki/GUID_Partition_Table">GUID Partition Table</doc:ulink>
scheme.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>apm</doc:term>
<doc:definition>
Use the
<doc:ulink url="http://en.wikipedia.org/wiki/Apple_Partition_Map">Apple Partition Map</doc:ulink>
partitioning scheme.
</doc:definition>
</doc:item>
</doc:list>
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.change</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
device</doc:definition>
</doc:item>
<doc:item>
<doc:term>org.freedesktop.udisks.change-system-internal</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
device</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device or a partition on it are busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="PartitionDelete">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>No options are currently supported.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Deletes a partition, removing it from the enclosing partition table.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.change</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
device</doc:definition>
</doc:item>
<doc:item>
<doc:term>org.freedesktop.udisks.change-system-internal</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
device</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device is busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="PartitionCreate">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="offset" direction="in" type="t">
<doc:doc><doc:summary>Where on the device to create the partition.</doc:summary></doc:doc>
</arg>
<arg name="size" direction="in" type="t">
<doc:doc><doc:summary>Size of the partitition to create.</doc:summary></doc:doc>
</arg>
<arg name="type" direction="in" type="s">
<doc:doc><doc:summary>
The type of the partition to create. Valid types depends
on the partitioning scheme used:
<doc:list>
<doc:item>
<doc:term>mbr</doc:term>
<doc:definition>
For the
<doc:ulink url="http://en.wikipedia.org/wiki/Master_Boot_Record">Master Boot Record</doc:ulink>
partitioning scheme, the
given type must be a string representation of an
integer (both decimal and hexadecimal encodings are
accepted) between 0 and 255 both inclusive.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>gpt</doc:term>
<doc:definition>
Any valid GUID string.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>apm</doc:term>
<doc:definition>
Any valid type for
<doc:ulink url="http://en.wikipedia.org/wiki/Apple_Partition_Map">Apple Partition Map</doc:ulink>
for example <doc:tt>Apple_Unix_SVR2</doc:tt>.
</doc:definition>
</doc:item>
</doc:list>
</doc:summary></doc:doc>
</arg>
<arg name="label" direction="in" type="s">
<doc:doc><doc:summary>
The label to use for the partition. Leave blank if the
partition table scheme is <doc:tt>mbr</doc:tt>.
</doc:summary></doc:doc>
</arg>
<arg name="flags" direction="in" type="as">
<doc:doc><doc:summary>
Flags to use for the partition. Valid flags depends on the
partitioning scheme used:
<doc:list>
<doc:item>
<doc:term>mbr</doc:term>
<doc:definition>
Only the flag <doc:tt>boot</doc:tt> is valid.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>gpt</doc:term>
<doc:definition>
Only the flag <doc:tt>required</doc:tt> is valid.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>apm</doc:term>
<doc:definition>
The flags
<doc:tt>allocated</doc:tt>,
<doc:tt>in_use</doc:tt>,
<doc:tt>boot</doc:tt>,
<doc:tt>allow_read</doc:tt>,
<doc:tt>allow_write</doc:tt>,
<doc:tt>boot_code_is_pic</doc:tt>
are valid.
</doc:definition>
</doc:item>
</doc:list>
</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Currently unused.</doc:summary></doc:doc>
</arg>
<arg name="fstype" direction="in" type="s">
<doc:doc><doc:summary>
The file system to create in new partition. Leave
blank to skip creating a file system. See the
<doc:ref type="method" to="Device.FilesystemCreate">FilesystemCreate()</doc:ref> method
for details.
</doc:summary></doc:doc>
</arg>
<arg name="fsoptions" direction="in" type="as">
<doc:doc><doc:summary>
Options to use for file system creation. See the
<doc:ref type="method" to="Device.FilesystemCreate">FilesystemCreate()</doc:ref> method
for details.
</doc:summary></doc:doc>
</arg>
<arg name="created_device" direction="out" type="o">
<doc:doc><doc:summary>The object path of the newly added partition.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Create a new partition and, optionally, create a file
system on it. The partition won't necessarily be created
at the exact location requested due to disk geometry
constraints.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.change</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
device</doc:definition>
</doc:item>
<doc:item>
<doc:term>org.freedesktop.udisks.change-system-internal</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
device</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device is busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="PartitionModify">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="type" direction="in" type="s">
<doc:doc><doc:summary>
The type of the partition to create. See the <doc:tt>type</doc:tt> parameter of the
<doc:ref type="method" to="Device.PartitionCreate">PartitionCreate()</doc:ref> method
for details on valid types.
</doc:summary></doc:doc>
</arg>
<arg name="label" direction="in" type="s">
<doc:doc><doc:summary>
The label to use for the partition. See the <doc:tt>label</doc:tt> parameter of the
<doc:ref type="method" to="Device.PartitionCreate">PartitionCreate()</doc:ref> method
for details on valid labels.
</doc:summary></doc:doc>
</arg>
<arg name="flags" direction="in" type="as">
<doc:doc><doc:summary>
Flags to use for the partition. See the <doc:tt>flags</doc:tt> parameter of the
<doc:ref type="method" to="Device.PartitionCreate">PartitionCreate()</doc:ref> method
for details on valid flags
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Modifies meta data for a partition, such as type, label and flags.
TODO: Consider allowing changing offset and
size. Or maybe that should be a separate method.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.change</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
device</doc:definition>
</doc:item>
<doc:item>
<doc:term>org.freedesktop.udisks.change-system-internal</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:device-is-system-internal">system-internal</doc:ref>
device</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the enclosing partition table device is busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="FilesystemCreate">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="fstype" direction="in" type="s">
<doc:doc><doc:summary>
The type of file system to
create. Pass <doc:tt>empty</doc:tt> to not create a file
system and just clear the areas of the device known to host
file system signatures. Use @TODO@ to get a list of file systems that can
be created.
</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>
To set the label on the file system use
the <doc:tt>label=NAME</doc:tt> option. Labels may not be
supported for all file systems and the allowed length of a
label may vary (see @TODO@). To create the file system on
an LUKS encrypted block device, pass
the <doc:tt>luks_encrypt=</doc:tt> option with the value
set to the passphrase to use. For file systems with the
concept of owners (e.g.
<doc:tt>ext3</doc:tt>), the options <doc:tt>take_ownership_uid=</doc:tt> and
<doc:tt>take_ownership_gid=</doc:tt> are supported and can be used to set the
initial owner of the created file system.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Create a file system on a device. If
the <doc:tt>luks_encrypt=</doc:tt> option is passed then an
LUKS encrypted block device will be created, then unlocked and
the file system will be created on the corresponding
cleartext device.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.change</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
device</doc:definition>
</doc:item>
<doc:item>
<doc:term>org.freedesktop.udisks.change-system-internal</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:device-is-system-internal">system-internal</doc:ref>
device</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device is busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.FilesystemToolsMissing">if mkfs for this type is not available</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="FilesystemSetLabel">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="new_label" direction="in" type="s">
<doc:doc><doc:summary>
New label for file system.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Changes the file system label. See the <doc:tt>options</doc:tt> parameter of
<doc:ref type="method"
to="Device.FilesystemCreate">FilesystemCreate()</doc:ref>
method for details of what valid labels are valid.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.change</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
device</doc:definition>
</doc:item>
<doc:item>
<doc:term>org.freedesktop.udisks.change-system-internal</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
device</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device is busy and changing the label requires an unmounted file system</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.FilesystemToolsMissing">if the label changing tool for this file system type is not available</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="FilesystemMount">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="filesystem_type" direction="in" type="s">
<doc:doc><doc:summary>File system type to use.</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>
Mount Options. Valid mount options include mount options accepted by the native mount program.
The option <quote>auth_no_user_interaction</quote> can be used to avoid user interaction (e.g. authentication dialogs) when checking whether the caller is authorized.</doc:summary></doc:doc>
</arg>
<arg name="mount_path" direction="out" type="s">
<doc:doc><doc:summary>Where the device was mounted.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Mount the device. If the device is referenced in the
system-wide <doc:tt>/etc/fstab</doc:tt> file, the given
parameters are all ignored and the device will be
attempted to be mounted as the calling user.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.filesystem-mount</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
device</doc:definition>
</doc:item>
<doc:item>
<doc:term>org.freedesktop.udisks.filesystem-mount-system-internal</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
device</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device is busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.InvalidOption">if an invalid or malformed mount option was given</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.FilesystemDriverMissing">if the kernel driver for this file system type is not available</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="FilesystemUnmount">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Unmount options. Valid options currently include only 'force'.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Unmount the device. If the device is referenced in the
system-wide <doc:tt>/etc/fstab</doc:tt> file (both at
mount time and when this method is invoked), the device
will be attempted to be unmounted as the calling user.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.filesystem-unmount-others</doc:term>
<doc:definition>To unmount a device mounted by another user</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device is busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.InvalidOption">if an invalid or malformed unmount option was given</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="FilesystemCheck">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Currently unused.</doc:summary></doc:doc>
</arg>
<arg name="is_clean" direction="out" type="b">
<doc:doc><doc:summary>
Returns TRUE if the file system is clean, FALSE if there are errors on the file system.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Perform a non-interactive file system check.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.filesystem-check</doc:term>
<doc:definition>To check a file system on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
device.</doc:definition>
</doc:item>
<doc:item>
<doc:term>org.freedesktop.udisks.filesystem-check-system-internal</doc:term>
<doc:definition>To check a file system on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
device.</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device is mounted and the file system doesn't support online file system checking. See TODO for how to determine if a file system supports online fsck</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="FilesystemListOpenFiles">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="processes" direction="out" type="a(uus)">
<doc:doc><doc:summary>
An array of triples (<doc:tt>pid</doc:tt>, <doc:tt>uid</doc:tt>, command line for the process
image) for processes currently having open files on the given mounted file system.
Note that this operation is not run as a job.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
List open files on a mounted file system.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.filesystem-lsof</doc:term>
<doc:definition>To check a file system on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
device.</doc:definition>
</doc:item>
<doc:item>
<doc:term>org.freedesktop.udisks.filesystem-lsof-system-internal</doc:term>
<doc:definition>To check a file system on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
device.</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device is mounted and the file system doesn't support online file system checking. See TODO for how to determine if a file system supports online fsck</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LuksUnlock">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="passphrase" direction="in" type="s">
<doc:doc><doc:summary>Passphrase for unlocking the cleartext data.</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Currently unused.</doc:summary></doc:doc>
</arg>
<arg name="cleartext_device" direction="out" type="o">
<doc:doc><doc:summary>The cleartext device created.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Sets up a cleartext device using the given device as backing store.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.luks-unlock</doc:term>
<doc:definition>To unlock LUKS encrypted devices</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device is busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LuksLock">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Currently unused.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Tears down the cleartext device set up using
e.g. the <doc:ref type="method"
to="Device.LuksUnlock">LuksUnlock()</doc:ref>
method.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.luks-lock-others</doc:term>
<doc:definition>To lock an encrypted LUKS device unlocked by another user</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device is busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LuksChangePassphrase">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="current_passphrase" direction="in" type="s">
<doc:doc><doc:summary>The current passphrase.</doc:summary></doc:doc>
</arg>
<arg name="new_passphrase" direction="in" type="s">
<doc:doc><doc:summary>The new passphrase.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Change the passphrase used to unlock a LUKS encrypted device.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.change</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">non-system-internal</doc:ref>
device</doc:definition>
</doc:item>
<doc:item>
<doc:term>org.freedesktop.udisks.change-system-internal</doc:term>
<doc:definition>If the operation is on a
<doc:ref type="property" to="Device:DeviceIsSystemInternal">system-internal</doc:ref>
device</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device is busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxMdAddSpare">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="component" direction="in" type="o">
<doc:doc><doc:summary>Object path of the component to add</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Currently unused.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Adds a component to a Linux md RAID array. Existing data
on the given component will be erased.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-md</doc:term>
<doc:definition>
Needed to configured Linux md Software RAID devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">component to add is busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxMdExpand">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="components" direction="in" type="ao">
<doc:doc><doc:summary>Object paths of the components to use for growing the array</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Currently unused.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Grows the Linux md RAID array with the given components.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-md</doc:term>
<doc:definition>
Needed to configured Linux md Software RAID devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">component to add is busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxMdRemoveComponent">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="component" direction="in" type="o">
<doc:doc><doc:summary>The component to remove from the array.</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>No options are currently supported.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Removes a component from a Linux md RAID array. The component
will be removed and then the signatures on the component will be
scrubbed.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-md</doc:term>
<doc:definition>
Needed to configured Linux md Software RAID devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">component to add is busy</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxMdStop">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Currently unused.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Stops a Linux md RAID array.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-md</doc:term>
<doc:definition>
Needed to configured Linux md Software RAID devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxLvm2LVStop">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Currently unused.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Stops a Linux LVM2 Logical Volume.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-lvm2</doc:term>
<doc:definition>
Needed to configured Linux LVM2.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="LinuxMdCheck">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>
Use the <doc:tt>repair</doc:tt> option to fix any problems encountered.
</doc:summary></doc:doc>
</arg>
<arg name="number_of_errors" direction="out" type="t">
<doc:doc>
<doc:summary>
Number of mismatched sectors/pages found (or fixed if the <doc:tt>repair</doc:tt> option is used).
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Checks a Linux md RAID array and returns the number of
sectors/page with errors found/fixed. This can only be done if the
property
<doc:ref type="property" to="Device:LinuxMdSyncAction">LinuxMdSyncAction</doc:ref>
is <quote>idle</quote>.
</doc:para>
</doc:description>
<doc:permission>
The caller will need the following PolicyKit authorization:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.linux-md</doc:term>
<doc:definition>
Needed to configured Linux md Software RAID devices.
</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveInhibitPolling">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Inhibit options. Currently no options are recognized.</doc:summary></doc:doc>
</arg>
<arg name="cookie" direction="out" type="s">
<doc:doc><doc:summary>
A cookie that can be used in the
<doc:ref type="method" to="Device.DriveUninhibitPolling">DriveUninhibitPolling()</doc:ref> method
to stop inhibiting polling of the device.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Inhibits the daemon from polling the device for media changes.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.inhibit-polling</doc:term>
<doc:definition>To inhibit polling</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveUninhibitPolling">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="cookie" direction="in" type="s">
<doc:doc><doc:summary>
A cookie obtained from the
<doc:ref type="method" to="Device.DriveInhibitPolling">DriveInhibitPolling()</doc:ref> method.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Uninhibits daemon from polling the device for media changes.
</doc:para>
</doc:description>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the given cookie is malformed</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DrivePollMedia">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Polls the drive for media. This is typically only useful when the
<doc:ref type="property" to="Device:DeviceIsMediaChangeDetected">DeviceIsMediaChangeDetected</doc:ref> property
is FALSE.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.inhibit-polling</doc:term>
<doc:definition>To inhibit polling</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveEject">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Eject options. Valid options currently include only 'unmount'.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Ejects media from the device. If the <doc:term>unmount</doc:term> option is given, the device might have mounted file systems, which will be unmounted before ejection.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.drive-eject</doc:term>
<doc:definition>To eject media from a device</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device or a dependent device (e.g. partition or cleartext luks device) is busy (e.g. mounted)</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.InvalidOption">if an invalid or malformed option was given</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveDetach">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Detach options. Currently no options are recognized.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Detachs the device by e.g. powering down the physical port
it is connected to. Note that not all devices or ports are
capable of this. Check the
<doc:ref type="property" to="Device:DriveCanDetach">DriveCanDetach</doc:ref>
property before attempting to invoke this method.
</doc:para>
<doc:para>
Note that the physical port a drive belongs to may be
located inside the physical casing - for example, some
netbooks provide a SD card drive connect through USB. As
such, users of this method should be careful – don't
automatically invoke this method if the user presses
e.g. an Eject button in the UI. Instead, provide e.g. a
"Safely Remove Drive" option.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.drive-detach</doc:term>
<doc:definition>To detach a device</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Busy">if the device or a dependent device (e.g. partition or cleartext luks device) is busy (e.g. mounted)</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.InvalidOption">if an invalid or malformed option was given</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveSetSpindownTimeout">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="timeout_seconds" direction="in" type="i">
<doc:doc><doc:summary>
Number of seconds before the drive should be spun down.
</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>
Options related to setting spindown timeout. Currently no options are recognized.
</doc:summary></doc:doc>
</arg>
<arg name="cookie" direction="out" type="s">
<doc:doc><doc:summary>
A cookie that can be used in the
<doc:ref type="method" to="Device.DriveUnsetSpindownTimeout">DriveUnsetSpindownTimeout()</doc:ref> method
to unset the spindown timeout of the device.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Configures spindown timeout for the drive.
Check the
<doc:ref type="property" to="Device:DriveCanSpindown">DriveCanSpindown</doc:ref>
property before attempting to invoke this method.
Caution should be exercised when using this method, see
the SPINNING DOWN DISKS section in the
udisks<doc:tt>(1)</doc:tt> man page before using it.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.drive-set-spindown</doc:term>
<doc:definition>To set spindown timeouts</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.InvalidOption">if an invalid or malformed option was given</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveUnsetSpindownTimeout">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="cookie" direction="in" type="s">
<doc:doc><doc:summary>
A cookie obtained from the
<doc:ref type="method" to="Device.DriveSetSpindownTimeout">DriveSetSpindownTimeout()</doc:ref> method.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Unsets spindown timeout for the drive.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.drive-set-spindown</doc:term>
<doc:definition>To set spindown timeouts</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveAtaSmartRefreshData">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>
The option <doc:tt>nowakeup</doc:tt> can be passed to
avoid spinning up the disk if it's in a low-power mode.
The option <doc:tt>simulate=</doc:tt> can be used to pass a path to
a blob with libatasmart data to use instead of reading it from the disk.
The <doc:tt>simulate=</doc:tt> option can only be used by the super user.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Refreshes the
<doc:ulink url="http://en.wikipedia.org/wiki/S.M.A.R.T">ATA SMART</doc:ulink>
data for the given drive. Note that this operation is not run as a job.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.drive-ata-smart-refresh</doc:term>
<doc:definition>Needed to refresh ATA SMART data</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.AtaSmartWouldWakeup">If the disk is sleeping and the <doc:tt>nowakeup</doc:tt> option was passed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveAtaSmartInitiateSelftest">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="test" direction="in" type="s">
<doc:doc><doc:summary>
The name of the test to run; supported values are 'short'
(usually less than ten minutes), 'extended' (usually tens
of minutes) and 'conveyance' (usually a few minutes).
</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Currently unused.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Runs a ATA SMART self test on the drive.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.drive-ata-smart-selftest</doc:term>
<doc:definition>Needed to run ATA SMART self tests</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="DriveBenchmark">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="do_write_benchmark" direction="in" type="b">
<doc:doc><doc:summary>
If TRUE, write performance will be benchmarked in addition
to read performance. Note that benchmarking write performance
will scribble zeros in various parts of the drive and can
only be used on a drive where the contents are completely
unrecognized (e.g. no partition table and device). Use
this option with caution.
</doc:summary></doc:doc>
</arg>
<arg name="options" direction="in" type="as">
<doc:doc><doc:summary>Currently unused.</doc:summary></doc:doc>
</arg>
<arg name="read_transfer_rate_results" direction="out" type="a(td)">
<doc:doc><doc:summary>
An array of pairs where the first element is the offset
and the second element is the measured read transfer rate
(in bytes/sec) at the given offset.
</doc:summary></doc:doc>
</arg>
<arg name="write_transfer_rate_results" direction="out" type="a(td)">
<doc:doc><doc:summary>
An array of pairs where the first element is the offset
and the second element is the measured read transfer rate
(in bytes/sec) at the given offset.
This is an empty array unless write benchmarking has been
requested.
</doc:summary></doc:doc>
</arg>
<arg name="access_time_results" direction="out" type="a(td)">
<doc:doc><doc:summary>
An array of pairs where the first element is the offset
and the second element the amount of time (in seconds) it
took to seek to the position.
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Benchmarks the drive.
</doc:para>
</doc:description>
<doc:permission>
The caller will need one of the following PolicyKit authorizations:
<doc:list>
<doc:item>
<doc:term>org.freedesktop.udisks.change</doc:term>
<doc:definition>Needed to run benchmarks</doc:definition>
</doc:item>
</doc:list>
</doc:permission>
<doc:errors>
<doc:error name="org.freedesktop.PolicyKit.Error.NotAuthorized">if the caller lacks the appropriate PolicyKit authorization</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Failed">if the operation failed</doc:error>
<doc:error name="org.freedesktop.PolicyKit.Error.Cancelled">if the job was cancelled</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<signal name="Changed">
<doc:doc>
<doc:description>
<doc:para>
Something on the device changed. Changes in job state wont
trigger this signal; see the <doc:ref type="signal"
to="Device::JobChanged">JobChanged()</doc:ref> signal.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="JobChanged">
<arg name="job_in_progress" type="b">
<doc:doc><doc:summary>Whether a job is currently in progress.</doc:summary></doc:doc>
</arg>
<arg name="job_is_cancellable" type="b">
<doc:doc><doc:summary>Whether the job is cancellable.</doc:summary></doc:doc>
</arg>
<arg name="job_id" type="s">
<doc:doc><doc:summary>The identifier of the job.</doc:summary></doc:doc>
</arg>
<arg name="job_initiated_by_uid" type="u">
<doc:doc><doc:summary>The UNIX user id of the user who initiated the job.</doc:summary></doc:doc>
</arg>
<arg name="job_percentage" type="d">
<doc:doc><doc:summary>Percentage completed of the job (between 0 and 100, negative if unknown).</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a job on a device changes. Clients should
listen to this signal to avoid polling the daemon for job
state.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<property name="NativePath" type="s" access="read">
<doc:doc><doc:description><doc:para>
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>.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceDetectionTime" type="t" access="read">
<doc:doc><doc:description><doc:para>
The point in time (seconds since the Epoch Jan 1, 1970 0:00 UTC) when the device
was detected by the daemon.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceMediaDetectionTime" type="t" access="read">
<doc:doc><doc:description><doc:para>
The point in time (seconds since the Epoch Jan 1, 1970 0:00 UTC) when the
media currently in the device was detected by the daemon or 0 if the
device has no media.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceMajor" type="x" access="read">
<doc:doc><doc:description><doc:para>
Major for the device or -1 if not set.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceMinor" type="x" access="read">
<doc:doc><doc:description><doc:para>
Major for the device or -1 if not set.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceFile" type="s" access="read">
<doc:doc><doc:description><doc:para>
UNIX special device file for device. Example: <doc:tt>/dev/sda</doc:tt>.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceFilePresentation" type="s" access="read">
<doc:doc><doc:description><doc:para>
Either the value of the
<doc:ref type="property" to="Device:DeviceFile">DeviceFile</doc:ref>
property, otherwise the preferred device file (typically a symlink to the value of the
<doc:ref type="property" to="Device:DeviceFile">DeviceFile</doc:ref>
property) to present in user interface.
Example: <doc:tt>/dev/mapper/mpathb</doc:tt> or
<doc:tt>/dev/vg_phobos/lv_root</doc:tt>.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceFileById" type="as" access="read">
<doc:doc><doc:description><doc:para>
Symlinks to UNIX special device file that are stable and uniquely identifies the device.
Example: <doc:tt>/dev/disk/by-id/scsi-SATA_ST910021AS_3MH05AVA</doc:tt>,
<doc:tt>/dev/disk/by-id/ata-ST910021AS_3MH05AVA</doc:tt>.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceFileByPath" type="as" access="read">
<doc:doc><doc:description><doc:para>
Symlinks to UNIX special device file that uniquely identifies the port/partition the device
is plugged into. Example: <doc:tt>/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:1:0</doc:tt>
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsSystemInternal" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device is considered system internal. Typically, system internal devices
include non-removable internal hard disks and other drives that are not easily added/removed
by a local console user. The heuristic typically used is that only devices on removable media
and devices connected via Firewire, USB, eSATA and SDIO are considered external.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsPartition" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device is a partition. See the properties starting with partition- for details.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsPartitionTable" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device contains a partition table. See partition- properties for details.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsRemovable" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device contains removable media.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsMediaAvailable" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if media is available in the device.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsMediaChangeDetected" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if media changes are detected.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsMediaChangeDetectionPolling" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if media changes are detected through the host
polling the device, e.g. waking up every two seconds to
revalidate the media. This typically keeps the device in a
high power state and uses cycles on the CPU. As an
example, SATA AN capable optical drives does not need
polling.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsMediaChangeDetectionInhibitable" type="b" access="read">
<doc:doc><doc:description><doc:para>
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).
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsMediaChangeDetectionInhibited" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if media detection is inhibited (to avoid keeping the device in a high power state and waking up the host).
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsReadOnly" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device read-only.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsDrive" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device is a drive.
See the drive- properties for details.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsOpticalDisc" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device is an optical drive and an optical disc is inserted.
See the optical-disc- properties for details.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsMounted" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device is mounted.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceMountPaths" type="as" access="read">
<doc:doc><doc:description><doc:para>
A list of paths in the root namespace where the root of the device is mounted.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsMounted">DeviceIsMounted</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceMountedByUid" type="u" access="read">
<doc:doc><doc:description><doc:para>
The UNIX user id of the user who mounted the device. Set to 0 if
not mounted by udisks.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsMounted">DeviceIsMounted</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsLuks" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if device is an LUKS encrypted device. See Lucks properties for details.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsLuksCleartext" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if device is a cleartext device backed by a LUKS encrypted device. See LucksCleartext properties for details.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsLinuxMdComponent" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device is a Linux md RAID component. See LinuxMdComponent properties for details.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsLinuxMd" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device is a Linux md RAID array. See LinuxMd properties for details.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsLinuxLvm2LV" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device is a Linux LVM2 logical volume. See LinuxLvm2LV properties for details.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsLinuxLvm2PV" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device is a Linux LVM2 physical. See LinuxLvm2PV properties for details.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsLinuxDmmpComponent" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device is a component (e.g. active path) of a Linux dm-multipath device.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsLinuxDmmp" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device is a Linux dm-multipath device.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceIsLinuxLoop" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the device is a Linux loop device.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceSize" type="t" access="read">
<doc:doc><doc:description><doc:para>
The size of the device in bytes.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceBlockSize" type="t" access="read">
<doc:doc><doc:description><doc:para>
The block size of the device in bytes.
</doc:para></doc:description></doc:doc>
</property>
<property name="DevicePresentationHide" type="b" access="read">
<doc:doc><doc:description><doc:para>
A hint if the device should be hidden from the user interface.
</doc:para></doc:description></doc:doc>
</property>
<property name="DevicePresentationNopolicy" type="b" access="read">
<doc:doc><doc:description><doc:para>
A hint if the device (or e.g. the multi-disk device that the device is
part of) shouldn't be automatically mounted / assembled.
</doc:para></doc:description></doc:doc>
</property>
<property name="DevicePresentationName" type="s" access="read">
<doc:doc><doc:description><doc:para>
The name to use when presenting the device to an end user.
</doc:para></doc:description></doc:doc>
</property>
<property name="DevicePresentationIconName" type="s" access="read">
<doc:doc><doc:description><doc:para>
The icon to use when presenting the device to an end user. If set, must be a name
following the freedesktop.org icon theme specification.
</doc:para></doc:description></doc:doc>
</property>
<property name="DeviceAutomountHint" type="s" access="read">
<doc:doc><doc:description><doc:para>
A hint to the desktop that indicates if a device should be automounted.
Possible values are:
<doc:list>
<doc:item>
<doc:term>always</doc:term>
<doc:definition>Device should always be auto-mounted.</doc:definition>
</doc:item>
<doc:item>
<doc:term>never</doc:term>
<doc:definition>Device should never be auto-mounted.</doc:definition>
</doc:item>
</doc:list>
An empty string is interpreted to mean that there is no
hint - the desktop auto-mounter should make its own
decision of whether to auto-mount the device.
</doc:para></doc:description></doc:doc>
</property>
<property name="JobInProgress" type="b" access="read">
<doc:doc><doc:description><doc:para>
The job properties specify if a job initiated via the
udisks daemon is currently in progress.
</doc:para></doc:description></doc:doc>
</property>
<property name="JobId" type="s" access="read">
<doc:doc><doc:description><doc:para>
This property is used to identify the job and maps 1-1
with the names of the method calls on this interface,
e.g. 'FilesystemCreate' and so on.
</doc:para></doc:description></doc:doc>
</property>
<property name="JobInitiatedByUid" type="u" access="read">
<doc:doc><doc:description><doc:para>
The UNIX user id of the user who initiated the job.
</doc:para></doc:description></doc:doc>
</property>
<property name="JobIsCancellable" type="b" access="read">
<doc:doc><doc:description><doc:para>
Whether the job can be cancelled
using <doc:ref type="method"
to="Device.JobCancel">JobCancel()</doc:ref> method.
</doc:para></doc:description></doc:doc>
</property>
<property name="JobPercentage" type="d" access="read">
<doc:doc><doc:description><doc:para>
Percentage completed of the job (between 0 and 100, negative if unknown).
</doc:para></doc:description></doc:doc>
</property>
<property name="IdUsage" type="s" access="read">
<doc:doc><doc:description><doc:para>
A result of probing for signatures on the block device;
known values are:
<doc:list>
<doc:item>
<doc:term>filesystem</doc:term>
<doc:definition>A mountable file system was detected</doc:definition>
</doc:item>
<doc:item>
<doc:term>crypto</doc:term>
<doc:definition>Encrypted data (e.g. LUKS) was detected</doc:definition>
</doc:item>
<doc:item>
<doc:term>partitiontable</doc:term>
<doc:definition>A partition table was detected</doc:definition>
</doc:item>
<doc:item>
<doc:term>raid</doc:term>
<doc:definition>Used for RAID and LVM components</doc:definition>
</doc:item>
<doc:item>
<doc:term>other</doc:term>
<doc:definition>A non-standard signature was detected</doc:definition>
</doc:item>
</doc:list>
If blank, no known signature was detected. This doesn't
necessarily mean the device contains no structured data;
it only means that no signature known to the probing code
was detected.
</doc:para></doc:description></doc:doc>
</property>
<property name="IdType" type="s" access="read">
<doc:doc><doc:description><doc:para>
This property contains more information about the result
of probing the block device. It's value depends of the
value the
<doc:ref type="property" to="Device:IdUsage">IdUsage</doc:ref>
property:
<doc:list>
<doc:item>
<doc:term>filesystem</doc:term>
<doc:definition>The mountable file system that was detected (e.g. <doc:tt>ext3</doc:tt>, <doc:tt>vfat</doc:tt>)</doc:definition>
</doc:item>
<doc:item>
<doc:term>crypto</doc:term>
<doc:definition>Known values include <doc:tt>crypto_LUKS</doc:tt></doc:definition>
</doc:item>
<doc:item>
<doc:term>partitiontable</doc:term>
<doc:definition>
Known values include
<doc:tt>mbr</doc:tt> (for the
<doc:ulink url="http://en.wikipedia.org/wiki/Master_Boot_Record">Master Boot Record</doc:ulink>
scheme),
<doc:tt>gpt</doc:tt> (for the
<doc:ulink url="http://en.wikipedia.org/wiki/GUID_Partition_Table">GUID Partition Table</doc:ulink>
scheme),
<doc:tt>apm</doc:tt> (for the
<doc:ulink url="http://en.wikipedia.org/wiki/Apple_Partition_Map">Apple Partition Map</doc:ulink>
scheme).
</doc:definition>
</doc:item>
<doc:item>
<doc:term>raid</doc:term>
<doc:definition>
Known values include
<doc:tt>LVM1_member</doc:tt> (for Linux LVM1 components),
<doc:tt>LVM2_member</doc:tt> (for Linux LVM2 components),
<doc:tt>linux_raid_member</doc:tt> (for Linux md (Software RAID) components)
</doc:definition>
</doc:item>
<doc:item>
<doc:term>other</doc:term>
<doc:definition>
Known values include
<doc:tt>swap</doc:tt> (for swap space),
<doc:tt>suspend</doc:tt> (data used when resuming from STD)
</doc:definition>
</doc:item>
</doc:list>
</doc:para></doc:description></doc:doc>
</property>
<property name="IdVersion" type="s" access="read">
<doc:doc><doc:description><doc:para>
The version of the
detected file system (or other identified data structure) identified by the
<doc:ref type="property" to="Device:IdUsage">IdUsage</doc:ref>
and
<doc:ref type="property" to="Device:IdType">IdType</doc:ref>
properties.
</doc:para></doc:description></doc:doc>
</property>
<property name="IdUuid" type="s" access="read">
<doc:doc><doc:description><doc:para>
The UUID (universally unique identifier) of the
detected file system (or other identified data structure) identified by the
<doc:ref type="property" to="Device:IdUsage">IdUsage</doc:ref>
and
<doc:ref type="property" to="Device:IdUsage">IdType</doc:ref>
properties.
</doc:para></doc:description></doc:doc>
</property>
<property name="IdLabel" type="s" access="read">
<doc:doc><doc:description><doc:para>
The user-visible label of the
detected file system (or other identified data structure) identified by the
<doc:ref type="property" to="Device:IdUsage">IdUsage</doc:ref>
and
<doc:ref type="property" to="Device:IdUsage">IdType</doc:ref>
properties.
</doc:para></doc:description></doc:doc>
</property>
<property name="LuksHolder" type="o" access="read">
<doc:doc><doc:description><doc:para>
The cleartext device that is using the LUKS device.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLuksCleartext">DeviceIsLuks</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LuksCleartextSlave" type="o" access="read">
<doc:doc><doc:description><doc:para>
The encrypted LUKS device backing a crypto cleartext device.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLuksCleartext">DeviceIsLuksCleartext</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LuksCleartextUnlockedByUid" type="u" access="read">
<doc:doc><doc:description><doc:para>
The UNIX user id of the user who unlocked the LUKS device. Set to 0 if
not unlocked by udisks.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLuksCleartext">DeviceIsLuksCleartext</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="PartitionSlave" type="o" access="read">
<doc:doc><doc:description><doc:para>
The object path of the partition table the partition is part of.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="PartitionScheme" type="s" access="read">
<doc:doc><doc:description><doc:para>
The scheme of the partition table this partition is part of.
See the <doc:tt>scheme</doc:tt> parameter of the
<doc:ref type="method" to="Device.PartitionTableCreate">PartitionTableCreate()</doc:ref> method
for details on known partitioning schemes.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="PartitionType" type="s" access="read">
<doc:doc><doc:description><doc:para>
The type of the partition.
See the <doc:tt>type</doc:tt> parameter of the
<doc:ref type="method" to="Device.PartitionCreate">PartitionCreate()</doc:ref> method
for details on known partitioning types.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="PartitionLabel" type="s" access="read">
<doc:doc><doc:description><doc:para>
The label of the partition.
See the <doc:tt>label</doc:tt> parameter of the
<doc:ref type="method" to="Device.PartitionCreate">PartitionCreate()</doc:ref> method
for details on partition labels.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="PartitionUuid" type="s" access="read">
<doc:doc><doc:description><doc:para>
The UUID of the partition.
See the <doc:tt>uuid</doc:tt> parameter of the
<doc:ref type="method" to="Device.PartitionCreate">PartitionCreate()</doc:ref> method
for details on partition UUID's.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="PartitionFlags" type="as" access="read">
<doc:doc><doc:description><doc:para>
Partition flags.
See the <doc:tt>flags</doc:tt> parameter of the
<doc:ref type="method" to="Device.PartitionCreate">PartitionCreate()</doc:ref> method
for details on partition flags.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="PartitionNumber" type="i" access="read">
<doc:doc><doc:description><doc:para>
Number of the partition. Typically partition numbers start at 1 and are identical
to the numbers used by the kernel. Note that partitions may not be sequentially
numbered.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="PartitionOffset" type="t" access="read">
<doc:doc><doc:description><doc:para>
Offset in bytes where the partition is located on the enclosing partition table device (see
<doc:ref type="property" to="Device:DeviceIsPartition">PartitionSlave</doc:ref>).
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="PartitionSize" type="t" access="read">
<doc:doc><doc:description><doc:para>
Size of the partition in bytes.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="PartitionAlignmentOffset" type="t" access="read">
<doc:doc><doc:description><doc:para>
The amount of bytes the beginning of the partition is offset
from the disk's natural alignment.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsPartition">DeviceIsPartition</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="PartitionTableScheme" type="s" access="read">
<doc:doc><doc:description><doc:para>
The scheme of the partition table.
See the <doc:tt>scheme</doc:tt> parameter of the
<doc:ref type="method" to="Device.PartitionTableCreate">PartitionTableCreate()</doc:ref> method
for details on known partitioning schemes.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsPartitionTable">DeviceIsPartitionTable</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="PartitionTableCount" type="i" access="read">
<doc:doc><doc:description><doc:para>
Number of partitions in the partition table.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsPartitionTable">DeviceIsPartitionTable</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveVendor" type="s" access="read">
<doc:doc><doc:description><doc:para>
Name of the vendor of the drive, for example <doc:tt>MATSHITA</doc:tt> or <doc:tt>BELKIN</doc:tt>.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveModel" type="s" access="read">
<doc:doc><doc:description><doc:para>
Name of the model of the drive, for example <doc:tt>ST910021AS</doc:tt> or <doc:tt>USB 2 HS-CF</doc:tt>.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveRevision" type="s" access="read">
<doc:doc><doc:description><doc:para>
Revision of the drive, for example <doc:tt>3.07</doc:tt> or <doc:tt>1.95</doc:tt>.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveSerial" type="s" access="read">
<doc:doc><doc:description><doc:para>
The serial number of the drive or blank if unknown.
Examples: <doc:tt>3MH05AVA</doc:tt>, <doc:tt>A0000001B900</doc:tt>.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveWwn" type="s" access="read">
<doc:doc><doc:description><doc:para>
The <doc:ulink url="http://en.wikipedia.org/wiki/World_Wide_Name">World Wide Name</doc:ulink>
in hex (without a leading "0x") or blank if the drive has no WWN.
Example: <doc:tt>50014ee0016eb572</doc:tt>.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveRotationRate" type="u" access="read">
<doc:doc><doc:description><doc:para>
The rotational rate of the disk (e.g. 4200, 5400, 5900, 7200, 10000, 15000) in rounds
per minute or 0 if unknown.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE and
<doc:ref type="property" to="Device:DriveIsRotational">DriveIsRotational</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveWriteCache" type="s" access="read">
<doc:doc><doc:description><doc:para>
Whether the write cache is enabled, known values include "enabled" and "disabled" and
the blank string if unknown.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveConnectionInterface" type="s" access="read">
<doc:doc><doc:description><doc:para>
The interface through which the drive is connected. Known values include:
<doc:list type="bullet">
<doc:item>
<doc:term>virtual</doc:term>
<doc:definition>Device is a composite device e.g. Software RAID or similar</doc:definition>
</doc:item>
<doc:item>
<doc:term>ata</doc:term>
<doc:definition>Connected via ATA</doc:definition>
</doc:item>
<doc:item>
<doc:term>ata_serial</doc:term>
<doc:definition>Connected via Serial ATA</doc:definition>
</doc:item>
<doc:item>
<doc:term>ata_serial_esata</doc:term>
<doc:definition>Connected via eSATA</doc:definition>
</doc:item>
<doc:item>
<doc:term>ata_parallel</doc:term>
<doc:definition>Connected via Parallel ATA</doc:definition>
</doc:item>
<doc:item>
<doc:term>scsi</doc:term>
<doc:definition>Connected via SCSI</doc:definition>
</doc:item>
<doc:item>
<doc:term>usb</doc:term>
<doc:definition>Connected via the Universal Serial Bus</doc:definition>
</doc:item>
<doc:item>
<doc:term>firewire</doc:term>
<doc:definition>Connected via Firewire</doc:definition>
</doc:item>
<doc:item>
<doc:term>sdio</doc:term>
<doc:definition>Connected via SDIO</doc:definition>
</doc:item>
<doc:item>
<doc:term>platform</doc:term>
<doc:definition>Part of the platform, e.g. PC floppy drive</doc:definition>
</doc:item>
</doc:list>
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveConnectionSpeed" type="t" access="read">
<doc:doc><doc:description><doc:para>
The nominal speed of the connection interface in bits per
second. If unknown this property is set to 0.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveMediaCompatibility" type="as" access="read">
<doc:doc><doc:description><doc:para>
An array of media types that can be used in the
drive. This property is sometimes set using quirk files if
the hardware isn't capable of precisely reporting it.
Known values include:
<doc:list>
<doc:item>
<doc:term>flash</doc:term>
<doc:definition>Flash Card</doc:definition>
</doc:item>
<doc:item>
<doc:term>flash_cf</doc:term>
<doc:definition>CompactFlash</doc:definition>
</doc:item>
<doc:item>
<doc:term>flash_ms</doc:term>
<doc:definition>MemoryStick</doc:definition>
</doc:item>
<doc:item>
<doc:term>flash_sm</doc:term>
<doc:definition>SmartMedia</doc:definition>
</doc:item>
<doc:item>
<doc:term>flash_sd</doc:term>
<doc:definition>Secure Digital</doc:definition>
</doc:item>
<doc:item>
<doc:term>flash_sdhc</doc:term>
<doc:definition>Secure Digital High-Capacity</doc:definition>
</doc:item>
<doc:item>
<doc:term>flash_mmc</doc:term>
<doc:definition>MultiMediaCard</doc:definition>
</doc:item>
<doc:item>
<doc:term>floppy</doc:term>
<doc:definition>Floppy Disk</doc:definition>
</doc:item>
<doc:item>
<doc:term>floppy_zip</doc:term>
<doc:definition>Zip Disk</doc:definition>
</doc:item>
<doc:item>
<doc:term>floppy_jaz</doc:term>
<doc:definition>Jaz Disk</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical</doc:term>
<doc:definition>Optical Disc</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_cd</doc:term>
<doc:definition>Compact Disc</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_cd_r</doc:term>
<doc:definition>Compact Disc Recordable</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_cd_rw</doc:term>
<doc:definition>Compact Disc Rewritable</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_dvd</doc:term>
<doc:definition>Digital Versatile Disc</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_dvd_r</doc:term>
<doc:definition>DVD-R</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_dvd_rw</doc:term>
<doc:definition>DVD-RW</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_dvd_ram</doc:term>
<doc:definition>DVD-RAM</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_dvd_plus_r</doc:term>
<doc:definition>DVD+R</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_dvd_plus_rw</doc:term>
<doc:definition>DVD+RW</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_dvd_plus_r_dl</doc:term>
<doc:definition>DVD+R Dual Layer</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_dvd_plus_rw_dl</doc:term>
<doc:definition>DVD+RW Dual Layer</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_bd</doc:term>
<doc:definition>Bluray Disc</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_bd_r</doc:term>
<doc:definition>BluRay Recordable</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_bd_re</doc:term>
<doc:definition>BluRay Rewritable</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_hddvd</doc:term>
<doc:definition>HD DVD</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_hddvd_r</doc:term>
<doc:definition>HD DVD Recordable</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_hddvd_rw</doc:term>
<doc:definition>HD DVD Rewritable</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_mo</doc:term>
<doc:definition>Magneto Optical</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_mrw</doc:term>
<doc:definition>Can read Mount Rainer media</doc:definition>
</doc:item>
<doc:item>
<doc:term>optical_mrw_w</doc:term>
<doc:definition>Can write Mount Rainer media</doc:definition>
</doc:item>
</doc:list>
</doc:para><doc:para>
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveMedia" type="s" access="read">
<doc:doc><doc:description><doc:para>
The type of media currently in the drive (blank if no media is available). Known
values include the ones listed for the
<doc:ref type="property" to="Device:DriveMediaCompatibility">DriveMediaCompatibility</doc:ref>
property.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveIsMediaEjectable" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE only if the media can be physically ejected by issuing a command
from the host to the drive (e.g. optical and Zip drives).
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveCanDetach" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE only if the drive is capable of being detached by
e.g. powering down the port it is connected to.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveCanSpindown" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE only if the drive is capable of being put into
a standby mode (typically powering down the spindle motor).
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveIsRotational" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the disk uses rotational media, such as a hard disk.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveAdapter" type="o" access="read">
<doc:doc><doc:description><doc:para>
The object of the storage adapter for the drive or "/" if no adapter exists.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DrivePorts" type="ao" access="read">
<doc:doc><doc:description><doc:para>
The object paths of the ports for the drive or empty if no ports exist.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveSimilarDevices" type="ao" access="read">
<doc:doc><doc:description><doc:para>
An array of object paths for devices with similar serial number and/or WWN.
Typically all drives with similar serial number and/or WWN
are configured as a multipath device (for example via the
Linux device-mapper target cf.
<doc:ref type="property" to="Device:DeviceIsLinuxDmmp">DeviceIsLinuxDmmp</doc:ref> and
<doc:ref type="property" to="Device:DeviceIsLinuxDmmpComponent">DeviceIsLinuxDmmpComponent</doc:ref>)
but in some cases the OS needs manual configuration.
Presentation-level software can (and should) display a
warning when this property is non-empty and the device
isn't a multipath component or multipath device e.g. when both
<doc:ref type="property" to="Device:DeviceIsLinuxDmmpComponent">DeviceIsLinuxDmmpComponent</doc:ref>) and
<doc:ref type="property" to="Device:DeviceIsLinuxDmmp">DeviceIsLinuxDmmp</doc:ref>)
is FALSE.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsDrive">DeviceIsDrive</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<!-- **************************************************************************************************** -->
<property name="OpticalDiscIsBlank" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE only if the disc is appendable.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsOpticalDisc">DeviceIsOpticalDisc</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="OpticalDiscIsAppendable" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE only if the disc is appendable.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsOpticalDisc">DeviceIsOpticalDisc</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="OpticalDiscIsClosed" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE only if the disc is appendable.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsOpticalDisc">DeviceIsOpticalDisc</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="OpticalDiscNumTracks" type="u" access="read">
<doc:doc><doc:description><doc:para>
Number of tracks on the disc.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsOpticalDisc">DeviceIsOpticalDisc</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="OpticalDiscNumAudioTracks" type="u" access="read">
<doc:doc><doc:description><doc:para>
Number of audio tracks on the disc.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsOpticalDisc">DeviceIsOpticalDisc</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="OpticalDiscNumSessions" type="u" access="read">
<doc:doc><doc:description><doc:para>
Number of sessions on the disc.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsOpticalDisc">DeviceIsOpticalDisc</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<!-- **************************************************************************************************** -->
<property name="DriveAtaSmartIsAvailable" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE if the disk is capable of reporting SMART data, FALSE otherwise.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveAtaSmartTimeCollected" type="t" access="read">
<doc:doc><doc:description><doc:para>
The point in time (seconds since the Epoch Jan 1, 1970
0:00 UTC) when ATA SMART data was collected.
This property is only valid if
<doc:ref type="property" to="Device:DriveAtaSmartTimeCollected">DriveAtaSmartTimeCollected</doc:ref>
is greater than zero.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveAtaSmartStatus" type="s" access="read">
<doc:doc><doc:description><doc:para>
The overall assessment for the disk. Is one of the following strings
<quote>GOOD</quote>,
<quote>BAD_ATTRIBUTES_IN_THE_PAST</quote> (At least one pre-fail attribute is exceeded its threshold in the past),
<quote>BAD_SECTOR</quote> (At least one bad sector),
<quote>BAD_ATTRIBUTE_NOW</quote> (At least one pre-fail attribute is exceeding its threshold now),
<quote>BAD_SECTOR_MANY</quote> (Many bad sectors)),
<quote>BAD_STATUS</quote> (Smart Self Assessment negative)
or empty if some error occured trying to determine the result.
This property is only valid if
<doc:ref type="property" to="Device:DriveAtaSmartTimeCollected">DriveAtaSmartTimeCollected</doc:ref>
is greater than zero.
</doc:para></doc:description></doc:doc>
</property>
<property name="DriveAtaSmartBlob" type="ay" access="read">
<doc:doc><doc:description><doc:para>
A blob containing the ATA SMART data. This blob can be used with libatasmart to get
more information.
This property is only valid if
<doc:ref type="property" to="Device:DriveAtaSmartTimeCollected">DriveAtaSmartTimeCollected</doc:ref>
is greater than zero.
</doc:para></doc:description></doc:doc>
</property>
<!-- **************************************************************************************************** -->
<property name="LinuxMdComponentLevel" type="s" access="read">
<doc:doc><doc:description><doc:para>
The RAID level of the array the component is part of. Known values include
<doc:list>
<doc:item>
<doc:term>linear</doc:term>
<doc:definition>The array is Just A Bunch of Disks</doc:definition>
</doc:item>
<doc:item>
<doc:term>raid0</doc:term>
<doc:definition>RAID-0</doc:definition>
</doc:item>
<doc:item>
<doc:term>raid1</doc:term>
<doc:definition>RAID-1</doc:definition>
</doc:item>
<doc:item>
<doc:term>raid4</doc:term>
<doc:definition>RAID-4</doc:definition>
</doc:item>
<doc:item>
<doc:term>raid5</doc:term>
<doc:definition>RAID-5</doc:definition>
</doc:item>
<doc:item>
<doc:term>raid6</doc:term>
<doc:definition>RAID-6</doc:definition>
</doc:item>
<doc:item>
<doc:term>raid10</doc:term>
<doc:definition>RAID-10</doc:definition>
</doc:item>
</doc:list>
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdComponentPosition" type="i" access="read">
<doc:doc><doc:description><doc:para>
The zero-based position of the component or -1 if not part of a running array.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdComponentNumRaidDevices" type="i" access="read">
<doc:doc><doc:description><doc:para>
The number of component devices in the array the component is part of.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdComponentUuid" type="s" access="read">
<doc:doc><doc:description><doc:para>
The UUID of the array the component is part of.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdComponentName" type="s" access="read">
<doc:doc><doc:description><doc:para>
The name of the array the component is part of. Blank if the array
doesn't have a name (e.g. pre-1.0 meta data).
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdComponentHomeHost" type="s" access="read">
<doc:doc><doc:description><doc:para>
The home host of the array the component is part of, e.g. where it was created. Blank if the array
has pre-1.0 meta data.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdComponentVersion" type="s" access="read">
<doc:doc><doc:description><doc:para>
The version of superblock of the component.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdComponentHolder" type="o" access="read">
<doc:doc><doc:description><doc:para>
The holder of the component or "/" if the component isn't claimed by any array.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdComponentState" type="as" access="read">
<doc:doc><doc:description><doc:para>
The state of the component (contents of <literal>md/dev-XXX/state</literal> file).
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponent">DeviceIsLinuxMdComponent</doc:ref>
is TRUE and
<doc:ref type="property" to="Device:DeviceIsLinuxMdComponentHolder">DeviceIsLinuxMdComponentHolder</doc:ref>
is non-empty.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdState" type="s" access="read">
<doc:doc><doc:description><doc:para>
The state of the array (contents of the <literal>md/array_state</literal> file).
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdLevel" type="s" access="read">
<doc:doc><doc:description><doc:para>
The RAID level of the array. For known values see the
<doc:ref type="property" to="Device:LinuxMdComponentLevel">LinuxMdComponentLevel</doc:ref>
property.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdUuid" type="s" access="read">
<doc:doc><doc:description><doc:para>
The UUID of the array.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdHomeHost" type="s" access="read">
<doc:doc><doc:description><doc:para>
The home host of the array, e.g. where if was created. Blank if the array
has pre-1.0 meta data.
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdName" type="s" access="read">
<doc:doc><doc:description><doc:para>
The name of the array. Blank if the array
doesn't have a name (e.g. pre-1.0 meta data).
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdNumRaidDevices" type="i" access="read">
<doc:doc><doc:description><doc:para>
Number of component devices in the array.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdVersion" type="s" access="read">
<doc:doc><doc:description><doc:para>
Metadata version used in the components.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdSlaves" type="ao" access="read">
<doc:doc><doc:description><doc:para>
An array of object paths for components currently part of the array.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdIsDegraded" type="b" access="read">
<doc:doc><doc:description><doc:para>
TRUE only if the array is running in degraded mode.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdSyncAction" type="s" access="read">
<doc:doc><doc:description><doc:para>
The operation currently pending on the array. Known values
include
<doc:list>
<doc:item>
<doc:term>idle</doc:term>
<doc:definition>No operation is pending</doc:definition>
</doc:item>
<doc:item>
<doc:term>reshape</doc:term>
<doc:definition>A reshape is in progress</doc:definition>
</doc:item>
<doc:item>
<doc:term>resync</doc:term>
<doc:definition>Redudancy is being calculated</doc:definition>
</doc:item>
<doc:item>
<doc:term>repair</doc:term>
<doc:definition>A repair operation is in progress</doc:definition>
</doc:item>
<doc:item>
<doc:term>recover</doc:term>
<doc:definition>A hot spare is being built to replace a failed/missing device</doc:definition>
</doc:item>
</doc:list>
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdSyncPercentage" type="d" access="read">
<doc:doc><doc:description><doc:para>
The progress of the current sync operation.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
is TRUE and the value of the property
<doc:ref type="property" to="Device:LinuxMdSyncAction">LinuxMdSyncAction</doc:ref>
is not <doc:tt>idle</doc:tt>.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxMdSyncSpeed" type="t" access="read">
<doc:doc><doc:description><doc:para>
The speed of the sync operation in bytes per second.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxMd">DeviceIsLinuxMd</doc:ref>
is TRUE and the value of the property
<doc:ref type="property" to="Device:LinuxMdSyncAction">LinuxMdSyncAction</doc:ref>
is not <doc:tt>idle</doc:tt>.
</doc:para></doc:description></doc:doc>
</property>
<!-- ********************* -->
<!-- LVM2 Physical Volumes -->
<!-- ********************* -->
<!-- Data about the Physical Volume itself -->
<property name="LinuxLvm2PVUuid" type="s" access="read">
<doc:doc><doc:description><doc:para>
The UUID of the PV.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2PV">DeviceIsLinuxLvm2PV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxLvm2PVNumMetadataAreas" type="u" access="read">
<doc:doc><doc:description><doc:para>
The number of metadata areas on the PV.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2PV">DeviceIsLinuxLvm2PV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<!-- Data about the Volume Group that the Physical Volume is part of -->
<property name="LinuxLvm2PVGroupName" type="s" access="read">
<doc:doc><doc:description><doc:para>
The name of the volume group (that this physical volume belongs to).
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2PV">DeviceIsLinuxLvm2PV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxLvm2PVGroupUuid" type="s" access="read">
<doc:doc><doc:description><doc:para>
The UUID of the volume group (that this physical volume belongs to).
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2PV">DeviceIsLinuxLvm2PV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxLvm2PVGroupSize" type="t" access="read">
<doc:doc><doc:description><doc:para>
The size of the volume group (that this physical volume belongs to) in bytes.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2PV">DeviceIsLinuxLvm2PV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxLvm2PVGroupUnallocatedSize" type="t" access="read">
<doc:doc><doc:description><doc:para>
The unallocated size of the volume group (that this physical volume belongs to) in bytes.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2PV">DeviceIsLinuxLvm2PV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxLvm2PVGroupSequenceNumber" type="t" access="read">
<doc:doc><doc:description><doc:para>
The sequence number for the volume group (that this physical volume belongs to).
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2PV">DeviceIsLinuxLvm2PV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxLvm2PVGroupExtentSize" type="t" access="read">
<doc:doc><doc:description><doc:para>
The extent size for the volume group (that this physical volume belongs to) in bytes.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2PV">DeviceIsLinuxLvm2PV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxLvm2PVGroupPhysicalVolumes" type="as" access="read">
<doc:doc><doc:description><doc:para>
The physical volumes that belongs to the volume group (that this physical volume belongs to).
Each element is a semicolon separated list of key/value pairs. The only known key/value
type as this point is <literal>uuid</literal> for the UUID of the physical volume.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2PV">DeviceIsLinuxLvm2PV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxLvm2PVGroupLogicalVolumes" type="as" access="read">
<doc:doc><doc:description><doc:para>
The logical volumes that belongs to the volume group (that this physical volume belongs to).
Each element is a semicolon separated list of key/value pairs. The only known key/value
types as this point are
<literal>uuid</literal> (for the UUID of the logical volume),
<literal>name</literal> (for the name of the logical volume),
<literal>size</literal> (for the size of the logical volume) and
<literal>active</literal> (whether the logical volume is active).
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2PV">DeviceIsLinuxLvm2PV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<!-- ******************** -->
<!-- LVM2 Logical Volumes -->
<!-- ******************** -->
<!-- Data about the LV itself -->
<property name="LinuxLvm2LVName" type="s" access="read">
<doc:doc><doc:description><doc:para>
The name of the logical volume.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2LV">DeviceIsLinuxLvm2LV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxLvm2LVUuid" type="s" access="read">
<doc:doc><doc:description><doc:para>
The UUID of the logical volume.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2LV">DeviceIsLinuxLvm2LV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxLvm2LVGroupName" type="s" access="read">
<doc:doc><doc:description><doc:para>
The name of volume group the logical volume belongs to.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2LV">DeviceIsLinuxLvm2LV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxLvm2LVGroupUuid" type="s" access="read">
<doc:doc><doc:description><doc:para>
The UUID of the volume group the logical volume belongs to.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLvm2LV">DeviceIsLinuxLvm2LV</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<!-- ******************** -->
<!-- Multipath Component -->
<!-- ******************** -->
<property name="LinuxDmmpComponentHolder" type="o" access="read">
<doc:doc><doc:description><doc:para>
The object path of the multi-path device the component is currently part of.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxDmmpComponent">DeviceIsLinuxDmmpComponent</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<!-- ***************** -->
<!-- Multipath Device -->
<!-- ***************** -->
<property name="LinuxDmmpName" type="s" access="read">
<doc:doc><doc:description><doc:para>
The symbolic name for the multipath device, e.g. <doc:tt>mpathb</doc:tt>.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxDmmp">DeviceIsLinuxDmmp</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxDmmpSlaves" type="ao" access="read">
<doc:doc><doc:description><doc:para>
The object paths of currently active component devices, e.g. paths.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxDmmp">DeviceIsLinuxDmmp</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxDmmpParameters" type="s" access="read">
<doc:doc><doc:description><doc:para>
The parameters/configuration for the multipath device.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxDmmp">DeviceIsLinuxDmmp</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
<property name="LinuxLoopFilename" type="s" access="read">
<doc:doc><doc:description><doc:para>
The file backing the loop device.
This property is only valid if
<doc:ref type="property" to="Device:DeviceIsLinuxLoop">DeviceIsLinuxLoop</doc:ref>
is TRUE.
</doc:para></doc:description></doc:doc>
</property>
</interface>
</node>
|