nvme-connect(1)
===============

NAME
----
nvme-connect - Connect to a Fabrics controller.

SYNOPSIS
--------
[verse]
'nvme' [<global-options>] 'connect' [--config=<filename>]
			[--devid-file=<filename>]
			[--idempotent]
			[--owner=<NAME>]
			[<fabrics-options>]

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
-------
--config=<filename>::
	Use the specified JSON configuration file instead of the default.

--devid-file=<filename>::
	Write the kernel-assigned device name (for example, nvme0) to
	<filename>. If the controller is already connected, the existing
	device name is written. Otherwise, the device name is written
	after the controller is connected.

	When used with --idempotent, the existing device name is written
	before the command exits successfully. This allows a supervising
	process, such as a systemd service, to identify the device for a
	later disconnect operation.

	The output file is created before attempting the connection. If
	the file cannot be created, for example because the parent
	directory does not exist, the command fails without attempting
	the connection.

--idempotent::
	Exit with status 0 if the requested controller is already
	connected instead of reporting an error.

--owner=<NAME>::
	Record NAME as the owner of the connected controller in the NVMe
	ownership registry, so other orchestrators (and nvme-disconnect-all)
	leave it alone.  See nvme-disconnect-all(1).

include::fabrics-options.txt[]

include::global-options.txt[]

EXAMPLES
--------
* 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:
+
------------
# nvme connect --transport=rdma --traddr=192.168.1.3 \
--nqn=nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
------------

SEE ALSO
--------
nvme-discover(1)
nvme-connect-all(1)

AUTHORS
-------
This was co-written by mailto:james.p.freyensee@intel.com[Jay Freyensee]
and mailto:hch@lst.de[Christoph Hellwig]

NVME
----
Part of the nvme-user suite
