doc iscsid.conf values

git-svn-id: svn://svn.berlios.de/open-iscsi@732 d7303112-9cec-0310-bdd2-e83a94d6c2b6

1 files changed, 143 insertions, 14 deletions

diff --git a/etc/iscsid.conf b/etc/iscsid.conf
index 61d46b2..2c38056 100644
--- a/etc/iscsid.conf
+++ b/etc/iscsid.conf
@@ -1,24 +1,153 @@
 #
 # Open-iSCSI default configuration.
-# Could be located at /etc/iscsid.conf or ~/.iscsid.conf
+# Could be located at /etc/iscsi/iscsid.conf or ~/.iscsid.conf
 #
-node.active_cnx = 1
+# Note: To set any of these values for a specific node/session run
+# the iscsiadm --mpde node --op command for the value. See the README
+# and man page for iscsiadm for details on the --op command.
+#
+
+#*****************
+# Startup settings
+#*****************
+
+# To request that the iscsi initd scripts startup a session set to "automatic".
+# node.startup = automatic
+#
+# To manually startup the session set to "manual". The default is manual.
 node.startup = manual
-#node.session.auth.username = dima
-#node.session.auth.password = aloha
+
+# *************
+# CHAP Settings
+# *************
+
+# To enable CHAP authentication set node.session.auth.authmethod
+# to CHAP. The default is None.
+#node.session.auth.authmethod = CHAP
+
+# To set a CHAP username and password for initiator
+# authentication by the target(s), uncomment the following lines:
+#node.session.auth.username = username
+#node.session.auth.password = password
+
+# To set a CHAP username and password for target(s)
+# authentication by the initiator, uncomment the following lines:
+#node.session.auth.username_in = username_in
+#node.session.auth.password_in = password_in
+
+# To enable CHAP authentication for a discovery session to the target
+# set discovery.sendtargets.auth.authmethod to CHAP. The default is None.
+#discovery.sendtargets.auth.authmethod = CHAP
+
+# To set a discovery session CHAP username and password for the initiator
+# authentication by the target(s), uncomment the following lines:
+#discovery.sendtargets.auth.username = username
+#discovery.sendtargets.auth.password = password
+
+# To set a discovery session CHAP username and password for target(s)
+# authentication by the initiator, uncomment the following lines:
+#discovery.sendtargets.auth.username_in = username_in
+#discovery.sendtargets.auth.password_in = password_in
+
+# ********
+# Timeouts
+# ********
+
+# To specify the length of time to wait for session re-establishment
+# before failing SCSI commands back to the application when running
+# the Linux SCSI Layer error handler, edit the line.
+# The value is in seconds and the default is 120 seconds.
 node.session.timeo.replacement_timeout = 120
-node.session.err_timeo.abort_timeout = 10
-node.session.err_timeo.reset_timeout = 30
+
+# To specify the time to wait for login to complete, edit the line.
+# The value is in seconds and the default is 15 seconds.
+node.conn[0].timeo.login_timeout = 15
+
+# To specify the time to wait for logout to complete, edit the line.
+# The value is in seconds and the default is 15 seconds.
+node.conn[0].timeo.logout_timeout = 15
+
+# To specify the intervale to send iSCSI Nop-outs as pings
+# to the target edit this the line.
+# The value is in seconds and the default is 15 seconds.
+node.conn[0].timeo.noop_out_interval = 15
+
+# To specify the time to wait for a Nop-out response before failing
+# the connection, edit this line. Failing the connection will
+# cause IO to be failed back to the SCSI layer. If using dm-multipath
+# this will cause the IO to be failed to the multipath layer.
+# The value is in seconds and the default is 15 seconds.
+node.conn[0].timeo.timeo.noop_out_timeout = 15
+
+#***************
+# iSCSI settings
+#***************
+
+# To enable R2T flow control (i.e., the initiator must wait for an R2T
+# command before sending any data), uncomment the following line:
+#
+#node.session.iscsi.InitialR2T = Yes
+#
+# To disable R2T flow control (i.e., the initiator has an implied
+# initial R2T of "FirstBurstLength" at offset 0), uncomment the following line:
+#
+# The defaults is No.
 node.session.iscsi.InitialR2T = No
+
+#
+# To disable immediate data (i.e., the initiator does not send
+# unsolicited data with the iSCSI command PDU), uncomment the following line:
+#
+#node.session.iscsi.ImmediateData = No
+#
+# To enable immediate data (i.e., the initiator sends unsolicited data
+# with the iSCSI command packet), uncomment the following line:
+#
+# The default is Yes
 node.session.iscsi.ImmediateData = Yes
+
+# To specify the maximum number of unsolicited data bytes the initiator
+# can send in an iSCSI PDU to a target, edit the following line.
+#
+# The value is the number of bytes in the range of 512 to (2^24-1) and
+# the default is 262144
 node.session.iscsi.FirstBurstLength = 262144
+
+# To specify the maximum SCSI payload that the initiator will negotiate
+# with the target for, edit the following line.
+#
+# The value is the number of bytes in the range of 512 to (2^24-1) and
+# the defauls it 16776192
 node.session.iscsi.MaxBurstLength = 16776192
-node.session.iscsi.DefaultTime2Wait = 0
-node.session.iscsi.DefaultTime2Retain = 0
-node.session.iscsi.MaxConnections = 0
-node.conn[0].iscsi.HeaderDigest = None
-node.conn[0].iscsi.DataDigest = None
+
+# To specify the maximum number of data bytes the initiator can receive
+# in an iSCSI PDU from a target, edit the following line.
+#
+# The value is the number of bytes in the range of 512 to (2^24-1) and
+# the default is 65536
 node.conn[0].iscsi.MaxRecvDataSegmentLength = 65536
-#discovery.sendtargets.auth.authmethod = CHAP
-#discovery.sendtargets.auth.username = dima
-#discovery.sendtargets.auth.password = aloha
+
+# To allow the targets to control the setting of the digest checking,
+# with the initiator requesting a preference of enabling the checking, uncomment# one or both of the following lines:
+#node.conn[0].iscsi.HeaderDigest = CRC32C,None
+#node.conn[0].iscsi.DataDigest = CRC32C,None
+#
+# To allow the targets to control the setting of the digest checking,
+# with the initiator requesting a preference of disabling the checking,
+# uncomment one or both of the following lines:
+#node.conn[0].iscsi.HeaderDigest = None,CRC32C
+#node.conn[0].iscsi.DataDigest = None,CRC32C
+#
+# To enable CRC32C digest checking for the header and/or data part of
+# iSCSI PDUs, uncomment one or both of the following lines:
+#node.conn[0].iscsi.HeaderDigest = CRC32C
+#node.conn[0].iscsi.DataDigest = CRC32C
+#
+# To disable digest checking for the header and/or data part of
+# iSCSI PDUs, uncomment one or both of the following lines:
+#node.conn[0].iscsi.HeaderDigest = None
+#node.conn[0].iscsi.DataDigest = None
+#
+# The default is to never use DataDigests and to allow the target to control
+# the setting of the HeaderDigest checking with the initiator requesting
+# a preference of disabling the checking.