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