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
30 .Dd September 14, 2014
35 .Nd CAM Target Layer / iSCSI target daemon configuration file
39 configuration file is used by the
44 are interpreted as comments.
45 The general syntax of the
48 .Bd -literal -offset indent
51 .No auth-group Ar name No {
52 .Dl chap Ar user Ar secret
56 .No portal-group Ar name No {
58 .Dl listen-iser Ar address
59 .Dl discovery-auth-group Ar name
64 .Dl auth-group Ar name
65 .Dl portal-group Ar name
66 .Dl lun Ar number No {
73 .Bl -tag -width indent
74 .It Ic auth-group Ar name
77 configuration context,
78 defining a new auth-group,
79 which can then be assigned to any number of targets.
81 The debug verbosity level.
83 .It Ic maxproc Ar number
84 The limit for concurrently running child processes handling
87 A setting of 0 disables the limit.
88 .It Ic pidfile Ar path
89 The path to the pidfile.
91 .Pa /var/run/ctld.pid .
92 .It Ic portal-group Ar name
95 configuration context,
96 defining a new portal-group,
97 which can then be assigned to any number of targets.
101 configuration context, which can contain one or more
104 .It Ic timeout Ar seconds
105 The timeout for login sessions, after which the connection
106 will be forcibly terminated.
108 A setting of 0 disables the timeout.
110 .Ss auth-group Context
111 .Bl -tag -width indent
113 .It Ic auth-type Ar type
114 Sets the authentication type.
121 In most cases it is not necessary to set the type using this clause;
122 it is usually used to disable authentication for a given
124 .It Ic chap Ar user Ar secret
125 A set of CHAP authentication credentials.
128 the configuration may only contain either
132 entries; it is an error to mix them.
133 .It Ic chap-mutual Ar user Ar secret Ar mutualuser Ar mutualsecret
134 A set of mutual CHAP authentication credentials.
137 the configuration may only contain either
141 entries; it is an error to mix them.
142 .It Ic initiator-name Ar initiator-name
143 An iSCSI initiator name.
144 Only initiators with a name matching one of the defined
145 names will be allowed to connect.
146 If not defined, there will be no restrictions based on initiator
148 .It Ic initiator-portal Ar address Ns Op / Ns Ar prefixlen
149 An iSCSI initiator portal: an IPv4 or IPv6 address, optionally
150 followed by a literal slash and a prefix length.
151 Only initiators with an address matching one of the defined
152 addresses will be allowed to connect.
153 If not defined, there will be no restrictions based on initiator
156 .Ss portal-group Context
157 .Bl -tag -width indent
158 .It Ic discovery-auth-group Ar name
159 Assign a previously defined authentication group to the portal group,
160 to be used for target discovery.
161 By default, portal groups that do not specify their own auth settings,
162 using clauses such as
170 which denies discovery.
173 .Qq Ar no-authentication ,
175 to permit discovery without authentication.
176 .It Ic listen Ar address
177 An IPv4 or IPv6 address and port to listen on for incoming connections.
178 .It Ic listen-iser Ar address
179 An IPv4 or IPv6 address and port to listen on for incoming connections
180 using iSER (iSCSI over RDMA) protocol.
183 .Bl -tag -width indent
185 Assign a human-readable description to the target.
187 .It Ic auth-group Ar name
188 Assign a previously defined authentication group to the target.
189 By default, targets that do not specify their own auth settings,
190 using clauses such as
198 which denies all access.
201 .Qq Ar no-authentication ,
202 may be used to permit access
203 without authentication.
204 Note that targets must only use one of
205 .Sy auth-group , chap , No or Sy chap-mutual ;
206 it is a configuration error to mix multiple types in one target.
207 .It Ic auth-type Ar type
208 Sets the authentication type.
215 In most cases it is not necessary to set the type using this clause;
216 it is usually used to disable authentication for a given
218 This clause is mutually exclusive with
221 both in a single target.
222 .It Ic chap Ar user Ar secret
223 A set of CHAP authentication credentials.
224 Note that targets must only use one of
225 .Sy auth-group , chap , No or Sy chap-mutual ;
226 it is a configuration error to mix multiple types in one target.
227 .It Ic chap-mutual Ar user Ar secret Ar mutualuser Ar mutualsecret
228 A set of mutual CHAP authentication credentials.
229 Note that targets must only use one of
230 .Sy auth-group , chap , No or Sy chap-mutual ;
231 it is a configuration error to mix multiple types in one target.
232 .It Ic initiator-name Ar initiator-name
233 An iSCSI initiator name.
234 Only initiators with a name matching one of the defined
235 names will be allowed to connect.
236 If not defined, there will be no restrictions based on initiator
238 This clause is mutually exclusive with
241 both in a single target.
242 .It Ic initiator-portal Ar address Ns Op / Ns Ar prefixlen
243 An iSCSI initiator portal: an IPv4 or IPv6 address, optionally
244 followed by a literal slash and a prefix length.
245 Only initiators with an address matching one of the defined
246 addresses will be allowed to connect.
247 If not defined, there will be no restrictions based on initiator
249 This clause is mutually exclusive with
252 both in a single target.
253 .It Ic portal-group Ar name
254 Assign a previously defined portal group to the target.
255 The default portal group is
257 which makes the target available
258 on TCP port 3260 on all configured IPv4 and IPv6 addresses.
262 configuration context, defining a LUN exported by the parent target.
265 .Bl -tag -width indent
266 .It Ic backend Ar block No | Ar ramdisk
267 The CTL backend to use for a given LUN.
272 block is used for LUNs backed
273 by files or disk device nodes; ramdisk is a bitsink device, used mostly for
275 The default backend is block.
276 .It Ic blocksize Ar size
277 The blocksize visible to the initiator.
278 The default blocksize is 512.
279 .It Ic device-id Ar string
280 The SCSI Device Identification string presented to the initiator.
281 .It Ic option Ar name Ar value
282 The CTL-specific options passed to the kernel.
283 All CTL-specific options are documented in the
288 The path to the file or device node used to back the LUN.
289 .It Ic serial Ar string
290 The SCSI serial number presented to the initiator.
292 The LUN size, in bytes.
295 .Bl -tag -width ".Pa /etc/ctl.conf" -compact
297 The default location of the
303 pidfile /var/run/ctld.pid
305 auth-group example2 {
306 chap-mutual "user" "secret" "mutualuser" "mutualsecret"
307 chap-mutual "user2" "secret2" "mutualuser" "mutualsecret"
310 portal-group example2 {
311 discovery-auth-group no-authentication
318 target iqn.2012-06.com.example:target0 {
319 alias "Example target"
320 auth-group no-authentication
322 path /dev/zvol/example_0
328 target iqn.2012-06.com.example:target3 {
329 chap chapuser chapsecret
331 path /dev/zvol/example_3
335 target iqn.2012-06.com.example:target2 {
337 portal-group example2
339 path /dev/zvol/example2_0
342 path /dev/zvol/example2_1
354 configuration file functionality for
357 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org
358 under sponsorship from the FreeBSD Foundation.