From 66e4b69042cd3b44acd42f1fad2109180c1bc48b Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 24 Dec 2023 08:57:54 +0100 Subject: Merging upstream version 2.7.1. Signed-off-by: Daniel Baumann --- Documentation/nvme-discover.html | 104 ++++++++++++++++++++++----------------- 1 file changed, 59 insertions(+), 45 deletions(-) (limited to 'Documentation/nvme-discover.html') diff --git a/Documentation/nvme-discover.html b/Documentation/nvme-discover.html index bce1ae8..dc56c6b 100644 --- a/Documentation/nvme-discover.html +++ b/Documentation/nvme-discover.html @@ -749,39 +749,30 @@ nvme-discover(1) Manual Page

SYNOPSIS

-
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]
@@ -793,7 +784,7 @@ nvme-discover(1) Manual Page Controller.

If no parameters are given, then nvme discover will attempt to find a /usr/local/etc/nvme/discovery.conf file to use to supply a list of -Discovery commands to run. If no /usr/local/etc/nvme/discovery.conf file +Discovery commands to run. If no /usr/local/etc/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 flags. A Discovery @@ -806,7 +797,7 @@ request will then be sent to the specified Discovery Controller.

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 @@ -819,7 +810,7 @@ In particular, the Host NQN uniquely identifies the NVMe Host, and 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.

@@ -837,7 +828,7 @@ nvme-cli for the discover command.

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:

- 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.

@@ -1168,15 +1159,15 @@ cellspacing="0" cellpadding="4">

--o <format> +-o <fmt>
---output-format=<format> +--output-format=<fmt>

- Set the reporting format to normal, json, or - binary. Only one output format can be used at a time. + Set the reporting format to normal, json or binary. Only one + output format can be used at a time.

@@ -1222,6 +1213,29 @@ cellspacing="0" cellpadding="4"> 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. +

+
@@ -1265,9 +1279,9 @@ Issue a nvme discover command using a /usr/local/etc/nvme/discovery.con

-
# 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
@@ -1303,7 +1317,7 @@ nvme-connect-all(1)
-- cgit v1.2.3