nvme/nvme-cli
1
0
Fork 0
Code Issues Activity

Adding upstream version 2.7.1.

Browse source 
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-16 12:25:25 +01:00
parent 83f51a6dde
commit e08cb5ae68
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
663 changed files with 15529 additions and 6994 deletions
Download patch file Download diff file Expand all files Collapse all files

94
Documentation/nvme-discover.txt
View file

@ -8,39 +8,30 @@ nvme-discover - Send Get Log Page request to Discovery Controller.
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>]
[--host-iface=<iface> | -f <iface>]
[--hostnqn=<hostnqn> | -q <hostnqn>]
[--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 <#>]
[--nr-io-queues=<#> | -i <#>]
[--nr-write-queues=<#> | -W <#>]
[--nr-poll-queues=<#> | -P <#>]
[--queue-size=<#> | -Q <#>]
[--keyring=<#> ]
[--tls_key=<#> ]
[--hdr-digest | -g]
[--data-digest | -G]
[--persistent | -p]
[--quiet | -S]
[--tls ]
[--dump-config | -O]
[--output-format=<fmt> | -o <fmt>]
[--force]
[--nbft]
[--no-nbft]
[--nbft-path=<STR>]
[--context=<STR>]
'nvme discover' [--transport=<trtype> | -t <trtype>]
[--nqn=<subnqn> | -n <subnqn>]
[--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>]
[--device=<device> | -d <device>]
[--cfg-file=<cfg> | -C <cfg>]
[--keep-alive-tmo=<sec> | -k <sec>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
[--nr-io-queues=<#> | -i <#>]
[--nr-write-queues=<#> | -W <#>]
[--nr-poll-queues=<#> | -P <#>]
[--queue-size=<#> | -Q <#>] [--keyring=<#>]
[--tls_key=<#>] [--hdr-digest | -g] [--data-digest | -G]
[--persistent | -p] [--quiet | -S] [--tls]
[--dump-config | -O] [--output-format=<fmt> | -o <fmt>]
[--force] [--nbft] [--no-nbft] [--nbft-path=<STR>]
[--context=<STR>]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
@ -49,7 +40,7 @@ Controller.
If no parameters are given, then 'nvme discover' will attempt to
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
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
@ -61,7 +52,7 @@ BACKGROUND
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
which it can connect to on the network. The Discovery Controller
will return Discovery Log Pages that provide the NVMe Host
with specific information (such as network address and unique
subsystem NQN) the NVMe Host can use to issue an
@ -76,7 +67,7 @@ may be used by the Discovery Controller to control what NVMe Target
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
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.
@ -85,7 +76,7 @@ OPTIONS
-t <trtype>::
--transport=<trtype>::
This field specifies the network fabric being used for
a NVMe-over-Fabrics network. Current string values include:
a NVMe-over-Fabrics network. Current string values include:
+
[]
|=================
@ -108,7 +99,7 @@ OPTIONS
-s <trsvcid>::
--trsvcid=<trsvcid>::
This field specifies the transport service id. For transports using IP
This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420.
@ -223,10 +214,10 @@ OPTIONS
--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.
-o <fmt>::
--output-format=<fmt>::
Set the reporting format to 'normal', 'json' or 'binary'. Only one
output format can be used at a time.
--force::
Disable the built-in persistent discover connection rules.
@ -234,18 +225,27 @@ OPTIONS
persistent discovery connection.
--nbft::
Only look at NBFT tables
Only look at NBFT tables
--no-nbft::
Do not look at NBFT tables
Do not look at NBFT tables
--nbft-path=<STR>::
Use a user-defined path to the NBFT tables
Use a user-defined path to the NBFT tables
--context <STR>::
Set the execution context to <STR>. This allows to coordinate
the management of the global resources.
-o <fmt>::
--output-format=<fmt>::
Set the reporting format to 'normal', 'json' or 'binary'. Only one
output format can be used at a time.
-v::
--verbose::
Increase the information detail in the output.
EXAMPLES
--------
* Query the Discover Controller with IP4 address 192.168.1.3 for all
@ -272,9 +272,9 @@ Port 4420 is used by default:
* Issue a 'nvme discover' command using a @SYSCONFDIR@/nvme/discovery.conf file:
+
-----------
# Machine default 'nvme discover' commands. Query the
# Machine default 'nvme discover' commands. Query the
# Discovery Controller's two ports (some resources may only
# be accessible on a single port). Note an official
# be accessible on a single port). Note an official
# nqn (Host) name defined in the NVMe specification is being used
# in this example.
-t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432