usr.sbin/ctld/ctl.conf.5

   1 .\" Copyright (c) 2012 The FreeBSD Foundation
   2 .\" Copyright (c) 2015 Alexander Motin <mav@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" This software was developed by Edward Tomasz Napierala under sponsorship
   6 .\" from the FreeBSD Foundation.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd September 7, 2015
  32 .Dt CTL.CONF 5
  33 .Os
  34 .Sh NAME
  35 .Nm ctl.conf
  36 .Nd CAM Target Layer / iSCSI target daemon configuration file
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 configuration file is used by the
  41 .Xr ctld 8
  42 daemon.
  43 Lines starting with
  44 .Ql #
  45 are interpreted as comments.
  46 The general syntax of the
  47 .Nm
  48 file is:
  49 .Bd -literal -offset indent
  50 .No pidfile Ar path
  51
  52 .No auth-group Ar name No {
  53 .Dl chap Ar user Ar secret
  54 .Dl ...
  55 }
  56
  57 .No portal-group Ar name No {
  58 .Dl listen Ar address
  59 .\".Dl listen-iser Ar address
  60 .Dl discovery-auth-group Ar name
  61 .Dl ...
  62 }
  63
  64 .No lun Ar name No {
  65 .Dl path Ar path
  66 }
  67
  68 .No target Ar name {
  69 .Dl auth-group Ar name
  70 .Dl portal-group Ar name Op Ar agname
  71 .Dl port Ar name
  72 .Dl lun Ar number Ar name
  73 .Dl lun Ar number No {
  74 .Dl     path Ar path
  75 .Dl }
  76 .Dl ...
  77 }
  78 .Ed
  79 .Ss Global Context
  80 .Bl -tag -width indent
  81 .It Ic auth-group Ar name
  82 Create an
  83 .Sy auth-group
  84 configuration context,
  85 defining a new auth-group,
  86 which can then be assigned to any number of targets.
  87 .It Ic debug Ar level
  88 The debug verbosity level.
  89 The default is 0.
  90 .It Ic maxproc Ar number
  91 The limit for concurrently running child processes handling
  92 incoming connections.
  93 The default is 30.
  94 A setting of 0 disables the limit.
  95 .It Ic pidfile Ar path
  96 The path to the pidfile.
  97 The default is
  98 .Pa /var/run/ctld.pid .
  99 .It Ic portal-group Ar name
 100 Create a
 101 .Sy portal-group
 102 configuration context,
 103 defining a new portal-group,
 104 which can then be assigned to any number of targets.
 105 .It Ic lun Ar name
 106 Create a
 107 .Sy lun
 108 configuration context, defining a LUN to be exported by some target(s).
 109 .It Ic target Ar name
 110 Create a
 111 .Sy target
 112 configuration context, which can contain one or more
 113 .Sy lun
 114 contexts.
 115 .It Ic timeout Ar seconds
 116 The timeout for login sessions, after which the connection
 117 will be forcibly terminated.
 118 The default is 60.
 119 A setting of 0 disables the timeout.
 120 .It Ic isns-server Ar address
 121 An IPv4 or IPv6 address and optionally port of iSNS server to register on.
 122 .It Ic isns-period Ar seconds
 123 iSNS registration period.
 124 Registered Network Entity not updated during this period will be unregistered.
 125 The default is 900.
 126 .It Ic isns-timeout Ar seconds
 127 Timeout for iSNS requests.
 128 The default is 5.
 129 .El
 130 .Ss auth-group Context
 131 .Bl -tag -width indent
 132 .It Ic auth-type Ar type
 133 Sets the authentication type.
 134 Type can be either
 135 .Qq Ar none ,
 136 .Qq Ar deny ,
 137 .Qq Ar chap ,
 138 or
 139 .Qq Ar chap-mutual .
 140 In most cases it is not necessary to set the type using this clause;
 141 it is usually used to disable authentication for a given
 142 .Sy auth-group .
 143 .It Ic chap Ar user Ar secret
 144 A set of CHAP authentication credentials.
 145 Note that for any
 146 .Sy auth-group ,
 147 the configuration may only contain either
 148 .Sy chap
 149 or
 150 .Sy chap-mutual
 151 entries; it is an error to mix them.
 152 .It Ic chap-mutual Ar user Ar secret Ar mutualuser Ar mutualsecret
 153 A set of mutual CHAP authentication credentials.
 154 Note that for any
 155 .Sy auth-group ,
 156 the configuration may only contain either
 157 .Sy chap
 158 or
 159 .Sy chap-mutual
 160 entries; it is an error to mix them.
 161 .It Ic initiator-name Ar initiator-name
 162 An iSCSI initiator name.
 163 Only initiators with a name matching one of the defined
 164 names will be allowed to connect.
 165 If not defined, there will be no restrictions based on initiator
 166 name.
 167 .It Ic initiator-portal Ar address Ns Op / Ns Ar prefixlen
 168 An iSCSI initiator portal: an IPv4 or IPv6 address, optionally
 169 followed by a literal slash and a prefix length.
 170 Only initiators with an address matching one of the defined
 171 addresses will be allowed to connect.
 172 If not defined, there will be no restrictions based on initiator
 173 address.
 174 .El
 175 .Ss portal-group Context
 176 .Bl -tag -width indent
 177 .It Ic discovery-auth-group Ar name
 178 Assign a previously defined authentication group to the portal group,
 179 to be used for target discovery.
 180 By default, portal groups are assigned predefined
 181 .Sy auth-group
 182 .Qq Ar default ,
 183 which denies discovery.
 184 Another predefined
 185 .Sy auth-group ,
 186 .Qq Ar no-authentication ,
 187 may be used
 188 to permit discovery without authentication.
 189 .It Ic discovery-filter Ar filter
 190 Determines which targets are returned during discovery.
 191 Filter can be either
 192 .Qq Ar none ,
 193 .Qq Ar portal ,
 194 .Qq Ar portal-name ,
 195 or
 196 .Qq Ar portal-name-auth .
 197 When set to
 198 .Qq Ar none ,
 199 discovery will return all targets assigned to that portal group.
 200 When set to
 201 .Qq Ar portal ,
 202 discovery will not return targets that cannot be accessed by the
 203 initiator because of their
 204 .Sy initiator-portal .
 205 When set to
 206 .Qq Ar portal-name ,
 207 the check will include both
 208 .Sy initiator-portal
 209 and
 210 .Sy initiator-name .
 211 When set to
 212 .Qq Ar portal-name-auth ,
 213 the check will include
 214 .Sy initiator-portal ,
 215 .Sy initiator-name ,
 216 and authentication credentials.
 217 The target is returned if it does not require CHAP authentication,
 218 or if the CHAP user and secret used during discovery match those
 219 used by the target.
 220 Note that when using
 221 .Qq Ar portal-name-auth ,
 222 targets that require CHAP authentication will only be returned if
 223 .Sy discovery-auth-group
 224 requires CHAP.
 225 The default is
 226 .Qq Ar none .
 227 .It Ic listen Ar address
 228 An IPv4 or IPv6 address and port to listen on for incoming connections.
 229 .\".It Ic listen-iser Ar address
 230 .\"An IPv4 or IPv6 address and port to listen on for incoming connections
 231 .\"using iSER (iSCSI over RDMA) protocol.
 232 .It Ic redirect Aq Ar address
 233 IPv4 or IPv6 address to redirect initiators to.
 234 When configured, all initiators attempting to connect to portal
 235 belonging to this
 236 .Sy portal-group
 237 will get redirected using "Target moved temporarily" login response.
 238 Redirection happens before authentication and any
 239 .Sy initiator-name
 240 or
 241 .Sy initiator-portal
 242 checks are skipped.
 243 .It Ic tag Ar value
 244 Unique 16-bit tag value of this
 245 .Sy portal-group .
 246 If not specified, the value is generated automatically.
 247 .It Ic foreign
 248 Specifies that this
 249 .Sy portal-group
 250 is listened by some other host.
 251 This host will announce it on discovery stage, but won't listen.
 252 .El
 253 .Ss target Context
 254 .Bl -tag -width indent
 255 .It Ic alias Ar text
 256 Assign a human-readable description to the target.
 257 There is no default.
 258 .It Ic auth-group Ar name
 259 Assign a previously defined authentication group to the target.
 260 By default, targets that do not specify their own auth settings,
 261 using clauses such as
 262 .Sy chap
 263 or
 264 .Sy initiator-name ,
 265 are assigned
 266 predefined
 267 .Sy auth-group
 268 .Qq Ar default ,
 269 which denies all access.
 270 Another predefined
 271 .Sy auth-group ,
 272 .Qq Ar no-authentication ,
 273 may be used to permit access
 274 without authentication.
 275 Note that targets must only use one of
 276 .Sy auth-group , chap , No or Sy chap-mutual ;
 277 it is a configuration error to mix multiple types in one target.
 278 .It Ic auth-type Ar type
 279 Sets the authentication type.
 280 Type can be either
 281 .Qq Ar none ,
 282 .Qq Ar deny ,
 283 .Qq Ar chap ,
 284 or
 285 .Qq Ar chap-mutual .
 286 In most cases it is not necessary to set the type using this clause;
 287 it is usually used to disable authentication for a given
 288 .Sy target .
 289 This clause is mutually exclusive with
 290 .Sy auth-group ;
 291 one cannot use
 292 both in a single target.
 293 .It Ic chap Ar user Ar secret
 294 A set of CHAP authentication credentials.
 295 Note that targets must only use one of
 296 .Sy auth-group , chap , No or Sy chap-mutual ;
 297 it is a configuration error to mix multiple types in one target.
 298 .It Ic chap-mutual Ar user Ar secret Ar mutualuser Ar mutualsecret
 299 A set of mutual CHAP authentication credentials.
 300 Note that targets must only use one of
 301 .Sy auth-group , chap , No or Sy chap-mutual ;
 302 it is a configuration error to mix multiple types in one target.
 303 .It Ic initiator-name Ar initiator-name
 304 An iSCSI initiator name.
 305 Only initiators with a name matching one of the defined
 306 names will be allowed to connect.
 307 If not defined, there will be no restrictions based on initiator
 308 name.
 309 This clause is mutually exclusive with
 310 .Sy auth-group ;
 311 one cannot use
 312 both in a single target.
 313 .It Ic initiator-portal Ar address Ns Op / Ns Ar prefixlen
 314 An iSCSI initiator portal: an IPv4 or IPv6 address, optionally
 315 followed by a literal slash and a prefix length.
 316 Only initiators with an address matching one of the defined
 317 addresses will be allowed to connect.
 318 If not defined, there will be no restrictions based on initiator
 319 address.
 320 This clause is mutually exclusive with
 321 .Sy auth-group ;
 322 one cannot use
 323 both in a single target.
 324 .It Ic portal-group Ar name Op Ar agname
 325 Assign a previously defined portal group to the target.
 326 The default portal group is
 327 .Qq Ar default ,
 328 which makes the target available
 329 on TCP port 3260 on all configured IPv4 and IPv6 addresses.
 330 Optional second argument specifies auth group name for connections
 331 to this specific portal group.
 332 If second argument is not specified, target auth group is used.
 333 .It Ic port Ar name
 334 .It Ic port Ar name/pp
 335 .It Ic port Ar name/pp/vp
 336 Assign specified CTL port (such as "isp0" or "isp2/1") to the target.
 337 On startup ctld configures LUN mapping and enables all assigned ports.
 338 Each port can be assigned to only one target.
 339 .It Ic redirect Aq Ar address
 340 IPv4 or IPv6 address to redirect initiators to.
 341 When configured, all initiators attempting to connect to this target
 342 will get redirected using "Target moved temporarily" login response.
 343 Redirection happens after successful authentication.
 344 .It Ic lun Ar number Ar name
 345 Export previously defined
 346 .Sy lun
 347 by the parent target.
 348 .It Ic lun Ar number
 349 Create a
 350 .Sy lun
 351 configuration context, defining a LUN exported by the parent target.
 352 .El
 353 .Ss lun Context
 354 .Bl -tag -width indent
 355 .It Ic backend Ar block No | Ar ramdisk
 356 The CTL backend to use for a given LUN.
 357 Valid choices are
 358 .Qq Ar block
 359 and
 360 .Qq Ar ramdisk ;
 361 block is used for LUNs backed
 362 by files or disk device nodes; ramdisk is a bitsink device, used mostly for
 363 testing.
 364 The default backend is block.
 365 .It Ic blocksize Ar size
 366 The blocksize visible to the initiator.
 367 The default blocksize is 512.
 368 .It Ic device-id Ar string
 369 The SCSI Device Identification string presented to the initiator.
 370 .It Ic option Ar name Ar value
 371 The CTL-specific options passed to the kernel.
 372 All CTL-specific options are documented in the
 373 .Sx OPTIONS
 374 section of
 375 .Xr ctladm 8 .
 376 .It Ic path Ar path
 377 The path to the file, device node, or
 378 .Xr zfs 8
 379 volume used to back the LUN.
 380 For optimal performance, create the volume with the
 381 .Qq Ar volmode=dev
 382 property set.
 383 .It Ic serial Ar string
 384 The SCSI serial number presented to the initiator.
 385 .It Ic size Ar size
 386 The LUN size, in bytes.
 387 .El
 388 .Sh FILES
 389 .Bl -tag -width ".Pa /etc/ctl.conf" -compact
 390 .It Pa /etc/ctl.conf
 391 The default location of the
 392 .Xr ctld 8
 393 configuration file.
 394 .El
 395 .Sh EXAMPLES
 396 .Bd -literal
 397 auth-group ag0 {
 398         chap-mutual "user" "secret" "mutualuser" "mutualsecret"
 399         chap-mutual "user2" "secret2" "mutualuser" "mutualsecret"
 400 }
 401
 402 auth-group ag1 {
 403         auth-type none
 404         initiator-name "iqn.2012-06.com.example:initiatorhost1"
 405         initiator-name "iqn.2012-06.com.example:initiatorhost2"
 406         initiator-portal 192.168.1.1/24
 407         initiator-portal [2001:db8::de:ef]
 408 }
 409
 410 portal-group pg0 {
 411         discovery-auth-group no-authentication
 412         listen 0.0.0.0:3260
 413         listen [::]:3260
 414         listen [fe80::be:ef]:3261
 415 }
 416
 417 target iqn.2012-06.com.example:target0 {
 418         alias "Example target"
 419         auth-group no-authentication
 420         lun 0 {
 421                 path /dev/zvol/tank/example_0
 422                 blocksize 4096
 423                 size 4G
 424         }
 425 }
 426
 427 lun example_1 {
 428         path /dev/zvol/tank/example_1
 429         option naa 0x50015178f369f093
 430 }
 431
 432 target iqn.2012-06.com.example:target1 {
 433         auth-group ag0
 434         portal-group pg0
 435         lun 0 example_1
 436         lun 1 {
 437                 path /dev/zvol/tank/example_2
 438                 option foo bar
 439         }
 440 }
 441
 442 target naa.50015178f369f092 {
 443         port isp0
 444         port isp1
 445         lun 0 example_1
 446 }
 447 .Ed
 448 .Sh SEE ALSO
 449 .Xr ctl 4 ,
 450 .Xr ctladm 8 ,
 451 .Xr ctld 8 ,
 452 .Xr zfs 8
 453 .Sh AUTHORS
 454 The
 455 .Nm
 456 configuration file functionality for
 457 .Xr ctld 8
 458 was developed by
 459 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org
 460 under sponsorship from the FreeBSD Foundation.