xref: /freebsd/usr.sbin/sesutil/sesutil.8 (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
1.\" Copyright (c) 2015 Baptiste Daroussin <bapt@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd September 6, 2015
28.Dt SESUTIL 8
29.Os
30.Sh NAME
31.Nm sesutil
32.Nd Utility for managing SCSI Enclosure Services (SES) device
33.Sh SYNOPSIS
34.Nm
35.Cm fault
36.Op Fl u Ar /dev/sesN
37.Aq Ar disk | Ar sesid | Li all
38.Op on | off
39.Nm
40.Cm locate
41.Op Fl u Ar /dev/sesN
42.Aq Ar disk | Ar sesid | Li all
43.Op on | off
44.Nm
45.Cm map
46.Op Fl u Ar /dev/sesN
47.Nm
48.Cm status
49.Op Fl u Ar /dev/sesN
50.Sh DESCRIPTION
51The
52.Nm
53utility can be used to query and modify various parameter of SCSI Enclosure
54Services (SES) devices.
55.Pp
56List of supported commands:
57.Bl -tag -width indent
58.It Cm fault Oo Fl u Ar /dev/sesN Oc Ao Ar disk | Li all Ac Op on | off
59Change the state of the external fault LED associated with
60.Ar disk .
61.Ar disk
62can be the device name of the disk, like
63.Cm da12 ,
64or
65.Ql all .
66to indicate all disks attached to SES controllers.
67.It Cm fault Fl u Ar /dev/sesN Ar sesid Op on | off
68Change the state of the external fault LED associated with an element
69connected to the SES controller.
70.Ar sesid
71must be the element ID of a valid item attached to the controller.
72Use the
73.Cm map
74command to list the elements attached to a controller.
75.It Cm locate Oo Fl u Ar /dev/sesN Oc Ao Ar disk | Li all Ac Op on | off
76Change the state of the external locate LED associated with
77.Ar disk .
78.Ar disk
79can be the device name of the disk, like
80.Cm da12 ,
81or
82.Ql all .
83to indicate all disks attached to SES controllers.
84.It Cm locate Fl u Ar /dev/sesN Ar sesid Op on | off
85Change the state of the external locate LED associated with an element
86connected to the SES controller.
87.Ar sesid
88must be the element ID of a valid item attached to the controller.
89Use the
90.Cm map
91command to list the elements attached to a controller.
92.It Cm map Op Fl u Ar /dev/sesN
93Display a map of all elements connected to the specified
94.Xr ses 4
95controller.
96If no controller is specified, all controllers are mapped.
97.It Cm status Op Fl u Ar /dev/sesN
98Display the status of the specified
99.Xr ses 4
100controller.
101If no controller is specified, the status of each controller is returned.
102.El
103.Sh EXAMPLES
104Turn off all locate LEDs:
105.Pp
106.Dl Nm Cm locate all off
107.Pp
108Turn on the locate LED for the drive bay corresponding to
109.Pa da15 :
110.Pp
111.Dl Nm Cm locate da15 on
112.Pp
113Turn on the fault LED for a drive bay not associated with a device:
114.Pp
115.Dl Nm Cm fault -u /dev/ses2 7 on
116.Sh SEE ALSO
117.Xr ses 4
118.Sh HISTORY
119The
120.Nm
121utility first appeared in
122.Fx 11.0 .
123.Sh AUTHORS
124.An -nosplit
125The
126.Nm
127utility was written by
128.An Baptiste Daroussin Aq Mt bapt@FreeBSD.org
129and
130.An Allan Jude Aq Mt allanjude@FreeBSD.org .
131