Debian Codegraph @

doc/html/gdbus-org.freedesktop.UDisks2.NVMe.Controller.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>org.freedesktop.UDisks2.NVMe.Controller: UDisks Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="UDisks Reference Manual">
8 <link rel="up" href="ch03.html" title="D-Bus Interfaces">
9 <link rel="prev" href="gdbus-org.freedesktop.UDisks2.Job.html" title="org.freedesktop.UDisks2.Job">
10 <link rel="next" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html" title="org.freedesktop.UDisks2.NVMe.Namespace">
11 <meta name="generator" content="GTK-Doc V1.35.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#gdbus-org.freedesktop.UDisks2.NVMe.Controller.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
19 <a href="#gdbus-org.freedesktop.UDisks2.NVMe.Controller.properties" class="shortcut">Properties</a></span>
20 </td>
21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22 <td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23 <td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.Job.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24 <td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25 </tr></table>
26 <div class="refentry">
27 <a name="gdbus-org.freedesktop.UDisks2.NVMe.Controller"></a><div class="titlepage"></div>
28 <div class="refnamediv"><table width="100%"><tr>
29 <td valign="top">
30 <h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-NVMe-Controller.top_of_page"></a>org.freedesktop.UDisks2.NVMe.Controller</span></h2>
31 <p>org.freedesktop.UDisks2.NVMe.Controller — NVMe controller device</p>
32 </td>
33 <td class="gallery_image" valign="top" align="right"></td>
34 </tr></table></div>
35 <div class="refsynopsisdiv">
36 <h2>Methods</h2>
37 <pre class="synopsis">
38 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-method-org-freedesktop-UDisks2-NVMe-Controller.SmartUpdate" title="The SmartUpdate() method">SmartUpdate</a> (IN a{sv} options);
39 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-method-org-freedesktop-UDisks2-NVMe-Controller.SmartGetAttributes" title="The SmartGetAttributes() method">SmartGetAttributes</a> (IN a{sv} options,
40 OUT a{sv} attributes);
41 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-method-org-freedesktop-UDisks2-NVMe-Controller.SmartSelftestStart" title="The SmartSelftestStart() method">SmartSelftestStart</a> (IN s type,
42 IN a{sv} options);
43 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-method-org-freedesktop-UDisks2-NVMe-Controller.SmartSelftestAbort" title="The SmartSelftestAbort() method">SmartSelftestAbort</a> (IN a{sv} options);
44 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-method-org-freedesktop-UDisks2-NVMe-Controller.SanitizeStart" title="The SanitizeStart() method">SanitizeStart</a> (IN s action,
45 IN a{sv} options);
46 </pre>
47 </div>
48 <div class="refsect1">
49 <a name="id-1.3.3.14.4"></a><h2>Properties</h2>
50 <pre class="synopsis">
51 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.State" title='The "State" property'>State</a> readable s
52 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.ControllerID" title='The "ControllerID" property'>ControllerID</a> readable q
53 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SubsystemNQN" title='The "SubsystemNQN" property'>SubsystemNQN</a> readable ay
54 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.FGUID" title='The "FGUID" property'>FGUID</a> readable s
55 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.NVMeRevision" title='The "NVMeRevision" property'>NVMeRevision</a> readable s
56 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.UnallocatedCapacity" title='The "UnallocatedCapacity" property'>UnallocatedCapacity</a> readable t
57 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SmartUpdated" title='The "SmartUpdated" property'>SmartUpdated</a> readable t
58 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SmartCriticalWarning" title='The "SmartCriticalWarning" property'>SmartCriticalWarning</a> readable as
59 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SmartPowerOnHours" title='The "SmartPowerOnHours" property'>SmartPowerOnHours</a> readable t
60 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SmartTemperature" title='The "SmartTemperature" property'>SmartTemperature</a> readable q
61 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SmartSelftestStatus" title='The "SmartSelftestStatus" property'>SmartSelftestStatus</a> readable s
62 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SmartSelftestPercentRemaining" title='The "SmartSelftestPercentRemaining" property'>SmartSelftestPercentRemaining</a> readable i
63 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SanitizeStatus" title='The "SanitizeStatus" property'>SanitizeStatus</a> readable s
64 <a class="link" href="gdbus-org.freedesktop.UDisks2.NVMe.Controller.html#gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SanitizePercentRemaining" title='The "SanitizePercentRemaining" property'>SanitizePercentRemaining</a> readable i
65 </pre>
66 </div>
67 <div class="refsect1">
68 <a name="gdbus-interface-org-freedesktop-UDisks2-NVMe-Controller"></a><h2>Description</h2>
69 <p>
70 This interface represents a controller device in a NVM subsystem.
71 </p>
72 </div>
73 <div class="refsect1">
74 <a name="gdbus-methods-org.freedesktop.UDisks2.NVMe.Controller"></a><h2>Method Details</h2>
75 <div class="refsect2">
76 <a name="gdbus-method-org-freedesktop-UDisks2-NVMe-Controller.SmartUpdate"></a><h3>The SmartUpdate() method</h3>
77 <pre class="programlisting">
78 SmartUpdate (IN a{sv} options);
79 </pre>
80 <p>
81 Reads SMART/Health Information from the NVMe controller and update relevant properties.
82 Data in this interface are typically updated on every uevent or as a result of Asynchronous
83 Event Notification.
84 </p>
85 <div class="variablelist"><table border="0" class="variablelist">
86 <colgroup>
87 <col align="left" valign="top">
88 <col>
89 </colgroup>
90 <tbody><tr>
91 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
92 <td><p>
93 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
94 </p></td>
95 </tr></tbody>
96 </table></div>
97 <p class="since">Since 2.10.0</p>
98 </div>
99 <hr>
100 <div class="refsect2">
101 <a name="gdbus-method-org-freedesktop-UDisks2-NVMe-Controller.SmartGetAttributes"></a><h3>The SmartGetAttributes() method</h3>
102 <pre class="programlisting">
103 SmartGetAttributes (IN a{sv} options,
104 OUT a{sv} attributes);
105 </pre>
106 <p>
107 Get the SMART/Health Information attributes.
108 </p>
109 <p>
110 Known values include:
111 </p>
112 <div class="variablelist"><table border="0" class="variablelist">
113 <colgroup>
114 <col align="left" valign="top">
115 <col>
116 </colgroup>
117 <tbody>
118 <tr>
119 <td><p><span class="term">avail_spare (type 'y')</span></p></td>
120 <td><p>Available Spare: a normalized percentage (0<code class="constant"></code> to 100<code class="constant"></code>) of the remaining spare capacity available.</p></td>
121 </tr>
122 <tr>
123 <td><p><span class="term">spare_thresh (type 'y')</span></p></td>
124 <td><p>Available Spare Threshold: a normalized percentage (0<code class="constant"></code> to 100<code class="constant"></code>) of the available spare threshold.</p></td>
125 </tr>
126 <tr>
127 <td><p><span class="term">percent_used (type 'y')</span></p></td>
128 <td><p>Percentage Used: a vendor specific estimate of the percentage drive life used based on the actual usage
129 and the manufacturer's prediction. A value of 100 indicates that the estimated endurance has been consumed,
130 but may not indicate an NVM subsystem failure. The value is allowed to exceed 100.</p></td>
131 </tr>
132 <tr>
133 <td><p><span class="term">total_data_read (type 't')</span></p></td>
134 <td><p>An estimated calculation of total data read in bytes based on calculation of data units read from the host.</p></td>
135 </tr>
136 <tr>
137 <td><p><span class="term">total_data_written (type 't')</span></p></td>
138 <td><p>An estimated calculation of total data written in bytes based on calculation of data units written by the host.</p></td>
139 </tr>
140 <tr>
141 <td><p><span class="term">ctrl_busy_time (type 't')</span></p></td>
142 <td><p>Amount of time the controller is busy with I/O commands, reported in minutes.</p></td>
143 </tr>
144 <tr>
145 <td><p><span class="term">power_cycles (type 't')</span></p></td>
146 <td><p>The number of power cycles.</p></td>
147 </tr>
148 <tr>
149 <td><p><span class="term">unsafe_shutdowns (type 't')</span></p></td>
150 <td><p>The number of unsafe shutdowns as a result of a Shutdown Notification not received prior to loss of power.</p></td>
151 </tr>
152 <tr>
153 <td><p><span class="term">media_errors (type 't')</span></p></td>
154 <td><p>Media and Data Integrity Errors: the number of occurrences where the controller detected an unrecovered data integrity error
155 (e.g. uncorrectable ECC, CRC checksum failure, or LBA tag mismatch).</p></td>
156 </tr>
157 <tr>
158 <td><p><span class="term">num_err_log_entries (type 't')</span></p></td>
159 <td><p>Number of Error Information Log Entries: the number of Error Information log entries over the life of the controller.</p></td>
160 </tr>
161 <tr>
162 <td><p><span class="term">temp_sensors (type 'aq')</span></p></td>
163 <td><p>Array of the current temperature reported by temperature sensors 1-8 in Kelvins or 0 when the particular sensor is not available.</p></td>
164 </tr>
165 <tr>
166 <td><p><span class="term">wctemp (type 'q')</span></p></td>
167 <td><p>Warning Composite Temperature Threshold (WCTEMP): indicates the minimum Composite Temperature (<em class="parameter"><code>SmartTemperature</code></em>) value
168 that indicates an overheating condition during which controller operation continues.</p></td>
169 </tr>
170 <tr>
171 <td><p><span class="term">cctemp (type 'q')</span></p></td>
172 <td><p>Critical Composite Temperature Threshold (CCTEMP): indicates the minimum Composite Temperature (<em class="parameter"><code>SmartTemperature</code></em>) value
173 that indicates a critical overheating condition (e.g., may prevent continued normal operation, possibility of data loss,
174 automatic device shutdown, extreme performance throttling, or permanent damage).</p></td>
175 </tr>
176 <tr>
177 <td><p><span class="term">warning_temp_time (type 'u')</span></p></td>
178 <td><p>Warning Composite Temperature Time: the amount of time in minutes that the Composite Temperature (<em class="parameter"><code>SmartTemperature</code></em>) is greater
179 than or equal to the Warning Composite Temperature Threshold (<em class="parameter"><code>wctemp</code></em>) and less than the Critical Composite Temperature Threshold
180 (<em class="parameter"><code>cctemp</code></em>).</p></td>
181 </tr>
182 <tr>
183 <td><p><span class="term">critical_temp_time (type 'u')</span></p></td>
184 <td><p>Critical Composite Temperature Time: the amount of time in minutes that the Composite Temperature (<em class="parameter"><code>SmartTemperature</code></em>) is greater
185 than or equal to the Critical Composite Temperature Threshold (<em class="parameter"><code>cctemp</code></em>).</p></td>
186 </tr>
187 </tbody>
188 </table></div>
189 <p>
190 </p>
191 <div class="variablelist"><table border="0" class="variablelist">
192 <colgroup>
193 <col align="left" valign="top">
194 <col>
195 </colgroup>
196 <tbody>
197 <tr>
198 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
199 <td><p>
200 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
201 </p></td>
202 </tr>
203 <tr>
204 <td><p><span class="term"><code class="literal">OUT a{sv} <em class="parameter"><code>attributes</code></em></code>:</span></p></td>
205 <td><p>
206 The SMART attributes.
207 </p></td>
208 </tr>
209 </tbody>
210 </table></div>
211 <p class="since">Since 2.10.0</p>
212 </div>
213 <hr>
214 <div class="refsect2">
215 <a name="gdbus-method-org-freedesktop-UDisks2-NVMe-Controller.SmartSelftestStart"></a><h3>The SmartSelftestStart() method</h3>
216 <pre class="programlisting">
217 SmartSelftestStart (IN s type,
218 IN a{sv} options);
219 </pre>
220 <p>
221 Starts a device selftest operation on all active namespaces accessible through the controller
222 at the time the operation is started. A device selftest operation is a diagnostic testing
223 sequence that tests the integrity and functionality of the controller and may include testing
224 of the media associated with namespaces.
225 </p>
226 <p>
227 The <em class="parameter"><code>type</code></em> parameter indicates the type of test to start - valid values are
228 <code class="literal">short</code>, <code class="literal">extended</code> and <code class="literal">vendor-specific</code>.
229 </p>
230 <p>
231 Note that the method returns immediately after the test has been started
232 successfully and the operation is performed in the background.
233 </p>
234 <div class="variablelist"><table border="0" class="variablelist">
235 <colgroup>
236 <col align="left" valign="top">
237 <col>
238 </colgroup>
239 <tbody>
240 <tr>
241 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
242 <td><p>
243 The type test to run.
244 </p></td>
245 </tr>
246 <tr>
247 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
248 <td><p>
249 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
250 </p></td>
251 </tr>
252 </tbody>
253 </table></div>
254 <p class="since">Since 2.10.0</p>
255 </div>
256 <hr>
257 <div class="refsect2">
258 <a name="gdbus-method-org-freedesktop-UDisks2-NVMe-Controller.SmartSelftestAbort"></a><h3>The SmartSelftestAbort() method</h3>
259 <pre class="programlisting">
260 SmartSelftestAbort (IN a{sv} options);
261 </pre>
262 <p>
263 Aborts a running device selftest.
264 </p>
265 <div class="variablelist"><table border="0" class="variablelist">
266 <colgroup>
267 <col align="left" valign="top">
268 <col>
269 </colgroup>
270 <tbody><tr>
271 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
272 <td><p>
273 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
274 </p></td>
275 </tr></tbody>
276 </table></div>
277 <p class="since">Since 2.10.0</p>
278 </div>
279 <hr>
280 <div class="refsect2">
281 <a name="gdbus-method-org-freedesktop-UDisks2-NVMe-Controller.SanitizeStart"></a><h3>The SanitizeStart() method</h3>
282 <pre class="programlisting">
283 SanitizeStart (IN s action,
284 IN a{sv} options);
285 </pre>
286 <p>
287 Starts a sanitize operation in the background. A sanitize operation alters all user data
288 in the NVM subsystem such that recovery of any previous user data from any cache,
289 the non-volatile media, or any Controller Memory Buffer is not possible. The scope
290 of a sanitize operation is all locations in the NVM subsystem that are able to contain
291 user data, including caches, Persistent Memory Regions, and unallocated or deallocated
292 areas of the media.
293 </p>
294 <p>
295 Once started, a sanitize operation is not able to be aborted and continues after
296 a Controller Level Reset including across power cycles. Once the sanitize operation
297 has run the media affected may not be immediately ready for use unless additional
298 media modification mechanism is run. This is often vendor specific and also depends
299 on the sanitize method (<em class="parameter"><code>action</code></em>) used.
300 </p>
301 <p>
302 The sanitize operation is set to be executed with the No-Deallocate After Sanitize
303 feature turned on, i.e. the controller shall not deallocate any user data as a result
304 of successfully completing the sanitize operation.
305 </p>
306 <p>
307 The <em class="parameter"><code>action</code></em> parameter indicates the type of the sanitize action to take - valid values are
308 <code class="literal">block-erase</code>, <code class="literal">overwrite</code> and <code class="literal">crypto-erase</code>.
309 </p>
310 <p>
311 In case of the <code class="literal">overwrite</code> action additional options are taken in account.
312 The <code class="literal">overwrite_pass_count</code> option specifies number of overwrite passes (1-15)
313 defaulting to 16 passes when not specified. The <code class="literal">overwrite_pattern</code> option
314 specifies a 32-bit pattern, defaulting to zero if not specified. The <code class="literal">overwrite_invert_pattern</code>
315 option indicates that the overwrite pattern should be inverted between passes.
316 </p>
317 <div class="variablelist"><table border="0" class="variablelist">
318 <colgroup>
319 <col align="left" valign="top">
320 <col>
321 </colgroup>
322 <tbody>
323 <tr>
324 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>action</code></em></code>:</span></p></td>
325 <td><p>
326 The sanitize action to perform.
327 </p></td>
328 </tr>
329 <tr>
330 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
331 <td><p>
332 Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>overwrite_pass_count</code></em> (of type 'y'), <em class="parameter"><code>overwrite_pattern</code></em> (of type 'u') and <em class="parameter"><code>overwrite_invert_pattern</code></em> (of type 'b').
333 </p></td>
334 </tr>
335 </tbody>
336 </table></div>
337 <p class="since">Since 2.10.0</p>
338 </div>
339 </div>
340 <div class="refsect1">
341 <a name="gdbus-properties-org.freedesktop.UDisks2.NVMe.Controller"></a><h2>Property Details</h2>
342 <div class="refsect2">
343 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.State"></a><h3>The "State" property</h3>
344 <pre class="programlisting">
345 State readable s
346 </pre>
347 <p>
348 </p>
349 <p>
350 <em class="parameter"><code>since</code></em>: 2.10.0
351 </p>
352 <p>
353 The controller operating state. Values other than <code class="literal">live</code> may result in temporary
354 refusal of any I/O and subsequent missing information provided by UDisks.
355 </p>
356 <p>
357 Known values include:
358 </p>
359 <div class="variablelist"><table border="0" class="variablelist">
360 <colgroup>
361 <col align="left" valign="top">
362 <col>
363 </colgroup>
364 <tbody>
365 <tr>
366 <td><p><span class="term">live</span></p></td>
367 <td><p>Controller is up and running.</p></td>
368 </tr>
369 <tr>
370 <td><p><span class="term">new</span></p></td>
371 <td><p></p></td>
372 </tr>
373 <tr>
374 <td><p><span class="term">resetting</span></p></td>
375 <td><p></p></td>
376 </tr>
377 <tr>
378 <td><p><span class="term">connecting</span></p></td>
379 <td><p></p></td>
380 </tr>
381 <tr>
382 <td><p><span class="term">deleting</span></p></td>
383 <td><p></p></td>
384 </tr>
385 <tr>
386 <td><p><span class="term">deleting (no IO)</span></p></td>
387 <td><p></p></td>
388 </tr>
389 <tr>
390 <td><p><span class="term">dead</span></p></td>
391 <td><p></p></td>
392 </tr>
393 </tbody>
394 </table></div>
395 <p>
396 </p>
397 </div>
398 <hr>
399 <div class="refsect2">
400 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.ControllerID"></a><h3>The "ControllerID" property</h3>
401 <pre class="programlisting">
402 ControllerID readable q
403 </pre>
404 <p>
405 </p>
406 <p>
407 <em class="parameter"><code>since</code></em>: 2.10.0
408 </p>
409 <p>
410 The NVM subsystem unique controller identifier.
411 </p>
412 </div>
413 <hr>
414 <div class="refsect2">
415 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SubsystemNQN"></a><h3>The "SubsystemNQN" property</h3>
416 <pre class="programlisting">
417 SubsystemNQN readable ay
418 </pre>
419 <p>
420 </p>
421 <p>
422 <em class="parameter"><code>since</code></em>: 2.10.0
423 </p>
424 <p>
425 The NVM Subsystem NVMe Qualified Name.
426 </p>
427 </div>
428 <hr>
429 <div class="refsect2">
430 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.FGUID"></a><h3>The "FGUID" property</h3>
431 <pre class="programlisting">
432 FGUID readable s
433 </pre>
434 <p>
435 </p>
436 <p>
437 <em class="parameter"><code>since</code></em>: 2.10.0
438 </p>
439 <p>
440 The FRU Globally Unique Identifier.
441 </p>
442 <p>
443 Field-Replaceable Unit (FRU) is a physical component, device, or assembly that is able
444 to be removed and replaced without having to replace the entire system.
445 </p>
446 <p>
447 The FRU Globally Unique Identifier is a 128-bit value that is globally unique for a given
448 Field Replaceable Unit (FRU). Value of <code class="constant">0</code> indicates this feature is not supported.
449 </p>
450 </div>
451 <hr>
452 <div class="refsect2">
453 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.NVMeRevision"></a><h3>The "NVMeRevision" property</h3>
454 <pre class="programlisting">
455 NVMeRevision readable s
456 </pre>
457 <p>
458 </p>
459 <p>
460 <em class="parameter"><code>since</code></em>: 2.10.0
461 </p>
462 <p>
463 The major, minor, and micro version of the NVM Express base specification
464 that the controller implementation supports. Note that some older devices
465 (typically NVMe rev. lower than 1.2) may not always report this value.
466 </p>
467 </div>
468 <hr>
469 <div class="refsect2">
470 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.UnallocatedCapacity"></a><h3>The "UnallocatedCapacity" property</h3>
471 <pre class="programlisting">
472 UnallocatedCapacity readable t
473 </pre>
474 <p>
475 </p>
476 <p>
477 <em class="parameter"><code>since</code></em>: 2.10.0
478 </p>
479 <p>
480 The unallocated NVM capacity that is accessible by the controller.
481 </p>
482 </div>
483 <hr>
484 <div class="refsect2">
485 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SmartUpdated"></a><h3>The "SmartUpdated" property</h3>
486 <pre class="programlisting">
487 SmartUpdated readable t
488 </pre>
489 <p>
490 </p>
491 <p>
492 <em class="parameter"><code>since</code></em>: 2.10.0
493 </p>
494 <p>
495 The point in time (seconds since the
496 <a class="ulink" href="http://en.wikipedia.org/wiki/Unix_epoch" target="_top">Unix Epoch</a>)
497 that the SMART/Health Information was updated or 0 if never updated.
498 </p>
499 <p>
500 The value of the other properties related to SMART are not
501 meaningful if this property is 0.
502 </p>
503 </div>
504 <hr>
505 <div class="refsect2">
506 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SmartCriticalWarning"></a><h3>The "SmartCriticalWarning" property</h3>
507 <pre class="programlisting">
508 SmartCriticalWarning readable as
509 </pre>
510 <p>
511 </p>
512 <p>
513 <em class="parameter"><code>since</code></em>: 2.10.0
514 </p>
515 <p>
516 Critical warnings issued for the current state of the controller. An empty array
517 indicates a healthy state. This is the primary health assessment property to watch for.
518 </p>
519 <p>
520 Known values include:
521 </p>
522 <div class="variablelist"><table border="0" class="variablelist">
523 <colgroup>
524 <col align="left" valign="top">
525 <col>
526 </colgroup>
527 <tbody>
528 <tr>
529 <td><p><span class="term">spare</span></p></td>
530 <td><p>The available spare capacity has fallen below the threshold.</p></td>
531 </tr>
532 <tr>
533 <td><p><span class="term">temperature</span></p></td>
534 <td><p>A temperature is either greater than or equal to an over temperature threshold; or less than or equal to an under temperature threshold.</p></td>
535 </tr>
536 <tr>
537 <td><p><span class="term">degraded</span></p></td>
538 <td><p>The NVM subsystem reliability has been degraded due to significant media related errors or any internal error that degrades NVM subsystem reliability.</p></td>
539 </tr>
540 <tr>
541 <td><p><span class="term">readonly</span></p></td>
542 <td><p>All of the media has been placed in read only mode. Unrelated to the write protection state of a namespace.</p></td>
543 </tr>
544 <tr>
545 <td><p><span class="term">volatile_mem</span></p></td>
546 <td><p>The volatile memory backup device has failed. Only valid if the controller has a volatile memory backup solution.</p></td>
547 </tr>
548 <tr>
549 <td><p><span class="term">pmr_readonly</span></p></td>
550 <td><p>Persistent Memory Region has become read-only or unreliable.</p></td>
551 </tr>
552 </tbody>
553 </table></div>
554 <p>
555 </p>
556 </div>
557 <hr>
558 <div class="refsect2">
559 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SmartPowerOnHours"></a><h3>The "SmartPowerOnHours" property</h3>
560 <pre class="programlisting">
561 SmartPowerOnHours readable t
562 </pre>
563 <p>
564 </p>
565 <p>
566 <em class="parameter"><code>since</code></em>: 2.10.0
567 </p>
568 <p>
569 The amount of time the disk has been powered on (according to SMART data) or 0 if unknown.
570 </p>
571 </div>
572 <hr>
573 <div class="refsect2">
574 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SmartTemperature"></a><h3>The "SmartTemperature" property</h3>
575 <pre class="programlisting">
576 SmartTemperature readable q
577 </pre>
578 <p>
579 </p>
580 <p>
581 <em class="parameter"><code>since</code></em>: 2.10.0
582 </p>
583 <p>
584 The temperature (in Kelvin) that represents the current composite temperature
585 of the controller and associated namespaces or 0 if unknown. Values of the particular
586 temperature sensors are exposed via the SmartGetAttributes() method.
587 </p>
588 </div>
589 <hr>
590 <div class="refsect2">
591 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SmartSelftestStatus"></a><h3>The "SmartSelftestStatus" property</h3>
592 <pre class="programlisting">
593 SmartSelftestStatus readable s
594 </pre>
595 <p>
596 </p>
597 <p>
598 <em class="parameter"><code>since</code></em>: 2.10.0
599 </p>
600 <p>
601 The status of the last self-test. Known values include:
602 </p>
603 <div class="variablelist"><table border="0" class="variablelist">
604 <colgroup>
605 <col align="left" valign="top">
606 <col>
607 </colgroup>
608 <tbody>
609 <tr>
610 <td><p><span class="term">success</span></p></td>
611 <td><p>Operation completed without error (or never ran).</p></td>
612 </tr>
613 <tr>
614 <td><p><span class="term">aborted</span></p></td>
615 <td><p>Operation was aborted by a Device Self-test command.</p></td>
616 </tr>
617 <tr>
618 <td><p><span class="term">ctrl_reset</span></p></td>
619 <td><p>Operation was aborted by a Controller Level Reset.</p></td>
620 </tr>
621 <tr>
622 <td><p><span class="term">ns_removed</span></p></td>
623 <td><p>Operation was aborted due to a removal of a namespace from the namespace inventory.</p></td>
624 </tr>
625 <tr>
626 <td><p><span class="term">aborted_format</span></p></td>
627 <td><p>Operation was aborted due to the processing of a Format NVM command.</p></td>
628 </tr>
629 <tr>
630 <td><p><span class="term">fatal_error</span></p></td>
631 <td><p>A fatal error or unknown test error occurred while the controller was executing the device self-test operation and the operation did not complete.</p></td>
632 </tr>
633 <tr>
634 <td><p><span class="term">unknown_seg_fail</span></p></td>
635 <td><p>Operation completed with a segment that failed and the segment that failed is not known.</p></td>
636 </tr>
637 <tr>
638 <td><p><span class="term">known_seg_fail</span></p></td>
639 <td><p>Operation completed with one or more failed segments.</p></td>
640 </tr>
641 <tr>
642 <td><p><span class="term">aborted_unknown</span></p></td>
643 <td><p>Operation was aborted for unknown reason.</p></td>
644 </tr>
645 <tr>
646 <td><p><span class="term">aborted_sanitize</span></p></td>
647 <td><p>Operation was aborted due to a sanitize operation.</p></td>
648 </tr>
649 <tr>
650 <td><p><span class="term">inprogress</span></p></td>
651 <td><p>Self-test operation is currently in progress.</p></td>
652 </tr>
653 </tbody>
654 </table></div>
655 <p>
656 </p>
657 </div>
658 <hr>
659 <div class="refsect2">
660 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SmartSelftestPercentRemaining"></a><h3>The "SmartSelftestPercentRemaining" property</h3>
661 <pre class="programlisting">
662 SmartSelftestPercentRemaining readable i
663 </pre>
664 <p>
665 The percent remaining or -1 if unknown.
666 </p>
667 <p class="since">Since 2.10.0</p>
668 </div>
669 <hr>
670 <div class="refsect2">
671 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SanitizeStatus"></a><h3>The "SanitizeStatus" property</h3>
672 <pre class="programlisting">
673 SanitizeStatus readable s
674 </pre>
675 <p>
676 </p>
677 <p>
678 <em class="parameter"><code>since</code></em>: 2.10.0
679 </p>
680 <p>
681 The information about the most recent sanitize operation. Known values include:
682 </p>
683 <div class="variablelist"><table border="0" class="variablelist">
684 <colgroup>
685 <col align="left" valign="top">
686 <col>
687 </colgroup>
688 <tbody>
689 <tr>
690 <td><p><span class="term">never_sanitized</span></p></td>
691 <td><p>The NVM subsystem has never been sanitized (or the status is unknown).</p></td>
692 </tr>
693 <tr>
694 <td><p><span class="term">success</span></p></td>
695 <td><p>Operation completed successfully.</p></td>
696 </tr>
697 <tr>
698 <td><p><span class="term">failure</span></p></td>
699 <td><p>The most recent sanitize operation failed.</p></td>
700 </tr>
701 <tr>
702 <td><p><span class="term">inprogress</span></p></td>
703 <td><p>A sanitize operation is currently in progress.</p></td>
704 </tr>
705 </tbody>
706 </table></div>
707 <p>
708 </p>
709 </div>
710 <hr>
711 <div class="refsect2">
712 <a name="gdbus-property-org-freedesktop-UDisks2-NVMe-Controller.SanitizePercentRemaining"></a><h3>The "SanitizePercentRemaining" property</h3>
713 <pre class="programlisting">
714 SanitizePercentRemaining readable i
715 </pre>
716 <p>
717 The percent remaining or -1 if unknown.
718 </p>
719 <p class="since">Since 2.10.0</p>
720 </div>
721 </div>
722 </div>
723 <div class="footer">
724 <hr>Generated by GTK-Doc V1.35.1</div>
725 </body>
726 </html>