xref: /openbsd-src/usr.sbin/iscsictl/iscsictl.8 (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1.\"	$OpenBSD: iscsictl.8,v 1.6 2015/07/27 17:28:39 sobrado 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: July 27 2015 $
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.
51.It Cm show Op Cm summary
52Show a list of all configured sessions.
53.It Cm show Cm vscsi stats
54Show statistics of
55.Xr vscsi 4
56usage.
57It shows how many calls were issued and how many bytes were read or written.
58.El
59.Sh FILES
60.Bl -tag -width "/var/run/iscsid.sockXX" -compact
61.It Pa /etc/iscsi.conf
62Default
63.Xr iscsid 8
64configuration file.
65.It Pa /var/run/iscsid.sock
66.Ux Ns -domain
67socket used for communication with
68.Xr iscsid 8 .
69.El
70.Sh SEE ALSO
71.Xr iscsi.conf 5 ,
72.Xr iscsid 8
73.Sh HISTORY
74The
75.Nm
76program first appeared in
77.Ox 4.9 .
78