summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLee Duncan <lduncan@suse.com>2022-04-01 10:25:06 -0700
committerLee Duncan <lduncan@suse.com>2022-04-07 09:01:26 -0700
commit1aafa5e52fe2bbd15b9597fe09a3e2afb6e662df (patch)
treef8e345e040771817fbeaa1fbb8d254bf7628eabe /doc
parent1451108792c1187974b87399f71822b59d62948c (diff)
downloadopen-iscsi-1aafa5e52fe2bbd15b9597fe09a3e2afb6e662df.tar.gz
Use kernel initiatorname when setting local iname
Update the iscsi-gen-initatorname script to take its initiator name from the kernel command line, if present. Also, beef up and simplify the error checking. Error messages will now go to stderr, and it is now an error to overwrite the initiatorname file unless the "force" option is set. The man page was updated, as well.
Diffstat (limited to 'doc')
-rw-r--r--doc/iscsi-gen-initiatorname.8.template19
1 files changed, 14 insertions, 5 deletions
diff --git a/doc/iscsi-gen-initiatorname.8.template b/doc/iscsi-gen-initiatorname.8.template
index e10a4ac..cd26f2d 100644
--- a/doc/iscsi-gen-initiatorname.8.template
+++ b/doc/iscsi-gen-initiatorname.8.template
@@ -1,4 +1,4 @@
-.TH ISCSI_GEN_INITIATORNAME 8 "Dec 2021" "" "Linux Administrator's Manual"
+.TH ISCSI_GEN_INITIATORNAME 8 "APR 2022" "" "Linux Administrator's Manual"
.SH NAME
iscsi-gen-initiatorname \- smart iSCSI initiator name generation tool
.SH SYNOPSIS
@@ -6,11 +6,20 @@ iscsi-gen-initiatorname \- smart iSCSI initiator name generation tool
[OPTIONS]
.SH "DESCRIPTION"
.B iscsi-gen-initiatorname
-generates a unique iSCSI node name on every invocation. If
-iBFT is in use, the iBFT-registered initiator name will be used.
+generates an iSCSI Initiator Name in the
+.I initiatorname.iscsi
+file. It is an error to try to overwrite an existing Initiator Name,
+unless the \fB-f\fP (\fIforce\fR) option is supplied.
.P
-If there is an existing initiator name, it will not be overwritten
-unless the \fB-f\fP option is supplied.
+The Initiator Name will be taken from the kernel command line,
+if present (from the \fIrd.initiatorname\fR parameter), else from
+the iBFT subsystem (if present in \fIsysfs\fR), else it will be
+generated using the \fBiscsi-iname\fR command.
+.P
+It is an error if both the kernel command-line Initiator Name
+and the iBFT Initiator Name are both set, and they are different.
+it is also an error to try to write over an Initiator Name file
+if it read-only, or to create one if its directory is not writable.
.SH OPTIONS
.TP
.BI [-h]