1 .\" Copyright (c) 2012 The FreeBSD Foundation
2 .\" All rights reserved.
4 .\" This software was developed by Edward Tomasz Napierala under sponsorship
5 .\" from the FreeBSD Foundation.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
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.
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
35 .Nd CAM Target Layer / iSCSI target daemon
39 .Op Fl f Ar config-file
43 .Op Fl f Ar config-file
48 daemon is responsible for managing the CAM Target Layer configuration,
49 accepting incoming iSCSI connections, performing authentication and
50 passing connections to the kernel part of the native iSCSI target.
54 daemon parses the configuration file.
55 If it encounters any errors,
58 It then compares the configuration with the kernel list of LUNs managed
61 instances, removes LUNs no longer existing in the configuration file,
62 and creates new LUNs as necessary.
63 After that it listens for the incoming iSCSI connections, performs
64 authentication, and, if successful, passes the connections to the kernel part
67 which handles it from that point.
69 When it receives a SIGHUP signal, the
71 reloads its configuration and applies the changes to the kernel.
72 Changes are applied in a way that avoids unnecessary disruptions;
73 for example removing one LUN does not affect other LUNs.
75 When exiting gracefully, the
77 daemon removes LUNs it managed and forcibly disconnects all the clients.
78 Otherwise - for example, when killed with SIGKILL - LUNs stay configured
79 and clients remain connected.
81 To perform administrative actions that apply to already connected
82 sessions, such as forcing termination, use
85 The following options are available:
86 .Bl -tag -width ".Fl P Ar pidfile"
87 .It Fl f Ar config-file
88 Specifies the name of the configuration file.
93 The daemon sends verbose debug output to standard error, and does not
94 put itself in the background.
95 The daemon will also not fork and will exit after processing one connection.
96 This option is only intended for debugging the target.
98 Test the configuration file for validity and exit.
100 Use UCL configuration file format instead of the traditional non-UCL format.
103 .Bl -tag -width ".Pa /var/run/ctld.pid" -compact
105 The configuration file for
107 The file format and configuration options are described in
109 .It Pa /var/run/ctld.pid
110 The default location of the
117 utility exits 0 on success, and >0 if an error occurs.
133 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
134 under sponsorship from the FreeBSD Foundation.