1 .\" Copyright (c) 2015 Baptiste Daroussin <bapt@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
30 .Nd Utility for managing SCSI Enclosure Services (SES) device
35 .Ar disk Ns | Ns Cm all
47 .Ar disk Ns | Ns Cm all
56 .Op Fl -libxo Ar options
60 .Op Fl -libxo Ar options
64 .Op Fl -libxo Ar options
69 utility can be used to query and modify various parameter of SCSI Enclosure
70 Services (SES) devices.
72 List of supported commands:
73 .Bl -tag -width indent
74 .It Cm fault Oo Fl u Ar /dev/sesN Oc Ar disk Ns | Ns Cm all Cm on Ns | Ns Cm off
75 Change the state of the external fault LED associated with
78 can be the device name of the disk, like
82 to indicate all disks attached to SES controllers.
83 .It Cm fault Fl u Ar /dev/sesN Ar sesid Cm on Ns | Ns Cm off
84 Change the state of the external fault LED associated with an element
85 connected to the SES controller.
87 must be the element ID of a valid item attached to the controller.
90 command to list the elements attached to a controller.
91 .It Cm locate Oo Fl u Ar /dev/sesN Oc Ar disk Ns | Ns Cm all Cm on Ns | Ns Cm off
92 Change the state of the external locate LED associated with
95 can be the device name of the disk, like
99 to indicate all disks attached to SES controllers.
100 .It Cm locate Fl u Ar /dev/sesN Ar sesid Cm on Ns | Ns Cm off
101 Change the state of the external locate LED associated with an element
102 connected to the SES controller.
104 must be the element ID of a valid item attached to the controller.
107 command to list the elements attached to a controller.
108 .It Cm map Oo Fl -libxo Ar options Oc Op Fl u Ar /dev/sesN
109 Display a map of all elements connected to the specified
112 If no controller is specified, all controllers are mapped.
113 .It Cm show Oo Fl -libxo Ar options Oc Op Fl u Ar /dev/sesN
114 Display user-friendly summary of specified
117 If no controller is specified, all controllers are mapped.
118 .It Cm status Oo Fl -libxo Ar options Oc Op Fl u Ar /dev/sesN
119 Display the status of the specified
122 If no controller is specified, the status of each controller is returned.
126 .Bl -tag -width indent
127 .It Fl -libxo Ar options
130 in a selection of different human and machine readable formats.
135 Turn off all locate LEDs:
137 .Dl Nm Cm locate all off
139 Turn on the locate LED for the drive bay corresponding to
142 .Dl Nm Cm locate da15 on
144 Turn on the fault LED for a drive bay not associated with a device:
146 .Dl Nm Cm fault -u /dev/ses2 7 on
149 .Xr xo_parse_args 3 ,
154 utility first appeared in
160 utility was written by
161 .An Baptiste Daroussin Aq Mt bapt@FreeBSD.org
163 .An Allan Jude Aq Mt allanjude@FreeBSD.org .