usr.sbin/iscsid/iscsid.8

   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 ISCSID 8
  32 .Os
  33 .Sh NAME
  34 .Nm iscsid
  35 .Nd iSCSI initiator daemon
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl P Ar pidfile
  39 .Op Fl d
  40 .Op Fl l Ar loglevel
  41 .Op Fl m Ar maxproc
  42 .Op Fl t Ar seconds
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 daemon is the userspace component of the iSCSI initiator,
  47 responsible for performing the Login Phase
  48 of iSCSI connections and the SendTargets discovery.
  49 .Pp
  50 Upon startup, the
  51 .Nm
  52 daemon opens the iSCSI initiator device file and waits for requests
  53 from the kernel component,
  54 .Xr iscsi 4 .
  55 .Nm
  56 does not use any configuration files.
  57 All needed information is supplied by the kernel.
  58 .Pp
  59 When the
  60 .Nm
  61 daemon is not running, already established iSCSI connections continue
  62 to work.
  63 However, establishing new connections, or recovering existing ones in case
  64 of connection error, is not possible.
  65 .Pp
  66 The following options are available:
  67 .Bl -tag -width ".Fl P Ar pidfile"
  68 .It Fl P Ar pidfile
  69 Specify alternative location of a file where main process PID will be stored.
  70 The default location is
  71 .Pa /var/run/iscsid.pid .
  72 .It Fl d
  73 Debug mode.
  74 The daemon sends verbose debug output to standard error, and does not
  75 put itself in the background.
  76 The daemon will also not fork and will exit after processing one connection.
  77 This option is only intended for debugging the initiator.
  78 .It Fl l Ar loglevel
  79 Specifies debug level.
  80 The default is 0.
  81 .It Fl m Ar maxproc
  82 Specifies limit for concurrently running child processes handling
  83 connections.
  84 The default is 30.
  85 Setting it to 0 disables the limit.
  86 .It Fl t Ar seconds
  87 Specifies timeout for login session, after which the connection
  88 will be forcibly terminated.
  89 The default is 60.
  90 Setting it to 0 disables the timeout.
  91 .El
  92 .Sh FILES
  93 .Bl -tag -width ".Pa /var/run/iscsid.pid" -compact
  94 .It Pa /dev/iscsi
  95 The iSCSI initiator device file.
  96 .It Pa /var/run/iscsid.pid
  97 The default location of the
  98 .Nm
  99 PID file.
 100 .El
 101 .Sh EXIT STATUS
 102 The
 103 .Nm
 104 utility exits 0 on success, and >0 if an error occurs.
 105 .Sh SEE ALSO
 106 .Xr iscsi 4 ,
 107 .Xr iscsictl 8
 108 .Sh HISTORY
 109 The
 110 .Nm
 111 command appeared in
 112 .Fx 10.0 .
 113 .Sh AUTHORS
 114 The
 115 .Nm
 116 utility was developed by
 117 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
 118 under sponsorship from the FreeBSD Foundation.