summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-discover.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-11-20 07:04:31 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-11-20 07:04:31 +0000
commit727de41af97db70722cfc1898ebb027b9e339969 (patch)
tree990f71500c8feeb9f437c5021522ebaff3915141 /Documentation/nvme-discover.1
parentAdding upstream version 1.15. (diff)
downloadnvme-cli-727de41af97db70722cfc1898ebb027b9e339969.tar.xz
nvme-cli-727de41af97db70722cfc1898ebb027b9e339969.zip
Adding upstream version 1.16.upstream/1.16
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-discover.1')
-rw-r--r--Documentation/nvme-discover.127
1 files changed, 24 insertions, 3 deletions
diff --git a/Documentation/nvme-discover.1 b/Documentation/nvme-discover.1
index 80b8a47..aa6edf4 100644
--- a/Documentation/nvme-discover.1
+++ b/Documentation/nvme-discover.1
@@ -2,12 +2,12 @@
.\" Title: nvme-discover
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 10/20/2020
+.\" Date: 11/11/2021
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-DISCOVER" "1" "10/20/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-DISCOVER" "1" "11/11/2021" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -37,9 +37,11 @@ nvme-discover \- Send Get Log Page request to Discovery Controller\&.
[\-\-traddr=<traddr> | \-a <traddr>]
[\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
[\-\-host\-traddr=<traddr> | \-w <traddr>]
+ [\-\-host\-iface=<iface> | \-f <iface>]
[\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
[\-\-hostid=<hostid> | \-I <hostid>]
[\-\-raw=<filename> | \-r <filename>]
+ [\-\-device=<device> | \-d <device>]
[\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
[\-\-reconnect\-delay=<#> | \-c <#>]
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
@@ -51,6 +53,7 @@ nvme-discover \- Send Get Log Page request to Discovery Controller\&.
[\-\-queue\-size=<#> | \-Q <#>]
[\-\-persistent | \-p]
[\-\-quiet | \-S]
+ [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
@@ -120,7 +123,12 @@ This field specifies the transport service id\&. For transports using IP address
.PP
\-w <traddr>, \-\-host\-traddr=<traddr>
.RS 4
-This field specifies the network address used on the host to connect to the Discovery Controller\&.
+This field specifies the network address used on the host to connect to the Controller\&. For TCP, this sets the source address on the socket\&.
+.RE
+.PP
+\-f <iface>, \-\-host\-iface=<iface>
+.RS 4
+This field specifies the network interface used on the host to connect to the Controller (e\&.g\&. IP eth1, enp2s0, enx78e7d1ea46da)\&. This forces the connection to be made on a specific interface instead of letting the system decide\&.
.RE
.PP
\-q <hostnqn>, \-\-hostnqn=<hostnqn>
@@ -142,6 +150,11 @@ command and dump it to a raw binary file\&. By default
will dump the output to stdout\&.
.RE
.PP
+\-d <device>, \-\-device=<device>
+.RS 4
+This field takes a device as input\&. Device is in the format of nvme*, eg\&. nvme0, nvme1
+.RE
+.PP
\-k <#>, \-\-keep\-alive\-tmo=<#>
.RS 4
Overrides the default dealy (in seconds) for keep alive\&. This option will be ignored for the discovery, and it is only implemented for completeness\&.
@@ -196,6 +209,14 @@ Persistent discovery connection\&.
.RS 4
Suppress already connected errors\&.
.RE
+.PP
+\-o <format>, \-\-output\-format=<format>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR, or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4