summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-discover.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-04-03 08:17:38 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-04-03 08:17:38 +0000
commitd57675fc67455faf7c68d4003a1ce884779e2c7c (patch)
tree3becd19ea8eda8827e45bf9e627d580fe614be64 /Documentation/nvme-discover.txt
parentReleasing debian version 2.4-1. (diff)
downloadnvme-cli-d57675fc67455faf7c68d4003a1ce884779e2c7c.tar.xz
nvme-cli-d57675fc67455faf7c68d4003a1ce884779e2c7c.zip
Merging upstream version 2.4+really2.3.
This reverts commit f42531334c05b7f49ae43c0a27e347a487fb2667.
Diffstat (limited to 'Documentation/nvme-discover.txt')
-rw-r--r--Documentation/nvme-discover.txt47
1 files changed, 16 insertions, 31 deletions
diff --git a/Documentation/nvme-discover.txt b/Documentation/nvme-discover.txt
index d4df75c..53826d5 100644
--- a/Documentation/nvme-discover.txt
+++ b/Documentation/nvme-discover.txt
@@ -23,17 +23,14 @@ SYNOPSIS
[--keep-alive-tmo=<sec> | -k <sec>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
+ [--hdr_digest | -g]
+ [--data_digest | -G]
[--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]
@@ -100,7 +97,7 @@ OPTIONS
--traddr=<traddr>::
This field specifies the network address of the Discovery Controller.
For transports using IP addressing (e.g. rdma) this should be an
- IP-based address (ex. IPv4).
+ IP-based (ex. IPv4) address.
-s <trsvcid>::
--trsvcid=<trsvcid>::
@@ -140,10 +137,8 @@ OPTIONS
-d <device>::
--device=<device>::
- This field takes a device as input. It must be a persistent device
- associated with a Discovery Controller previously created by the
- command "connect-all" or "discover". <device> follows the format
- nvme*, eg. nvme0, nvme1.
+ This field takes a device as input. Device is in the format of nvme*,
+ eg. nvme0, nvme1
-C <cfg>::
--config-file=<cfg>::
@@ -155,8 +150,8 @@ OPTIONS
-k <#>::
--keep-alive-tmo=<#>::
- Overrides the default keep alive timeout (in seconds). This
- option will be ignored for discovery, and it is only
+ Overrides the default timeout (in seconds) for keep alive.
+ This option will be ignored for the discovery, and it is only
implemented for completeness.
-c <#>::
@@ -168,6 +163,14 @@ OPTIONS
--ctrl-loss-tmo=<#>::
Overrides the default controller loss timeout period (in seconds).
+-g::
+--hdr_digest::
+ Generates/verifies header digest (TCP).
+
+-G::
+--data_digest::
+ Generates/verifies data digest (TCP).
+
-i <#>::
--nr-io-queues=<#>::
Overrides the default number of I/O queues create by the driver.
@@ -189,27 +192,9 @@ OPTIONS
This option will be ignored for the discovery, and it is only
implemented for completeness.
---keyring=<#>::
- Keyring for TLS key lookup.
-
---tls_key=<#>::
- TLS key for the connection (TCP).
-
--g::
---hdr-digest::
- Generates/verifies header digest (TCP).
-
--G::
---data-digest::
- Generates/verifies data digest (TCP).
-
-p::
--persistent::
- Don't remove the discovery controller after retrieving the discovery
- log page.
-
---tls::
- Enable TLS encryption (TCP).
+ Persistent discovery connection.
-S::
--quiet::