summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-discover.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:27:59 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-16 15:11:56 +0000
commit6197903bd42478987516bc4cc3f0769488a37065 (patch)
tree508d399340039960289dd1d96696db7c56c22321 /Documentation/nvme-discover.txt
parentAdding upstream version 1.16. (diff)
downloadnvme-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 'Documentation/nvme-discover.txt')
-rw-r--r--Documentation/nvme-discover.txt35
1 files changed, 30 insertions, 5 deletions
diff --git a/Documentation/nvme-discover.txt b/Documentation/nvme-discover.txt
index d0a281a..e27949b 100644
--- a/Documentation/nvme-discover.txt
+++ b/Documentation/nvme-discover.txt
@@ -10,6 +10,7 @@ SYNOPSIS
[verse]
'nvme discover'
[--transport=<trtype> | -t <trtype>]
+ [--nqn=<subnqn> | -n <subnqn>]
[--traddr=<traddr> | -a <traddr>]
[--trsvcid=<trsvcid> | -s <trsvcid>]
[--host-traddr=<traddr> | -w <traddr>]
@@ -18,6 +19,7 @@ SYNOPSIS
[--hostid=<hostid> | -I <hostid>]
[--raw=<filename> | -r <filename>]
[--device=<device> | -d <device>]
+ [--cfg-file=<cfg> | -C <cfg> ]
[--keep-alive-tmo=<sec> | -k <sec>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
@@ -29,7 +31,9 @@ SYNOPSIS
[--queue-size=<#> | -Q <#>]
[--persistent | -p]
[--quiet | -S]
+ [--dump-config | -O]
[--output-format=<fmt> | -o <fmt>]
+ [--force]
DESCRIPTION
-----------
@@ -37,8 +41,8 @@ Send one or more Get Log Page requests to a NVMe-over-Fabrics Discovery
Controller.
If no parameters are given, then 'nvme discover' will attempt to
-find a /etc/nvme/discovery.conf file to use to supply a list of
-Discovery commands to run. If no /etc/nvme/discovery.conf file
+find a @SYSCONFDIR@/nvme/discovery.conf file to use to supply a list of
+Discovery commands to run. If no @SYSCONFDIR@/nvme/discovery.conf file
exists, the command will quit with an error.
Otherwise, a specific Discovery Controller should be specified using the
@@ -85,6 +89,10 @@ OPTIONS
|loop|Connect to a NVMe over Fabrics target on the local host
|=================
+-n <subnqn>::
+--nqn <subnqn>::
+ This field specifies the name for the NVMe subsystem to connect to.
+
-a <traddr>::
--traddr=<traddr>::
This field specifies the network address of the Discovery Controller.
@@ -113,8 +121,8 @@ 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
- NQN value from the NVMe Host kernel module is used next.
+ @SYSCONFDIR@/nvme/hostnqn first. If that does not exist, the
+ autogenerated NQN value from the NVMe Host kernel module is used next.
-I <hostid>::
--hostid=<hostid>::
@@ -132,6 +140,14 @@ OPTIONS
This field takes a device as input. Device is in the format of nvme*,
eg. nvme0, nvme1
+-C <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
+
-k <#>::
--keep-alive-tmo=<#>::
Overrides the default dealy (in seconds) for keep alive.
@@ -184,11 +200,20 @@ OPTIONS
--quiet::
Suppress already connected errors.
+-O::
+--dump-config::
+ Print out resulting JSON configuration file to stdout.
+
-o <format>::
--output-format=<format>::
Set the reporting format to 'normal', 'json', or
'binary'. Only one output format can be used at a time.
+--force::
+ Disable the built-in persitent discover connection rules.
+ Combined with --persistent flag, always create new
+ persistent discovery connection.
+
EXAMPLES
--------
* Query the Discover Controller with IP4 address 192.168.1.3 for all
@@ -200,7 +225,7 @@ Port 4420 is used by default:
--hostnqn=host1-rogue-nqn
------------
+
-* Issue a 'nvme discover' command using a /etc/nvme/discovery.conf file:
+* Issue a 'nvme discover' command using a @SYSCONFDIR@/nvme/discovery.conf file:
+
-----------
# Machine default 'nvme discover' commands. Query the