summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-connect-all.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-connect-all.174
1 files changed, 72 insertions, 2 deletions
diff --git a/Documentation/nvme-connect-all.1 b/Documentation/nvme-connect-all.1
index 57f27c1..9e795f5 100644
--- a/Documentation/nvme-connect-all.1
+++ b/Documentation/nvme-connect-all.1
@@ -2,12 +2,12 @@
.\" Title: nvme-connect-all
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 03/31/2023
+.\" Date: 06/30/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-CONNECT\-ALL" "1" "03/31/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-CONNECT\-ALL" "1" "06/30/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -59,6 +59,10 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&.
[\-\-tls ]
[\-\-quiet | \-S]
[\-\-dump\-config | \-O]
+ [\-\-nbft]
+ [\-\-no\-nbft]
+ [\-\-nbft\-path=<STR>]
+ [\-\-context=<STR>]
.fi
.SH "DESCRIPTION"
.sp
@@ -242,6 +246,26 @@ Suppress error messages\&.
.RS 4
Print out resulting JSON configuration file to stdout\&.
.RE
+.PP
+\-\-nbft
+.RS 4
+Only look at NBFT tables
+.RE
+.PP
+\-\-no\-nbft
+.RS 4
+Do not look at NBFT tables
+.RE
+.PP
+\-\-nbft\-path=<STR>
+.RS 4
+Use a user\-defined path to the NBFT tables
+.RE
+.PP
+\-\-context <STR>
+.RS 4
+Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
@@ -276,6 +300,52 @@ Connect to all records returned by the Discover Controller with IP4 address 192\
.\}
Issue a
\fInvme connect\-all\fR
+command using the default system defined NBFT tables:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme connect\-all \-\-nbft
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Issue a
+\fInvme connect\-all\fR
+command with a user\-defined path for the NBFT table:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme connet\-all \-\-nbft\-path=/sys/firmware/acpi/tables/NBFT1
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Issue a
+\fInvme connect\-all\fR
command using a /usr/local/etc/nvme/discovery\&.conf file:
.sp
.if n \{\