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
32 .Nd Utility for managing SCSI Enclosure Services (SES) device
37 .Ar disk Ns | Ns Cm all
49 .Ar disk Ns | Ns Cm all
58 .Op Fl -libxo Ar options
62 .Op Fl -libxo Ar options
66 .Op Fl -libxo Ar options
71 utility can be used to query and modify various parameter of SCSI Enclosure
72 Services (SES) devices.
74 List of supported commands:
75 .Bl -tag -width indent
76 .It Cm fault Oo Fl u Ar /dev/sesN Oc Ar disk Ns | Ns Cm all Cm on Ns | Ns Cm off
77 Change the state of the external fault LED associated with
80 can be the device name of the disk, like
84 to indicate all disks attached to SES controllers.
85 .It Cm fault Fl u Ar /dev/sesN Ar sesid Cm on Ns | Ns Cm off
86 Change the state of the external fault LED associated with an element
87 connected to the SES controller.
89 must be the element ID of a valid item attached to the controller.
92 command to list the elements attached to a controller.
93 .It Cm locate Oo Fl u Ar /dev/sesN Oc Ar disk Ns | Ns Cm all Cm on Ns | Ns Cm off
94 Change the state of the external locate LED associated with
97 can be the device name of the disk, like
101 to indicate all disks attached to SES controllers.
102 .It Cm locate Fl u Ar /dev/sesN Ar sesid Cm on Ns | Ns Cm off
103 Change the state of the external locate LED associated with an element
104 connected to the SES controller.
106 must be the element ID of a valid item attached to the controller.
109 command to list the elements attached to a controller.
110 .It Cm map Oo Fl -libxo Ar options Oc Op Fl u Ar /dev/sesN
111 Display a map of all elements connected to the specified
114 If no controller is specified, all controllers are mapped.
115 .It Cm show Oo Fl -libxo Ar options Oc Op Fl u Ar /dev/sesN
116 Display user-friendly summary of specified
119 If no controller is specified, all controllers are mapped.
120 .It Cm status Oo Fl -libxo Ar options Oc Op Fl u Ar /dev/sesN
121 Display the status of the specified
124 If no controller is specified, the status of each controller is returned.
128 .Bl -tag -width indent
129 .It Fl -libxo Ar options
132 in a selection of different human and machine readable formats.
137 Turn off all locate LEDs:
139 .Dl Nm Cm locate all off
141 Turn on the locate LED for the drive bay corresponding to
144 .Dl Nm Cm locate da15 on
146 Turn on the fault LED for a drive bay not associated with a device:
148 .Dl Nm Cm fault -u /dev/ses2 7 on
151 .Xr xo_parse_args 3 ,
156 utility first appeared in
162 utility was written by
163 .An Baptiste Daroussin Aq Mt bapt@FreeBSD.org
165 .An Allan Jude Aq Mt allanjude@FreeBSD.org .