diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-14 18:28:04 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-16 15:12:07 +0000 |
| commit | 589986012c4b3ab68e299a2eadca18f90080113b (patch) | |
| tree | f29a53b04a1950cdddae69344bccb3f0146fa728 /Documentation/nvme-connect-all.html | |
| parent | Releasing debian version 1.16-4. (diff) | |
| download | nvme-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-connect-all.html')
| -rw-r--r-- | Documentation/nvme-connect-all.html | 68 |
1 files changed, 47 insertions, 21 deletions
diff --git a/Documentation/nvme-connect-all.html b/Documentation/nvme-connect-all.html index 91bd91a..39d5732 100644 --- a/Documentation/nvme-connect-all.html +++ b/Documentation/nvme-connect-all.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-connect-all(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-connect-all(1) Manual Page <div class="verseblock">
<pre class="content"><em>nvme connect-all</em>
[--transport=<trtype> | -t <trtype>]
+ [--nqn=<subnqn> | -n <subnqn>]
[--traddr=<traddr> | -a <traddr>]
[--trsvcid=<trsvcid> | -s <trsvcid>]
[--host-traddr=<traddr> | -w <traddr>]
@@ -758,6 +759,7 @@ nvme-connect-all(1) Manual Page [--hostnqn=<hostnqn> | -q <hostnqn>]
[--hostid=<hostid> | -I <hostid>]
[--raw=<filename> | -r <filename>]
+ [--cfg-file=<cfg> | -C <cfg>]
[--keep-alive-tmo=<#> | -k <#>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
@@ -767,9 +769,9 @@ nvme-connect-all(1) Manual Page [--nr-write-queues=<#> | -W <#>]
[--nr-poll-queues=<#> | -P <#>]
[--queue-size=<#> | -Q <#>]
- [--matching | -m]
[--persistent | -p]
- [--quiet | -S]</pre>
+ [--quiet | -S]
+ [--dump-config | -O]</pre>
<div class="attribution">
</div></div>
</div>
@@ -781,8 +783,8 @@ nvme-connect-all(1) Manual Page Controller, and create controllers for the returned discovery records.</p></div>
<div class="paragraph"><p>If no parameters are given, then <em>nvme connect-all</em> will attempt to
find a /etc/nvme/discovery.conf file to use to supply a list of
-connect-all commands to run. If no /etc/nvme/discovery.conf file exists,
-the command will quit with an error.</p></div>
+connect-all commands to run. If no /etc/nvme/discovery.conf file
+exists, the command will quit with an error.</p></div>
<div class="paragraph"><p>Otherwise a specific Discovery Controller should be specified using the
--transport, --traddr and if necessary the --trsvcid and a Diѕcovery
request will be sent to the specified Discovery Controller.</p></div>
@@ -838,6 +840,17 @@ cellspacing="0" cellpadding="4"> </div>
</dd>
<dt class="hdlist1">
+-n <subnqn>
+</dt>
+<dt class="hdlist1">
+--nqn <subnqn>
+</dt>
+<dd>
+<p>
+ This field specifies the name for the NVMe subsystem to connect to.
+</p>
+</dd>
+<dt class="hdlist1">
-a <traddr>
</dt>
<dt class="hdlist1">
@@ -899,8 +912,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.
The Host NQN uniquely identifies the NVMe Host, and may be used by the
the Discovery Controller to control what NVMe Target resources are
allocated to the NVMe Host for a connection.
@@ -932,6 +945,21 @@ cellspacing="0" cellpadding="4"> </p>
</dd>
<dt class="hdlist1">
+-C <cfg>
+</dt>
+<dt class="hdlist1">
+--config-file=<cfg>
+</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 <#>
</dt>
<dt class="hdlist1">
@@ -1038,39 +1066,37 @@ cellspacing="0" cellpadding="4"> </p>
</dd>
<dt class="hdlist1">
--m
+-p
</dt>
<dt class="hdlist1">
---matching
+--persistent
</dt>
<dd>
<p>
- If a traddr was specified on the command line or in the configuration
- file, only create controllers for discovery records that match the
- given traddr, rather than for all entries in the discovery log page.
+ Don’t remove the discovery controller after retrieving the discovery
+ log page.
</p>
</dd>
<dt class="hdlist1">
--p
+-S
</dt>
<dt class="hdlist1">
---persistent
+--quiet
</dt>
<dd>
<p>
- Don’t remove the discovery controller after retrieving the discovery
- log page.
+ Suppress error messages.
</p>
</dd>
<dt class="hdlist1">
--S
+-O
</dt>
<dt class="hdlist1">
---quiet
+--dump-config
</dt>
<dd>
<p>
- Suppress error messages.
+ Print out resulting JSON configuration file to stdout.
</p>
</dd>
</dl></div>
@@ -1130,7 +1156,7 @@ nvme-connect(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>
|