Annotation of embedaddon/istgt/etc/istgt.conf.in, revision 1.1.1.2

1.1       misho       1: # istgt configuration file
                      2: #
                      3: # Please do not write parameters excluding ASCII.
                      4: # The parameter must be quoted if space or separator include.
                      5: #
1.1.1.2 ! misho       6: # The section of PortalGroup, InitiatorGroup and LogicalUnit can be
        !             7: # reloaded by sending SIGHUP to the istgt process.
        !             8: #
1.1       misho       9: # configuration syntax:
                     10: # spaces at head of line are deleted, other spaces are as separator
                     11: # starting with '#' is comment line, not evaluate
                     12: # ending with '\' is concatenating next line
                     13: # bracket key is section key grouping following keys
                     14: # group number of section key is used as tag number
                     15: # (group number might not be continuous value)
                     16: # 1st string is key may appear multiple times
                     17: # 2nd and more are value associated the key
                     18: # Comment key is placed for human readable like user interface
                     19: #
                     20: [Global]
                     21:   Comment "Global section"
                     22:   # node name (not include optional part)
                     23:   NodeBase "iqn.2007-09.jp.ne.peach.istgt"
                     24: 
                     25:   # files
                     26:   PidFile /var/run/istgt.pid
                     27:   AuthFile %%CONFIGDIR%%/auth.conf
                     28: 
                     29:   # directories
                     30:   # for removable media (virtual DVD/virtual Tape)
                     31:   MediaDirectory %%MEDIADIR%%
                     32: 
                     33:   # syslog facility
                     34:   LogFacility "local7"
                     35: 
                     36:   # socket I/O timeout sec. (polling is infinity)
                     37:   Timeout 30
                     38:   # NOPIN sending interval sec.
                     39:   NopInInterval 20
                     40: 
                     41:   # authentication information for discovery session
                     42:   DiscoveryAuthMethod Auto
                     43:   #DiscoveryAuthGroup AuthGroup9999
                     44: 
                     45:   # reserved maximum connections and sessions
                     46:   # NOTE: iSCSI boot is 2 or more sessions required
                     47:   MaxSessions 16
                     48:   MaxConnections 4
                     49: 
                     50:   # maximum number of sending R2T in each connection
                     51:   # actual number is limited to QueueDepth and MaxCmdSN and ExpCmdSN
                     52:   # 0=disabled, 1-256=improves large writing
                     53:   MaxR2T 32
                     54: 
                     55:   # iSCSI initial parameters negotiate with initiators
                     56:   # NOTE: incorrect values might crash
                     57:   MaxOutstandingR2T 16
                     58:   DefaultTime2Wait 2
                     59:   DefaultTime2Retain 60
                     60:   FirstBurstLength 262144
                     61:   MaxBurstLength 1048576
                     62:   MaxRecvDataSegmentLength 262144
                     63: 
                     64:   # NOTE: not supported
                     65:   InitialR2T Yes
                     66:   ImmediateData Yes
                     67:   DataPDUInOrder Yes
                     68:   DataSequenceInOrder Yes
                     69:   ErrorRecoveryLevel 0
                     70: 
                     71: [UnitControl]
                     72:   Comment "Internal Logical Unit Controller"
                     73:   #AuthMethod Auto
                     74:   AuthMethod CHAP Mutual
                     75:   AuthGroup AuthGroup10000
                     76:   # this portal is only used as controller (by istgtcontrol)
                     77:   # if it's not necessary, no portal is valid
                     78:   #Portal UC1 [::1]:3261
                     79:   Portal UC1 127.0.0.1:3261
                     80:   # accept IP netmask
                     81:   #Netmask [::1]
                     82:   Netmask 127.0.0.1
                     83: 
                     84: # You should set IPs in /etc/rc.conf for physical I/F
                     85: [PortalGroup1]
                     86:   Comment "SINGLE PORT TEST"
                     87:   # Portal Label(not used) IP(IPv6 or IPv4):Port
                     88:   #Portal DA1 [2001:03e0:06cf:0003:021b:21ff:fe04:f405]:3260
                     89:   Portal DA1 192.168.2.36:3260
                     90: 
                     91: # wildcard address you may need if use DHCP
                     92: # DO NOT USE WITH OTHER PORTALS
                     93: #[PortalGroup1]
                     94: #  Comment "ANY IP"
                     95: #  # Portal Label(not used) IP(IPv6 or IPv4):Port
                     96: #  #Portal DA1 [::]:3260
                     97: #  Portal DA1 0.0.0.0:3260
                     98: 
                     99: [InitiatorGroup1]
                    100:   Comment "Initiator Group1"
                    101:   # name with ! deny login/discovery
                    102:   #InitiatorName "!iqn.1991-05.com.microsoft:moon"
                    103:   # spetified name allow login/discovery
                    104:   #InitiatorName "iqn.1991-05.com.microsoft:saturn"
                    105:   # special word "ALL" match all of initiators
                    106:   InitiatorName "ALL"
                    107:   Netmask 192.168.2.0/24
                    108: 
                    109: # TargetName, Mapping, UnitType, LUN0 are minimum required
                    110: [LogicalUnit1]
                    111:   Comment "Hard Disk Sample"
                    112:   # full specified iqn (same as below)
                    113:   #TargetName iqn.2007-09.jp.ne.peach.istgt:disk1
                    114:   # short specified non iqn (will add NodeBase)
                    115:   TargetName disk1
                    116:   TargetAlias "Data Disk1"
                    117:   # use initiators in tag1 via portals in tag1
                    118:   Mapping PortalGroup1 InitiatorGroup1
                    119:   # accept both CHAP and None
                    120:   AuthMethod Auto
                    121:   AuthGroup AuthGroup1
                    122:   #UseDigest Header Data
                    123:   UseDigest Auto
                    124:   UnitType Disk
                    125:   # SCSI INQUIRY - Vendor(8) Product(16) Revision(4) Serial(16)
                    126:   #UnitInquiry "FreeBSD" "iSCSI Disk" "0123" "10000001"
                    127:   # Queuing 0=disabled, 1-255=enabled with specified depth.
                    128:   #QueueDepth 32
                    129: 
                    130:   # override global setting if need
                    131:   #MaxOutstandingR2T 16
                    132:   #DefaultTime2Wait 2
                    133:   #DefaultTime2Retain 60
                    134:   #FirstBurstLength 262144
                    135:   #MaxBurstLength 1048576
                    136:   #MaxRecvDataSegmentLength 262144
                    137:   #InitialR2T Yes
                    138:   #ImmediateData Yes
                    139:   #DataPDUInOrder Yes
                    140:   #DataSequenceInOrder Yes
                    141:   #ErrorRecoveryLevel 0
                    142: 
                    143:   # LogicalVolume for this unit on LUN0
                    144:   # for file extent
                    145:   LUN0 Storage /tank/iscsi/istgt-disk1 10GB
                    146:   # for raw device extent
                    147:   #LUN0 Storage /dev/ad4 Auto
                    148:   # for ZFS volume extent
                    149:   #LUN0 Storage /dev/zvol/tank/istgt-vol1 Auto
                    150: 
                    151:   # override the serial of LUN0 specified with UnitInquiry
                    152:   #LUN0 Option Serial "10000001"
                    153: 
                    154:   # for 3.5inch, 7200rpm HDD
                    155:   # RPM 0=not reported, 1=non-rotating(SSD), n>1024 rpm
                    156:   #LUN0 Option RPM 7200
                    157:   # FormFactor 0=not reported, 1=5.25, 2=3.5, 3=2.5, 4=1.8, 5=less 1.8 inch
                    158:   #LUN0 Option FormFactor 2
                    159: 
                    160:   # for 2.5inch, SSD
                    161:   #LUN0 Option RPM 1
                    162:   #LUN0 Option FormFactor 3
                    163: 
                    164:   # for future use (enabled by default)
                    165:   #LUN0 Option ReadCache Disable
                    166:   #LUN0 Option WriteCache Disable
                    167: 
                    168: #[LogicalUnit2]
                    169: #  # SCSI commands pass through to SCSI device by CAM
                    170: #  Comment "Pass-through Disk Sample"
                    171: #  TargetName pass-disk1
                    172: #  TargetAlias "Pass Through Disk1"
                    173: #  Mapping PortalGroup1 InitiatorGroup1
                    174: #  AuthMethod Auto
                    175: #  AuthGroup AuthGroup1
                    176: #  UnitType Pass
                    177: #  # DO NOT SPECIFY PARTITION, PASS-THROUGH USE ENTIRE LOGICAL UNIT
                    178: #  LUN0 Device /dev/da0

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>