summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-connect.1
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-connect.1')
-rw-r--r--Documentation/nvme-connect.124
1 files changed, 17 insertions, 7 deletions
diff --git a/Documentation/nvme-connect.1 b/Documentation/nvme-connect.1
index 4477f4c..aca8d8c 100644
--- a/Documentation/nvme-connect.1
+++ b/Documentation/nvme-connect.1
@@ -2,12 +2,12 @@
.\" Title: nvme-connect
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 08/05/2024
+.\" Date: 10/31/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-CONNECT" "1" "08/05/2024" "NVMe" "NVMe Manual"
+.TH "NVME\-CONNECT" "1" "10/31/2024" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -50,7 +50,8 @@ nvme-connect \- Connect to a Fabrics controller\&.
[\-\-keep\-alive\-tmo=<#> | \-k <#>]
[\-\-reconnect\-delay=<#> | \-c <#>]
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>] [\-\-tos=<#> | \-T <#>]
- [\-\-keyring=<#>] [\-\-tls_key=<#>]
+ [\-\-keyring=<keyring>] [\-\-tls\-key=<tls\-key>]
+ [\-\-tls\-key\-identity=<identity>]
[\-\-duplicate\-connect | \-D] [\-\-disable\-sqflow ]
[\-\-hdr\-digest | \-g] [\-\-data\-digest | \-G] [\-\-tls]
[\-\-concat] [\-\-dump\-config | \-O] [\-\-application=<id>]
@@ -198,14 +199,23 @@ seconds\&.
Type of service for the connection (TCP)
.RE
.PP
-\-\-keyring=<#>
+\-\-keyring=<keyring>
.RS 4
-Keyring for TLS key lookup\&.
+Keyring for TLS key lookup, either the key id or the keyring name\&.
.RE
.PP
-\-\-tls_key=<#>
+\-\-tls\-key=<tls\-key>
.RS 4
-TLS key for the connection (TCP)\&.
+TLS key for the connection (TCP), either the TLS key in interchange format or the key id\&. It\(cqs strongly recommended not to provide the TLS key via the comamnd line due to security concerns\&. Instead in production situation, the key should be loaded into the keystore with
+\fInvme tls \-\-import\fR
+and only the
+\fI\-\-tls\fR
+options used\&. The kernel will select the matching key\&.
+.RE
+.PP
+\-\-tls\-key\-identity=<identity>
+.RS 4
+The identity used for the tls\-key\&. If none is provided the tls\-key provided via the comamnd line is considered a configuration key and a derive key will be loaded into the keyring\&.
.RE
.PP
\-D, \-\-duplicate\-connect