History log of /freebsd-current/usr.sbin/ctld/ctl.conf.5
Revision Date Author Comments
# fa9896e0 16-Aug-2023 Warner Losh <imp@FreeBSD.org>

Remove $FreeBSD$: two-line nroff pattern

Remove /^\.\\"\n\.\\"\s*\$FreeBSD\$$\n/


# ea8f1280 24-Oct-2020 Richard Scheffenegger <rscheff@FreeBSD.org>

Add network QoS support for PCP to iscsi target.

Mak the Ethernet PCP codepoint configurable
for L2 local traffic, to allow lower latency for
iSCSI block IO. This addresses the target
side only.

Reviewed by: mav, trasz, bcr
Sponsored by: NetApp, Inc.
Differential Revision: https://reviews.freebsd.org/D26740


# 915dcdb7 13-Oct-2020 Robert Wing <rew@FreeBSD.org>

ctl.conf(5): fix LUN size in UCL format example.

Remove quotes around size in the LUN section and change the suffix to 'GB'. The
UCL format does recognize 'G' on its own, which uses a base 10 multiplier where
'GB' uses a 2 power multiplier.

Document the difference between valid suffixes when using ctl.conf(5) in the
general syntax form or in UCL format.

Reviewed by: kevans, mav
Approved by: kevans (mentor)
Differential Revision: https://reviews.freebsd.org/D26716


# 64ffe6d4 27-Sep-2020 Richard Scheffenegger <rscheff@FreeBSD.org>

Add DSCP support for network QoS to iscsi target.

In order to prioritize iSCSI traffic across a network,
DSCP can be used. In order not to rely on "ipfw setdscp"
or in-network reclassification, this adds the dscp value
directly to the portal group (where TCP sessions are accepted).

The incoming iSCSI session is first handled by ctld for any
CHAP authentication and the socket is then handed off to the
in-kernel iscsi driver without modification of the socket
parameters. Simply setting up the socket in ctld is sufficient
to keep sending outgoing iSCSI related traffic with the
configured DSCP value.

Reviewed by: mav, trasz
MFC after: 2 weeks
Sponsored by: NetApp, Inc.
Differential Revision: https://reviews.freebsd.org/D26385


# 53ed4b30 10-Apr-2018 Edward Tomasz Napierala <trasz@FreeBSD.org>

Strip trailing whitespace.

MFC after: 2 weeks


# 2b30a69d 21-Jul-2016 Edward Tomasz Napierala <trasz@FreeBSD.org>

Add documentation for "ctld -u", the UCL configuration file format.

Submitted by: jceel@
Reviewed by: wblock@
MFC after: 3 days
Differential Revision: https://reviews.freebsd.org/D7222


# ba4a30ae 01-Jun-2016 Edward Tomasz Napierala <trasz@FreeBSD.org>

Describe default value for "offload".

MFC after: 1 month


# 398290f2 09-Nov-2015 Alexander Motin <mav@FreeBSD.org>

Introduce portal group options in ctl.conf.

While CTL has concept of port options, used at least for iSCSI ports now,
before this change it was impossible to set them manually. There still
no user-configurable port options now, but I am planning to change that.


# cf8f2fa2 02-Oct-2015 Alexander Motin <mav@FreeBSD.org>

Document CD block size of 2048.


# 91be33dc 27-Sep-2015 Alexander Motin <mav@FreeBSD.org>

Add to CTL initial support for CDROMs and removable devices.

Relnotes: yes


# 3933f7b1 15-Sep-2015 Alexander Motin <mav@FreeBSD.org>

Add ctl-lun config option for consistency in HA setups.


# db7bf2ba 07-Sep-2015 Alexander Motin <mav@FreeBSD.org>

Add two new portal group options "tag" and "foreign".

They are going to be useful in clustered setups.


# 10b5297f 03-Sep-2015 Edward Tomasz Napierala <trasz@FreeBSD.org>

Simplify the introductory example in ctl.conf(5) down to absolute
basics. The more complicated cases - like how to use physical
ports - are explained later, in the "EXAMPLES" section.

MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# d3219654 24-Aug-2015 Edward Tomasz Napierala <trasz@FreeBSD.org>

Some random tweaks to ctl.conf(5).

MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# d83595b2 24-Jun-2015 Alexander Motin <mav@FreeBSD.org>

Teach ctld about CTL's physical_port and virtual_port fields.

