summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-discover.html
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-14 18:28:04 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-16 15:12:07 +0000
commit589986012c4b3ab68e299a2eadca18f90080113b (patch)
treef29a53b04a1950cdddae69344bccb3f0146fa728 /Documentation/nvme-discover.html
parentReleasing debian version 1.16-4. (diff)
downloadnvme-cli-589986012c4b3ab68e299a2eadca18f90080113b.tar.xz
nvme-cli-589986012c4b3ab68e299a2eadca18f90080113b.zip
Merging upstream version 2.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-discover.html')
-rw-r--r--Documentation/nvme-discover.html63
1 files changed, 57 insertions, 6 deletions
diff --git a/Documentation/nvme-discover.html b/Documentation/nvme-discover.html
index 2a4493f..9dd5e22 100644
--- a/Documentation/nvme-discover.html
+++ b/Documentation/nvme-discover.html
@@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.6.10" />
+<meta name="generator" content="AsciiDoc" />
<title>nvme-discover(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
-/* Because the table frame attribute is overriden by CSS in most browsers. */
+/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@@ -751,6 +751,7 @@ nvme-discover(1) Manual Page
<div class="verseblock">
<pre class="content"><em>nvme discover</em>
[--transport=&lt;trtype&gt; | -t &lt;trtype&gt;]
+ [--nqn=&lt;subnqn&gt; | -n &lt;subnqn&gt;]
[--traddr=&lt;traddr&gt; | -a &lt;traddr&gt;]
[--trsvcid=&lt;trsvcid&gt; | -s &lt;trsvcid&gt;]
[--host-traddr=&lt;traddr&gt; | -w &lt;traddr&gt;]
@@ -759,6 +760,7 @@ nvme-discover(1) Manual Page
[--hostid=&lt;hostid&gt; | -I &lt;hostid&gt;]
[--raw=&lt;filename&gt; | -r &lt;filename&gt;]
[--device=&lt;device&gt; | -d &lt;device&gt;]
+ [--cfg-file=&lt;cfg&gt; | -C &lt;cfg&gt; ]
[--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;]
@@ -770,7 +772,9 @@ nvme-discover(1) Manual Page
[--queue-size=&lt;#&gt; | -Q &lt;#&gt;]
[--persistent | -p]
[--quiet | -S]
- [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre>
+ [--dump-config | -O]
+ [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]
+ [--force]</pre>
<div class="attribution">
</div></div>
</div>
@@ -861,6 +865,17 @@ cellspacing="0" cellpadding="4">
</div>
</dd>
<dt class="hdlist1">
+-n &lt;subnqn&gt;
+</dt>
+<dt class="hdlist1">
+--nqn &lt;subnqn&gt;
+</dt>
+<dd>
+<p>
+ This field specifies the name for the NVMe subsystem to connect to.
+</p>
+</dd>
+<dt class="hdlist1">
-a &lt;traddr&gt;
</dt>
<dt class="hdlist1">
@@ -922,8 +937,8 @@ cellspacing="0" cellpadding="4">
<p>
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.
+ /etc/nvme/hostnqn first. If that does not exist, the
+ autogenerated NQN value from the NVMe Host kernel module is used next.
</p>
</dd>
<dt class="hdlist1">
@@ -964,6 +979,21 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
+-C &lt;cfg&gt;
+</dt>
+<dt class="hdlist1">
+--config-file=&lt;cfg&gt;
+</dt>
+<dd>
+<p>
+ Use the specified JSON configuration file instead of the
+ default /etc/nvme/config.json file or <em>none</em> to not read in
+ an existing configuration file. The JSON configuration file
+ format is documented in
+ <a href="https://github.com/linux-nvme/libnvme/doc/config-schema.json">https://github.com/linux-nvme/libnvme/doc/config-schema.json</a>
+</p>
+</dd>
+<dt class="hdlist1">
-k &lt;#&gt;
</dt>
<dt class="hdlist1">
@@ -1093,6 +1123,17 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
+-O
+</dt>
+<dt class="hdlist1">
+--dump-config
+</dt>
+<dd>
+<p>
+ Print out resulting JSON configuration file to stdout.
+</p>
+</dd>
+<dt class="hdlist1">
-o &lt;format&gt;
</dt>
<dt class="hdlist1">
@@ -1104,6 +1145,16 @@ cellspacing="0" cellpadding="4">
<em>binary</em>. Only one output format can be used at a time.
</p>
</dd>
+<dt class="hdlist1">
+--force
+</dt>
+<dd>
+<p>
+ Disable the built-in persitent discover connection rules.
+ Combined with --persistent flag, always create new
+ persistent discovery connection.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -1167,7 +1218,7 @@ nvme-connect-all(1)</p></div>
<div id="footer">
<div id="footer-text">
Last updated
- 2021-07-19 10:10:19 PDT
+ 2022-04-08 18:46:59 CEST
</div>
</div>
</body>