1 .\" Copyright (c) 2012 The FreeBSD Foundation
2 .\" All rights reserved.
4 .\" This software was developed by Edward Tomasz Napierala under sponsorship
5 .\" from the FreeBSD Foundation.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Nd CAM Target Layer / iSCSI target daemon configuration file
39 configuration file is used by the
44 and empty lines are interpreted as comments.
45 The general syntax of the
48 .Bd -literal -offset indent
59 discovery-auth-group <name>
73 The following statements are available at the global level:
74 .Bl -tag -width indent
75 .It Ic auth-group Aq Ar name
76 Opens an auth-group section, defining an authentication group,
77 which can then be assigned to any number of targets.
78 .It Ic debug Aq Ar level
79 Specifies debug level.
81 .It Ic maxproc Aq Ar number
82 Specifies limit for concurrently running child processes handling
85 Setting it to 0 disables the limit.
86 .It Ic pidfile Aq Ar path
87 Specifies path to pidfile.
89 .Pa /var/run/ctld.pid .
90 .It Ic portal-group Aq Ar name
91 Opens a portal-group section, defining a portal group,
92 which can then be assigned to any number of targets.
93 .It Ic target Aq Ar name
94 Opens a target configuration section.
95 .It Ic timeout Aq Ar seconds
96 Specifies timeout for login session, after which the connection
97 will be forcibly terminated.
99 Setting it to 0 disables the timeout.
102 The following statements are available at the auth-group level:
103 .Bl -tag -width indent
104 .It Ic chap Ao Ar user Ac Aq Ar secret
105 Specifies CHAP authentication credentials.
106 .It Ic chap-mutual Ao Ar user Ac Ao Ar secret Ac Ao Ar mutualuser Ac Aq Ar mutualsecret
107 Specifies mutual CHAP authentication credentials.
108 Note that for any auth-group, configuration may contain either chap,
109 or chap-mutual entries; it's an error to mix them.
111 .Ss portal-group level
112 The following statements are available at the portal-group level:
113 .Bl -tag -width indent
114 .It Ic discovery-auth-group Aq Ar name
115 Assigns previously defined authentication group to that portal group,
116 to be used for target discovery.
117 By default, the discovery will be denied.
118 A special auth-group, "no-authentication", may be used to allow for discovery
119 without authentication.
120 .It Ic listen Aq Ar address
121 Specifies IPv4 or IPv6 address and port to listen on for incoming connections.
122 .It Ic listen-iser Aq Ar address
123 Specifies IPv4 or IPv6 address and port to listen on for incoming connections
124 using iSER (iSCSI over RDMA) protocol.
127 The following statements are available at the target level:
128 .Bl -tag -width indent
129 .It Ic alias Aq Ar text
130 Assigns human-readable description to that target.
132 .It Ic auth-group Aq Ar name
133 Assigns previously defined authentication group to that target.
134 There is no default; every target must use either auth-group,
135 or chap, or chap-mutual statements.
136 A special auth-group, "no-authentication", may be used to permit access
137 without authentication.
138 .It Ic chap Ao Ar user Ac Aq Ar secret
139 Specifies CHAP authentication credentials.
140 Note that targets must use either auth-group, or chap,
141 or chap-mutual clauses; it's a configuration error to mix them in one target.
142 .It Ic chap-mutual Ao Ar user Ac Ao Ar secret Ac Ao Ar mutualuser Ac Aq Ar mutualsecret
143 Specifies mutual CHAP authentication credentials.
144 Note that targets must use either auth-group, chap, or
145 chap-mutual clauses; it's a configuration error to mix them in one target.
146 .It Ic portal-group Aq Ar name
147 Assigns previously defined portal group to that target.
148 Default portal group is "default", which makes the target available
149 on TCP port 3260 on all configured IPv4 and IPv6 addresses.
150 .It Ic lun Aq Ar number
151 Opens a lun configuration section, defining LUN exported by a target.
154 The following statements are available at the lun level:
155 .Bl -tag -width indent
156 .It Ic backend Ao Ar block | Ar ramdisk Ac
157 Specifies the CTL backend to use for a given LUN.
162 block is used for LUNs backed
163 by files in the filesystem; ramdisk is a bitsink device, used mostly for
165 The default backend is block.
166 .It Ic blocksize Aq Ar size
167 Specifies blocksize visible to the initiator.
168 The default blocksize is 512.
169 .It Ic device-id Aq Ar string
170 Specifies SCSI Device Identification string presented to the initiator.
171 .It Ic option Ao Ar name Ac Aq Ar value
172 Specifies CTL-specific options passed to the kernel.
173 .It Ic path Aq Ar path
174 Specifies path to file used to back the LUN.
175 .It Ic serial Aq Ar string
176 Specifies SCSI serial number presented to the initiator.
177 .It Ic size Aq Ar size
178 Specifies LUN size, in bytes.
181 .Bl -tag -width ".Pa /etc/ctl.conf" -compact
183 The default location of the
189 pidfile /var/run/ctld.pid
191 auth-group example2 {
192 chap-mutual "user" "secret" "mutualuser" "mutualsecret"
193 chap-mutual "user2" "secret2" "mutualuser" "mutualsecret"
196 portal-group example2 {
197 discovery-auth-group no-authentication
204 target iqn.2012-06.com.example:target0 {
205 alias "Testing target"
206 auth-group no-authentication
208 path /dev/zvol/example_0
214 target iqn.2012-06.com.example:target3 {
215 chap chapuser chapsecret
217 path /dev/zvol/example_3
221 target iqn.2012-06.com.example:target2 {
223 portal-group example2
225 path /dev/zvol/example2_0
228 path /dev/zvol/example2_1
240 configuration file functionality for
243 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org
244 under sponsorship from the FreeBSD Foundation.