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 27, 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 target Ar name {
  65 .Dl auth-group Ar name
  66 .Dl portal-group Ar name
  67 .Dl lun Ar number No {
  68 .Dl     path Ar path
  69 .Dl }
  70 .Dl ...
  71 }
  72 .Ed
  73 .Ss Global Context
  74 .Bl -tag -width indent
  75 .It Ic auth-group Ar name
  76 Create an
  77 .Sy auth-group
  78 configuration context,
  79 defining a new auth-group,
  80 which can then be assigned to any number of targets.
  81 .It Ic debug Ar level
  82 The debug verbosity level.
  83 The default is 0.
  84 .It Ic maxproc Ar number
  85 The limit for concurrently running child processes handling
  86 incoming connections.
  87 The default is 30.
  88 A setting of 0 disables the limit.
  89 .It Ic pidfile Ar path
  90 The path to the pidfile.
  91 The default is
  92 .Pa /var/run/ctld.pid .
  93 .It Ic portal-group Ar name
  94 Create a
  95 .Sy portal-group
  96 configuration context,
  97 defining a new portal-group,
  98 which can then be assigned to any number of targets.
  99 .It Ic lun Ar name
 100 Create a
 101 .Sy lun
 102 configuration context, defining a LUN to be exported by any number of targets.
 103 .It Ic target Ar name
 104 Create a
 105 .Sy target
 106 configuration context, which can optionally contain one or more
 107 .Sy lun
 108 contexts.
 109 .It Ic timeout Ar seconds
 110 The timeout for login sessions, after which the connection
 111 will be forcibly terminated.
 112 The default is 60.
 113 A setting of 0 disables the timeout.
 114 .It Ic isns-server Ar address
 115 An IPv4 or IPv6 address and optionally port of iSNS server to register on.
 116 .It Ic isns-period Ar seconds
 117 iSNS registration period.
 118 Registered Network Entity not updated during this period will be unregistered.
 119 The default is 900.
 120 .It Ic isns-timeout Ar seconds
 121 Timeout for iSNS requests.
 122 The default is 5.
 123 .El
 124 .Ss auth-group Context
 125 .Bl -tag -width indent
 126 .It Ic auth-type Ar type
 127 Sets the authentication type.
 128 Type can be either
 129 .Qq Ar none ,
 130 .Qq Ar deny ,
 131 .Qq Ar chap ,
 132 or
 133 .Qq Ar chap-mutual .
 134 In most cases it is not necessary to set the type using this clause;
 135 it is usually used to disable authentication for a given
 136 .Sy auth-group .
 137 .It Ic chap Ar user Ar secret
 138 A set of CHAP authentication credentials.
 139 Note that for any
 140 .Sy auth-group ,
 141 the configuration may only contain either
 142 .Sy chap
 143 or
 144 .Sy chap-mutual
 145 entries; it is an error to mix them.
 146 .It Ic chap-mutual Ar user Ar secret Ar mutualuser Ar mutualsecret
 147 A set of mutual CHAP authentication credentials.
 148 Note that for any
 149 .Sy auth-group ,
 150 the configuration may only contain either
 151 .Sy chap
 152 or
 153 .Sy chap-mutual
 154 entries; it is an error to mix them.
 155 .It Ic initiator-name Ar initiator-name
 156 An iSCSI initiator name.
 157 Only initiators with a name matching one of the defined
 158 names will be allowed to connect.
 159 If not defined, there will be no restrictions based on initiator
 160 name.
 161 .It Ic initiator-portal Ar address Ns Op / Ns Ar prefixlen
 162 An iSCSI initiator portal: an IPv4 or IPv6 address, optionally
 163 followed by a literal slash and a prefix length.
 164 Only initiators with an address matching one of the defined
 165 addresses will be allowed to connect.
 166 If not defined, there will be no restrictions based on initiator
 167 address.
 168 .El
 169 .Ss portal-group Context
 170 .Bl -tag -width indent
 171 .It Ic discovery-auth-group Ar name
 172 Assign a previously defined authentication group to the portal group,
 173 to be used for target discovery.
 174 By default, portal groups are assigned predefined
 175 .Sy auth-group
 176 .Qq Ar default ,
 177 which denies discovery.
 178 Another predefined
 179 .Sy auth-group ,
 180 .Qq Ar no-authentication ,
 181 may be used
 182 to permit discovery without authentication.
 183 .It Ic discovery-filter Ar filter
 184 Determines which targets are returned during discovery.
 185 Filter can be either
 186 .Qq Ar none ,
 187 .Qq Ar portal ,
 188 .Qq Ar portal-name ,
 189 or
 190 .Qq Ar portal-name-auth .
 191 When set to
 192 .Qq Ar none ,
 193 discovery will return all targets assigned to that portal group.
 194 When set to
 195 .Qq Ar portal ,
 196 discovery will not return targets that cannot be accessed by the
 197 initiator because of their
 198 .Sy initiator-portal .
 199 When set to
 200 .Qq Ar portal-name ,
 201 the check will include both
 202 .Sy initiator-portal
 203 and
 204 .Sy initiator-name .
 205 When set to
 206 .Qq Ar portal-name-auth ,
 207 the check will include
 208 .Sy initiator-portal ,
 209 .Sy initiator-name ,
 210 and authentication credentials.
 211 The target is returned if it does not require CHAP authentication,
 212 or if the CHAP user and secret used during discovery match those
 213 used by the target.
 214 Note that when using
 215 .Qq Ar portal-name-auth ,
 216 targets that require CHAP authentication will only be returned if
 217 .Sy discovery-auth-group
 218 requires CHAP.
 219 The default is
 220 .Qq Ar none .
 221 .It Ic listen Ar address
 222 An IPv4 or IPv6 address and port to listen on for incoming connections.
 223 .\".It Ic listen-iser Ar address
 224 .\"An IPv4 or IPv6 address and port to listen on for incoming connections
 225 .\"using iSER (iSCSI over RDMA) protocol.
 226 .It Ic offload Ar driver
 227 Define iSCSI hardware offload driver to use for this
 228 .Sy portal-group .
 229 .It Ic redirect Ar address
 230 IPv4 or IPv6 address to redirect initiators to.
 231 When configured, all initiators attempting to connect to portal
 232 belonging to this
 233 .Sy portal-group
 234 will get redirected using "Target moved temporarily" login response.
 235 Redirection happens before authentication and any
 236 .Sy initiator-name
 237 or
 238 .Sy initiator-portal
 239 checks are skipped.
 240 .It Ic tag Ar value
 241 Unique 16-bit tag value of this
 242 .Sy portal-group .
 243 If not specified, the value is generated automatically.
 244 .It Ic foreign
 245 Specifies that this
 246 .Sy portal-group
 247 is listened by some other host.
 248 This host will announce it on discovery stage, but won't listen.
 249 .El
 250 .Ss target Context
 251 .Bl -tag -width indent
 252 .It Ic alias Ar text
 253 Assign a human-readable description to the target.
 254 There is no default.
 255 .It Ic auth-group Ar name
 256 Assign a previously defined authentication group to the target.
 257 By default, targets that do not specify their own auth settings,
 258 using clauses such as
 259 .Sy chap
 260 or
 261 .Sy initiator-name ,
 262 are assigned
 263 predefined
 264 .Sy auth-group
 265 .Qq Ar default ,
 266 which denies all access.
 267 Another predefined
 268 .Sy auth-group ,
 269 .Qq Ar no-authentication ,
 270 may be used to permit access
 271 without authentication.
 272 Note that this clause can be overridden using the second argument
 273 to a
 274 .Sy portal-group
 275 clause.
 276 .It Ic auth-type Ar type
 277 Sets the authentication type.
 278 Type can be either
 279 .Qq Ar none ,
 280 .Qq Ar deny ,
 281 .Qq Ar chap ,
 282 or
 283 .Qq Ar chap-mutual .
 284 In most cases it is not necessary to set the type using this clause;
 285 it is usually used to disable authentication for a given
 286 .Sy target .
 287 This clause is mutually exclusive with
 288 .Sy auth-group ;
 289 one cannot use
 290 both in a single target.
 291 .It Ic chap Ar user Ar secret
 292 A set of CHAP authentication credentials.
 293 Note that targets must only use one of
 294 .Sy auth-group , chap , No or Sy chap-mutual ;
 295 it is a configuration error to mix multiple types in one target.
 296 .It Ic chap-mutual Ar user Ar secret Ar mutualuser Ar mutualsecret
 297 A set of mutual CHAP authentication credentials.
 298 Note that targets must only use one of
 299 .Sy auth-group , chap , No or Sy chap-mutual ;
 300 it is a configuration error to mix multiple types in one target.
 301 .It Ic initiator-name Ar initiator-name
 302 An iSCSI initiator name.
 303 Only initiators with a name matching one of the defined
 304 names will be allowed to connect.
 305 If not defined, there will be no restrictions based on initiator
 306 name.
 307 This clause is mutually exclusive with
 308 .Sy auth-group ;
 309 one cannot use
 310 both in a single target.
 311 .It Ic initiator-portal Ar address Ns Op / Ns Ar prefixlen
 312 An iSCSI initiator portal: an IPv4 or IPv6 address, optionally
 313 followed by a literal slash and a prefix length.
 314 Only initiators with an address matching one of the defined
 315 addresses will be allowed to connect.
 316 If not defined, there will be no restrictions based on initiator
 317 address.
 318 This clause is mutually exclusive with
 319 .Sy auth-group ;
 320 one cannot use
 321 both in a single target.
 322 .Pp
 323 The
 324 .Sy auth-type ,
 325 .Sy chap ,
 326 .Sy chap-mutual ,
 327 .Sy initiator-name ,
 328 and
 329 .Sy initiator-portal
 330 clauses in the target context provide an alternative to assigning an
 331 .Sy auth-group
 332 defined separately, useful in the common case of authentication settings
 333 specific to a single target.
 334 .It Ic portal-group Ar name Op Ar ag-name
 335 Assign a previously defined portal group to the target.
 336 The default portal group is
 337 .Qq Ar default ,
 338 which makes the target available
 339 on TCP port 3260 on all configured IPv4 and IPv6 addresses.
 340 Optional second argument specifies
 341 .Sy auth-group
 342 for connections to this specific portal group.
 343 If second argument is not specified, target
 344 .Sy auth-group
 345 is used.
 346 .It Ic port Ar name
 347 .It Ic port Ar name/pp
 348 .It Ic port Ar name/pp/vp
 349 Assign specified CTL port (such as "isp0" or "isp2/1") to the target.
 350 This is used to export the target through a specific physical - eg Fibre
 351 Channel - port, in addition to portal-groups configured for the target.
 352 Use
 353 .Cm "ctladm portlist"
 354 command to retrieve the list of available ports.
 355 On startup
 356 .Xr ctld 8
 357 configures LUN mapping and enables all assigned ports.
 358 Each port can be assigned to only one target.
 359 .It Ic redirect Ar address
 360 IPv4 or IPv6 address to redirect initiators to.
 361 When configured, all initiators attempting to connect to this target
 362 will get redirected using "Target moved temporarily" login response.
 363 Redirection happens after successful authentication.
 364 .It Ic lun Ar number Ar name
 365 Export previously defined
 366 .Sy lun
 367 by the parent target.
 368 .It Ic lun Ar number
 369 Create a
 370 .Sy lun
 371 configuration context, defining a LUN exported by the parent target.
 372 .Pp
 373 This is an alternative to defining the LUN separately, useful in the common
 374 case of a LUN being exported by a single target.
 375 .El
 376 .Ss lun Context
 377 .Bl -tag -width indent
 378 .It Ic backend Ar block No | Ar ramdisk
 379 The CTL backend to use for a given LUN.
 380 Valid choices are
 381 .Qq Ar block
 382 and
 383 .Qq Ar ramdisk ;
 384 block is used for LUNs backed
 385 by files or disk device nodes; ramdisk is a bitsink device, used mostly for
 386 testing.
 387 The default backend is block.
 388 .It Ic blocksize Ar size
 389 The blocksize visible to the initiator.
 390 The default blocksize is 512 for disks, and 2048 for CD/DVDs.
 391 .It Ic ctl-lun Ar lun_id
 392 Global numeric identifier to use for a given LUN inside CTL.
 393 By default CTL allocates those IDs dynamically, but explicit specification
 394 may be needed for consistency in HA configurations.
 395 .It Ic device-id Ar string
 396 The SCSI Device Identification string presented to the initiator.
 397 .It Ic device-type Ar type
 398 Specify the SCSI device type to use when creating the LUN.
 399 Currently CTL supports Direct Access (type 0), Processor (type 3)
 400 and CD/DVD (type 5) LUNs.
 401 .It Ic option Ar name Ar value
 402 The CTL-specific options passed to the kernel.
 403 All CTL-specific options are documented in the
 404 .Sx OPTIONS
 405 section of
 406 .Xr ctladm 8 .
 407 .It Ic path Ar path
 408 The path to the file, device node, or
 409 .Xr zfs 8
 410 volume used to back the LUN.
 411 For optimal performance, create the volume with the
 412 .Qq Ar volmode=dev
 413 property set.
 414 .It Ic serial Ar string
 415 The SCSI serial number presented to the initiator.
 416 .It Ic size Ar size
 417 The LUN size, in bytes.
 418 .El
 419 .Sh FILES
 420 .Bl -tag -width ".Pa /etc/ctl.conf" -compact
 421 .It Pa /etc/ctl.conf
 422 The default location of the
 423 .Xr ctld 8
 424 configuration file.
 425 .El
 426 .Sh EXAMPLES
 427 .Bd -literal
 428 auth-group ag0 {
 429         chap-mutual "user" "secret" "mutualuser" "mutualsecret"
 430         chap-mutual "user2" "secret2" "mutualuser" "mutualsecret"
 431         initiator-portal 192.168.1.1/16
 432 }
 433
 434 auth-group ag1 {
 435         auth-type none
 436         initiator-name "iqn.2012-06.com.example:initiatorhost1"
 437         initiator-name "iqn.2012-06.com.example:initiatorhost2"
 438         initiator-portal 192.168.1.1/24
 439         initiator-portal [2001:db8::de:ef]
 440 }
 441
 442 portal-group pg0 {
 443         discovery-auth-group no-authentication
 444         listen 0.0.0.0:3260
 445         listen [::]:3260
 446         listen [fe80::be:ef]:3261
 447 }
 448
 449 target iqn.2012-06.com.example:target0 {
 450         alias "Example target"
 451         auth-group no-authentication
 452         lun 0 {
 453                 path /dev/zvol/tank/example_0
 454                 blocksize 4096
 455                 size 4G
 456         }
 457 }
 458
 459 lun example_1 {
 460         path /dev/zvol/tank/example_1
 461         option naa 0x50015178f369f093
 462 }
 463
 464 target iqn.2012-06.com.example:target1 {
 465         auth-group ag0
 466         portal-group pg0
 467         lun 0 example_1
 468         lun 1 {
 469                 path /dev/zvol/tank/example_2
 470                 option vendor "FreeBSD"
 471         }
 472 }
 473
 474 target naa.50015178f369f092 {
 475         port isp0
 476         port isp1
 477         lun 0 example_1
 478 }
 479 .Ed
 480 .Sh SEE ALSO
 481 .Xr ctl 4 ,
 482 .Xr ctladm 8 ,
 483 .Xr ctld 8 ,
 484 .Xr zfs 8
 485 .Sh AUTHORS
 486 The
 487 .Nm
 488 configuration file functionality for
 489 .Xr ctld 8
 490 was developed by
 491 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
 492 under sponsorship from the FreeBSD Foundation.