summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-discover.html
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-04-03 07:59:35 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-04-03 07:59:35 +0000
commitf42531334c05b7f49ae43c0a27e347a487fb2667 (patch)
treee7a40dd5265005869a4e85eb1e96fdc588b42ef0 /Documentation/nvme-discover.html
parentAdding upstream version 2.3. (diff)
downloadnvme-cli-f42531334c05b7f49ae43c0a27e347a487fb2667.tar.xz
nvme-cli-f42531334c05b7f49ae43c0a27e347a487fb2667.zip
Adding upstream version 2.4.upstream/2.4
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-discover.html')
-rw-r--r--Documentation/nvme-discover.html90
1 files changed, 60 insertions, 30 deletions
diff --git a/Documentation/nvme-discover.html b/Documentation/nvme-discover.html
index 17d8e51..5f3c94e 100644
--- a/Documentation/nvme-discover.html
+++ b/Documentation/nvme-discover.html
@@ -764,14 +764,17 @@ nvme-discover(1) Manual Page
[--keep-alive-tmo=&lt;sec&gt; | -k &lt;sec&gt;]
[--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;]
[--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;]
- [--hdr_digest | -g]
- [--data_digest | -G]
[--nr-io-queues=&lt;#&gt; | -i &lt;#&gt;]
[--nr-write-queues=&lt;#&gt; | -W &lt;#&gt;]
[--nr-poll-queues=&lt;#&gt; | -P &lt;#&gt;]
[--queue-size=&lt;#&gt; | -Q &lt;#&gt;]
+ [--keyring=&lt;#&gt; ]
+ [--tls_key=&lt;#&gt; ]
+ [--hdr-digest | -g]
+ [--data-digest | -G]
[--persistent | -p]
[--quiet | -S]
+ [--tls ]
[--dump-config | -O]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]
[--force]</pre>
@@ -885,7 +888,7 @@ cellspacing="0" cellpadding="4">
<p>
This field specifies the network address of the Discovery Controller.
For transports using IP addressing (e.g. rdma) this should be an
- IP-based (ex. IPv4) address.
+ IP-based address (ex. IPv4).
</p>
</dd>
<dt class="hdlist1">
@@ -974,8 +977,10 @@ cellspacing="0" cellpadding="4">
</dt>
<dd>
<p>
- This field takes a device as input. Device is in the format of nvme*,
- eg. nvme0, nvme1
+ 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". &lt;device&gt; follows the format
+ nvme*, eg. nvme0, nvme1.
</p>
</dd>
<dt class="hdlist1">
@@ -1001,8 +1006,8 @@ cellspacing="0" cellpadding="4">
</dt>
<dd>
<p>
- Overrides the default timeout (in seconds) for keep alive.
- This option will be ignored for the discovery, and it is only
+ Overrides the default keep alive timeout (in seconds). This
+ option will be ignored for discovery, and it is only
implemented for completeness.
</p>
</dd>
@@ -1030,74 +1035,90 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
--g
+-i &lt;#&gt;
</dt>
<dt class="hdlist1">
---hdr_digest
+--nr-io-queues=&lt;#&gt;
</dt>
<dd>
<p>
- Generates/verifies header digest (TCP).
+ Overrides the default number of I/O queues create by the driver.
+ This option will be ignored for the discovery, and it is only
+ implemented for completeness.
</p>
</dd>
<dt class="hdlist1">
--G
+-W &lt;#&gt;
</dt>
<dt class="hdlist1">
---data_digest
+--nr-write-queues=&lt;#&gt;
</dt>
<dd>
<p>
- Generates/verifies data digest (TCP).
+ Adds additional queues that will be used for write I/O.
</p>
</dd>
<dt class="hdlist1">
--i &lt;#&gt;
+-P &lt;#&gt;
</dt>
<dt class="hdlist1">
---nr-io-queues=&lt;#&gt;
+--nr-poll-queues=&lt;#&gt;
</dt>
<dd>
<p>
- Overrides the default number of I/O queues create by the driver.
+ Adds additional queues that will be used for polling latency sensitive I/O.
+</p>
+</dd>
+<dt class="hdlist1">
+-Q &lt;#&gt;
+</dt>
+<dt class="hdlist1">
+--queue-size=&lt;#&gt;
+</dt>
+<dd>
+<p>
+ Overrides the default number of elements in the I/O queues created
+ by the driver which can be found at drivers/nvme/host/fabrics.h.
This option will be ignored for the discovery, and it is only
implemented for completeness.
</p>
</dd>
<dt class="hdlist1">
--W &lt;#&gt;
+--keyring=&lt;#&gt;
</dt>
+<dd>
+<p>
+ Keyring for TLS key lookup.
+</p>
+</dd>
<dt class="hdlist1">
---nr-write-queues=&lt;#&gt;
+--tls_key=&lt;#&gt;
</dt>
<dd>
<p>
- Adds additional queues that will be used for write I/O.
+ TLS key for the connection (TCP).
</p>
</dd>
<dt class="hdlist1">
--P &lt;#&gt;
+-g
</dt>
<dt class="hdlist1">
---nr-poll-queues=&lt;#&gt;
+--hdr-digest
</dt>
<dd>
<p>
- Adds additional queues that will be used for polling latency sensitive I/O.
+ Generates/verifies header digest (TCP).
</p>
</dd>
<dt class="hdlist1">
--Q &lt;#&gt;
+-G
</dt>
<dt class="hdlist1">
---queue-size=&lt;#&gt;
+--data-digest
</dt>
<dd>
<p>
- Overrides the default number of elements in the I/O queues created
- by the driver which can be found at drivers/nvme/host/fabrics.h.
- This option will be ignored for the discovery, and it is only
- implemented for completeness.
+ Generates/verifies data digest (TCP).
</p>
</dd>
<dt class="hdlist1">
@@ -1108,7 +1129,16 @@ cellspacing="0" cellpadding="4">
</dt>
<dd>
<p>
- Persistent discovery connection.
+ Don&#8217;t remove the discovery controller after retrieving the discovery
+ log page.
+</p>
+</dd>
+<dt class="hdlist1">
+--tls
+</dt>
+<dd>
+<p>
+ Enable TLS encryption (TCP).
</p>
</dd>
<dt class="hdlist1">
@@ -1218,7 +1248,7 @@ nvme-connect-all(1)</p></div>
<div id="footer">
<div id="footer-text">
Last updated
- 2023-01-30 14:14:16 CET
+ 2023-03-31 16:17:28 CEST
</div>
</div>
</body>