This allows ctld to work with isp(4) virtual ports, specifying them as
isp0/1, isp0/2, etc. There are still problems on isp(4) layer with
disabling those ports after enabling, but hopefully they can be fixed.

MFC after: 3 days
Sponsored by: iXsystems, Inc.


# 6775608b 21-Apr-2015 Edward Tomasz Napierala <trasz@FreeBSD.org>

Add hint about "volmode=dev" to ctl.conf(5).

Differential Revision: https://reviews.freebsd.org/D2328
Reviewed by: allanjude@, bcr@
MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# 3bac1be8 04-Mar-2015 Alexander Motin <mav@FreeBSD.org>

Add example configuration for FibreChannel ports.

MFC after: 1 week


# a9d78210 27-Feb-2015 Edward Tomasz Napierala <trasz@FreeBSD.org>

Move the "offload" clause from the target section to portal-group
section; it makes more sense there.

MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# 8774c018 11-Feb-2015 Edward Tomasz Napierala <trasz@FreeBSD.org>

Fix formatting.

MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# 057abcb0 07-Feb-2015 Alexander Motin <mav@FreeBSD.org>

Teach ctld(8) to control non-iSCSI CTL ports.

This change introduces new target option "port", that assigns current target
to specified CTL port. On config application ctld(8) will apply LUN mapping
according to target configuration to specified port and bring the port up.
On shutdown cltd(8) will remove the mapping and put the port down.

This change allows to configure both iSCSI and FibreChannel targets in the
same configuration file in alike way.

Kernel side support was added earlier at r278037.

MFC after: 2 weeks
Relnotes: yes
Sponsored by: iXsystems, Inc.


# 07b49a3e 06-Feb-2015 Edward Tomasz Napierala <trasz@FreeBSD.org>

Make it possible to set (via ctl.conf(5)) and query (via ctladm islist -v)
target iSCSI offload. Add mechanism to query maximum receive data segment
size supported by chosen hardware offload module, and use it in ctld(8)
to determine the value to advertise to the other side.

MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# 92847ee1 06-Feb-2015 Alexander Motin <mav@FreeBSD.org>

Add support for multiple portal groups per target.

This change allows multiple "portal-group" options to be specified per
target. Each of them may include new optional auth-group name parameter
to override per-target auth parameters for specific portal group.

Kernel side support was added earlier at r278161.

MFC after: 2 weeks
Sponsored by: iXsystems, Inc.


# 920c6cba 01-Feb-2015 Alexander Motin <mav@FreeBSD.org>

CTL LUN mapping rewrite.

Replace iSCSI-specific LUN mapping mechanism with new one, working for any
ports. By default all ports are created without LUN mapping, exposing all
CTL LUNs as before. But, if needed, LUN mapping can be manually set on
per-port basis via ctladm. For its iSCSI ports ctld does it via ioctl(2).
The next step will be to teach ctld to work with FibreChannel ports also.

Respecting additional flexibility of the new mechanism, ctl.conf now allows
alternative syntax for LUN definition. LUNs can now be defined in global
context, and then referenced from targets by unique name, as needed. It
allows same LUN to be exposed several times via multiple targets.

While there, increase limit for LUNs per target in ctld from 256 to 1024.
Some initiators do not support LUNs above 255, but that is not our problem.

Discussed with: trasz
MFC after: 2 weeks
Relnotes: yes
Sponsored by: iXsystems, Inc.


# b822a994 24-Nov-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Remove the pidfile clause from the ctl.conf example. Why do everyone
just copy/paste this line into their configs, it's beyond me.

MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# 6dbdbf82 09-Nov-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Add support for sending redirections to iSCSI target.

MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# 1195fe34 08-Nov-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Improve wording in ctl.conf(5).

Differential Revision: https://reviews.freebsd.org/D1020
Reviewed by: bcr@ (earlier version), wblock@
MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# 05374883 29-Oct-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Add discovery-filter. This makes it possible to restrict which targets
are returned during discovery based on initiator portal, name, and CHAP
credentials.

Reviewed by: mav@
MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# be6527d5 28-Oct-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Document iSNS defaults.

MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# 829603e2 24-Oct-2014 Alexander Motin <mav@FreeBSD.org>

Add basic iSNS client to the iSCSI target.

This makes ctld(8) register its iSCSI targets and portals on configured
iSNS servers to allow initiators find them without active discovery.

