diff options
author | Eric Mackay <eric.mackay@oracle.com> | 2022-05-06 18:00:08 -0700 |
---|---|---|
committer | Eric Mackay <eric.mackay@oracle.com> | 2022-05-18 17:41:42 -0700 |
commit | 10e3bf175bd8b1ad7f9c9900644a674b317e6428 (patch) | |
tree | 62a6f2a22008f29f1a9c07874c1be7b046abd1f5 /doc/iscsistart.8.template | |
parent | 433fad9ddadd62e5edf9597493f32a3b9443cc59 (diff) | |
download | open-iscsi-10e3bf175bd8b1ad7f9c9900644a674b317e6428.tar.gz |
Use config for iscsistart and iscsiadm fw login
Specifying name-value pairs as arguments to iscsistart or
iscsiadm can become unwieldy very quickly, and is less flexible
than using a config file. If a user desires to update settings,
modifying a config file and rebuilding initramfs can be simpler
than modifying arguments directly in initramfs code or scripts.
Node records created from boot context are populated with
defaults, then any settings specified in a config file are
applied (if config is present).
FW and user-specified params are still applicable. User-specified
name-value arguments are applied after config settings, so they
can serve as a safeguard against config file changes if
desired.
Added -c|--config options for iscsistart to specify the config
Updated iscsistart man page
Signed-off-by: Eric Mackay <eric.mackay@oracle.com>
Reviewed-by: Mike Christie <michael.christie@oracle.com>
Diffstat (limited to 'doc/iscsistart.8.template')
-rw-r--r-- | doc/iscsistart.8.template | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/doc/iscsistart.8.template b/doc/iscsistart.8.template new file mode 100644 index 0000000..62fae4d --- /dev/null +++ b/doc/iscsistart.8.template @@ -0,0 +1,75 @@ +.TH ISCSISTART 8 "Jan 2010" "" "Linux Administrator's Manual" +.SH NAME +iscsistart \- iSCSI boot tool +.SH SYNOPSIS +.BI iscsistart +[OPTION] +.SH "DESCRIPTION" +.B iscsistart +will start a session using the settings passed in, or +using the iBFT or Open Firmware [OF] boot information. This program should +not be run to manage sessions. Its primary use is to start +sessions used for iSCSI root boot. +.SH OPTIONS +.TP +.BI [-c|--config=]\fIconfig\-file\fP +Read configuration from \fIconfig\-file\fR rather than the default +\fI@HOMEDIR@/iscsid.conf\fR file. +.TP +.BI [-i|--initiatorname=]\fIname\fP +Set InitiatorName to name (Required if not using iBFT or OF) +.TP +.BI [-t|--targetname=]\fIname\fP +Set TargetName to name (Required if not using iBFT or OF) +.TP +.BI [-g|--tgpt=]\fIN\fP +Set target portal group tag to N (Required if not using iBFT or OF) +.TP +.BI [-a|--address=]\fIA.B.C.D\fP +Set IP address to A.B.C.D (Required if not using iBFT or OF) +.TP +.BI [-p|--port=]\fIN\fP +Set port to N (Optional. Default 3260) +.TP +.BI [-u|--username=]\fIN\fP +Set username to N (Optional) +.TP +.BI [-w|--password=]\fIN\fP +Set password to N (Optional) +.TP +.BI [-U|-username_in=]\fIN\fP +Set incoming username to N (Optional) +.TP +.BI [-W|--password_in=]\fIN\fP +Set incoming password to N (Optional) +.TP +.BI [-d|--debug=]\fIdebug_level\fP +Print debugging information +.TP +.BI [-b|--fwparam_connect] +Create a session to the target using the iBFT or OF info +.TP +.BI [-N|--fwparam_network] +Bring up the network as specified by iBFT or OF +.TP +.BI [-f|--fwparam_print] +Print the iBFT or OF info to STDOUT +.TP +.BI [-P|--param=]\fINAME=VALUE\fP +Set the parameter with the name NAME to VALUE. NAME is one of the settings +in the node record or iscsid.conf. Multiple params can be passed in. +.TP +.BI [-h|--help] +Display this help and exit +.TP +.BI [-v|--version] +Display version and exit + + +.SH "SEE ALSO" +.BR iscsiadm (8) + +.SH AUTHORS +Open-iSCSI project <http://www.open-iscsi.com/> +.br +Mike Christie <mchristi@redhat.com> |