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 Visualizes "Rebuild" pattern.
59 ifa or failed_array
61 Visualizes "In a Failed Array" pattern.
62 hotspare
64 Visualizes "Hotspare" pattern.
65 pfa Visualizes "Predicted Failure Analysis" pattern.
67 failure or disk_failed
69 Visualizes "Failure" pattern.
70 ses_abort
72 SES-2 R/R ABORD
73 ses_rebuild
75 SES-2 REBUILD/REMAP
76 ses_ifa SES-2 IN FAILED ARRAY
78 ses_ica SES-2 IN CRIT ARRAY
80 ses_cons_check
82 SES-2 CONS CHECK
83 ses_hotspare
85 SES-2 HOT SPARE
86 ses_rsvd_dev
88 SES-2 RSVD DEVICE
89 ses_ok SES-2 OK
91 ses_ident
93 SES-2 IDENT
94 ses_rm SES-2 REMOVE
96 ses_insert
98 SES-2 INSERT
99 ses_missing
101 SES-2 MISSING
102 ses_dnr SES-2 DO NOT REMOVE
104 ses_active
106 SES-2 ACTIVE
107 ses_enable_bb
109 SES-2 ENABLE BYP B
110 ses_enable_ba
112 SES-2 ENABLE BYP A
113 ses_devoff
115 SES-2 DEVICE OFF
116 ses_fault
118 SES-2 FAULT
119 ses_prdfail
121 SES-2 PRDFAIL
122 Patterns Translation
124 When non SES-2 pattern is send to device in enclosure automatic
125 translation is being done.
126 locate locate is translated to ses_ident
128 locate_off
130 locate_off is translated to ~ses_ident
131 normal or off
133 normal or off is translated to ses_ok
134 ica or degraded
136 ica or degraded is translated to ses_ica
137 rebuild rebuild is translated to ses_rebuild
139 ifa or failed_array
141 ifa or failed_array is translated to ses_ifa
142 hotspare
144 hotspare is translated to ses_hotspare
145 pfa pfa is translated to ses_prdfail
147 failure or disk_failed
149 failure or disk_failed is translated to ses_fault
150 List of Devices
152 The application accepts a list of devices in two formats. The first
153 format is a list with comma separated elements. The second format is
154 a list in curly braces and elements are separated by space. See
155 examples section bellow for details.
156 A device is a path to file in /dev directory or in /sys/block
158 directory. It may identify a block device, a RAID device or a
159 container device. In case of a RAID device or a container device a
160 state will be set for all block devices associated, respectively.
161 The LEDs of devices listed in list_of_devices are set to the given
163 pattern pattern_name and all other LEDs are turned off (unless
164 --listed-only option is given).
165
167 -l or --log=path
168 Sets a path to local log file. If this option is specified the
169 global log file /var/log/ledctl.log is not used.
170 -h or --help
172 Prints this text out and exits.
173 -v or --version
175 Displays version of ledctl and information about the license
176 and exits.
177 -L or --list-controllers
179 Prints information (system path and type) of all controllers
180 detected by ledmon and exits.
181 -x or --listed-only
183 With this option ledctl will change state only on devices
184 listed in CLI. The rest of devices will not be touched.
185 --quiet or --error or --warning or --info or --debug or --all
187 Verbose level - 'quiet' means no logging at all and 'all' means
188 to log everything. The levels are given in order. If user
189 specifies more then one verbose option the last option comes
190 into effect. The default level is 'warning'. Verbose level also
191 can be set by --log-level=level.
192
194 /var/log/ledctl.log
195 Global log file, used by all instances of ledctl application.
196 To force logging to user defined file use -l option switch.
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-2017 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), ledmon.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.92 April 2019 ledctl(8)