nvme/nvme-cli
1
0
Fork 0
Code Issues Activity

Adding upstream version 2.0.

Browse source 
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-16 12:15:30 +01:00
parent 50aec1e4c5
commit 1b3a431c1d
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
521 changed files with 21541 additions and 21644 deletions
Download patch file Download diff file Expand all files Collapse all files

31
Documentation/nvme-discover.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-discover
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/11/2021
.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DISCOVER" "1" "11/11/2021" "NVMe" "NVMe Manual"
.TH "NVME\-DISCOVER" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -34,6 +34,7 @@ nvme-discover \- Send Get Log Page request to Discovery Controller\&.
.nf
\fInvme discover\fR
[\-\-transport=<trtype> | \-t <trtype>]
[\-\-nqn=<subnqn> | \-n <subnqn>]
[\-\-traddr=<traddr> | \-a <traddr>]
[\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
[\-\-host\-traddr=<traddr> | \-w <traddr>]
@ -42,6 +43,7 @@ nvme-discover \- Send Get Log Page request to Discovery Controller\&.
[\-\-hostid=<hostid> | \-I <hostid>]
[\-\-raw=<filename> | \-r <filename>]
[\-\-device=<device> | \-d <device>]
[\-\-cfg\-file=<cfg> | \-C <cfg> ]
[\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
[\-\-reconnect\-delay=<#> | \-c <#>]
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
@ -53,7 +55,9 @@ nvme-discover \- Send Get Log Page request to Discovery Controller\&.
[\-\-queue\-size=<#> | \-Q <#>]
[\-\-persistent | \-p]
[\-\-quiet | \-S]
[\-\-dump\-config | \-O]
[\-\-output\-format=<fmt> | \-o <fmt>]
[\-\-force]
.fi
.SH "DESCRIPTION"
.sp
@ -111,6 +115,11 @@ T}
.sp 1
.RE
.PP
\-n <subnqn>, \-\-nqn <subnqn>
.RS 4
This field specifies the name for the NVMe subsystem to connect to\&.
.RE
.PP
\-a <traddr>, \-\-traddr=<traddr>
.RS 4
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\&.
@ -155,6 +164,14 @@ will dump the output to stdout\&.
This field takes a device as input\&. Device is in the format of nvme*, eg\&. nvme0, nvme1
.RE
.PP
\-C <cfg>, \-\-config\-file=<cfg>
.RS 4
Use the specified JSON configuration file instead of the default /etc/nvme/config\&.json file or
\fInone\fR
to not read in an existing configuration file\&. The JSON configuration file format is documented in
\m[blue]\fBhttps://github\&.com/linux\-nvme/libnvme/doc/config\-schema\&.json\fR\m[]
.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\&.
@ -210,6 +227,11 @@ Persistent discovery connection\&.
Suppress already connected errors\&.
.RE
.PP
\-O, \-\-dump\-config
.RS 4
Print out resulting JSON configuration file to stdout\&.
.RE
.PP
\-o <format>, \-\-output\-format=<format>
.RS 4
Set the reporting format to
@ -217,6 +239,11 @@ Set the reporting format to
\fIjson\fR, or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-\-force
.RS 4
Disable the built\-in persitent discover connection rules\&. Combined with \-\-persistent flag, always create new persistent discovery connection\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4