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