NVMe Connect Command
The nvme connect command requires several parameters for the NVMe/TCP storage server to be discovered and connected to.
The simplified syntax of this command is:
nvme connect -t [transport type] -a [IP address] -s [target tcp port]-n [target nqn] -q [acl] -l [timeout]These are only a small sample of the possible parameters. See the NVMe documentation for a complete list and usage of the nvme connect command. We have selected these parameters as an example of the minimum required to connect to and use an NVMe/TCP volume.
NVMe Connect Parameter Overview
| Parameter Name | Parameter Description |
|---|---|
| nvme connect | The standard NVMe-oF command for a Linux application client to connect to an NVMe-oF target. |
| -t [transport type] | Indicates to the client’s NVMe driver the transport protocol that should be used for connecting. For Lightbits SDS, the transport protocol is TCP. |
| -a [IP address] | The Lightbits instance’s IP address. |
| -s [target tcp port] | The TCP port the Lightbits nodes are listening on. |
| -n [target nqn] | The NQN assigned to the Lightbits cluster where the volume was created. |
| -q [acl] | The access control list (ACL) string used when the volume was created on the Lightbits cluster to restrict access to the volume. |
| -l [timeout] | When connecting to a Lightbits cluster, this should be set to -1. |
After the application client connects to the Lightbits storage cluster, the volumes that this application client can access appear as local block devices. The following example shows how to use the Linux lsblk command to list all block devices after the connect command finishes.
Sample Command
$ lsblkSample Output
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTnvme1n2 259:3 0 500G 0 disknvme0n2 259:1 0 500G 0 disknvme1n1 259:2 0 10G 0 disknvme0n1 259:0 0 10G 0 diskIn this example, the Lightbits storage server serves four volumes via NVMe/TCP. These volumes are mapped to the /dev Linux file system path. The NVMe/TCP block device names are listed in the Name column.