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