iscsi tools: fix iscsiadm return value on failed login
[open-iscsi.git] / doc / iscsistart.8
blob5dcecd3393e2b87ee6a7ff7f666b1ad8c0ece1ac
1 .TH ISCSISTART 8 "Jan 2010" "" "Linux Administrator's Manual"
2 .SH NAME
3 iscsistart \- iSCSI boot tool
4 .SH SYNOPSIS
5 .BI iscsistart
6 [OPTION]
7 .SH "DESCRIPTION"
8 .B iscsistart
9 will start a session using the settings passed in, or
10 using the iBFT or Open Firmware [OF] boot information. This program should
11 not be run to manage sessions. Its primary use is to start
12 sessions used for iSCSI root boot.
13 .SH OPTIONS
14 .TP
15 .BI [-i|--initiatorname=]\fIname\fP
16 Set InitiatorName to name (Required if not using iBFT or OF)
17 .TP
18 .BI [-t|--targetname=]\fIname\fP
19 Set TargetName to name (Required if not using iBFT or OF)
20 .TP
21 .BI [-g|--tgpt=]\fIN\fP
22 Set target portal group tag to N (Required if not using iBFT or OF)
23 .TP
24 .BI [-a|--address=]\fIA.B.C.D\fP
25 Set IP addres to A.B.C.D (Required if not using iBFT or OF)
26 .TP
27 .BI [-p|--port=]\fIN\fP
28 Set port to N (Optional. Default 3260)
29 .TP
30 .BI [-u|--username=]\fIN\fP
31 Set username to N (Optional)
32 .TP
33 .BI [-w|--password=]\fIN\fP
34 Set password to N (Optional)
35 .TP
36 .BI [-U|-username_in=]\fIN\fP
37 Set incoming username to N (Optional)
38 .TP
39 .BI [-W|--password_in=]\fIN\fP
40 Set incoming password to N (Optional)
41 .TP
42 .BI [-d|--debug=]\fIdebug_level\fP
43 Print debugging information
44 .TP
45 .BI [-b|--fwparam_connect]
46 Create a session to the target using the iBFT or OF info
47 .TP
48 .BI [-N|--fwparam_network]
49 Bring up the network as specified by iBFT or OF
50 .TP
51 .BI [-f|--fwparam_print]
52 Print the iBFT or OF info to STDOUT
53 .TP
54 .BI [-h|--help]
55 Display this help and exit
56 .TP
57 .BI [-v|--version]
58 Display version and exit
61 .SH "SEE ALSO"
62 .BR iscsiadm (8)
64 .SH AUTHORS
65 Open-iSCSI project <http://www.open-iscsi.org/>
66 .br
67 Mike Christie <mchristi@redhat.com>