1.\" Copyright (c) 2012 The FreeBSD Foundation 2.\" All rights reserved. 3.\" 4.\" This software was developed by Edward Tomasz Napierala under sponsorship 5.\" from the FreeBSD Foundation. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" $FreeBSD$ 29.\" 30.Dd March 31, 2020 31.Dt CTLD 8 32.Os 33.Sh NAME 34.Nm ctld 35.Nd CAM Target Layer / iSCSI target daemon 36.Sh SYNOPSIS 37.Nm 38.Op Fl d 39.Op Fl f Ar config-file 40.Op Fl u 41.Nm 42.Fl t 43.Op Fl f Ar config-file 44.Op Fl u 45.Sh DESCRIPTION 46The 47.Nm 48daemon is responsible for managing the CAM Target Layer configuration, 49accepting incoming iSCSI connections, performing authentication and 50passing connections to the kernel part of the native iSCSI target. 51.Pp 52Upon startup, the 53.Nm 54daemon parses the configuration file. 55If it encounters any errors, 56.Nm 57exits. 58It then compares the configuration with the kernel list of LUNs managed 59by previously running 60.Nm 61instances, removes LUNs no longer existing in the configuration file, 62and creates new LUNs as necessary. 63After that it listens for the incoming iSCSI connections, performs 64authentication, and, if successful, passes the connections to the kernel part 65of CTL iSCSI target, 66.Xr cfiscsi 4 , 67which handles it from that point. 68.Pp 69When it receives a SIGHUP signal, the 70.Nm 71reloads its configuration and applies the changes to the kernel. 72Changes are applied in a way that avoids unnecessary disruptions; 73for example removing one LUN does not affect other LUNs. 74.Pp 75When exiting gracefully, the 76.Nm 77daemon removes LUNs it managed and forcibly disconnects all the clients. 78Otherwise - for example, when killed with SIGKILL - LUNs stay configured 79and clients remain connected. 80.Pp 81To perform administrative actions that apply to already connected 82sessions, such as forcing termination, use 83.Xr ctladm 8 . 84.Pp 85The following options are available: 86.Bl -tag -width ".Fl P Ar pidfile" 87.It Fl f Ar config-file 88Specifies the name of the configuration file. 89The default is 90.Pa /etc/ctl.conf . 91.It Fl d 92Debug mode. 93The daemon sends verbose debug output to standard error, and does not 94put itself in the background. 95The daemon will also not fork and will exit after processing one connection. 96This option is only intended for debugging the target. 97.It Fl t 98Test the configuration file for validity and exit. 99.It Fl u 100Use UCL configuration file format instead of the traditional non-UCL format. 101.El 102.Sh FILES 103.Bl -tag -width ".Pa /var/run/ctld.pid" -compact 104.It Pa /etc/ctl.conf 105The configuration file for 106.Nm . 107The file format and configuration options are described in 108.Xr ctl.conf 5 . 109.It Pa /var/run/ctld.pid 110The default location of the 111.Nm 112PID file. 113.El 114.Sh EXIT STATUS 115The 116.Nm 117utility exits 0 on success, and >0 if an error occurs. 118.Sh SEE ALSO 119.Xr cfiscsi 4 , 120.Xr ctl 4 , 121.Xr ctl.conf 5 , 122.Xr ctladm 8 , 123.Xr ctlstat 8 124.Sh HISTORY 125The 126.Nm 127command appeared in 128.Fx 10.0 . 129.Sh AUTHORS 130The 131.Nm 132was developed by 133.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org 134under sponsorship from the FreeBSD Foundation. 135