diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-14 18:28:04 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-16 15:12:07 +0000 |
| commit | 589986012c4b3ab68e299a2eadca18f90080113b (patch) | |
| tree | f29a53b04a1950cdddae69344bccb3f0146fa728 /Documentation/nvme-connect.txt | |
| parent | Releasing debian version 1.16-4. (diff) | |
| download | nvme-cli-589986012c4b3ab68e299a2eadca18f90080113b.tar.xz nvme-cli-589986012c4b3ab68e299a2eadca18f90080113b.zip | |
Merging upstream version 2.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-connect.txt')
| -rw-r--r-- | Documentation/nvme-connect.txt | 35 |
1 files changed, 33 insertions, 2 deletions
diff --git a/Documentation/nvme-connect.txt b/Documentation/nvme-connect.txt index dd31cd3..f57b34d 100644 --- a/Documentation/nvme-connect.txt +++ b/Documentation/nvme-connect.txt @@ -17,6 +17,9 @@ SYNOPSIS [--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 <#>] @@ -28,6 +31,7 @@ SYNOPSIS [--disable-sqflow | -d] [--hdr-digest | -g] [--data-digest | -G] + [--dump-config | -O] [--output-format=<fmt> | -o <fmt>] DESCRIPTION @@ -84,7 +88,7 @@ OPTIONS --hostnqn=<hostnqn>:: Overrides the default Host NQN that identifies the NVMe Host. If this option is not specified, the default is read from - /etc/nvme/hostnqn first. If that does not exist, the autogenerated + @SYSCONFDIR@/nvme/hostnqn first. If that does not exist, the autogenerated NQN value from the NVMe Host kernel module is used next. The Host NQN uniquely identifies the NVMe Host. @@ -93,6 +97,29 @@ OPTIONS UUID(Universally Unique Identifier) to be discovered which should be formatted. +-J <cfg>:: +--config-file=<cfg>:: + Use the specified JSON configuration file instead of the + default @SYSCONFDIR@/nvme/config.json file or 'none' to not read in + an existing configuration file. The JSON configuration file + format is documented in + https://github.com/linux-nvme/libnvme/doc/config-schema.json + +-S <secret>:: +--dhchap-secret=<secret>:: + NVMe In-band authentication secret; needs to be in ASCII format as + specified in NVMe 2.0 section 8.13.5.8 'Secret representation'. + If this option is not specified, the default is read from + @SYSCONFDIR@/nvme/hostkey. If that does not exist no in-band authentication + is attempted. + +-C <secret>:: +--dhchap-ctrl-secret=<secret>:: + 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 'Secret representation'. + If not present bi-directional authentication is not attempted. + -i <#>:: --nr-io-queues=<#>:: Overrides the default number of I/O queues create by the driver. @@ -125,7 +152,7 @@ OPTIONS -D:: --duplicate-connect:: - Allows duplicated connections between same trnsport host and subsystem + Allows duplicated connections between same transport host and subsystem port. -d:: @@ -141,6 +168,10 @@ OPTIONS --data-digest:: Generates/verifies data digest (TCP). +-O:: +--dump-config:: + Print out resulting JSON configuration file to stdout. + -o <format>:: --output-format=<format>:: Set the reporting format to 'normal' or 'json'. Only one output format can |