xref: /openbsd/usr.sbin/iscsictl/iscsictl.8 (revision 4bdff4be)
1.\"	$OpenBSD: iscsictl.8,v 1.7 2021/05/05 12:34:12 claudio Exp $
2.\"
3.\" Copyright (c) 2010 David Gwynne <dlg@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: May 5 2021 $
18.Dt ISCSICTL 8
19.Os
20.Sh NAME
21.Nm iscsictl
22.Nd control the Internet SCSI (iSCSI) daemon
23.Sh SYNOPSIS
24.Nm
25.Op Fl s Ar socket
26.Ar command
27.Op Ar argument ...
28.Sh DESCRIPTION
29The
30.Nm
31program controls the
32.Xr iscsid 8
33daemon.
34Commands may be abbreviated to the minimum unambiguous prefix.
35.Pp
36The following options are available:
37.Bl -tag -width Ds
38.It Fl s Ar socket
39Use
40.Ar socket
41instead of the default
42.Pa /var/run/iscsid.sock
43to communicate with
44.Xr iscsid 8 .
45.El
46.Pp
47The following commands are available:
48.Bl -tag -width Ds
49.It Cm reload
50Reload the configuration file and wait to return until iscsid reports all
51connections have completed (successfully or otherwise), or for up to 10
52seconds.
53.It Cm show Op Cm summary
54Show a list of all configured sessions.
55.It Cm show Cm vscsi stats
56Show statistics of
57.Xr vscsi 4
58usage.
59It shows how many calls were issued and how many bytes were read or written.
60.El
61.Sh FILES
62.Bl -tag -width "/var/run/iscsid.sockXX" -compact
63.It Pa /etc/iscsi.conf
64Default
65.Xr iscsid 8
66configuration file.
67.It Pa /var/run/iscsid.sock
68.Ux Ns -domain
69socket used for communication with
70.Xr iscsid 8 .
71.El
72.Sh SEE ALSO
73.Xr iscsi.conf 5 ,
74.Xr iscsid 8
75.Sh HISTORY
76The
77.Nm
78program first appeared in
79.Ox 4.9 .
80