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 October 13, 2020
  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 The default is
 230 .Qq Ar none .
 231 .It Ic option Ar name Ar value
 232 The CTL-specific port options passed to the kernel.
 233 .It Ic redirect Ar address
 234 IPv4 or IPv6 address to redirect initiators to.
 235 When configured, all initiators attempting to connect to portal
 236 belonging to this
 237 .Sy portal-group
 238 will get redirected using "Target moved temporarily" login response.
 239 Redirection happens before authentication and any
 240 .Sy initiator-name
 241 or
 242 .Sy initiator-portal
 243 checks are skipped.
 244 .It Ic tag Ar value
 245 Unique 16-bit tag value of this
 246 .Sy portal-group .
 247 If not specified, the value is generated automatically.
 248 .It Ic foreign
 249 Specifies that this
 250 .Sy portal-group
 251 is listened by some other host.
 252 This host will announce it on discovery stage, but won't listen.
 253 .It Ic dscp Ar value
 254 The DiffServ Codepoint used for sending data. The DSCP can be
 255 set to numeric, or hexadecimal values directly, as well as the
 256 well-defined
 257 .Qq Ar CSx
 258 and
 259 .Qq Ar AFxx
 260 codepoints.
 261 .El
 262 .Ss target Context
 263 .Bl -tag -width indent
 264 .It Ic alias Ar text
 265 Assign a human-readable description to the target.
 266 There is no default.
 267 .It Ic auth-group Ar name
 268 Assign a previously defined authentication group to the target.
 269 By default, targets that do not specify their own auth settings,
 270 using clauses such as
 271 .Sy chap
 272 or
 273 .Sy initiator-name ,
 274 are assigned
 275 predefined
 276 .Sy auth-group
 277 .Qq Ar default ,
 278 which denies all access.
 279 Another predefined
 280 .Sy auth-group ,
 281 .Qq Ar no-authentication ,
 282 may be used to permit access
 283 without authentication.
 284 Note that this clause can be overridden using the second argument
 285 to a
 286 .Sy portal-group
 287 clause.
 288 .It Ic auth-type Ar type
 289 Sets the authentication type.
 290 Type can be either
 291 .Qq Ar none ,
 292 .Qq Ar deny ,
 293 .Qq Ar chap ,
 294 or
 295 .Qq Ar chap-mutual .
 296 In most cases it is not necessary to set the type using this clause;
 297 it is usually used to disable authentication for a given
 298 .Sy target .
 299 This clause is mutually exclusive with
 300 .Sy auth-group ;
 301 one cannot use
 302 both in a single target.
 303 .It Ic chap Ar user Ar secret
 304 A set of CHAP authentication credentials.
 305 Note that targets must only use one of
 306 .Sy auth-group , chap , No or Sy chap-mutual ;
 307 it is a configuration error to mix multiple types in one target.
 308 .It Ic chap-mutual Ar user Ar secret Ar mutualuser Ar mutualsecret
 309 A set of mutual CHAP authentication credentials.
 310 Note that targets must only use one of
 311 .Sy auth-group , chap , No or Sy chap-mutual ;
 312 it is a configuration error to mix multiple types in one target.
 313 .It Ic initiator-name Ar initiator-name
 314 An iSCSI initiator name.
 315 Only initiators with a name matching one of the defined
 316 names will be allowed to connect.
 317 If not defined, there will be no restrictions based on initiator
 318 name.
 319 This clause is mutually exclusive with
 320 .Sy auth-group ;
 321 one cannot use
 322 both in a single target.
 323 .It Ic initiator-portal Ar address Ns Op / Ns Ar prefixlen
 324 An iSCSI initiator portal: an IPv4 or IPv6 address, optionally
 325 followed by a literal slash and a prefix length.
 326 Only initiators with an address matching one of the defined
 327 addresses will be allowed to connect.
 328 If not defined, there will be no restrictions based on initiator
 329 address.
 330 This clause is mutually exclusive with
 331 .Sy auth-group ;
 332 one cannot use
 333 both in a single target.
 334 .Pp
 335 The
 336 .Sy auth-type ,
 337 .Sy chap ,
 338 .Sy chap-mutual ,
 339 .Sy initiator-name ,
 340 and
 341 .Sy initiator-portal
 342 clauses in the target context provide an alternative to assigning an
 343 .Sy auth-group
 344 defined separately, useful in the common case of authentication settings
 345 specific to a single target.
 346 .It Ic portal-group Ar name Op Ar ag-name
 347 Assign a previously defined portal group to the target.
 348 The default portal group is
 349 .Qq Ar default ,
 350 which makes the target available
 351 on TCP port 3260 on all configured IPv4 and IPv6 addresses.
 352 Optional second argument specifies
 353 .Sy auth-group
 354 for connections to this specific portal group.
 355 If second argument is not specified, target
 356 .Sy auth-group
 357 is used.
 358 .It Ic port Ar name
 359 .It Ic port Ar name/pp
 360 .It Ic port Ar name/pp/vp
 361 Assign specified CTL port (such as "isp0" or "isp2/1") to the target.
 362 This is used to export the target through a specific physical - eg Fibre
 363 Channel - port, in addition to portal-groups configured for the target.
 364 Use
 365 .Cm "ctladm portlist"
 366 command to retrieve the list of available ports.
 367 On startup
 368 .Xr ctld 8
 369 configures LUN mapping and enables all assigned ports.
 370 Each port can be assigned to only one target.
 371 .It Ic redirect Ar address
 372 IPv4 or IPv6 address to redirect initiators to.
 373 When configured, all initiators attempting to connect to this target
 374 will get redirected using "Target moved temporarily" login response.
 375 Redirection happens after successful authentication.
 376 .It Ic lun Ar number Ar name
 377 Export previously defined
 378 .Sy lun
 379 by the parent target.
 380 .It Ic lun Ar number
 381 Create a
 382 .Sy lun
 383 configuration context, defining a LUN exported by the parent target.
 384 .Pp
 385 This is an alternative to defining the LUN separately, useful in the common
 386 case of a LUN being exported by a single target.
 387 .El
 388 .Ss lun Context
 389 .Bl -tag -width indent
 390 .It Ic backend Ar block No | Ar ramdisk
 391 The CTL backend to use for a given LUN.
 392 Valid choices are
 393 .Qq Ar block
 394 and
 395 .Qq Ar ramdisk ;
 396 block is used for LUNs backed
 397 by files or disk device nodes; ramdisk is a bitsink device, used mostly for
 398 testing.
 399 The default backend is block.
 400 .It Ic blocksize Ar size
 401 The blocksize visible to the initiator.
 402 The default blocksize is 512 for disks, and 2048 for CD/DVDs.
 403 .It Ic ctl-lun Ar lun_id
 404 Global numeric identifier to use for a given LUN inside CTL.
 405 By default CTL allocates those IDs dynamically, but explicit specification
 406 may be needed for consistency in HA configurations.
 407 .It Ic device-id Ar string
 408 The SCSI Device Identification string presented to the initiator.
 409 .It Ic device-type Ar type
 410 Specify the SCSI device type to use when creating the LUN.
 411 Currently CTL supports Direct Access (type 0), Processor (type 3)
 412 and CD/DVD (type 5) LUNs.
 413 .It Ic option Ar name Ar value
 414 The CTL-specific options passed to the kernel.
 415 All CTL-specific options are documented in the
 416 .Sx OPTIONS
 417 section of
 418 .Xr ctladm 8 .
 419 .It Ic path Ar path
 420 The path to the file, device node, or
 421 .Xr zfs 8
 422 volume used to back the LUN.
 423 For optimal performance, create the volume with the
 424 .Qq Ar volmode=dev
 425 property set.
 426 .It Ic serial Ar string
 427 The SCSI serial number presented to the initiator.
 428 .It Ic size Ar size
 429 The LUN size, in bytes or by number with a suffix of
 430 .Sy K , M , G , T
 431 (for kilobytes, megabytes, gigabytes, or terabytes).
 432 When the configuration is in UCL format, use the suffix format
 433 .Sy kKmMgG Ns | Ns Sy bB ,
 434 (i.e., 4GB, 4gb, and 4Gb are all equivalent).
 435 .El
 436 .Sh FILES
 437 .Bl -tag -width ".Pa /etc/ctl.conf" -compact
 438 .It Pa /etc/ctl.conf
 439 The default location of the
 440 .Xr ctld 8
 441 configuration file.
 442 .El
 443 .Sh EXAMPLES
 444 .Bd -literal
 445 auth-group ag0 {
 446         chap-mutual "user" "secret" "mutualuser" "mutualsecret"
 447         chap-mutual "user2" "secret2" "mutualuser" "mutualsecret"
 448         initiator-portal 192.168.1.1/16
 449 }
 450
 451 auth-group ag1 {
 452         auth-type none
 453         initiator-name "iqn.2012-06.com.example:initiatorhost1"
 454         initiator-name "iqn.2012-06.com.example:initiatorhost2"
 455         initiator-portal 192.168.1.1/24
 456         initiator-portal [2001:db8::de:ef]
 457 }
 458
 459 portal-group pg0 {
 460         discovery-auth-group no-authentication
 461         listen 0.0.0.0:3260
 462         listen [::]:3260
 463         listen [fe80::be:ef]:3261
 464 }
 465
 466 target iqn.2012-06.com.example:target0 {
 467         alias "Example target"
 468         auth-group no-authentication
 469         lun 0 {
 470                 path /dev/zvol/tank/example_0
 471                 blocksize 4096
 472                 size 4G
 473         }
 474 }
 475
 476 lun example_1 {
 477         path /dev/zvol/tank/example_1
 478         option naa 0x50015178f369f093
 479 }
 480
 481 target iqn.2012-06.com.example:target1 {
 482         auth-group ag0
 483         portal-group pg0
 484         lun 0 example_1
 485         lun 1 {
 486                 path /dev/zvol/tank/example_2
 487                 option vendor "FreeBSD"
 488         }
 489 }
 490
 491 target naa.50015178f369f092 {
 492         port isp0
 493         port isp1
 494         lun 0 example_1
 495 }
 496 .Ed
 497 .Pp
 498 An equivalent configuration in UCL format, for use with
 499 .Fl u :
 500 .Bd -literal
 501 auth-group {
 502         ag0 {
 503                 chap-mutual = [
 504                         {
 505                                 user = "user"
 506                                 secret = "secretsecret"
 507                                 mutual-user = "mutualuser"
 508                                 mutual-secret = "mutualsecret"
 509                         },
 510                         {
 511                                 user = "user2"
 512                                 secret = "secret2secret2"
 513                                 mutual-user = "mutualuser"
 514                                 mutual-secret = "mutualsecret"
 515                         }
 516                 ]
 517         }
 518
 519         ag1 {
 520                 auth-type = none
 521                 initiator-name = [
 522                         "iqn.2012-06.com.example:initiatorhost1",
 523                         "iqn.2012-06.com.example:initiatorhost2"
 524                 ]
 525                 initiator-portal = [192.168.1.1/24, "[2001:db8::de:ef]"]
 526         }
 527 }
 528
 529 portal-group {
 530         pg0 {
 531                 discovery-auth-group = no-authentication
 532                 listen = [
 533                         0.0.0.0:3260,
 534                         "[::]:3260",
 535                         "[fe80::be:ef]:3261"
 536                 ]
 537         }
 538 }
 539
 540 lun {
 541         example_0 {
 542                 path = /dev/zvol/tank/example_0
 543                 blocksize = 4096
 544                 size = 4GB
 545         }
 546
 547         example_1 {
 548                 path = /dev/zvol/tank/example_1
 549                 options {
 550                         naa = "0x50015178f369f093"
 551                 }
 552         }
 553
 554         example_2 {
 555                 path = /dev/zvol/tank/example_2
 556                 options {
 557                         vendor = "FreeBSD"
 558                 }
 559         }
 560 }
 561
 562 target {
 563         "iqn.2012-06.com.example:target0" {
 564                 alias = "Example target"
 565                 auth-group = no-authentication
 566                 lun = [
 567                         { number = 0, name = example_0 },
 568                 ]
 569         }
 570
 571         "iqn.2012-06.com.example:target1" {
 572                 auth-group = ag0
 573                 portal-group { name = pg0 }
 574                 lun = [
 575                         { number = 0, name = example_1 },
 576                         { number = 1, name = example_2 }
 577                 ]
 578         }
 579
 580         naa.50015178f369f092 {
 581                 port = isp0
 582                 lun = [
 583                         { number = 0, name = example_1 }
 584                 ]
 585         }
 586 }
 587 .Ed
 588 .Sh SEE ALSO
 589 .Xr ctl 4 ,
 590 .Xr ctladm 8 ,
 591 .Xr ctld 8 ,
 592 .Xr zfs 8
 593 .Sh AUTHORS
 594 The
 595 .Nm
 596 configuration file functionality for
 597 .Xr ctld 8
 598 was developed by
 599 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
 600 under sponsorship from the FreeBSD Foundation.