summaryrefslogtreecommitdiffstats
path: root/doc/rst/fabrics.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-04-03 07:38:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-04-03 07:38:49 +0000
commita10a53dd934a67693d068bba16e635ddabcdabe2 (patch)
tree262c2fe9621c7903046080bc3fe9812b423c0dda /doc/rst/fabrics.rst
parentAdding upstream version 1.3. (diff)
downloadlibnvme-a10a53dd934a67693d068bba16e635ddabcdabe2.tar.xz
libnvme-a10a53dd934a67693d068bba16e635ddabcdabe2.zip
Adding upstream version 1.4.upstream/1.4
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/rst/fabrics.rst')
-rw-r--r--doc/rst/fabrics.rst24
1 files changed, 22 insertions, 2 deletions
diff --git a/doc/rst/fabrics.rst b/doc/rst/fabrics.rst
index a7e0e60..bd4bd1d 100644
--- a/doc/rst/fabrics.rst
+++ b/doc/rst/fabrics.rst
@@ -27,6 +27,8 @@ Fabrics-specific definitions.
int nr_write_queues;
int nr_poll_queues;
int tos;
+ int keyring;
+ int tls_key;
bool duplicate_connect;
bool disable_sqflow;
bool hdr_digest;
@@ -69,6 +71,12 @@ Fabrics-specific definitions.
``tos``
Type of service
+``keyring``
+ Keyring to store and lookup keys
+
+``tls_key``
+ TLS PSK for the connection
+
``duplicate_connect``
Allow multiple connections to the same target
@@ -424,10 +432,16 @@ identifier, or NULL if not successful.
.. c:function:: char * nvmf_hostnqn_from_file ()
- Reads the host nvm qualified name from the config default location in /usr/local/etc/nvme/
+ Reads the host nvm qualified name from the config default location
**Parameters**
+**Description**
+
+
+Retrieve the qualified name from the config file located in $SYSCONFIDR/nvme.
+$SYSCONFDIR is usually /etc.
+
**Return**
The host nqn, or NULL if unsuccessful. If found, the caller
@@ -436,10 +450,16 @@ is responsible to free the string.
.. c:function:: char * nvmf_hostid_from_file ()
- Reads the host identifier from the config default location in /usr/local/etc/nvme/.
+ Reads the host identifier from the config default location
**Parameters**
+**Description**
+
+
+Retrieve the host idenditifer from the config file located in $SYSCONFDIR/nvme/.
+$SYSCONFDIR is usually /etc.
+
**Return**
The host identifier, or NULL if unsuccessful. If found, the caller