xref: /freebsd/usr.sbin/sesutil/sesutil.8 (revision eb69d1f144a6fcc765d1b9d44a5ae8082353e70b)
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 June 29, 2017
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 -libxo Ar options
47.Op Fl u Ar /dev/sesN
48.Nm
49.Cm status
50.Op Fl -libxo Ar options
51.Op Fl u Ar /dev/sesN
52.Sh DESCRIPTION
53The
54.Nm
55utility can be used to query and modify various parameter of SCSI Enclosure
56Services (SES) devices.
57.Pp
58List of supported commands:
59.Bl -tag -width indent
60.It Fl -libxo
61Generate output via
62.Xr libxo 3
63in a selection of different human and machine readable formats.
64See
65.Xr xo_parse_args 3
66.It Cm fault Oo Fl u Ar /dev/sesN Oc Ao Ar disk | Li all Ac Op on | off
67Change the state of the external fault LED associated with
68.Ar disk .
69.Ar disk
70can be the device name of the disk, like
71.Cm da12 ,
72or
73.Ql all .
74to indicate all disks attached to SES controllers.
75.It Cm fault Fl u Ar /dev/sesN Ar sesid Op on | off
76Change the state of the external fault LED associated with an element
77connected to the SES controller.
78.Ar sesid
79must be the element ID of a valid item attached to the controller.
80Use the
81.Cm map
82command to list the elements attached to a controller.
83.It Cm locate Oo Fl u Ar /dev/sesN Oc Ao Ar disk | Li all Ac Op on | off
84Change the state of the external locate LED associated with
85.Ar disk .
86.Ar disk
87can be the device name of the disk, like
88.Cm da12 ,
89or
90.Ql all .
91to indicate all disks attached to SES controllers.
92.It Cm locate Fl u Ar /dev/sesN Ar sesid Op on | off
93Change the state of the external locate LED associated with an element
94connected to the SES controller.
95.Ar sesid
96must be the element ID of a valid item attached to the controller.
97Use the
98.Cm map
99command to list the elements attached to a controller.
100.It Cm map Op Fl u Ar /dev/sesN
101Display a map of all elements connected to the specified
102.Xr ses 4
103controller.
104If no controller is specified, all controllers are mapped.
105.It Cm status Op Fl u Ar /dev/sesN
106Display the status of the specified
107.Xr ses 4
108controller.
109If no controller is specified, the status of each controller is returned.
110.El
111.Sh EXAMPLES
112Turn off all locate LEDs:
113.Pp
114.Dl Nm Cm locate all off
115.Pp
116Turn on the locate LED for the drive bay corresponding to
117.Pa da15 :
118.Pp
119.Dl Nm Cm locate da15 on
120.Pp
121Turn on the fault LED for a drive bay not associated with a device:
122.Pp
123.Dl Nm Cm fault -u /dev/ses2 7 on
124.Sh SEE ALSO
125.Xr libxo 3 ,
126.Xr xo_parse_args 3 ,
127.Xr ses 4
128.Sh HISTORY
129The
130.Nm
131utility first appeared in
132.Fx 11.0 .
133.Sh AUTHORS
134.An -nosplit
135The
136.Nm
137utility was written by
138.An Baptiste Daroussin Aq Mt bapt@FreeBSD.org
139and
140.An Allan Jude Aq Mt allanjude@FreeBSD.org .
141