'\" t
.\" Title: nvme-discover
.\" Author: [see the "AUTHORS" section]
-.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 01/08/2019
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\" Date: 04/04/2019
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-DISCOVER" "1" "01/08/2019" "NVMe" "NVMe Manual"
+.TH "NVME\-DISCOVER" "1" "04/04/2019" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
[\-\-host\-traddr=<traddr> | \-w <traddr>]
[\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
+ [\-\-hostid=<hostid> | \-I <hostid>]
[\-\-raw=<filename> | \-r <filename>]
+ [\-\-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 <#>]
.fi
.SH "DESCRIPTION"
.sp
This field specifies the transport service id\&. For transports using IP addressing (e\&.g\&. rdma) this field is the port number\&. By default, the IP port number for the RDMA transport is 4420\&.
.RE
.PP
+\-w <traddr>, \-\-host\-traddr=<traddr>
+.RS 4
+This field specifies the network address used on the host to connect to the Discovery Controller\&.
+.RE
+.PP
\-q <hostnqn>, \-\-hostnqn=<hostnqn>
.RS 4
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\&.
.RE
.PP
-\-w <traddr>, \-\-host\-traddr=<traddr>
+\-I <hostid>, \-\-hostid=<hostid>
.RS 4
-This field specifies the network address used on the host to connect to the Discovery Controller\&.
+UUID(Universally Unique Identifier) to be discovered which should be formatted\&.
.RE
.PP
\-r <filename>, \-\-raw=<filename>
will dump the output to stdout\&.
.RE
.PP
+\-k <#>, \-\-keep\-alive\-tmo=<#>
+.RS 4
+Overrides the default dealy (in seconds) for keep alive\&.
+.RE
+.PP
\-c <#>, \-\-reconnect\-delay=<#>
.RS 4
Overrides the default delay (in seconds) before reconnect is attempted after a connect loss\&.
.RS 4
Overrides the default controller loss timeout period (in seconds)\&.
.RE
+.PP
+\-g, \-\-hdr_digest
+.RS 4
+Generates/verifies header digest (TCP)\&.
+.RE
+.PP
+\-G, \-\-data_digest
+.RS 4
+Generates/verifies data digest (TCP)\&.
+.RE
+.PP
+\-i <#>, \-\-nr\-io\-queues=<#>
+.RS 4
+Overrides the default number of I/O queues create by the driver\&.
+.RE
+.PP
+\-W <#>, \-\-nr\-write\-queues=<#>
+.RS 4
+Adds additional queues that will be used for write I/O\&.
+.RE
+.PP
+\-P <#>, \-\-nr\-poll\-queues=<#>
+.RS 4
+Adds additional queues that will be used for polling latency sensitive I/O\&.
+.RE
+.PP
+\-Q <#>, \-\-queue\-size=<#>
+.RS 4
+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\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
Issue a
\fInvme discover\fR
command using a /etc/nvme/discovery\&.conf file:
-.RE
.sp
.if n \{\
.RS 4
.if n \{\
.RE
.\}
+.RE
.SH "SEE ALSO"
.sp
nvme\-connect(1) nvme\-connect\-all(1)
+<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
<head>\r
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.10" />\r
<title>nvme-discover(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
padding: 0;\r
margin: 0;\r
}\r
-\r
+pre {\r
+ white-space: pre-wrap;\r
+}\r
\r
#author {\r
color: #527bbd;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
a.image:visited { color: white; }\r
\r
dl {\r
[--trsvcid=<trsvcid> | -s <trsvcid>]\r
[--host-traddr=<traddr> | -w <traddr>]\r
[--hostnqn=<hostnqn> | -q <hostnqn>]\r
+ [--hostid=<hostid> | -I <hostid>]\r
[--raw=<filename> | -r <filename>]\r
+ [--keep-alive-tmo=<sec> | -k <sec>]\r
[--reconnect-delay=<#> | -c <#>]\r
- [--ctrl-loss-tmo=<#> | -l <#>]</pre>\r
+ [--ctrl-loss-tmo=<#> | -l <#>]\r
+ [--hdr_digest | -g]\r
+ [--data_digest | -G]\r
+ [--nr-io-queues=<#> | -i <#>]\r
+ [--nr-write-queues=<#> | -W <#>]\r
+ [--nr-poll-queues=<#> | -P <#>]\r
+ [--queue-size=<#> | -Q <#>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
+-w <traddr>\r
+</dt>\r
+<dt class="hdlist1">\r
+--host-traddr=<traddr>\r
+</dt>\r
+<dd>\r
+<p>\r
+ This field specifies the network address used on the host to connect\r
+ to the Discovery Controller.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
-q <hostnqn>\r
</dt>\r
<dt class="hdlist1">\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--w <traddr>\r
+-I <hostid>\r
</dt>\r
<dt class="hdlist1">\r
---host-traddr=<traddr>\r
+--hostid=<hostid>\r
</dt>\r
<dd>\r
<p>\r
- This field specifies the network address used on the host to connect\r
- to the Discovery Controller.\r
+ UUID(Universally Unique Identifier) to be discovered which should be\r
+ formatted.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
+-k <#>\r
+</dt>\r
+<dt class="hdlist1">\r
+--keep-alive-tmo=<#>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Overrides the default dealy (in seconds) for keep alive.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
-c <#>\r
</dt>\r
<dt class="hdlist1">\r
Overrides the default controller loss timeout period (in seconds).\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-g\r
+</dt>\r
+<dt class="hdlist1">\r
+--hdr_digest\r
+</dt>\r
+<dd>\r
+<p>\r
+ Generates/verifies header digest (TCP).\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-G\r
+</dt>\r
+<dt class="hdlist1">\r
+--data_digest\r
+</dt>\r
+<dd>\r
+<p>\r
+ Generates/verifies data digest (TCP).\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-i <#>\r
+</dt>\r
+<dt class="hdlist1">\r
+--nr-io-queues=<#>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Overrides the default number of I/O queues create by the driver.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-W <#>\r
+</dt>\r
+<dt class="hdlist1">\r
+--nr-write-queues=<#>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Adds additional queues that will be used for write I/O.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-P <#>\r
+</dt>\r
+<dt class="hdlist1">\r
+--nr-poll-queues=<#>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Adds additional queues that will be used for polling latency sensitive I/O.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-Q <#>\r
+</dt>\r
+<dt class="hdlist1">\r
+--queue-size=<#>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Overrides the default number of elements in the I/O queues created\r
+ by the driver which can be found at drivers/nvme/host/fabrics.h.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<p>\r
Issue a <em>nvme discover</em> command using a /etc/nvme/discovery.conf file:\r
</p>\r
-</li>\r
-</ul></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><code># Machine default 'nvme discover' commands. Query the\r
\r
At the prompt type "nvme discover".</code></pre>\r
</div></div>\r
+</li>\r
+</ul></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2018-12-17 13:07:47 MST\r
+Last updated\r
+ 2019-04-04 01:15:26 KST\r
</div>\r
</div>\r
</body>\r
[--trsvcid=<trsvcid> | -s <trsvcid>]
[--host-traddr=<traddr> | -w <traddr>]
[--hostnqn=<hostnqn> | -q <hostnqn>]
+ [--hostid=<hostid> | -I <hostid>]
[--raw=<filename> | -r <filename>]
+ [--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 <#>]
DESCRIPTION
-----------
This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420.
+
+-w <traddr>::
+--host-traddr=<traddr>::
+ This field specifies the network address used on the host to connect
+ to the Discovery Controller.
-q <hostnqn>::
--hostnqn=<hostnqn>::
/etc/nvme/hostnqn first. If that does not exist, the autogenerated
NQN value from the NVMe Host kernel module is used next.
--w <traddr>::
---host-traddr=<traddr>::
- This field specifies the network address used on the host to connect
- to the Discovery Controller.
+-I <hostid>::
+--hostid=<hostid>::
+ UUID(Universally Unique Identifier) to be discovered which should be
+ formatted.
-r <filename>::
--raw=<filename>::
and dump it to a raw binary file. By default 'nvme discover' will
dump the output to stdout.
+-k <#>::
+--keep-alive-tmo=<#>::
+ Overrides the default dealy (in seconds) for keep alive.
+
-c <#>::
--reconnect-delay=<#>::
Overrides the default delay (in seconds) before reconnect is attempted
--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.
+
+-W <#>::
+--nr-write-queues=<#>::
+ Adds additional queues that will be used for write I/O.
+
+-P <#>::
+--nr-poll-queues=<#>::
+ Adds additional queues that will be used for polling latency sensitive I/O.
+
+-Q <#>::
+--queue-size=<#>::
+ 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.
+
EXAMPLES
--------
* Query the Discover Controller with IP4 address 192.168.1.3 for all
------------
+
* Issue a 'nvme discover' command using a /etc/nvme/discovery.conf file:
++
-----------
# Machine default 'nvme discover' commands. Query the
# Discovery Controller's two ports (some resources may only
projects / users / sagi / nvme-cli.git / commitdiff