|
Packit Service |
b7b338 |
'\" t
|
|
Packit Service |
b7b338 |
.\" Title: nvme-discover
|
|
Packit Service |
b7b338 |
.\" Author: [see the "AUTHORS" section]
|
|
Packit Service |
b7b338 |
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
|
|
Packit Service |
b7b338 |
.\" Date: 04/24/2020
|
|
Packit Service |
b7b338 |
.\" Manual: NVMe Manual
|
|
Packit Service |
b7b338 |
.\" Source: NVMe
|
|
Packit Service |
b7b338 |
.\" Language: English
|
|
Packit Service |
b7b338 |
.\"
|
|
Packit Service |
b7b338 |
.TH "NVME\-DISCOVER" "1" "04/24/2020" "NVMe" "NVMe Manual"
|
|
Packit Service |
b7b338 |
.\" -----------------------------------------------------------------
|
|
Packit Service |
b7b338 |
.\" * Define some portability stuff
|
|
Packit Service |
b7b338 |
.\" -----------------------------------------------------------------
|
|
Packit Service |
b7b338 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Packit Service |
b7b338 |
.\" http://bugs.debian.org/507673
|
|
Packit Service |
b7b338 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
Packit Service |
b7b338 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Packit Service |
b7b338 |
.ie \n(.g .ds Aq \(aq
|
|
Packit Service |
b7b338 |
.el .ds Aq '
|
|
Packit Service |
b7b338 |
.\" -----------------------------------------------------------------
|
|
Packit Service |
b7b338 |
.\" * set default formatting
|
|
Packit Service |
b7b338 |
.\" -----------------------------------------------------------------
|
|
Packit Service |
b7b338 |
.\" disable hyphenation
|
|
Packit Service |
b7b338 |
.nh
|
|
Packit Service |
b7b338 |
.\" disable justification (adjust text to left margin only)
|
|
Packit Service |
b7b338 |
.ad l
|
|
Packit Service |
b7b338 |
.\" -----------------------------------------------------------------
|
|
Packit Service |
b7b338 |
.\" * MAIN CONTENT STARTS HERE *
|
|
Packit Service |
b7b338 |
.\" -----------------------------------------------------------------
|
|
Packit Service |
b7b338 |
.SH "NAME"
|
|
Packit Service |
b7b338 |
nvme-discover \- Send Get Log Page request to Discovery Controller\&.
|
|
Packit Service |
b7b338 |
.SH "SYNOPSIS"
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
.nf
|
|
Packit Service |
b7b338 |
\fInvme discover\fR
|
|
Packit Service |
b7b338 |
[\-\-transport=<trtype> | \-t <trtype>]
|
|
Packit Service |
b7b338 |
[\-\-traddr=<traddr> | \-a <traddr>]
|
|
Packit Service |
b7b338 |
[\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
|
|
Packit Service |
b7b338 |
[\-\-host\-traddr=<traddr> | \-w <traddr>]
|
|
Packit Service |
b7b338 |
[\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
|
|
Packit Service |
b7b338 |
[\-\-hostid=<hostid> | \-I <hostid>]
|
|
Packit Service |
b7b338 |
[\-\-raw=<filename> | \-r <filename>]
|
|
Packit Service |
b7b338 |
[\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
|
|
Packit Service |
b7b338 |
[\-\-reconnect\-delay=<#> | \-c <#>]
|
|
Packit Service |
b7b338 |
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
|
|
Packit Service |
b7b338 |
[\-\-hdr_digest | \-g]
|
|
Packit Service |
b7b338 |
[\-\-data_digest | \-G]
|
|
Packit Service |
b7b338 |
[\-\-nr\-io\-queues=<#> | \-i <#>]
|
|
Packit Service |
b7b338 |
[\-\-nr\-write\-queues=<#> | \-W <#>]
|
|
Packit Service |
b7b338 |
[\-\-nr\-poll\-queues=<#> | \-P <#>]
|
|
Packit Service |
b7b338 |
[\-\-queue\-size=<#> | \-Q <#>]
|
|
Packit Service |
b7b338 |
[\-\-persistent | \-p]
|
|
Packit Service |
b7b338 |
[\-\-quiet | \-S]
|
|
Packit Service |
b7b338 |
.fi
|
|
Packit Service |
b7b338 |
.SH "DESCRIPTION"
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
Send one or more Get Log Page requests to a NVMe\-over\-Fabrics Discovery Controller\&.
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
If no parameters are given, then \fInvme discover\fR will attempt to find a /etc/nvme/discovery\&.conf file to use to supply a list of Discovery commands to run\&. If no /etc/nvme/discovery\&.conf file exists, the command will quit with an error\&.
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
Otherwise, a specific Discovery Controller should be specified using the \-\-transport, \-\-traddr, and if necessary the \-\-trsvcid flags\&. A Diѕcovery request will then be sent to the specified Discovery Controller\&.
|
|
Packit Service |
b7b338 |
.SH "BACKGROUND"
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
The NVMe\-over\-Fabrics specification defines the concept of a Discovery Controller that an NVMe Host can query on a fabric network to discover NVMe subsystems contained in NVMe Targets which it can connect to on the network\&. The Discovery Controller will return Discovery Log Pages that provide the NVMe Host with specific information (such as network address and unique subsystem NQN) the NVMe Host can use to issue an NVMe connect command to connect itself to a storage resource contained in that NVMe subsystem on the NVMe Target\&.
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
Note that the base NVMe specification defines the NQN (NVMe Qualified Name) format which an NVMe endpoint (device, subsystem, etc) must follow to guarantee a unique name under the NVMe standard\&. In particular, 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\&.
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
A Discovery Controller has it\(cqs own NQN defined in the NVMe\-over\-Fabrics specification, \fBnqn\&.2014\-08\&.org\&.nvmexpress\&.discovery\fR\&. All Discovery Controllers must use this NQN name\&. This NQN is used by default by nvme\-cli for the \fIdiscover\fR command\&.
|
|
Packit Service |
b7b338 |
.SH "OPTIONS"
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-t <trtype>, \-\-transport=<trtype>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
This field specifies the network fabric being used for a NVMe\-over\-Fabrics network\&. Current string values include:
|
|
Packit Service |
b7b338 |
.TS
|
|
Packit Service |
b7b338 |
allbox tab(:);
|
|
Packit Service |
b7b338 |
lt lt
|
|
Packit Service |
b7b338 |
lt lt
|
|
Packit Service |
b7b338 |
lt lt
|
|
Packit Service |
b7b338 |
lt lt.
|
|
Packit Service |
b7b338 |
T{
|
|
Packit Service |
b7b338 |
Value
|
|
Packit Service |
b7b338 |
T}:T{
|
|
Packit Service |
b7b338 |
Definition
|
|
Packit Service |
b7b338 |
T}
|
|
Packit Service |
b7b338 |
T{
|
|
Packit Service |
b7b338 |
rdma
|
|
Packit Service |
b7b338 |
T}:T{
|
|
Packit Service |
b7b338 |
The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc)
|
|
Packit Service |
b7b338 |
T}
|
|
Packit Service |
b7b338 |
T{
|
|
Packit Service |
b7b338 |
fc
|
|
Packit Service |
b7b338 |
T}:T{
|
|
Packit Service |
b7b338 |
\fBWIP\fR
|
|
Packit Service |
b7b338 |
The network fabric is a Fibre Channel network\&.
|
|
Packit Service |
b7b338 |
T}
|
|
Packit Service |
b7b338 |
T{
|
|
Packit Service |
b7b338 |
loop
|
|
Packit Service |
b7b338 |
T}:T{
|
|
Packit Service |
b7b338 |
Connect to a NVMe over Fabrics target on the local host
|
|
Packit Service |
b7b338 |
T}
|
|
Packit Service |
b7b338 |
.TE
|
|
Packit Service |
b7b338 |
.sp 1
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-a <traddr>, \-\-traddr=<traddr>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
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\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-s <trsvcid>, \-\-trsvcid=<trsvcid>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
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\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-w <traddr>, \-\-host\-traddr=<traddr>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
This field specifies the network address used on the host to connect to the Discovery Controller\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-q <hostnqn>, \-\-hostnqn=<hostnqn>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
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\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-I <hostid>, \-\-hostid=<hostid>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
UUID(Universally Unique Identifier) to be discovered which should be formatted\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-r <filename>, \-\-raw=<filename>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
This field will take the output of the
|
|
Packit Service |
b7b338 |
\fInvme discover\fR
|
|
Packit Service |
b7b338 |
command and dump it to a raw binary file\&. By default
|
|
Packit Service |
b7b338 |
\fInvme discover\fR
|
|
Packit Service |
b7b338 |
will dump the output to stdout\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-k <#>, \-\-keep\-alive\-tmo=<#>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
Overrides the default dealy (in seconds) for keep alive\&. This option will be ignored for the discovery, and it is only implemented for completeness\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-c <#>, \-\-reconnect\-delay=<#>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
Overrides the default delay (in seconds) before reconnect is attempted after a connect loss\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-l <#>, \-\-ctrl\-loss\-tmo=<#>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
Overrides the default controller loss timeout period (in seconds)\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-g, \-\-hdr_digest
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
Generates/verifies header digest (TCP)\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-G, \-\-data_digest
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
Generates/verifies data digest (TCP)\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-i <#>, \-\-nr\-io\-queues=<#>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
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\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-W <#>, \-\-nr\-write\-queues=<#>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
Adds additional queues that will be used for write I/O\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-P <#>, \-\-nr\-poll\-queues=<#>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
Adds additional queues that will be used for polling latency sensitive I/O\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-Q <#>, \-\-queue\-size=<#>
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
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\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-p, \-\-persistent
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
Persistent discovery connection\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.PP
|
|
Packit Service |
b7b338 |
\-S, \-\-quiet
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
Suppress already connected errors\&.
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.SH "EXAMPLES"
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
.ie n \{\
|
|
Packit Service |
b7b338 |
\h'-04'\(bu\h'+03'\c
|
|
Packit Service |
b7b338 |
.\}
|
|
Packit Service |
b7b338 |
.el \{\
|
|
Packit Service |
b7b338 |
.sp -1
|
|
Packit Service |
b7b338 |
.IP \(bu 2.3
|
|
Packit Service |
b7b338 |
.\}
|
|
Packit Service |
b7b338 |
Query the Discover Controller with IP4 address 192\&.168\&.1\&.3 for all resources allocated for NVMe Host name host1\-rogue\-nqn on the RDMA network\&. Port 4420 is used by default:
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
.if n \{\
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
.\}
|
|
Packit Service |
b7b338 |
.nf
|
|
Packit Service |
b7b338 |
# nvme discover \-\-transport=rdma \-\-traddr=192\&.168\&.1\&.3 \e
|
|
Packit Service |
b7b338 |
\-\-hostnqn=host1\-rogue\-nqn
|
|
Packit Service |
b7b338 |
.fi
|
|
Packit Service |
b7b338 |
.if n \{\
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.\}
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
.ie n \{\
|
|
Packit Service |
b7b338 |
\h'-04'\(bu\h'+03'\c
|
|
Packit Service |
b7b338 |
.\}
|
|
Packit Service |
b7b338 |
.el \{\
|
|
Packit Service |
b7b338 |
.sp -1
|
|
Packit Service |
b7b338 |
.IP \(bu 2.3
|
|
Packit Service |
b7b338 |
.\}
|
|
Packit Service |
b7b338 |
Issue a
|
|
Packit Service |
b7b338 |
\fInvme discover\fR
|
|
Packit Service |
b7b338 |
command using a /etc/nvme/discovery\&.conf file:
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
.if n \{\
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
.\}
|
|
Packit Service |
b7b338 |
.nf
|
|
Packit Service |
b7b338 |
# Machine default \*(Aqnvme discover\*(Aq commands\&. Query the
|
|
Packit Service |
b7b338 |
# Discovery Controller\*(Aqs two ports (some resources may only
|
|
Packit Service |
b7b338 |
# be accessible on a single port)\&. Note an official
|
|
Packit Service |
b7b338 |
# nqn (Host) name defined in the NVMe specification is being used
|
|
Packit Service |
b7b338 |
# in this example\&.
|
|
Packit Service |
b7b338 |
\-t rdma \-a 192\&.168\&.69\&.33 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432
|
|
Packit Service |
b7b338 |
\-t rdma \-a 192\&.168\&.1\&.4 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432
|
|
Packit Service |
b7b338 |
|
|
Packit Service |
b7b338 |
At the prompt type "nvme discover"\&.
|
|
Packit Service |
b7b338 |
.fi
|
|
Packit Service |
b7b338 |
.if n \{\
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.\}
|
|
Packit Service |
b7b338 |
.RE
|
|
Packit Service |
b7b338 |
.SH "SEE ALSO"
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
nvme\-connect(1) nvme\-connect\-all(1)
|
|
Packit Service |
b7b338 |
.SH "AUTHORS"
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
This was written by \m[blue]\fBJay Freyensee\fR\m[]\&\s-2\u[1]\d\s+2
|
|
Packit Service |
b7b338 |
.SH "NVME"
|
|
Packit Service |
b7b338 |
.sp
|
|
Packit Service |
b7b338 |
Part of the nvme\-user suite
|
|
Packit Service |
b7b338 |
.SH "NOTES"
|
|
Packit Service |
b7b338 |
.IP " 1." 4
|
|
Packit Service |
b7b338 |
Jay Freyensee
|
|
Packit Service |
b7b338 |
.RS 4
|
|
Packit Service |
b7b338 |
\%mailto:james.p.freyensee@intel.com
|
|
Packit Service |
b7b338 |
.RE
|