Copyright (c) 2007-2010 Daniel Braniss <danny@cs.huji.ac.il>
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
.Dd February 25, 2022 .Dt ISCSI.CONF 5 .Os .Sh NAME .Nm iscsi.conf .Nd iSCSI initiator configuration file .Sh DESCRIPTION The .Nm configuration file is used by the .Xr iscsictl 8 utility. The general syntax is: f Li d -literal # this is a comment nickname_1 { variable = value; ... } nickname_2 { variable = value; ... } ... .Ed .Ef l -tag -width MaxConnections t Cm AuthMethod Sets the authentication type. Type can be either .Qq Ar None , or .Qq Ar CHAP . Default is .Qq Ar None . When set to .Cm CHAP , both .Cm chapIName and .Cm chapSecret must be defined. t Cm chapIName Login for CHAP authentication. t Cm chapSecret Secret for CHAP authentication. t Cm tgtChapName Target login for Mutual CHAP authentication. t Cm tgtChapSecret Target secret for Mutual CHAP authentication. t Cm HeaderDigest Sets the header digest; a checksum calculated over the header of iSCSI PDUs, and verified on receive. Digest can be either .Qq Ar None , or .Qq Ar CRC32C . Default is .Qq Ar None . t Cm DataDigest Sets the data digest; a checksum calculated over the Data Section of iSCSI PDUs, and verified on receive. Digest can be either .Qq Ar None , or .Qq Ar CRC32C . Default is .Qq Ar None . t Cm InitiatorName Sets the initiator name. By default, the name is concatenation of .Qq Ar iqn.1994-09.org.freebsd: with the hostname. t Cm TargetName Sets the target name. Not required for discovery sessions. t Cm TargetAddress Sets the target address and port, in .Sy address[:port] format. The .Sy address can be either an IP address, or hostname. The optional port defaults to 3260. t Cm SessionType Sets the session type. Type can be either .Qq Ar Discovery , or .Qq Ar Normal . Default is .Qq Ar Normal . For normal sessions, the .Sy TargetName must be defined. Discovery sessions result in the initiator connecting to all the targets returned by SendTargets iSCSI discovery with the defined .Sy TargetAddress . t Cm Enable Enable or disable the session. State can be either .Qq Ar On , or .Qq Ar Off . Default is .Qq Ar On . t Cm Offload Name of selected iSCSI hardware offload driver. Default is .Qq Ar None . t Cm Protocol Name of selected protocol. It can be either .Qq Ar iSER , for iSCSI over RDMA, or .Qq Ar iSCSI . Default is .Qq Ar iSCSI . t Cm dscp The DiffServ Codepoint used for sending data. The DSCP can be set to numeric, or hexadecimal values directly, as well as the well-defined .Qq Ar cs<n> and .Qq Ar af<xx> codepoints. Default is no specified dscp codepoint, which means the default of the outgoing interface is used. t Cm pcp The 802.1Q Priority CodePoint used for sending packets. The PCP can be set to a value in the range between .Qq Ar 0 to .Qq Ar 7 . When omitted, the default for the outgoing interface is used. t Cm PingTimeout Specify the time in seconds to wait between pings (SCSI NOP), and for a ping response before declaring the session as dead and attempting a re-establishment. If this entry is not present in the conf file, the default value configured using .Qq Ar kern.iscsi.ping_timeout (default at .Qq Ar 5 seconds) is taken by the driver. If present, the PingTimeout can be set to any positive value starting with .Qq Ar 1 . t Cm LoginTimeout Specify the time in seconds to wait for a login PDU to be sent or received after trying to establish a new session. When no login PDU is received within this time, the login on a particular connection fails and a new reconnection attempt is made. If this entry is not present in the conf file, the default value of .Qq Ar 60 seconds is used, as configured by .Qq Ar kern.iscsi.login_timeout . The LoginTimeout can be set to any positive value starting with .Qq Ar 1 . .El .Sh FILES l -tag -width indent t Pa /etc/iscsi.conf .El .Sh EXAMPLES d -literal myiscsi { # nickname targetaddress = iscsi1 targetname = iqn.1900.com.com:sn.123456 } myiscsi6 { # nickname targetaddress = [2001:db8::de:ef]:3260 targetname = iqn.1900.com.com:sn.123456 } chaptest { targetaddress = 10.0.0.1; targetname = iqn.1900.com.com:sn.123456; initiatorname = iqn.2005-01.il.ac.huji.cs:nobody; authmethod = CHAP; chapiname = iqn.2005-01.il.ac.huji.cs:nobody; chapsecret = "secretsecret"; } .Ed .Sh SEE ALSO .Xr iscsictl 8 Sh HISTORY
Sh AUTHORS
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
.Dd February 25, 2022 .Dt ISCSI.CONF 5 .Os .Sh NAME .Nm iscsi.conf .Nd iSCSI initiator configuration file .Sh DESCRIPTION The .Nm configuration file is used by the .Xr iscsictl 8 utility. The general syntax is: f Li d -literal # this is a comment nickname_1 { variable = value; ... } nickname_2 { variable = value; ... } ... .Ed .Ef l -tag -width MaxConnections t Cm AuthMethod Sets the authentication type. Type can be either .Qq Ar None , or .Qq Ar CHAP . Default is .Qq Ar None . When set to .Cm CHAP , both .Cm chapIName and .Cm chapSecret must be defined. t Cm chapIName Login for CHAP authentication. t Cm chapSecret Secret for CHAP authentication. t Cm tgtChapName Target login for Mutual CHAP authentication. t Cm tgtChapSecret Target secret for Mutual CHAP authentication. t Cm HeaderDigest Sets the header digest; a checksum calculated over the header of iSCSI PDUs, and verified on receive. Digest can be either .Qq Ar None , or .Qq Ar CRC32C . Default is .Qq Ar None . t Cm DataDigest Sets the data digest; a checksum calculated over the Data Section of iSCSI PDUs, and verified on receive. Digest can be either .Qq Ar None , or .Qq Ar CRC32C . Default is .Qq Ar None . t Cm InitiatorName Sets the initiator name. By default, the name is concatenation of .Qq Ar iqn.1994-09.org.freebsd: with the hostname. t Cm TargetName Sets the target name. Not required for discovery sessions. t Cm TargetAddress Sets the target address and port, in .Sy address[:port] format. The .Sy address can be either an IP address, or hostname. The optional port defaults to 3260. t Cm SessionType Sets the session type. Type can be either .Qq Ar Discovery , or .Qq Ar Normal . Default is .Qq Ar Normal . For normal sessions, the .Sy TargetName must be defined. Discovery sessions result in the initiator connecting to all the targets returned by SendTargets iSCSI discovery with the defined .Sy TargetAddress . t Cm Enable Enable or disable the session. State can be either .Qq Ar On , or .Qq Ar Off . Default is .Qq Ar On . t Cm Offload Name of selected iSCSI hardware offload driver. Default is .Qq Ar None . t Cm Protocol Name of selected protocol. It can be either .Qq Ar iSER , for iSCSI over RDMA, or .Qq Ar iSCSI . Default is .Qq Ar iSCSI . t Cm dscp The DiffServ Codepoint used for sending data. The DSCP can be set to numeric, or hexadecimal values directly, as well as the well-defined .Qq Ar cs<n> and .Qq Ar af<xx> codepoints. Default is no specified dscp codepoint, which means the default of the outgoing interface is used. t Cm pcp The 802.1Q Priority CodePoint used for sending packets. The PCP can be set to a value in the range between .Qq Ar 0 to .Qq Ar 7 . When omitted, the default for the outgoing interface is used. t Cm PingTimeout Specify the time in seconds to wait between pings (SCSI NOP), and for a ping response before declaring the session as dead and attempting a re-establishment. If this entry is not present in the conf file, the default value configured using .Qq Ar kern.iscsi.ping_timeout (default at .Qq Ar 5 seconds) is taken by the driver. If present, the PingTimeout can be set to any positive value starting with .Qq Ar 1 . t Cm LoginTimeout Specify the time in seconds to wait for a login PDU to be sent or received after trying to establish a new session. When no login PDU is received within this time, the login on a particular connection fails and a new reconnection attempt is made. If this entry is not present in the conf file, the default value of .Qq Ar 60 seconds is used, as configured by .Qq Ar kern.iscsi.login_timeout . The LoginTimeout can be set to any positive value starting with .Qq Ar 1 . .El .Sh FILES l -tag -width indent t Pa /etc/iscsi.conf .El .Sh EXAMPLES d -literal myiscsi { # nickname targetaddress = iscsi1 targetname = iqn.1900.com.com:sn.123456 } myiscsi6 { # nickname targetaddress = [2001:db8::de:ef]:3260 targetname = iqn.1900.com.com:sn.123456 } chaptest { targetaddress = 10.0.0.1; targetname = iqn.1900.com.com:sn.123456; initiatorname = iqn.2005-01.il.ac.huji.cs:nobody; authmethod = CHAP; chapiname = iqn.2005-01.il.ac.huji.cs:nobody; chapsecret = "secretsecret"; } .Ed .Sh SEE ALSO .Xr iscsictl 8 Sh HISTORY
Sh AUTHORS