summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-connect-all.txt
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-connect-all.txt38
1 files changed, 25 insertions, 13 deletions
diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt
index 1cb7822..605d245 100644
--- a/Documentation/nvme-connect-all.txt
+++ b/Documentation/nvme-connect-all.txt
@@ -10,6 +10,7 @@ SYNOPSIS
[verse]
'nvme connect-all'
[--transport=<trtype> | -t <trtype>]
+ [--nqn=<subnqn> | -n <subnqn>]
[--traddr=<traddr> | -a <traddr>]
[--trsvcid=<trsvcid> | -s <trsvcid>]
[--host-traddr=<traddr> | -w <traddr>]
@@ -17,6 +18,7 @@ SYNOPSIS
[--hostnqn=<hostnqn> | -q <hostnqn>]
[--hostid=<hostid> | -I <hostid>]
[--raw=<filename> | -r <filename>]
+ [--cfg-file=<cfg> | -C <cfg>]
[--keep-alive-tmo=<#> | -k <#>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
@@ -26,9 +28,9 @@ SYNOPSIS
[--nr-write-queues=<#> | -W <#>]
[--nr-poll-queues=<#> | -P <#>]
[--queue-size=<#> | -Q <#>]
- [--matching | -m]
[--persistent | -p]
[--quiet | -S]
+ [--dump-config | -O]
DESCRIPTION
-----------
@@ -36,9 +38,9 @@ Send one or more Discovery requests to a NVMe over Fabrics Discovery
Controller, and create controllers for the returned discovery records.
If no parameters are given, then 'nvme connect-all' will attempt to
-find a /etc/nvme/discovery.conf file to use to supply a list of
-connect-all commands to run. If no /etc/nvme/discovery.conf file exists,
-the command will quit with an error.
+find a @SYSCONFDIR@/nvme/discovery.conf file to use to supply a list of
+connect-all 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
--transport, --traddr and if necessary the --trsvcid and a Diѕcovery
@@ -63,6 +65,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.
@@ -91,8 +97,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.
The Host NQN uniquely identifies the NVMe Host, and may be used by the
the Discovery Controller to control what NVMe Target resources are
allocated to the NVMe Host for a connection.
@@ -108,6 +114,14 @@ OPTIONS
and dump it to a raw binary file. By default 'nvme connect-all' will
dump the output to stdout.
+-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 keep alive timeout (in seconds). This
@@ -151,12 +165,6 @@ OPTIONS
by the driver. This option will be ignored for discovery, but will be
passed on to the subsequent connect call.
--m::
---matching::
- If a traddr was specified on the command line or in the configuration
- file, only create controllers for discovery records that match the
- given traddr, rather than for all entries in the discovery log page.
-
-p::
--persistent::
Don't remove the discovery controller after retrieving the discovery
@@ -166,6 +174,10 @@ OPTIONS
--quiet::
Suppress error messages.
+-O::
+--dump-config::
+ Print out resulting JSON configuration file to stdout.
+
EXAMPLES
--------
@@ -178,7 +190,7 @@ the RDMA network. Port 4420 is used by default:
--hostnqn=host1-rogue-nqn
------------
+
-* Issue a 'nvme connect-all' command using a /etc/nvme/discovery.conf file:
+* Issue a 'nvme connect-all' command using a @SYSCONFDIR@/nvme/discovery.conf file:
+
-----------
# Machine default 'nvme discover' commands. Query the