diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-14 18:27:59 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-16 15:11:56 +0000 |
| commit | 6197903bd42478987516bc4cc3f0769488a37065 (patch) | |
| tree | 508d399340039960289dd1d96696db7c56c22321 /Documentation/nvme-dim.html | |
| parent | Adding upstream version 1.16. (diff) | |
| download | nvme-cli-6197903bd42478987516bc4cc3f0769488a37065.tar.xz nvme-cli-6197903bd42478987516bc4cc3f0769488a37065.zip | |
Adding upstream version 2.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
| -rw-r--r-- | Documentation/nvme-dim.html (renamed from Documentation/nvme-lnvm-diag-set-bbtbl.html) | 113 |
1 files changed, 57 insertions, 56 deletions
diff --git a/Documentation/nvme-lnvm-diag-set-bbtbl.html b/Documentation/nvme-dim.html index b8e5943..875689d 100644 --- a/Documentation/nvme-lnvm-diag-set-bbtbl.html +++ b/Documentation/nvme-dim.html @@ -4,8 +4,8 @@ <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" />
-<title>nvme-lnvm-diag-set-bbtbl(1)</title>
+<meta name="generator" content="AsciiDoc" />
+<title>nvme-dim(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;
}
@@ -735,12 +735,12 @@ asciidoc.install(); <body class="manpage">
<div id="header">
<h1>
-nvme-lnvm-diag-set-bbtbl(1) Manual Page
+nvme-dim(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
-<p>nvme-lnvm-diag-set-bbtbl -
- Set a block state in the bad block table
+<p>nvme-dim -
+ Send Discovery Information Management command to one or more Discovery Controllers.
</p>
</div>
</div>
@@ -749,12 +749,10 @@ nvme-lnvm-diag-set-bbtbl(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme lnvm-diag-set-bbtbl</em> [--namespace-id=<NUM> | -n <NUM>]
- [--channel-id=<CHID> | -c <CHID>]
- [--lun-id=<LUNID> | -l <LUNID>]
- [--plane-id=<PLANEID> | -p <PLANEID>]
- [--block-id=<BLKID> | -b <BLKID>]
- [--value=<NUM> | -v <NUM>]</pre>
+<pre class="content"><em>nvme dim</em>
+ [--task=<task> | -t <task>]
+ [--nqn=<nqn> | -n <nqn>]
+ [--device=<device> | -d <device>]</pre>
<div class="attribution">
</div></div>
</div>
@@ -762,14 +760,20 @@ nvme-lnvm-diag-set-bbtbl(1) Manual Page <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Set the bad block table for a given channel, lun, plane and block with value v.</p></div>
-<div class="paragraph"><p>For each block available, the status byte is read as follows:</p></div>
-<div class="paragraph"><p>0: Good block
-1: Bad block
-2: Grown bad block
-4: Device reserved block
-8: Host-side reserved block
-16: Media managed reserved block</p></div>
+<div class="paragraph"><p>Send Discovery Information Management (DIM) command to one or more Discovery
+Controllers. The DIM command allows performing two types of tasks: register or
+deregister.</p></div>
+<div class="paragraph"><p>The DIM command is used to explicitly register with Discovery Controllers (DC),
+especially with Central Discovery Controllers (CDC). CDCs maintain a database (DB)
+of all the Hosts and Storage Susbsystems in a network. The register task is used
+to add a host to the CDC’s DB. The deregister task is used to remove a host from
+the CDC’s DB.</p></div>
+<div class="paragraph"><p>During a register operation the host will send mandatory information such as the
+Host’s NQN and ID, as well as the Host’s hostname and the Operating System’s
+version that it is running on. There is also an optional Host Symbolic Name
+that can be registered with the CDC.</p></div>
+<div class="paragraph"><p>This command can only be applied to existing DC connections previously created
+with the nvme-discover(1) command using the --persistent option.</p></div>
</div>
</div>
<div class="sect1">
@@ -777,58 +781,40 @@ nvme-lnvm-diag-set-bbtbl(1) Manual Page <div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
---namespace-id=<NUM>
+-t <task>
</dt>
<dt class="hdlist1">
--n <NUM>
+--task <task>
</dt>
<dd>
<p>
- Namespace id to use
+ The task to perform: "register" or "deregister".
</p>
</dd>
<dt class="hdlist1">
---channel-id
+-n <subnqn>
</dt>
<dt class="hdlist1">
--c
+--nqn <nqn>
</dt>
<dd>
<p>
- Channel id
+ The DIM command will be sent to the Discovery Controller (DC) matching this
+ NQN. A list of comma-separated NQNs can be supplied to apply the command to
+ more than one DC.
</p>
</dd>
<dt class="hdlist1">
---lun-id
+-d <device>
</dt>
<dt class="hdlist1">
--l
+--device <device>
</dt>
<dd>
<p>
- LUN id
-</p>
-</dd>
-<dt class="hdlist1">
---plane-id
-</dt>
-<dt class="hdlist1">
--p
-</dt>
-<dd>
-<p>
- Plane id
-</p>
-</dd>
-<dt class="hdlist1">
---block-id
-</dt>
-<dt class="hdlist1">
--b
-</dt>
-<dd>
-<p>
- Block id
+ The DIM command will be sent to the Discovery Controllers (DC) associated
+ with this NVMe device handle. A list of comma-separated device handles can
+ be supplied to apply the command to more than one DC.
</p>
</dd>
</dl></div>
@@ -840,15 +826,30 @@ nvme-lnvm-diag-set-bbtbl(1) Manual Page <div class="ulist"><ul>
<li>
<p>
-Set channel 0, lun 0, plane 0, block 10 to bad block value 2 (grown bad)
- on physical device /dev/nvme0
+Register with the Central Discovery Controller (CDC) named
+nqn.1988-11.com.dell:SFSS:1:20220118125153e8:
</p>
+<div class="listingblock">
+<div class="content">
+<pre><code># nvme dim --task=register --nqn=nqn.1988-11.com.dell:SFSS:1:20220118125153e8</code></pre>
+</div></div>
</li>
-</ul></div>
+<li>
+<p>
+Deregister from Central Discovery Controller (CDC) associated with nvme4
+</p>
<div class="listingblock">
<div class="content">
-<pre><code># nvme lnvm-diag-set-bbtbl /dev/nvme0 -c 0 -l 0 -p 0 -b 10 -v 2</code></pre>
+<pre><code># nvme dim --task=deregister --device=nvme4</code></pre>
</div></div>
+</li>
+</ul></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_see_also">SEE ALSO</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>nvme-discover(1)</p></div>
</div>
</div>
<div class="sect1">
@@ -862,7 +863,7 @@ Set channel 0, lun 0, plane 0, block 10 to bad block value 2 (grown bad) <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>
|