usr.sbin/iscsid/iscsid.8

   1 .\" Copyright (c) 2012 The FreeBSD Foundation
   2 .\"
   3 .\" This software was developed by Edward Tomasz Napierala under sponsorship
   4 .\" from the FreeBSD Foundation.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .Dd May 28, 2017
  28 .Dt ISCSID 8
  29 .Os
  30 .Sh NAME
  31 .Nm iscsid
  32 .Nd iSCSI initiator daemon
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl P Ar pidfile
  36 .Op Fl d
  37 .Op Fl l Ar loglevel
  38 .Op Fl m Ar maxproc
  39 .Op Fl t Ar seconds
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 daemon is the userspace component of the iSCSI initiator,
  44 responsible for performing the Login Phase
  45 of iSCSI connections and the SendTargets discovery.
  46 .Pp
  47 Upon startup, the
  48 .Nm
  49 daemon opens the iSCSI initiator device file and waits for requests
  50 from the kernel component,
  51 .Xr iscsi 4 .
  52 .Nm
  53 does not use any configuration files.
  54 All needed information is supplied by the kernel.
  55 .Pp
  56 When the
  57 .Nm
  58 daemon is not running, already established iSCSI connections continue
  59 to work.
  60 However, establishing new connections, or recovering existing ones in case
  61 of connection error, is not possible.
  62 .Pp
  63 The following options are available:
  64 .Bl -tag -width ".Fl P Ar pidfile"
  65 .It Fl P Ar pidfile
  66 Specify alternative location of a file where main process PID will be stored.
  67 The default location is
  68 .Pa /var/run/iscsid.pid .
  69 .It Fl d
  70 Debug mode.
  71 The daemon sends verbose debug output to standard error, and does not
  72 put itself in the background.
  73 The daemon will also not fork and will exit after processing one connection.
  74 This option is only intended for debugging the initiator.
  75 .It Fl l Ar loglevel
  76 Specifies debug level.
  77 The default is 0.
  78 .It Fl m Ar maxproc
  79 Specifies limit for concurrently running child processes handling
  80 connections.
  81 The default is 30.
  82 Setting it to 0 disables the limit.
  83 .It Fl t Ar seconds
  84 Specifies timeout for login session, after which the connection
  85 will be forcibly terminated.
  86 The default is 60.
  87 Setting it to 0 disables the timeout.
  88 .El
  89 .Sh FILES
  90 .Bl -tag -width ".Pa /var/run/iscsid.pid" -compact
  91 .It Pa /dev/iscsi
  92 The iSCSI initiator device file.
  93 .It Pa /var/run/iscsid.pid
  94 The default location of the
  95 .Nm
  96 PID file.
  97 .El
  98 .Sh EXIT STATUS
  99 The
 100 .Nm
 101 utility exits 0 on success, and >0 if an error occurs.
 102 .Sh SEE ALSO
 103 .Xr iscsi 4 ,
 104 .Xr iscsictl 8
 105 .Sh HISTORY
 106 The
 107 .Nm
 108 command appeared in
 109 .Fx 10.0 .
 110 .Sh AUTHORS
 111 The
 112 .Nm
 113 utility was developed by
 114 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
 115 under sponsorship from the FreeBSD Foundation.