Adding upstream version 1.12.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
3b95ae912c
commit
ac60c09ef6
GPG key ID:
FBB4F0E80A80222F
457 changed files with 159628 additions and 0 deletions
220
Documentation/nvme-connect.1
Normal file
220
Documentation/nvme-connect.1
Normal file
|
|
@ -0,0 +1,220 @@
|
|||
'\" t
|
||||
.\" Title: nvme-connect
|
||||
.\" Author: [see the "AUTHORS" section]
|
||||
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
|
||||
.\" Date: 04/24/2020
|
||||
.\" Manual: NVMe Manual
|
||||
.\" Source: NVMe
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "NVME\-CONNECT" "1" "04/24/2020" "NVMe" "NVMe Manual"
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * Define some portability stuff
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.\" http://bugs.debian.org/507673
|
||||
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
||||
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.ie \n(.g .ds Aq \(aq
|
||||
.el .ds Aq '
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * set default formatting
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" disable hyphenation
|
||||
.nh
|
||||
.\" disable justification (adjust text to left margin only)
|
||||
.ad l
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * MAIN CONTENT STARTS HERE *
|
||||
.\" -----------------------------------------------------------------
|
||||
.SH "NAME"
|
||||
nvme-connect \- Connect to a Fabrics controller\&.
|
||||
.SH "SYNOPSIS"
|
||||
.sp
|
||||
.nf
|
||||
\fInvme connect\fR
|
||||
[\-\-transport=<trtype> | \-t <trtype>]
|
||||
[\-\-nqn=<subnqn> | \-n <subnqn>]
|
||||
[\-\-traddr=<traddr> | \-a <traddr>]
|
||||
[\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
|
||||
[\-\-host\-traddr=<traddr> | \-w <traddr>]
|
||||
[\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
|
||||
[\-\-hostid=<hostid> | \-I <hostid>]
|
||||
[\-\-nr\-io\-queues=<#> | \-i <#>]
|
||||
[\-\-nr\-write\-queues=<#> | \-W <#>]
|
||||
[\-\-nr\-poll\-queues=<#> | \-P <#>]
|
||||
[\-\-queue\-size=<#> | \-Q <#>]
|
||||
[\-\-keep\-alive\-tmo=<#> | \-k <#>]
|
||||
[\-\-reconnect\-delay=<#> | \-c <#>]
|
||||
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
|
||||
[\-\-duplicate\-connect | \-D]
|
||||
[\-\-disable\-sqflow | \-d]
|
||||
[\-\-hdr\-digest | \-g]
|
||||
[\-\-data\-digest | \-G]
|
||||
.fi
|
||||
.SH "DESCRIPTION"
|
||||
.sp
|
||||
Create a transport connection to a remote system (specified by \-\-traddr and \-\-trsvcid) and create a NVMe over Fabrics controller for the NVMe subsystem specified by the \-\-nqn option\&.
|
||||
.SH "OPTIONS"
|
||||
.PP
|
||||
\-t <trtype>, \-\-transport=<trtype>
|
||||
.RS 4
|
||||
This field specifies the network fabric being used for a NVMe\-over\-Fabrics network\&. Current string values include:
|
||||
.TS
|
||||
allbox tab(:);
|
||||
lt lt
|
||||
lt lt
|
||||
lt lt
|
||||
lt lt.
|
||||
T{
|
||||
Value
|
||||
T}:T{
|
||||
Definition
|
||||
T}
|
||||
T{
|
||||
rdma
|
||||
T}:T{
|
||||
The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc)
|
||||
T}
|
||||
T{
|
||||
fc
|
||||
T}:T{
|
||||
\fBWIP\fR
|
||||
The network fabric is a Fibre Channel network\&.
|
||||
T}
|
||||
T{
|
||||
loop
|
||||
T}:T{
|
||||
Connect to a NVMe over Fabrics target on the local host
|
||||
T}
|
||||
.TE
|
||||
.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 Controller\&. For transports using IP addressing (e\&.g\&. rdma) this should be an IP\-based address (ex\&. IPv4)\&.
|
||||
.RE
|
||||
.PP
|
||||
\-s <trsvcid>, \-\-trsvcid=<trsvcid>
|
||||
.RS 4
|
||||
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 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\&. The Host NQN uniquely identifies the NVMe Host\&.
|
||||
.RE
|
||||
.PP
|
||||
\-I <hostid>, \-\-hostid=<hostid>
|
||||
.RS 4
|
||||
UUID(Universally Unique Identifier) to be discovered which should be formatted\&.
|
||||
.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\&.
|
||||
.RE
|
||||
.PP
|
||||
\-k <#>, \-\-keep\-alive\-tmo=<#>
|
||||
.RS 4
|
||||
Overrides the default keep alive timeout (in seconds)\&.
|
||||
.RE
|
||||
.PP
|
||||
\-c <#>, \-\-reconnect\-delay=<#>
|
||||
.RS 4
|
||||
Overrides the default delay (in seconds) before reconnect is attempted after a connect loss\&.
|
||||
.RE
|
||||
.PP
|
||||
\-l <#>, \-\-ctrl\-loss\-tmo=<#>
|
||||
.RS 4
|
||||
Overrides the default controller loss timeout period (in seconds)\&.
|
||||
.RE
|
||||
.PP
|
||||
\-D, \-\-duplicate\-connect
|
||||
.RS 4
|
||||
Allows duplicated connections between same trnsport host and subsystem port\&.
|
||||
.RE
|
||||
.PP
|
||||
\-d, \-\-disable\-sqflow
|
||||
.RS 4
|
||||
Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions\&.
|
||||
.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
|
||||
.SH "EXAMPLES"
|
||||
.sp
|
||||
.RS 4
|
||||
.ie n \{\
|
||||
\h'-04'\(bu\h'+03'\c
|
||||
.\}
|
||||
.el \{\
|
||||
.sp -1
|
||||
.IP \(bu 2.3
|
||||
.\}
|
||||
Connect to a subsystem named nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432 on the IP4 address 192\&.168\&.1\&.3\&. Port 4420 is used by default:
|
||||
.sp
|
||||
.if n \{\
|
||||
.RS 4
|
||||
.\}
|
||||
.nf
|
||||
# nvme connect \-\-transport=rdma \-\-traddr=192\&.168\&.1\&.3 \e
|
||||
\-\-nqn=nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432
|
||||
.fi
|
||||
.if n \{\
|
||||
.RE
|
||||
.\}
|
||||
.RE
|
||||
.SH "SEE ALSO"
|
||||
.sp
|
||||
nvme\-discover(1) nvme\-connect\-all(1)
|
||||
.SH "AUTHORS"
|
||||
.sp
|
||||
This was co\-written by \m[blue]\fBJay Freyensee\fR\m[]\&\s-2\u[1]\d\s+2 and \m[blue]\fBChristoph Hellwig\fR\m[]\&\s-2\u[2]\d\s+2
|
||||
.SH "NVME"
|
||||
.sp
|
||||
Part of the nvme\-user suite
|
||||
.SH "NOTES"
|
||||
.IP " 1." 4
|
||||
Jay Freyensee
|
||||
.RS 4
|
||||
\%mailto:james.p.freyensee@intel.com
|
||||
.RE
|
||||
.IP " 2." 4
|
||||
Christoph Hellwig
|
||||
.RS 4
|
||||
\%mailto:hch@lst.de
|
||||
.RE
|
||||
Loading…
Add table
Add a link
Reference in a new issue