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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.UDisks2.Manager.NVMe: UDisks Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="UDisks Reference Manual">
<link rel="up" href="ch03.html" title="D-Bus Interfaces">
<link rel="prev" href="gdbus-org.freedesktop.UDisks2.NVMe.Namespace.html" title="org.freedesktop.UDisks2.NVMe.Namespace">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.NVMe.Fabrics.html" title="org.freedesktop.UDisks2.NVMe.Fabrics">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#gdbus-org.freedesktop.UDisks2.Manager.NVMe.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#gdbus-org.freedesktop.UDisks2.Manager.NVMe.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<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>
<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>
</tr></table>
<div class="refentry">
<a name="gdbus-org.freedesktop.UDisks2.Manager.NVMe"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-Manager-NVMe.top_of_page"></a>org.freedesktop.UDisks2.Manager.NVMe</span></h2>
<p>org.freedesktop.UDisks2.Manager.NVMe — NVMe host management</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<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,
IN a{sv} options);
<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,
IN a{sv} options);
<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,
IN s transport,
IN s transport_addr,
IN a{sv} options,
OUT o nvme_ctrl);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.16.4"></a><h2>Properties</h2>
<pre class="synopsis">
<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
<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
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-Manager-NVMe"></a><h2>Description</h2>
<p>
Extension of the top-level manager singleton object exposing
NVMe host management.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.Manager.NVMe"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostNQN"></a><h3>The SetHostNQN() method</h3>
<pre class="programlisting">
SetHostNQN (IN ay hostnqn,
IN a{sv} options);
</pre>
<p>
Sets the system-wide Host NQN string,
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN ay <em class="parameter"><code>hostnqn</code></em></code>:</span></p></td>
<td><p>
The Host NQN value to set.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>
Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostID"></a><h3>The SetHostID() method</h3>
<pre class="programlisting">
SetHostID (IN ay hostid,
IN a{sv} options);
</pre>
<p>
Sets the system-wide Host ID string,
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN ay <em class="parameter"><code>hostid</code></em></code>:</span></p></td>
<td><p>
The Host ID value to set.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>
Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.Connect"></a><h3>The Connect() method</h3>
<pre class="programlisting">
Connect (IN ay subsysnqn,
IN s transport,
IN s transport_addr,
IN a{sv} options,
OUT o nvme_ctrl);
</pre>
<p>
Create a transport connection to a remote system and create a NVMe over Fabrics controller
for the NVMe subsystem specified by the <em class="parameter"><code>subsysnqn</code></em> option.
</p>
<p>
Valid values for <em class="parameter"><code>transport</code></em> are <code class="literal">rdma</code>, <code class="literal">fc</code>,
<code class="literal">tcp</code> and <code class="literal">loop</code>.
</p>
<p>
By default, additional options are read from the system configuration file <code class="filename">/etc/nvme/config.json</code>.
This follows the default behaviour of <code class="literal">nvme-cli</code>. Use the <code class="literal">config</code>
option to either specify a different config file or disable use of it altogether. The naming
of the additional options are generally kept consistent with the JSON config file schema and
any option specified acts as an override. Available options are:
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">transport_svcid (type 's')</span></p></td>
<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>
</tr>
<tr>
<td><p><span class="term">host_traddr (type 's')</span></p></td>
<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>
</tr>
<tr>
<td><p><span class="term">host_iface (type 's')</span></p></td>
<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>
</tr>
<tr>
<td><p><span class="term">host_nqn (type 'ay')</span></p></td>
<td><p>Overrides the default Host NQN that identifies the NVMe Host.</p></td>
</tr>
<tr>
<td><p><span class="term">host_id (type 'ay')</span></p></td>
<td><p>Overrides the default Host UUID.</p></td>
</tr>
<tr>
<td><p><span class="term">config (type 'ay')</span></p></td>
<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>
</tr>
<tr>
<td><p><span class="term">dhchap_key (type 'ay')</span></p></td>
<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>
</tr>
<tr>
<td><p><span class="term">dhchap_ctrl_key (type 'ay')</span></p></td>
<td><p>NVMe in-band authentication controller secret for bi-directional authentication. When not specified, no bi-directional authentication is attempted.</p></td>
</tr>
<tr>
<td><p><span class="term">nr_io_queues (type 'i')</span></p></td>
<td><p>The number of I/O queues.</p></td>
</tr>
<tr>
<td><p><span class="term">nr_write_queues (type 'i')</span></p></td>
<td><p>Number of additional queues that will be used for write I/O.</p></td>
</tr>
<tr>
<td><p><span class="term">nr_poll_queues (type 'i')</span></p></td>
<td><p>Number of additional queues that will be used for polling latency sensitive I/O.</p></td>
</tr>
<tr>
<td><p><span class="term">queue_size (type 'i')</span></p></td>
<td><p>Number of elements in the I/O queues.</p></td>
</tr>
<tr>
<td><p><span class="term">keep_alive_tmo (type 'i')</span></p></td>
<td><p>The keep alive timeout (in seconds).</p></td>
</tr>
<tr>
<td><p><span class="term">reconnect_delay (type 'i')</span></p></td>
<td><p>The delay (in seconds) before reconnect is attempted after a connect loss.</p></td>
</tr>
<tr>
<td><p><span class="term">ctrl_loss_tmo (type 'i')</span></p></td>
<td><p>The controller loss timeout period (in seconds). A special value of <code class="literal">-1</code> will cause reconnecting forever.</p></td>
</tr>
<tr>
<td><p><span class="term">fast_io_fail_tmo (type 'i')</span></p></td>
<td><p>Fast I/O Fail timeout (in seconds).</p></td>
</tr>
<tr>
<td><p><span class="term">tos (type 's')</span></p></td>
<td><p>Type of service.</p></td>
</tr>
<tr>
<td><p><span class="term">duplicate_connect (type 'b')</span></p></td>
<td><p>Allow duplicated connections between same transport host and subsystem port.</p></td>
</tr>
<tr>
<td><p><span class="term">disable_sqflow (type 'b')</span></p></td>
<td><p>Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions.</p></td>
</tr>
<tr>
<td><p><span class="term">hdr_digest (type 'b')</span></p></td>
<td><p>Generates/verifies header digest (TCP).</p></td>
</tr>
<tr>
<td><p><span class="term">data_digest (type 'b')</span></p></td>
<td><p>Generates/verifies data digest (TCP).</p></td>
</tr>
<tr>
<td><p><span class="term">tls (type 'b')</span></p></td>
<td><p>Enable TLS encryption (TCP).</p></td>
</tr>
<tr>
<td><p><span class="term">hostsymname (type 'ay')</span></p></td>
<td><p>TP8010: NVMe host symbolic name.</p></td>
</tr>
<tr>
<td><p><span class="term">keyring (type 'ay')</span></p></td>
<td><p>Keyring to store and lookup keys.</p></td>
</tr>
<tr>
<td><p><span class="term">tls_key (type 'ay')</span></p></td>
<td><p>TLS PSK for the connection.</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN ay <em class="parameter"><code>subsysnqn</code></em></code>:</span></p></td>
<td><p>
The name for the NVMe subsystem to connect to.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>transport</code></em></code>:</span></p></td>
<td><p>
The network fabric used for a NVMe-over-Fabrics network.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>transport_addr</code></em></code>:</span></p></td>
<td><p>
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.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>
Additional options, includes <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>nvme_ctrl</code></em></code>:</span></p></td>
<td><p>
An object path to the connected NVMeoF controller.
</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10.0</p>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.Manager.NVMe"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Manager-NVMe.HostNQN"></a><h3>The "HostNQN" property</h3>
<pre class="programlisting">
HostNQN readable ay
</pre>
<p>
The Host NQN configured for the system. Reflects contents of the <code class="filename">/etc/nvme/hostnqn</code>
file if present or uses autogenerated NQN value otherwise.
</p>
<p class="since">Since 2.10.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Manager-NVMe.HostID"></a><h3>The "HostID" property</h3>
<pre class="programlisting">
HostID readable ay
</pre>
<p>
The Host ID configured for the system. Reflects contents of the <code class="filename">/etc/nvme/hostid</code>
file if present.
</p>
<p class="since">Since 2.10.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
|
