Debian Codegraph @

doc/html/gdbus-org.freedesktop.UDisks2.Manager.NVMe.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.Manager.NVMe: 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.NVMe.Namespace.html" title="org.freedesktop.UDisks2.NVMe.Namespace">
10 <link rel="next" href="gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.html" title="org.freedesktop.UDisks2.NVMe.Fabrics">
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.Manager.NVMe.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
19 <a href="#gdbus-org.freedesktop.UDisks2.Manager.NVMe.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.NVMe.Namespace.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.Fabrics.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.Manager.NVMe"></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-Manager-NVMe.top_of_page"></a>org.freedesktop.UDisks2.Manager.NVMe</span></h2>
31 <p>org.freedesktop.UDisks2.Manager.NVMe — NVMe host management</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.Manager.NVMe.html#gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostNQN" title="The SetHostNQN() method">SetHostNQN</a> (IN ay hostnqn,
39 IN a{sv} options);
40 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.NVMe.html#gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostID" title="The SetHostID() method">SetHostID</a> (IN ay hostid,
41 IN a{sv} options);
42 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.NVMe.html#gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.Connect" title="The Connect() method">Connect</a> (IN ay subsysnqn,
43 IN s transport,
44 IN s transport_addr,
45 IN a{sv} options,
46 OUT o nvme_ctrl);
47 </pre>
48 </div>
49 <div class="refsect1">
50 <a name="id-1.3.3.16.4"></a><h2>Properties</h2>
51 <pre class="synopsis">
52 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.NVMe.html#gdbus-property-org-freedesktop-UDisks2-Manager-NVMe.HostNQN" title='The "HostNQN" property'>HostNQN</a> readable ay
53 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.NVMe.html#gdbus-property-org-freedesktop-UDisks2-Manager-NVMe.HostID" title='The "HostID" property'>HostID</a> readable ay
54 </pre>
55 </div>
56 <div class="refsect1">
57 <a name="gdbus-interface-org-freedesktop-UDisks2-Manager-NVMe"></a><h2>Description</h2>
58 <p>
59 Extension of the top-level manager singleton object exposing
60 NVMe host management.
61 </p>
62 </div>
63 <div class="refsect1">
64 <a name="gdbus-methods-org.freedesktop.UDisks2.Manager.NVMe"></a><h2>Method Details</h2>
65 <div class="refsect2">
66 <a name="gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostNQN"></a><h3>The SetHostNQN() method</h3>
67 <pre class="programlisting">
68 SetHostNQN (IN ay hostnqn,
69 IN a{sv} options);
70 </pre>
71 <p>
72 Sets the system-wide Host NQN string,
73 </p>
74 <div class="variablelist"><table border="0" class="variablelist">
75 <colgroup>
76 <col align="left" valign="top">
77 <col>
78 </colgroup>
79 <tbody>
80 <tr>
81 <td><p><span class="term"><code class="literal">IN ay <em class="parameter"><code>hostnqn</code></em></code>:</span></p></td>
82 <td><p>
83 The Host NQN value to set.
84 </p></td>
85 </tr>
86 <tr>
87 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
88 <td><p>
89 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
90 </p></td>
91 </tr>
92 </tbody>
93 </table></div>
94 <p class="since">Since 2.10.0</p>
95 </div>
96 <hr>
97 <div class="refsect2">
98 <a name="gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostID"></a><h3>The SetHostID() method</h3>
99 <pre class="programlisting">
100 SetHostID (IN ay hostid,
101 IN a{sv} options);
102 </pre>
103 <p>
104 Sets the system-wide Host ID string,
105 </p>
106 <div class="variablelist"><table border="0" class="variablelist">
107 <colgroup>
108 <col align="left" valign="top">
109 <col>
110 </colgroup>
111 <tbody>
112 <tr>
113 <td><p><span class="term"><code class="literal">IN ay <em class="parameter"><code>hostid</code></em></code>:</span></p></td>
114 <td><p>
115 The Host ID value to set.
116 </p></td>
117 </tr>
118 <tr>
119 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
120 <td><p>
121 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
122 </p></td>
123 </tr>
124 </tbody>
125 </table></div>
126 <p class="since">Since 2.10.0</p>
127 </div>
128 <hr>
129 <div class="refsect2">
130 <a name="gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.Connect"></a><h3>The Connect() method</h3>
131 <pre class="programlisting">
132 Connect (IN ay subsysnqn,
133 IN s transport,
134 IN s transport_addr,
135 IN a{sv} options,
136 OUT o nvme_ctrl);
137 </pre>
138 <p>
139 Create a transport connection to a remote system and create a NVMe over Fabrics controller
140 for the NVMe subsystem specified by the <em class="parameter"><code>subsysnqn</code></em> option.
141 </p>
142 <p>
143 Valid values for <em class="parameter"><code>transport</code></em> are <code class="literal">rdma</code>, <code class="literal">fc</code>,
144 <code class="literal">tcp</code> and <code class="literal">loop</code>.
145 </p>
146 <p>
147 By default, additional options are read from the system configuration file <code class="filename">/etc/nvme/config.json</code>.
148 This follows the default behaviour of <code class="literal">nvme-cli</code>. Use the <code class="literal">config</code>
149 option to either specify a different config file or disable use of it altogether. The naming
150 of the additional options are generally kept consistent with the JSON config file schema and
151 any option specified acts as an override. Available options are:
152 </p>
153 <div class="variablelist"><table border="0" class="variablelist">
154 <colgroup>
155 <col align="left" valign="top">
156 <col>
157 </colgroup>
158 <tbody>
159 <tr>
160 <td><p><span class="term">transport_svcid (type 's')</span></p></td>
161 <td><p>The transport service id. For transports using IP addressing (e.g. <code class="literal">rdma</code>) this field is the port number. By default, the IP port number for the RDMA transport is <code class="literal">4420</code>.</p></td>
162 </tr>
163 <tr>
164 <td><p><span class="term">host_traddr (type 's')</span></p></td>
165 <td><p>The network address used on the host to connect to the Controller. For TCP, this sets the source address on the socket.</p></td>
166 </tr>
167 <tr>
168 <td><p><span class="term">host_iface (type 's')</span></p></td>
169 <td><p>The network interface used on the host to connect to the Controller (e.g. IP <code class="literal">eth1</code>, <code class="literal">enp2s0</code>). This forces the connection to be made on a specific interface instead of letting the system decide.</p></td>
170 </tr>
171 <tr>
172 <td><p><span class="term">host_nqn (type 'ay')</span></p></td>
173 <td><p>Overrides the default Host NQN that identifies the NVMe Host.</p></td>
174 </tr>
175 <tr>
176 <td><p><span class="term">host_id (type 'ay')</span></p></td>
177 <td><p>Overrides the default Host UUID.</p></td>
178 </tr>
179 <tr>
180 <td><p><span class="term">config (type 'ay')</span></p></td>
181 <td><p>Use the specified JSON configuration file instead of the default file (see above) or specify <code class="literal">"none"</code> to avoid reading any configuration file.</p></td>
182 </tr>
183 <tr>
184 <td><p><span class="term">dhchap_key (type 'ay')</span></p></td>
185 <td><p>NVMe in-band authentication secret in ASCII format as described in the NVMe 2.0 specification. When not specified, the secret is by default read from <code class="filename">/etc/nvme/hostkey</code>. In case that file does not exist no in-band authentication is attempted.</p></td>
186 </tr>
187 <tr>
188 <td><p><span class="term">dhchap_ctrl_key (type 'ay')</span></p></td>
189 <td><p>NVMe in-band authentication controller secret for bi-directional authentication. When not specified, no bi-directional authentication is attempted.</p></td>
190 </tr>
191 <tr>
192 <td><p><span class="term">nr_io_queues (type 'i')</span></p></td>
193 <td><p>The number of I/O queues.</p></td>
194 </tr>
195 <tr>
196 <td><p><span class="term">nr_write_queues (type 'i')</span></p></td>
197 <td><p>Number of additional queues that will be used for write I/O.</p></td>
198 </tr>
199 <tr>
200 <td><p><span class="term">nr_poll_queues (type 'i')</span></p></td>
201 <td><p>Number of additional queues that will be used for polling latency sensitive I/O.</p></td>
202 </tr>
203 <tr>
204 <td><p><span class="term">queue_size (type 'i')</span></p></td>
205 <td><p>Number of elements in the I/O queues.</p></td>
206 </tr>
207 <tr>
208 <td><p><span class="term">keep_alive_tmo (type 'i')</span></p></td>
209 <td><p>The keep alive timeout (in seconds).</p></td>
210 </tr>
211 <tr>
212 <td><p><span class="term">reconnect_delay (type 'i')</span></p></td>
213 <td><p>The delay (in seconds) before reconnect is attempted after a connect loss.</p></td>
214 </tr>
215 <tr>
216 <td><p><span class="term">ctrl_loss_tmo (type 'i')</span></p></td>
217 <td><p>The controller loss timeout period (in seconds). A special value of <code class="literal">-1</code> will cause reconnecting forever.</p></td>
218 </tr>
219 <tr>
220 <td><p><span class="term">fast_io_fail_tmo (type 'i')</span></p></td>
221 <td><p>Fast I/O Fail timeout (in seconds).</p></td>
222 </tr>
223 <tr>
224 <td><p><span class="term">tos (type 's')</span></p></td>
225 <td><p>Type of service.</p></td>
226 </tr>
227 <tr>
228 <td><p><span class="term">duplicate_connect (type 'b')</span></p></td>
229 <td><p>Allow duplicated connections between same transport host and subsystem port.</p></td>
230 </tr>
231 <tr>
232 <td><p><span class="term">disable_sqflow (type 'b')</span></p></td>
233 <td><p>Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions.</p></td>
234 </tr>
235 <tr>
236 <td><p><span class="term">hdr_digest (type 'b')</span></p></td>
237 <td><p>Generates/verifies header digest (TCP).</p></td>
238 </tr>
239 <tr>
240 <td><p><span class="term">data_digest (type 'b')</span></p></td>
241 <td><p>Generates/verifies data digest (TCP).</p></td>
242 </tr>
243 <tr>
244 <td><p><span class="term">tls (type 'b')</span></p></td>
245 <td><p>Enable TLS encryption (TCP).</p></td>
246 </tr>
247 <tr>
248 <td><p><span class="term">hostsymname (type 'ay')</span></p></td>
249 <td><p>TP8010: NVMe host symbolic name.</p></td>
250 </tr>
251 <tr>
252 <td><p><span class="term">keyring (type 'ay')</span></p></td>
253 <td><p>Keyring to store and lookup keys.</p></td>
254 </tr>
255 <tr>
256 <td><p><span class="term">tls_key (type 'ay')</span></p></td>
257 <td><p>TLS PSK for the connection.</p></td>
258 </tr>
259 </tbody>
260 </table></div>
261 <p>
262 </p>
263 <div class="variablelist"><table border="0" class="variablelist">
264 <colgroup>
265 <col align="left" valign="top">
266 <col>
267 </colgroup>
268 <tbody>
269 <tr>
270 <td><p><span class="term"><code class="literal">IN ay <em class="parameter"><code>subsysnqn</code></em></code>:</span></p></td>
271 <td><p>
272 The name for the NVMe subsystem to connect to.
273 </p></td>
274 </tr>
275 <tr>
276 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>transport</code></em></code>:</span></p></td>
277 <td><p>
278 The network fabric used for a NVMe-over-Fabrics network.
279 </p></td>
280 </tr>
281 <tr>
282 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>transport_addr</code></em></code>:</span></p></td>
283 <td><p>
284 The network address of the Controller. For transports using IP addressing (e.g. <code class="literal">rdma</code>) this should be an IP-based address.
285 </p></td>
286 </tr>
287 <tr>
288 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
289 <td><p>
290 Additional options, includes <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>.
291 </p></td>
292 </tr>
293 <tr>
294 <td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>nvme_ctrl</code></em></code>:</span></p></td>
295 <td><p>
296 An object path to the connected NVMeoF controller.
297 </p></td>
298 </tr>
299 </tbody>
300 </table></div>
301 <p class="since">Since 2.10.0</p>
302 </div>
303 </div>
304 <div class="refsect1">
305 <a name="gdbus-properties-org.freedesktop.UDisks2.Manager.NVMe"></a><h2>Property Details</h2>
306 <div class="refsect2">
307 <a name="gdbus-property-org-freedesktop-UDisks2-Manager-NVMe.HostNQN"></a><h3>The "HostNQN" property</h3>
308 <pre class="programlisting">
309 HostNQN readable ay
310 </pre>
311 <p>
312 </p>
313 <p>
314 <em class="parameter"><code>since</code></em>: 2.10.0
315 </p>
316 <p>
317 The Host NQN configured for the system. Reflects contents of the <code class="filename">/etc/nvme/hostnqn</code>
318 file if present or uses autogenerated NQN value otherwise.
319 </p>
320 </div>
321 <hr>
322 <div class="refsect2">
323 <a name="gdbus-property-org-freedesktop-UDisks2-Manager-NVMe.HostID"></a><h3>The "HostID" property</h3>
324 <pre class="programlisting">
325 HostID readable ay
326 </pre>
327 <p>
328 </p>
329 <p>
330 <em class="parameter"><code>since</code></em>: 2.10.0
331 </p>
332 <p>
333 The Host ID configured for the system. Reflects contents of the <code class="filename">/etc/nvme/hostid</code>
334 file if present.
335 </p>
336 </div>
337 </div>
338 </div>
339 <div class="footer">
340 <hr>Generated by GTK-Doc V1.35.1</div>
341 </body>
342 </html>