Debian Codegraph @

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

raw
1 <!DOCTYPE node PUBLIC
2 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
3 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
4 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
5
6 <!--
7 Copyright (C) 2014 Tomas Bzatek <[email protected]>
8 2015 Gris Ge <[email protected]>
9
10 This library is free software; you can redistribute it and/or
11 modify it under the terms of the GNU Lesser General Public
12 License as published by the Free Software Foundation; either
13 version 2 of the License, or (at your option) any later version.
14
15 This library is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
19
20 You should have received a copy of the GNU Lesser General
21 Public License along with this library; if not, write to the
22 Free Software Foundation, Inc., 59 Temple Place, Suite 330,
23 Boston, MA 02111-1307, USA.
24 -->
25
26 <!-- ******************************************************************* -->
27
28 <!--
29 org.freedesktop.UDisks2.Drive.LSM:
30 @short_description: LSM interface exported on disk objects
31 @since: 2.3.0
32
33 Objects implementing this interface also implement the
34 #org.freedesktop.UDisks2.Drive interface.
35 -->
36 <interface name="org.freedesktop.UDisks2.Drive.LSM">
37 <!-- IsOK:
38 Whether this drive is read and writeable without any error or warnings.
39 It's the single preliminary check on whether things go wrong.
40 Noted: even from user's view, RAID degrade does not cause any
41 error or warning at OS level, the 'isOK' property will still be set
42 as 'FALSE' to suggest user to do more checking on what's going on.
43 -->
44 <property name="IsOK" type="b" access="read"/>
45
46 <!-- IsRaidDegraded:
47 Whether this drive is degraded RAID, for example, one disk failure
48 in RAID 5 group is considered as degraded RAID.
49 -->
50 <property name="IsRaidDegraded" type="b" access="read"/>
51
52 <!-- IsRaidError:
53 Whether this drive is facing RAID error, for example, two disks
54 failure in RAID 5 group at the same time is considered as RAID error,
55 user will lose data access and facing write failure.
56 -->
57 <property name="IsRaidError" type="b" access="read"/>
58
59 <!-- IsRaidVerifying:
60 Whether the RAID group of current drive allocated from is
61 verifying its data integrity by comparing mirror(RAID1) or verifying
62 parity(RAID 5/6).
63 -->
64 <property name="IsRaidVerifying" type="b" access="read"/>
65
66 <!-- IsRaidReconstructing:
67 Whether the RAID group of current drive allocated from is
68 reconstructing its data on newly joined disk or out-synced disk.
69 -->
70 <property name="IsRaidReconstructing" type="b" access="read"/>
71
72 <!-- RaidType:
73 A string of backend RAID type of this disk drive.
74 Could be one of these values:
75 JBOD, RAID 0, RAID 1, RAID 5, RAID 6, RAID 10, RAID 50, RAID 60
76 There will be a space between RAID number and 'RAID' string.
77 If unknown, leave it as empty.
78 -->
79 <property name="RaidType" type="s" access="read"/>
80
81 <!-- StatusInfo:
82 A message for administrator about RAID detail issue.
83 Some examples:
84 Disk enclosure 1 slot 9(serial: CVDA452606ME1207GN) is offline.
85 Disk enclosure 1 slot 10 is predicted to be fail soon.
86 Empty string if no issue or LibStorageMgmt failed to retrieve so.
87 -->
88 <property name="StatusInfo" type="s" access="read"/>
89
90
91 <!-- MinIoSize:
92 The minimum I/O size, device preferred I/O size for random I/O.
93 Any I/O size not equal to a multiple of this value may get
94 significant speed penalty. Normally it refers to strip size of
95 each RAID disk(extent). If LibStorageMgmt failed to detect min_io_size,
96 it will try these values in the sequence of:
97 logical sector size -> physical sector size -> 0
98 -->
99 <property name="MinIoSize" type="u" access="read"/>
100
101 <!-- OptIoSize:
102 The optimal I/O size, device preferred I/O size for sequential
103 I/O. Normally it refers to RAID group stripe size. If LibStorageMgmt
104 failed to detect opt_io_size, it will be set to 0.
105 -->
106 <property name="OptIoSize" type="u" access="read"/>
107
108 <!-- RaidDiskCount:
109 The count of disk assebled the RAID group where this disk drive came
110 from. This impact the performance of this disk drive.
111 If LibStorageMgmt failed to detect RAID disk count, it will be set to
112 0.
113 -->
114 <property name="RaidDiskCount" type="u" access="read"/>
115
116 </interface>
117
118 <!--
119 org.freedesktop.UDisks2.Drive.LsmLocal:
120 @short_description: Interface exported on disk drive objects for managing
121 local direct attached storage.
122 @since: 2.6.3
123
124 Objects implementing this interface also implement the
125 #org.freedesktop.UDisks2.Drive interface.
126 This interface will exist on all disk drive objects.
127 -->
128 <interface name="org.freedesktop.UDisks2.Drive.LsmLocal">
129 <!--
130 TurnIdentLEDOn:
131 @since: 2.6.3
132 @options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
133
134 Turn on the identification LED of disk.
135 This method only works on SCSI enclosure disks yet.
136 Error 'org.freedesktop.UDisks2.Error.NotSupported' will be raised
137 if not supported.
138 -->
139 <method name="TurnIdentLEDOn">
140 <arg name="options" direction="in" type="a{sv}"/>
141 </method>
142
143 <!--
144 TurnIdentLEDOff:
145 @since: 2.6.3
146 @options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
147
148 Turn off the identification LED of disk.
149 This method only works on SCSI enclosure disks yet.
150 Error 'org.freedesktop.UDisks2.Error.NotSupported' will be raised
151 if not supported.
152 -->
153 <method name="TurnIdentLEDOff">
154 <arg name="options" direction="in" type="a{sv}"/>
155 </method>
156
157 <!--
158 TurnFaultLEDOn:
159 @since: 2.6.3
160 @options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
161
162 Turn on the fault LED of disk.
163 This method only works on SCSI enclosure disks yet.
164 Error 'org.freedesktop.UDisks2.Error.NotSupported' will be raised
165 if not supported.
166 -->
167 <method name="TurnFaultLEDOn">
168 <arg name="options" direction="in" type="a{sv}"/>
169 </method>
170
171 <!--
172 TurnFaultLEDOff:
173 @since: 2.6.3
174 @options: Options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
175
176 Turn off the fault LED of disk.
177 This method only works on SCSI enclosure disks yet.
178 Error 'org.freedesktop.UDisks2.Error.NotSupported' will be raised
179 if not supported.
180 -->
181 <method name="TurnFaultLEDOff">
182 <arg name="options" direction="in" type="a{sv}"/>
183 </method>
184 </interface>
185 </node>