usr.sbin/ctld/ctl.conf.5

   1 .\" Copyright (c) 2012 The FreeBSD Foundation
   2 .\" All rights reserved.
   3 .\"
   4 .\" This software was developed by Edward Tomasz Napierala under sponsorship
   5 .\" from the FreeBSD Foundation.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  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.
  15 .\"
  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
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd October 28, 2014
  31 .Dt CTL.CONF 5
  32 .Os
  33 .Sh NAME
  34 .Nm ctl.conf
  35 .Nd CAM Target Layer / iSCSI target daemon configuration file
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 configuration file is used by the
  40 .Xr ctld 8
  41 daemon.
  42 Lines starting with
  43 .Ql #
  44 are interpreted as comments.
  45 The general syntax of the
  46 .Nm
  47 file is:
  48 .Bd -literal -offset indent
  49 .No pidfile Ar path
  50
  51 .No auth-group Ar name No {
  52 .Dl chap Ar user Ar secret
  53 .Dl ...
  54 }
  55
  56 .No portal-group Ar name No {
  57 .Dl listen Ar address
  58 .\".Dl listen-iser Ar address
  59 .Dl discovery-auth-group Ar name
  60 .Dl ...
  61 }
  62
  63 .No target Ar name {
  64 .Dl auth-group Ar name
  65 .Dl portal-group Ar name
  66 .Dl lun Ar number No {
  67 .Dl     path Ar path
  68 .Dl }
  69 .Dl ...
  70 }
  71 .Ed
  72 .Ss Global Context
  73 .Bl -tag -width indent
  74 .It Ic auth-group Ar name
  75 Create an
  76 .Sy auth-group
  77 configuration context,
  78 defining a new auth-group,
  79 which can then be assigned to any number of targets.
  80 .It Ic debug Ar level
  81 The debug verbosity level.
  82 The default is 0.
  83 .It Ic maxproc Ar number
  84 The limit for concurrently running child processes handling
  85 incoming connections.
  86 The default is 30.
  87 A setting of 0 disables the limit.
  88 .It Ic pidfile Ar path
  89 The path to the pidfile.
  90 The default is
  91 .Pa /var/run/ctld.pid .
  92 .It Ic portal-group Ar name
  93 Create a
  94 .Sy portal-group
  95 configuration context,
  96 defining a new portal-group,
  97 which can then be assigned to any number of targets.
  98 .It Ic target Ar name
  99 Create a
 100 .Sy target
 101 configuration context, which can contain one or more
 102 .Sy lun
 103 contexts.
 104 .It Ic timeout Ar seconds
 105 The timeout for login sessions, after which the connection
 106 will be forcibly terminated.
 107 The default is 60.
 108 A setting of 0 disables the timeout.
 109 .It Ic isns-server Ar address
 110 An IPv4 or IPv6 address and optionally port of iSNS server to register on.
 111 .It Ic isns-period Ar seconds
 112 iSNS registration period.
 113 Registered Network Entity not updated during this period will be unregistered.
 114 The default is 900.
 115 .It Ic isns-timeout Ar seconds
 116 Timeout for iSNS requests.
 117 The default is 5.
 118 .El
 119 .Ss auth-group Context
 120 .Bl -tag -width indent
 121 .It Ic auth-type Ar type
 122 Sets the authentication type.
 123 Type can be either
 124 .Qq Ar none ,
 125 .Qq Ar deny ,
 126 .Qq Ar chap ,
 127 or
 128 .Qq Ar chap-mutual .
 129 In most cases it is not necessary to set the type using this clause;
 130 it is usually used to disable authentication for a given
 131 .Sy auth-group .
 132 .It Ic chap Ar user Ar secret
 133 A set of CHAP authentication credentials.
 134 Note that for any
 135 .Sy auth-group ,
 136 the configuration may only contain either
 137 .Sy chap
 138 or
 139 .Sy chap-mutual
 140 entries; it is an error to mix them.
 141 .It Ic chap-mutual Ar user Ar secret Ar mutualuser Ar mutualsecret
 142 A set of mutual CHAP authentication credentials.
 143 Note that for any
 144 .Sy auth-group ,
 145 the configuration may only contain either
 146 .Sy chap
 147 or
 148 .Sy chap-mutual
 149 entries; it is an error to mix them.
 150 .It Ic initiator-name Ar initiator-name
 151 An iSCSI initiator name.
 152 Only initiators with a name matching one of the defined
 153 names will be allowed to connect.
 154 If not defined, there will be no restrictions based on initiator
 155 name.
 156 .It Ic initiator-portal Ar address Ns Op / Ns Ar prefixlen
 157 An iSCSI initiator portal: an IPv4 or IPv6 address, optionally
 158 followed by a literal slash and a prefix length.
 159 Only initiators with an address matching one of the defined
 160 addresses will be allowed to connect.
 161 If not defined, there will be no restrictions based on initiator
 162 address.
 163 .El
 164 .Ss portal-group Context
 165 .Bl -tag -width indent
 166 .It Ic discovery-auth-group Ar name
 167 Assign a previously defined authentication group to the portal group,
 168 to be used for target discovery.
 169 By default, portal groups are assigned predefined
 170 .Sy auth-group
 171 .Qq Ar default ,
 172 which denies discovery.
 173 Another predefined
 174 .Sy auth-group ,
 175 .Qq Ar no-authentication ,
 176 may be used
 177 to permit discovery without authentication.
 178 .It Ic listen Ar address
 179 An IPv4 or IPv6 address and port to listen on for incoming connections.
 180 .\".It Ic listen-iser Ar address
 181 .\"An IPv4 or IPv6 address and port to listen on for incoming connections
 182 .\"using iSER (iSCSI over RDMA) protocol.
 183 .El
 184 .Ss target Context
 185 .Bl -tag -width indent
 186 .It Ic alias Ar text
 187 Assign a human-readable description to the target.
 188 There is no default.
 189 .It Ic auth-group Ar name
 190 Assign a previously defined authentication group to the target.
 191 By default, targets that do not specify their own auth settings,
 192 using clauses such as
 193 .Sy chap
 194 or
 195 .Sy initiator-name ,
 196 are assigned
 197 predefined
 198 .Sy auth-group
 199 .Qq Ar default ,
 200 which denies all access.
 201 Another predefined
 202 .Sy auth-group ,
 203 .Qq Ar no-authentication ,
 204 may be used to permit access
 205 without authentication.
 206 Note that targets must only use one of
 207 .Sy auth-group , chap , No or Sy chap-mutual ;
 208 it is a configuration error to mix multiple types in one target.
 209 .It Ic auth-type Ar type
 210 Sets the authentication type.
 211 Type can be either
 212 .Qq Ar none ,
 213 .Qq Ar deny ,
 214 .Qq Ar chap ,
 215 or
 216 .Qq Ar chap-mutual .
 217 In most cases it is not necessary to set the type using this clause;
 218 it is usually used to disable authentication for a given
 219 .Sy target .
 220 This clause is mutually exclusive with
 221 .Sy auth-group ;
 222 one cannot use
 223 both in a single target.
 224 .It Ic chap Ar user Ar secret
 225 A set of CHAP authentication credentials.
 226 Note that targets must only use one of
 227 .Sy auth-group , chap , No or Sy chap-mutual ;
 228 it is a configuration error to mix multiple types in one target.
 229 .It Ic chap-mutual Ar user Ar secret Ar mutualuser Ar mutualsecret
 230 A set of mutual CHAP authentication credentials.
 231 Note that targets must only use one of
 232 .Sy auth-group , chap , No or Sy chap-mutual ;
 233 it is a configuration error to mix multiple types in one target.
 234 .It Ic initiator-name Ar initiator-name
 235 An iSCSI initiator name.
 236 Only initiators with a name matching one of the defined
 237 names will be allowed to connect.
 238 If not defined, there will be no restrictions based on initiator
 239 name.
 240 This clause is mutually exclusive with
 241 .Sy auth-group ;
 242 one cannot use
 243 both in a single target.
 244 .It Ic initiator-portal Ar address Ns Op / Ns Ar prefixlen
 245 An iSCSI initiator portal: an IPv4 or IPv6 address, optionally
 246 followed by a literal slash and a prefix length.
 247 Only initiators with an address matching one of the defined
 248 addresses will be allowed to connect.
 249 If not defined, there will be no restrictions based on initiator
 250 address.
 251 This clause is mutually exclusive with
 252 .Sy auth-group ;
 253 one cannot use
 254 both in a single target.
 255 .It Ic portal-group Ar name
 256 Assign a previously defined portal group to the target.
 257 The default portal group is
 258 .Qq Ar default ,
 259 which makes the target available
 260 on TCP port 3260 on all configured IPv4 and IPv6 addresses.
 261 .It Ic lun Ar number
 262 Create a
 263 .Sy lun
 264 configuration context, defining a LUN exported by the parent target.
 265 .El
 266 .Ss lun Context
 267 .Bl -tag -width indent
 268 .It Ic backend Ar block No | Ar ramdisk
 269 The CTL backend to use for a given LUN.
 270 Valid choices are
 271 .Qq Ar block
 272 and
 273 .Qq Ar ramdisk ;
 274 block is used for LUNs backed
 275 by files or disk device nodes; ramdisk is a bitsink device, used mostly for
 276 testing.
 277 The default backend is block.
 278 .It Ic blocksize Ar size
 279 The blocksize visible to the initiator.
 280 The default blocksize is 512.
 281 .It Ic device-id Ar string
 282 The SCSI Device Identification string presented to the initiator.
 283 .It Ic option Ar name Ar value
 284 The CTL-specific options passed to the kernel.
 285 All CTL-specific options are documented in the
 286 .Sx OPTIONS
 287 section of
 288 .Xr ctladm 8 .
 289 .It Ic path Ar path
 290 The path to the file or device node used to back the LUN.
 291 .It Ic serial Ar string
 292 The SCSI serial number presented to the initiator.
 293 .It Ic size Ar size
 294 The LUN size, in bytes.
 295 .El
 296 .Sh FILES
 297 .Bl -tag -width ".Pa /etc/ctl.conf" -compact
 298 .It Pa /etc/ctl.conf
 299 The default location of the
 300 .Xr ctld 8
 301 configuration file.
 302 .El
 303 .Sh EXAMPLES
 304 .Bd -literal
 305 pidfile /var/run/ctld.pid
 306
 307 auth-group example2 {
 308         chap-mutual "user" "secret" "mutualuser" "mutualsecret"
 309         chap-mutual "user2" "secret2" "mutualuser" "mutualsecret"
 310 }
 311
 312 portal-group example2 {
 313         discovery-auth-group no-authentication
 314         listen 127.0.0.1
 315         listen 0.0.0.0:3261
 316         listen [::]:3261
 317         listen [fe80::be:ef]
 318 }
 319
 320 target iqn.2012-06.com.example:target0 {
 321         alias "Example target"
 322         auth-group no-authentication
 323         lun 0 {
 324                 path /dev/zvol/example_0
 325                 blocksize 4096
 326                 size 4G
 327         }
 328 }
 329
 330 target iqn.2012-06.com.example:target3 {
 331         chap chapuser chapsecret
 332         lun 0 {
 333                 path /dev/zvol/example_3
 334         }
 335 }
 336
 337 target iqn.2012-06.com.example:target2 {
 338         auth-group example2
 339         portal-group example2
 340         lun 0 {
 341                 path /dev/zvol/example2_0
 342         }
 343         lun 1 {
 344                 path /dev/zvol/example2_1
 345                 option foo bar
 346         }
 347 }
 348 .Ed
 349 .Sh SEE ALSO
 350 .Xr ctl 4 ,
 351 .Xr ctladm 8 ,
 352 .Xr ctld 8
 353 .Sh AUTHORS
 354 The
 355 .Nm
 356 configuration file functionality for
 357 .Xr ctld 8
 358 was developed by
 359 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org
 360 under sponsorship from the FreeBSD Foundation.