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 23, 2018 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.Sh DESCRIPTION 42The 43.Nm 44daemon is responsible for managing the CAM Target Layer configuration, 45accepting incoming iSCSI connections, performing authentication and 46passing connections to the kernel part of the native iSCSI target. 47.Pp 48Upon startup, the 49.Nm 50daemon parses the configuration file. 51If it encounters any errors, 52.Nm 53exits. 54It then compares the configuration with the kernel list of LUNs managed 55by previously running 56.Nm 57instances, removes LUNs no longer existing in the configuration file, 58and creates new LUNs as necessary. 59After that it listens for the incoming iSCSI connections, performs 60authentication, and, if successful, passes the connections to the kernel part 61of CTL iSCSI target, 62.Xr cfiscsi 4 , 63which handles it from that point. 64.Pp 65When it receives a SIGHUP signal, the 66.Nm 67reloads its configuration and applies the changes to the kernel. 68Changes are applied in a way that avoids unnecessary disruptions; 69for example removing one LUN does not affect other LUNs. 70.Pp 71When exiting gracefully, the 72.Nm 73daemon removes LUNs it managed and forcibly disconnects all the clients. 74Otherwise - for example, when killed with SIGKILL - LUNs stay configured 75and clients remain connected. 76.Pp 77To perform administrative actions that apply to already connected 78sessions, such as forcing termination, use 79.Xr ctladm 8 . 80.Pp 81The following options are available: 82.Bl -tag -width ".Fl P Ar pidfile" 83.It Fl f Ar config-file 84Specifies the name of the configuration file. 85The default is 86.Pa /etc/ctl.conf . 87.It Fl d 88Debug mode. 89The daemon sends verbose debug output to standard error, and does not 90put itself in the background. 91The daemon will also not fork and will exit after processing one connection. 92This option is only intended for debugging the target. 93.It Fl u 94Use UCL configuration file format instead of the traditional non-UCL format. 95.El 96.Sh FILES 97.Bl -tag -width ".Pa /var/run/ctld.pid" -compact 98.It Pa /etc/ctl.conf 99The configuration file for 100.Nm . 101The file format and configuration options are described in 102.Xr ctl.conf 5 . 103.It Pa /var/run/ctld.pid 104The default location of the 105.Nm 106PID file. 107.El 108.Sh EXIT STATUS 109The 110.Nm 111utility exits 0 on success, and >0 if an error occurs. 112.Sh SEE ALSO 113.Xr cfiscsi 4 , 114.Xr ctl 4 , 115.Xr ctl.conf 5 , 116.Xr ctladm 8 , 117.Xr ctlstat 8 118.Sh HISTORY 119The 120.Nm 121command appeared in 122.Fx 10.0 . 123.Sh AUTHORS 124The 125.Nm 126was developed by 127.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org 128under sponsorship from the FreeBSD Foundation. 129