NVME-CONNECT(1) | NVMe Manual | NVME-CONNECT(1) |
NAME¶
nvme-connect - Connect to a Fabrics controller.
SYNOPSIS¶
nvme connect [--transport=<trtype> | -t <trtype>]
[--nqn=<subnqn> | -n <subnqn>]
[--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>]
[--config=<filename> | -J <filename>]
[--dhchap-secret=<secret> | -S <secret>]
[--dhchap-ctrl-secret=<secret> | -C <secret>]
[--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 <#>] [--tos=<#> | -T <#>]
[--keyring=<keyring>] [--tls-key=<tls-key>]
[--tls-key-identity=<identity>]
[--duplicate-connect | -D] [--disable-sqflow ]
[--hdr-digest | -g] [--data-digest | -G] [--tls]
[--concat] [--dump-config | -O] [--application=<id>]
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION¶
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.
OPTIONS¶
-t <trtype>, --transport=<trtype>
Value | Definition |
rdma | The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc) |
fc | WIP The network fabric is a Fibre Channel network. |
tcp | The network fabric is a TCP/IP network. |
loop | Connect to a NVMe over Fabrics target on the local host |
-n <subnqn>, --nqn <subnqn>
-a <traddr>, --traddr=<traddr>
-s <trsvcid>, --trsvcid=<trsvcid>
-w <traddr>, --host-traddr=<traddr>
-f <iface>, --host-iface=<iface>
-q <hostnqn>, --hostnqn=<hostnqn>
-I <hostid>, --hostid=<hostid>
-J <filename>, --config=<filename>
-S <secret>, --dhchap-secret=<secret>
-C <secret>, --dhchap-ctrl-secret=<secret>
-i <#>, --nr-io-queues=<#>
-W <#>, --nr-write-queues=<#>
-P <#>, --nr-poll-queues=<#>
-Q <#>, --queue-size=<#>
-k <#>, --keep-alive-tmo=<#>
-c <#>, --reconnect-delay=<#>
-l <#>, --ctrl-loss-tmo=<#>
-T <#>, --tos=<#>
--keyring=<keyring>
--tls-key=<tls-key>
--tls-key-identity=<identity>
-D, --duplicate-connect
--disable-sqflow
-g, --hdr-digest
-G, --data-digest
--tls
--concat
-O, --dump-config
--context <STR>
-o <fmt>, --output-format=<fmt>
-v, --verbose
EXAMPLES¶
# nvme connect --transport=rdma --traddr=192.168.1.3 \ --nqn=nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
SEE ALSO¶
AUTHORS¶
This was co-written by Jay Freyensee[1] and Christoph Hellwig[2]
NVME¶
Part of the nvme-user suite
NOTES¶
- 1.
- Jay Freyensee
- 2.
- Christoph Hellwig
10/31/2024 | NVMe |