usr.bin/iscsictl/iscsi.conf.5

   1 .\" Copyright (c) 2007-2010 Daniel Braniss <danny@cs.huji.ac.il>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd May 6, 2016
  28 .Dt ISCSI.CONF 5
  29 .Os
  30 .Sh NAME
  31 .Nm iscsi.conf
  32 .Nd iSCSI initiator configuration file
  33 .Sh DESCRIPTION
  34 The
  35 .Nm
  36 configuration file is used by the
  37 .Xr iscsictl 8
  38 and
  39 .Xr iscontrol 8
  40 utilities.
  41 The general syntax is:
  42 .Bf Li
  43 .Bd -literal
  44         # this is a comment
  45         nickname_1 {
  46            variable = value;
  47            ...
  48         }
  49         nickname_2 {
  50            variable = value;
  51            ...
  52         }
  53         ...
  54 .Ed
  55 .Ef
  56 .Bl -tag -width MaxConnections
  57 .It Cm AuthMethod
  58 Sets the authentication type.
  59 Type can be either
  60 .Qq Ar None ,
  61 or
  62 .Qq Ar CHAP .
  63 Default is
  64 .Qq Ar None .
  65 When set to
  66 .Cm CHAP ,
  67 both
  68 .Cm chapIName
  69 and
  70 .Cm chapSecret
  71 must be defined.
  72 .It Cm chapIName
  73 Login for CHAP authentication.
  74 .It Cm chapSecret
  75 Secret for CHAP authentication.
  76 .It Cm tgtChapName
  77 Target login for Mutual CHAP authentication.
  78 .It Cm tgtChapSecret
  79 Target secret for Mutual CHAP authentication.
  80 .It Cm HeaderDigest
  81 Sets the header digest; a checksum calculated over the header of iSCSI
  82 PDUs, and verified on receive.
  83 Digest can be either
  84 .Qq Ar None ,
  85 or
  86 .Qq Ar CRC32C .
  87 Default is
  88 .Qq Ar None .
  89 .It Cm DataDigest
  90 Sets the data digest; a checksum calculated over the Data Section of iSCSI
  91 PDUs, and verified on receive.
  92 Digest can be either
  93 .Qq Ar None ,
  94 or
  95 .Qq Ar CRC32C .
  96 Default is
  97 .Qq Ar None .
  98 .It Cm InitiatorName
  99 Sets the initiator name.
 100 By default, the name is concatenation of
 101 .Qq Ar iqn.1994-09.org.freebsd:
 102 with the hostname.
 103 .It Cm TargetName
 104 Sets the target name.
 105 Not required for discovery sessions.
 106 .It Cm TargetAddress
 107 Sets the target address and port, in
 108 .Sy address[:port]
 109 format.
 110 The
 111 .Sy address
 112 can be either an IP address, or hostname.
 113 The optional port defaults to 3260.
 114 .It Cm SessionType
 115 Sets the session type.
 116 Type can be either
 117 .Qq Ar Discovery ,
 118 or
 119 .Qq Ar Normal .
 120 Default is
 121 .Qq Ar Normal .
 122 For normal sessions, the
 123 .Sy TargetName
 124 must be defined.
 125 Discovery sessions result in the initiator connecting to all the targets
 126 returned by SendTargets iSCSI discovery with the defined
 127 .Sy TargetAddress .
 128 .It Cm Enable
 129 Enable or disable the session.
 130 State can be either
 131 .Qq Ar On ,
 132 or
 133 .Qq Ar Off .
 134 Default is
 135 .Qq Ar On .
 136 .It Cm Offload
 137 Name of selected iSCSI hardware offload driver.
 138 Default is
 139 .Qq Ar None .
 140 .It Cm Protocol
 141 Name of selected protocol.
 142 It can be either
 143 .Qq Ar iSER ,
 144 for iSCSI over RDMA, or
 145 .Qq Ar iSCSI .
 146 Default is
 147 .Qq Ar iSCSI .
 148 .It Cm dscp
 149 The DiffServ Codepoint used for sending data. The DSCP can be
 150 set to numeric, or hexadecimal values directly, as well as the
 151 well-defined
 152 .Qq Ar cs<n>
 153 and
 154 .Qq Ar af<xx>
 155 codepoints.
 156 Default is no specified dscp codepoint, which means the default
 157 of the outgoing interface is used.
 158 .El
 159 .Sh FILES
 160 .Bl -tag -width indent
 161 .It Pa /etc/iscsi.conf
 162 .El
 163 .Sh EXAMPLES
 164 .Bd -literal
 165 myiscsi { # nickname
 166    targetaddress = iscsi1
 167    targetname    = iqn.1900.com.com:sn.123456
 168 }
 169
 170 myiscsi6 { # nickname
 171    targetaddress = [2001:db8::de:ef]:3260
 172    targetname    = iqn.1900.com.com:sn.123456
 173 }
 174
 175 chaptest {
 176    targetaddress = 10.0.0.1;
 177    targetname    = iqn.1900.com.com:sn.123456;
 178    initiatorname = iqn.2005-01.il.ac.huji.cs:nobody;
 179    authmethod    = CHAP;
 180    chapiname     = iqn.2005-01.il.ac.huji.cs:nobody;
 181    chapsecret    = "secretsecret";
 182 }
 183 .Ed
 184 .Sh SEE ALSO
 185 .Xr iscontrol 8 ,
 186 .Xr iscsictl 8
 187 .\"Sh HISTORY
 188 .\"Sh AUTHORS