Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
NVME-LIST-SUBSYS(1)		  NVMe Manual		   NVME-LIST-SUBSYS(1)

NAME
       nvme-list-subsys	- List all NVMe	subsystems

SYNOPSIS
       nvme list-subsys	<device> [--output-format=<fmt>	| -o <fmt>] [--verbose | -v]

DESCRIPTION
       Scan the	sysfs tree for NVM Express subsystems and return the
       controllers for those subsystems	as well	as some	pertinent information
       about them. If a	device is given, print out only	the values for the
       controllers and subsystems leading to the device.

OPTIONS
       -o <fmt>, --output-format=<fmt>
	   Set the reporting format to normal, json or binary. Only one	output
	   format can be used at a time.

       -v, --verbose
	   Increase the	information detail in the output.

EXAMPLES
	   root@host[1]# nvme list-subsys
	   nvme-subsys0	- NQN=nvmf-test
	   \
	    +- nvme0 rdma traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.1
	    +- nvme1 rdma traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.2
	   nvme-subsys1	- NQN=nvmf-test2
	   \
	    +- nvme2 rdma traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.2
	    +- nvme3 rdma traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.1

	   root@host[1]# nvme list-subsys -o json
	   {
	     "Subsystems" : [
	       {
		 "Name"	: "nvme-subsys0",
		 "NQN" : "nvmf-test"
	       },
	       {
		 "Paths" : [
		   {
		     "Name" : "nvme0",
		     "Transport" : "rdma",
		     "Address" : "traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.1"
		   },
		   {
		     "Name" : "nvme1",
		     "Transport" : "rdma",
		     "Address" : "traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.2"
		   }
		 ]
	       },
	       {
		 "Name"	: "nvme-subsys1",
		 "NQN" : "nvmf-test2"
	       },
	       {
		 "Paths" : [
		   {
		     "Name" : "nvme2",
		     "Transport" : "rdma",
		     "Address" : "traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.2"
		   },
		   {
		     "Name" : "nvme3",
		     "Transport" : "rdma",
		     "Address" : "traddr=1.1.1.3,trsvcid=4420,host_traddr=1.1.1.1"
		   }
		 ]
	       }
	     ]
	   }

NVME
       Part of the nvme-user suite

NOTES
	1. root@host
	   mailto:root@host

NVMe				  10/31/2024		   NVME-LIST-SUBSYS(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=nvme-list-subsys&sektion=1&manpath=FreeBSD+Ports+15.0>

home | help