1ledctl(8) Intel(R) Enclosure LED Control Application ledctl(8)
2
6 ledctl - Intel(R) LED control application for a storage enclosures.
7
9 ledctl [OPTIONS] pattern_name=list_of_devices ...
10
12 The ledctl is an user space application designed to control LEDs
13 associated with each slot in an enclosure or a drive bay. The LEDs of
14 devices listed in list_of_devices are set to the given pattern
15 pattern_name and all other LEDs are turned off. User must have root
16 privileges to use this application.
17 There are two types of systems: 2-LEDs systems (Activity LED, Status
19 LED) and 3-LEDs systems (Activity LED, Locate LED, Fail LED). The
20 ledctl application uses SGPIO and SES-2 protocol to control LEDs. The
21 program implements IBPI patterns of SFF-8489 specification for SGPIO.
22 Please note some enclosures do not stick close to SFF-8489
23 specification. It might happen that enclosure's processor will accept
24 an IBPI pattern but it will blink the LEDs at variance with SFF-8489
25 specification or it has limited number of patterns supported.
26 LED management (AHCI) and SAF-TE protocols are not supported.
28 The ledctl application has been verified to work with Intel(R) storage
30 controllers (i.e. Intel(R) AHCI controller and Intel(R) SAS
31 controller). The application might work with storage controllers of
32 other vendors (especially SCSI/SAS controllers). However, storage
33 controllers of other vendors have not been tested.
34 The ledmon application has the highest priority when accessing LEDs.
36 It means that some patterns set by ledctl may have no effect if ledmon
37 is running (except Locate pattern).
38 The ledctl application is a part of Intel(R) Enclosure LED Utilities.
40 Pattern Names
42 The ledctl application accepts the following names for pattern_name
43 argument according to SFF-8489 specification.
44 locate Turns Locate LED associated with the given device(s) or empty
46 slot(s) on.
47 locate_off
49 Turns only Locate LED off.
50 normal Turns Status LED, Failure LED and Locate LED off.
52 off Turns only Status LED and Failure LED off.
54 ica or degraded
56 Visualizes "In a Critical Array" pattern.
57 rebuild or rebuild_p
59 Visualizes "Rebuild" pattern.
60 ifa or failed_array
62 Visualizes "In a Failed Array" pattern.
63 hotspare
65 Visualizes "Hotspare" pattern.
66 pfa Visualizes "Predicted Failure Analysis" pattern.
68 failure or disk_failed
70 Visualizes "Failure" pattern.
71 ses_abort
73 SES-2 R/R ABORD
74 ses_rebuild
76 SES-2 REBUILD/REMAP
77 ses_ifa SES-2 IN FAILED ARRAY
79 ses_ica SES-2 IN CRIT ARRAY
81 ses_cons_check
83 SES-2 CONS CHECK
84 ses_hotspare
86 SES-2 HOT SPARE
87 ses_rsvd_dev
89 SES-2 RSVD DEVICE
90 ses_ok SES-2 OK
92 ses_ident
94 SES-2 IDENT
95 ses_rm SES-2 REMOVE
97 ses_insert
99 SES-2 INSERT
100 ses_missing
102 SES-2 MISSING
103 ses_dnr SES-2 DO NOT REMOVE
105 ses_active
107 SES-2 ACTIVE
108 ses_enbale_bb
110 SES-2 ENABLE BYP B
111 ses_enable_ba
113 SES-2 ENABLE BYP A
114 ses_devoff
116 SES-2 DEVICE OFF
117 ses_fault
119 SES-2 FAULT
120 Patterns Translation
122 When non SES-2 pattern is send to device in enclosure automatic
123 translation is being done.
124 locate locate is translated to ses_ident
126 locate_off
128 locate_off is translated to ~ses_ident
129 normal normal is translated to ses_ok
131 off off is translated to ses_ok
133 degraded
135 degraded is translated to ses_ica
136 rebuild rebuild is translated to ses_rebuild
138 rebuild_p
140 rebuild_p is translated to ses_rebuild
141 failed failed is translated to ses_ifa
143 hotspare
145 hotspare is translated to ses_hotspare
146 pfa pfa is translated to ses_rsvd_dev
148 failure failure is translated to ses_fault
150 disk_failed
152 disk_failed is translated to ses_fault
153 List of Devices
155 The application accepts a list of devices in two formats. The first
156 format is a list with comma separated elements. The second format is
157 a list in curly braces and elements are separated by space. See
158 examples section bellow for details.
159 A device is a path to file in /dev directory or in /sys/block
161 directory. It may identify a block device, a RAID device or a
162 container device. In case of a RAID device or a container device a
163 state will be set for all block devices associated, respectively.
164 The LEDs of devices listed in list_of_devices are set to the given
166 pattern pattern_name and all other LEDs are turned off.
167
169 -c or --config=path
170 Sets a path to local configuration file. If this option is
171 specified the global configuration file and user configuration
172 file has no effect.
173 -l or --log=path
175 Sets a path to local log file. If this option is specified the
176 global log file /var/log/ledctl.log is not used.
177 -h or --help
179 Prints this text out and exits.
180 -v or --version
182 Displays version of ledctl and information about the license
183 and exits.
184
186 /var/log/ledctl.log
187 Global log file, used by all instances of ledctl application.
188 To force logging to user defined file use -l option switch.
189 ~/.ledctl
191 User configuration file, shared between ledmon and all ledctl
192 application instances.
193 /etc/ledcfg.conf
195 Global configuration file, shared between ledmon and all ledctl
196 application instances.
197
199 The following example illustrates how to locate a single block device.
200 ledctl locate=/dev/sda
202 The following example illustrates how to turn Locate LED off for the
204 same block device.
205 ledctl locate_off=/dev/sda
207 The following example illustrates how to locate disks of a RAID device
209 and how to set rebuild pattern for two block devices at the same time.
210 This example uses both formats of device list.
211 ledctl locate=/dev/md127 rebuild={ /sys/block/sd[a-b] }
213 The following example illustrates how to turn Status LED and Failure
215 LED off for the given device(s).
216 ledctl off={ /dev/sda /dev/sdb }
218 The following example illustrates how to locate a three block devices.
220 This example uses the first format of device list.
221 ledctl locate=/dev/sda,/dev/sdb,/dev/sdc
223
225 Copyright (c) 2009-2013 Intel Corporation.
226 This program is distributed under the terms of the GNU General Public
228 License as published by the Free Software Foundation. See the built-in
229 help for details on the License and the lack of warranty.
230
232 ledmon(8), ledctl.conf(5)
233
235 This manual page was written by Artur Wojcik <artur.wojcik@intel.com>.
236 It may be used by others.
237LEDCTL Version 0.79 November 2013 ledctl(8)