Fetching of allowed initiators from iSNS is not implemented now, so target
ACLs still should be configured manually.

Reviewed by: trasz@
MFC after: 1 month
Sponsored by: iXsystems, Inc.


# 3bea5b97 23-Oct-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Improve ctld.conf example.

MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# a178d09e 22-Oct-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Fix ctl.conf example to use proper paths to ZVOLs.

Sponsored by: The FreeBSD Foundation


# 4af184b9 22-Oct-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Remove misleading statement. Bump date.

MFC after: 1 month
Sponsored by: FreeBSD Foundation


# 3a6accd5 22-Oct-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Comment out parts about iSER; it's not implemented.

Sponsored by: The FreeBSD Foundation


# e2eb7f47 22-Oct-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Remove spurious empty line.

MFC after: 1 month
Sponsored by: The FreeBSD Foundation


# 4f66b233 14-Sep-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Fix two small nits in ctl.conf(5).

MFC after: 3 days
Sponsored by: The FreeBSD Foundation


# ce20734f 13-Sep-2014 Allan Jude <allanjude@FreeBSD.org>

Resolve an ambiguity with the definition of a new auth-group
Resolve a markup mistake

Reviewed by: trasz
Approved by: bcr (mentor), wblock (mentor)
Sponsored by: ScaleEngine Inc.
CR: https://reviews.freebsd.org/D735


# 263be6a9 11-Sep-2014 Allan Jude <allanjude@FreeBSD.org>

Fix minor syntax error

Submitted by: bjk
Approved by: bcr (mentor)
Sponsored by: ScaleEngine Inc.


# d1e933ed 11-Sep-2014 Allan Jude <allanjude@FreeBSD.org>

Improve markup and language throughout the ctl.conf man page

Reviewed by: trasz
Approved by: bcr (mentor)
Sponsored by: ScaleEngine Inc.


# a5f9f526 05-Sep-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Document initiator-portal netmask support.

MFC after: 2 weeks
Sponsored by: The FreeBSD Foundation


# 073edb1c 27-Jul-2014 Alexander Motin <mav@FreeBSD.org>

Add netmasks support to initiator-portal option.

MFC after: 2 weeks


# a8a5af86 20-Jul-2014 Warren Block <wblock@FreeBSD.org>

Correct spelling errors in ctld.8. While here, correct similar errors
in ctl.conf.5 and fix a couple of contractions.

PR: 191984
Submitted by: olgeni
MFC after: 1 week


# 01c2b8ac 20-Jun-2014 Baptiste Daroussin <bapt@FreeBSD.org>

use .Mt to mark up email addresses consistently (part2)

PR: 191174
Submitted by: Franco Fichtner <franco@lastsummer.de>


# c63d8c3b 24-Apr-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Style fixes.


# e76ce448 11-Feb-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Use new auth-type "deny" instead of using "chap" with no chap entries;
it's cleaner this way, and gives better feedback to the user.

Sponsored by: The FreeBSD Foundation


# ccb1f04d 11-Feb-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Use "default" as default discovery-auth-group, instead of "no-access".
It doesn't change visible behaviour, as previously auth-group "default"
wasn't redefinable, so by default access was always denied.

Sponsored by: The FreeBSD Foundation


# affb88f5 11-Feb-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Update manual page to match recent auth-group "default" changes.

Sponsored by: The FreeBSD Foundation


# df9900fb 11-Feb-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Add auth-type.

Sponsored by: The FreeBSD Foundation


# 8cb2e958 11-Feb-2014 Edward Tomasz Napierala <trasz@FreeBSD.org>

Implement initiator-name and initiator-portal restrictions.

Sponsored by: The FreeBSD Foundation


# 5292c670 02-Dec-2013 Edward Tomasz Napierala <trasz@FreeBSD.org>

Grammar fix.

MFC after: 3 days
Sponsored by: The FreeBSD Foundation


# c095756f 10-Nov-2013 Edward Tomasz Napierala <trasz@FreeBSD.org>

Fix typo.

Submitted by: feld@
MFC after: 3 days
Sponsored by: The FreeBSD Foundation


# 009ea47e 14-Sep-2013 Edward Tomasz Napierala <trasz@FreeBSD.org>

Bring in the new iSCSI target and initiator.

Reviewed by: ken (parts)
Approved by: re (delphij)
Sponsored by: FreeBSD Foundation