diff options
Diffstat (limited to '')
| -rw-r--r-- | Documentation/nvme-discover.txt | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/Documentation/nvme-discover.txt b/Documentation/nvme-discover.txt index 74add74..d0a281a 100644 --- a/Documentation/nvme-discover.txt +++ b/Documentation/nvme-discover.txt @@ -13,6 +13,7 @@ SYNOPSIS [--traddr=<traddr> | -a <traddr>] [--trsvcid=<trsvcid> | -s <trsvcid>] [--host-traddr=<traddr> | -w <traddr>] + [--host-iface=<iface> | -f <iface>] [--hostnqn=<hostnqn> | -q <hostnqn>] [--hostid=<hostid> | -I <hostid>] [--raw=<filename> | -r <filename>] @@ -35,7 +36,7 @@ DESCRIPTION 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 +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 exists, the command will quit with an error. @@ -46,7 +47,7 @@ request will then be sent to the specified Discovery Controller. BACKGROUND ---------- -The NVMe-over-Fabrics specification defines the concept of a +The NVMe-over-Fabrics specification defines the concept of a Discovery Controller that an NVMe Host can query on a fabric network to discover NVMe subsystems contained in NVMe Targets which it can connect to on the network. The Discovery Controller @@ -66,7 +67,7 @@ resources are allocated to the NVMe Host for a connection. A Discovery Controller has it's own NQN defined in the NVMe-over-Fabrics specification, *nqn.2014-08.org.nvmexpress.discovery*. All Discovery Controllers must use this NQN name. This NQN is used by default by -nvme-cli for the 'discover' command. +nvme-cli for the 'discover' command. OPTIONS ------- @@ -99,11 +100,18 @@ OPTIONS -w <traddr>:: --host-traddr=<traddr>:: This field specifies the network address used on the host to connect - to the Discovery Controller. - + to the Controller. For TCP, this sets the source address on the socket. + +-f <iface>:: +--host-iface=<iface>:: + This field specifies the network interface used on the host to connect + to the Controller (e.g. IP eth1, enp2s0, enx78e7d1ea46da). This forces + the connection to be made on a specific interface instead of letting + the system decide. + -q <hostnqn>:: --hostnqn=<hostnqn>:: - Overrides the default host NQN that identifies the NVMe Host. + 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. |