diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-14 18:27:59 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-16 15:11:56 +0000 |
commit | 6197903bd42478987516bc4cc3f0769488a37065 (patch) | |
tree | 508d399340039960289dd1d96696db7c56c22321 /Documentation/nvme-connect.1 | |
parent | Adding upstream version 1.16. (diff) | |
download | nvme-cli-6197903bd42478987516bc4cc3f0769488a37065.tar.xz nvme-cli-6197903bd42478987516bc4cc3f0769488a37065.zip |
Adding upstream version 2.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | Documentation/nvme-connect.1 | 35 |
1 files changed, 32 insertions, 3 deletions
diff --git a/Documentation/nvme-connect.1 b/Documentation/nvme-connect.1 index 55ff773..8139ecd 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: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -41,6 +41,9 @@ nvme-connect \- Connect to a Fabrics controller\&. [\-\-host\-iface=<iface> | \-f <iface>] [\-\-hostnqn=<hostnqn> | \-q <hostnqn>] [\-\-hostid=<hostid> | \-I <hostid>] + [\-\-config\-file=<cfg> | \-J <cfg> ] + [\-\-dhchap\-secret=<secret> | \-S <secret>] + [\-\-dhchap\-ctrl\-secret=<secret> | \-C <secret>] [\-\-nr\-io\-queues=<#> | \-i <#>] [\-\-nr\-write\-queues=<#> | \-W <#>] [\-\-nr\-poll\-queues=<#> | \-P <#>] @@ -52,6 +55,7 @@ nvme-connect \- Connect to a Fabrics controller\&. [\-\-disable\-sqflow | \-d] [\-\-hdr\-digest | \-g] [\-\-data\-digest | \-G] + [\-\-dump\-config | \-O] [\-\-output\-format=<fmt> | \-o <fmt>] .fi .SH "DESCRIPTION" @@ -134,6 +138,26 @@ Overrides the default Host NQN that identifies the NVMe Host\&. If this option i UUID(Universally Unique Identifier) to be discovered which should be formatted\&. .RE .PP +\-J <cfg>, \-\-config\-file=<cfg> +.RS 4 +Use the specified JSON configuration file instead of the default /etc/nvme/config\&.json file or +\fInone\fR +to not read in an existing configuration file\&. The JSON configuration file format is documented in +\m[blue]\fBhttps://github\&.com/linux\-nvme/libnvme/doc/config\-schema\&.json\fR\m[] +.RE +.PP +\-S <secret>, \-\-dhchap\-secret=<secret> +.RS 4 +NVMe In\-band authentication secret; needs to be in ASCII format as specified in NVMe 2\&.0 section 8\&.13\&.5\&.8 +\fISecret representation\fR\&. If this option is not specified, the default is read from /etc/nvme/hostkey\&. If that does not exist no in\-band authentication is attempted\&. +.RE +.PP +\-C <secret>, \-\-dhchap\-ctrl\-secret=<secret> +.RS 4 +NVMe In\-band authentication controller secret for bi\-directional authentication; needs to be in ASCII format as specified in NVMe 2\&.0 section 8\&.13\&.5\&.8 +\fISecret representation\fR\&. If not present bi\-directional authentication is not attempted\&. +.RE +.PP \-i <#>, \-\-nr\-io\-queues=<#> .RS 4 Overrides the default number of I/O queues create by the driver\&. @@ -171,7 +195,7 @@ Overrides the default controller loss timeout period (in seconds)\&. .PP \-D, \-\-duplicate\-connect .RS 4 -Allows duplicated connections between same trnsport host and subsystem port\&. +Allows duplicated connections between same transport host and subsystem port\&. .RE .PP \-d, \-\-disable\-sqflow @@ -189,6 +213,11 @@ Generates/verifies header digest (TCP)\&. Generates/verifies data digest (TCP)\&. .RE .PP +\-O, \-\-dump\-config +.RS 4 +Print out resulting JSON configuration file to stdout\&. +.RE +.PP \-o <format>, \-\-output\-format=<format> .RS 4 Set the reporting format to |