iscsi-initiator(8)

1ISCSI-INITIATOR(8)        BSD System Manager's Manual       ISCSI-INITIATOR(8)
2

NAME

4     iscsi-initiator — refuse-based iSCSI initiator
5

SYNOPSIS

7     iscsi-initiator [-46bcDfVv] [-a authentication-type] [-d digest-type]
8                     [-h target-hostname] [-p target-port-number]
9                     [-t target-number] [-u username] mount_point
10

DESCRIPTION

12     The iscsi-initiator utility can be used to access an iSCSI target, such
13     as iscsi-target(8), to access block storage which has been exported.
14     Information pertaining to the target is displayed underneath the mount
15     point, along with the device corresponding to the storage which the tar‐
16     get exports.
17
18     The various arguments are as follows:
19
20     -4      Use an IPv4 connection to the target.
21
22     -6      Use an IPv6 connection to the target.
23
24     -a authentication-type
25             Use the specified authentication type when communicating with the
26             target.  The possible values are chap, kerberos, srp or none.
27             The default value is none.
28
29     -b      Show the storage as a block device.
30
31     -c      Show the storage as a character device.
32
33     -d digest-type
34             Use the specified digest type when communicating with the target.
35             The possible values are header, data, both, all or none.  The
36             default value is none.
37
38     -D      List the LUNs on the specified target and exit (i.e. do discovery
39             only)
40
41     -f      Show the storage as a regular file.
42
43     -h hostname
44             Connect to the iSCSI target running on the host specified as the
45             argument.
46
47     -p port-number
48             Connect to the iSCSI target running on the port specified as the
49             argument.  The default value is 3260.
50
51     -t target
52             Connect to the number of the iSCSI target running as the argu‐
53             ment.
54
55     -u username
56             Use the specified user's credentials when logging in to the iSCSI
57             target.  There is no default.
58
59     -V      Print out the version number and then exit.
60
61     -v      Be verbose in operation.
62
63     The refuse(3) library is used to provide the file system features.
64
65     The mandatory parameter is the local mount point.
66
67     This iSCSI initiator presents a view of the targets underneath the mount
68     point.  Firstly, it creates a directory tree with the hostname of the
69     target, and, in that directory, a virtual directory is created for each
70     target name exported by the iSCSI target program.  Within that virtual
71     target directory, symbolic links exist for the hostname (for conve‐
72     nience), a textual representation of the IP address, the iSCSI target
73     product name, the iSCSI target IQN, the iSCSI target vendor and version
74     number.  One other directory entry is presented in the virtual target
75     directory, relating to the storage presented by the iSCSI target.  This
76     can be in the form of a regular file, which is also the default, a block
77     device or a character device.
78
79     Please note that the iscsi-initiator utility needs the “puffs” kernel
80     module loaded via modload(8) to operate.
81

EXAMPLES

83     # ./iscsi-initiator -u agc -h iscsi-target0.alistaircrooks.co.uk /mnt
84     # ls -al /mnt/target0
85     total 576
86     drwxr-xr-x  2 agc  agc        512 May 11 22:24 .
87     drwxr-xr-x  2 agc  agc        512 May 11 22:24 ..
88     lrw-r--r--  1 agc  agc         39 May 11 22:24 hostname -> iscsi-target0.alistaircrooks.co.uk
89     lrw-r--r--  1 agc  agc         14 May 11 22:24 ip -> 172.16.135.130
90     lrw-r--r--  1 agc  agc         16 May 11 22:24 product -> NetBSD iSCSI
91     -rw-r--r--  1 agc  agc  104857600 May 11 22:24 storage
92     lrw-r--r--  1 agc  agc         43 May 11 22:24 targetname -> iqn.1994-04.org.netbsd.iscsi-target:target0
93     lrw-r--r--  1 agc  agc          8 May 11 22:24 vendor -> NetBSD
94     lrw-r--r--  1 agc  agc          4 May 11 22:24 version -> 0
95     #
96

HISTORY

101     The iscsi-initiator utility first appeared in NetBSD 6.0.
102

AUTHORS

104     The iscsi-initiator utility was written by Alistair Crooks
105     ⟨agc@NetBSD.org⟩.
106

BUGS

108     iscsi-initiator currently only supports a CHAP challenge length of 16
109     octets.  Other initiators support up to 1024 and thus it is expected that
110     most targets will also support such lengths.  This means that CHAP com‐
111     patibility with other targets apart from iscsi-target(8) is likely to be
112     poor.  To workaround this, please use authentication type none by not
113     specifying a username with the -u option.
114
115BSD                            February 22, 2011                           BSD