Return to README CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / istgt

20121028

    1: The iSCSI target for Debian/NetBSD/FreeBSD
    2: 
    3: This software (istgt) is the implementation of iSCSI target
    4: (refer to RFC3720 about iSCSI) for FreeBSD 7.1 or later.
    5: It includes iSCSI protocol processor and SPC-3 (SCSI Primary
    6: Commands - 3) based logical unit emulation.
    7: You can easily create over 2TB storage for iSCSI target.
    8: If necessary, you can configure to use multipath failover or
    9: MCS failover.
   10: 
   11: If you want use the command queuing, change QueueDepth key of
   12: the configuration. Because default is comment out, you only
   13: remove # from this line to make the parameter take effect.
   14: The command queuing is not yet stable. If you have any problem,
   15: comment out or specify 0 to disable it. The small QueueDepth
   16: may cause a problem. I recommend you to specify more than 32.
   17: 
   18: You can use a file or any raw device as the backing store.
   19: Microsoft Windows Server 2008 or Microsoft iSCSI initiator 2.08
   20: or later is recommended.
   21: Diskless iSCSI boot is tested with Intel PRO/1000 PT Server
   22: Adapter and Windows Server 2003/2008/2008R2/Windows7 RC.
   23: iSCSI install/boot is tested with gPXE 1.0.0 and WS2K8/2K8R2/W7.
   24: Intel Gigabit CT Desktop Adapter is tested with WS 2K8R2/W7.
   25: 
   26: This software is under development and less document.
   27: The format of the configuration file may frequently be changed.
   28: Please use it carefully.
   29: It is made based on the concept of my own MCS extra patch
   30: (release 20090125) for iscsi-target (netbsd-iscsi-20080207).
   31: 
   32: If you want to run FreeBSD in Hyper-V environment,
   33: please use my small kernel patch of reboot issue which can be
   34: downloaded below.
   35: 
   36: The latest version is available at:
   37: http://shell.peach.ne.jp/aoyama/
   38: 
   39: For FreeBSD initiator, please check here:
   40: ftp://ftp.cs.huji.ac.il/users/danny/freebsd/
   41: 
   42: Using path-through tape drive from Microsoft iSCSI Initiator:
   43: open registry of initiator by regedit.exe.
   44: change the value of MaxTransferLength to 0x10000 (65536).
   45: reboot Windows.
   46: (0000 is an instance number. It might be a different value.)
   47: 
   48: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Class\
   49: {4D36E97B-E325-11CE-BFC1-08002BE10318}\0000\Parameters\
   50: MaxTransferLength
   51: 
   52: Timeout of Microsoft iSCSI Initiator:
   53: If you want fast recovery from failure, try to decrease the value in
   54: above registry:
   55: LinkDownTime
   56: TCPConnectTime
   57: TCPDisconnectTime
   58: DelayBetweenReconnect
   59: 
   60: If you want to keep failed command, try to increase:
   61: MaxRequestHoldTime
   62: SrbTimeoutDelta
   63: 
   64: 
   65: External Libs:
   66:  o OpenSSL (shipped with FreeBSD)
   67:  o CAM (shipped with FreeBSD)
   68:  o VirtualBox 4.x DSO (if use --with-vbox configure option)
   69: 
   70: Tested Initiators:
   71:  o Microsoft Windows Server 2008 (builtin)
   72:  o Microsoft Windows Server 2008 R2 (builtin)
   73:  o Microsoft Windows 7 Ultimate x64 (builtin)
   74:  o Microsoft Windows 8 Preview x64 (builtin)
   75:  o Microsoft iSCSI Initiator 2.08 on WS2003
   76:  o Intel iSCSI Remote Boot 2.1.22
   77:  o Intel iSCSI Remote Boot 2.3.81
   78:  o Intel iSCSI Remote Boot 2.5.12 (CT Desktop Adapter)
   79:  o Intel iSCSI Remote Boot 2.7.44 (ET Dual Port Server Adapter)
   80:  o Sun VirtualBOX 2.1.2 (builtin)
   81:  o Sun VirtualBOX 3.0.12 (builtin)
   82:  o Sun VirtualBOX 3.1.2 (builtin)
   83:  o VMware ESXi 3.5 Update 3 (builtin)
   84:  o VMware ESXi 4.0 (builtin)
   85:  o VMware ESXi 4.1 Update 1 (builtin)
   86:  o VMware ESXi 5.0 (builtin)
   87:  o VMware ESXi 5.1 (builtin)
   88:  o Xen Server 5.0 Update 3 (builtin)
   89:  o Xen Server 5.5 (builtin)
   90:  o FreeBSD 7.1 + iscsi 2.1.3
   91:  o FreeBSD 7.2 + iscsi 2.2.3
   92:  o FreeBSD 7.3 + iscsi 2.2.4
   93:  o FreeBSD 8.2 + isboot 0.2.3
   94:  o FreeBSD 9.1 + isboot 0.2.6
   95:  o CentOS 5.2 + Open-iSCSI (package)
   96:  o Ubuntu 9.10 + Open-iSCSI (package)
   97:  o gPXE 1.0.0 + VirtualBox 3.1.2 on FreeNAS 0.7.1
   98:  o iPXE 1.0.0 + isboot 0.2.5 + FreeBSD 9.1
   99:  o FreeNAS 0.7.1 (FreeBSD 7.2/7.3 + iscsi 2.2.4)
  100:  o FreeNAS 0.7.2 (FreeBSD 7.3 + iscsi 2.2.4)
  101:  o FreeNAS 0.7.5 (FreeBSD 9.0 + iscsi 2.3.1.0)
  102:  o NAS4Free 9.1.0.1 (FreeBSD 9.1 + iscsi 2.3.1.0)
  103: 
  104: Features:
  105:  o MCS/MPIO for failover (up to 255 concurrent sessions)
  106:  o Multipath I/O (only support Microsoft MPIO/VMware ESXi)
  107:  o SPC-3 Persistent Reservation for cluster nodes
  108:  o 64bit LBA for over 2TB
  109:  o Header/Data digest by CRC32C
  110:  o CHAP w/Mutual authentication
  111:  o Multiple LUNs and ACLs for portals
  112:  o IPv6/IPv4 dual support
  113:  (experimental features)
  114:  o Command Queuing (up to 255 depth, 32 by default)
  115:  o iSCSI boot with Intel PRO/1000 Server Adapters
  116:  o virtual DVD-ROM and virtual tape drive (DLT emulator)
  117:  o pass-through device (only support DA/SA/CD/CH type)
  118: 
  119: Current Limitations:
  120:  o can't create empty VirtualBox VirtualDisk.
  121:  o The parameters other than PG, IG, and LU are not reloaded by SIGHUP.
  122:  o PG and IG mapped to LU can't be deleted by SIGHUP.
  123:  o LU connected by the initiator can't be reloaded by SIGHUP.
  124:  o If you delete an active LU, all connections of the LU are closed by SIGHUP.
  125:  o Updating IG is not affected until the next login.
  126:  o logical unit is sharing with exclusive lock
  127:  o exclusive port w/asynchronous operation
  128:  o command queuing is incomplete for multiple initiators
  129:  o LUN1 and more are shared information of LUN0 (e.g. UnitInquiry)
  130:  o APTPL (Activate Persist Through Power Loss) is not supported
  131:  o TPGS is incomplete for multipath failover (disabled by default)
  132:  o path-through SA variable length must not exceed 65536 (CAM limit)
  133:  o maximum LUN is 63
  134:  o maximum PortalGroup are 1024
  135:  o maximum InitiatorGroup, LogicalUnit are 4096
  136:  o maximum mapping per target is 256
  137:  o maximum concurrent session identifier per target is 255
  138:  o maximum persistent reservation keys per target is 256
  139:  (most case of limitation is due to memory allocation and finding
  140:   method by linear search)
  141: 
  142: Special Thanks to:
  143: Isao Takatani (bug report and idea suggestion)
  144: Toshiya Shimpo of Meikohsha Information System Co.,Ltd
  145: Yoshio Takii of Meikohsha Information System Co.,Ltd
  146: 
  147: Author:
  148: Daisuke Aoyama <aoyama@peach.ne.jp>