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 user space application design to control LEDs associated
13 with each slot in an enclosure or a drive bay. There are two types of
14 system: 2-LEDs system (Activity LED, Status LED) and 3-LEDs system
15 (Activity LED, Locate LED, Fail LED). User must have root privileges to
16 use this application.
17 The ledctl application uses SGPIO and SES-2 protocol to control LEDs.
19 The program implements IBPI patterns of SFF-8489 specification for
20 SGPIO. Please note some enclosures do not stick close to SFF-8489
21 specification. It might happen that enclosure processor will accept an
22 IBPI pattern but it will blink the LEDs not according to SFF-8489
23 specification or it has limited number of patterns supported.
24 LED management (AHCI) and SAF-TE protocols are not supported.
26 The ledctl application has been verified to work with Intel(R) storage
28 controllers (i.e. Intel(R) AHCI controller). The application might work
29 with storage controllers of other vendors (especially SCSI/SAS
30 controllers). However storage controllers of other vendors have not
31 been tested.
32 The ledmon application has the highest priority when accessing LEDs
34 then other programs. It means some patterns set by ledctl may have no
35 effect (except Locate pattern).
36 The ledctl application is part of Intel(R) Enclosure LED Utilities.
38 Pattern Names
40 The ledctl application accepts the following names for pattern_name
41 argument according to SFF-8489 specification.
42 locate Turns Locate LED associated with the given device(s) or empty
44 slot(s) on.
45 locate_off
47 Only turns Locate LED off.
48 normal Turns Status LED, Failure LED and Locate LED off.
50 off Only turns Status LED and Failure LED off.
52 ica or degraded
54 Visualizes "In a Critical Array" pattern.
55 rebuild or rebuild_p
57 Visualizes "Rebuild" pattern.
58 ifa or failed_array
60 Visualizes "In a Failed Array" pattern.
61 hotspare
63 Visualizes "Hotspare" pattern.
64 pfa Visualizes "Predicted Failure Analysis" pattern.
66 failure or disk_failed
68 Visualizes "Failure" pattern.
69 List of Devices
71 The application accepts a list of devices in two formats. The first
72 format is a list with comma separated elements. The second format is
73 a list in curly braces and elements are separated by space. See
74 examples section bellow for details.
75 A device is a path to file in /dev directory or in /sys/block
77 directory. It may identify a block device, a RAID device or a
78 container device. In case of RAID device or container device a state
79 will be set for all block devices associated, respectively.
80
82 -c or --config=path
83 Sets a path to local configuration file. If this option is
84 specified the global configuration file and user configuration
85 file has no effect.
86 -l or --log=path
88 Sets a path to local log file. If this option is specified the
89 global log file /var/log/ledctl.log is not used.
90 --quiet Turns off all messages send to "stdout" or "stderr" out. The
92 messages will be still logged to local file and syslog
93 facility.
94 -h or --help
96 Prints this text out and exits.
97 -v or --version
99 Displays version of ledctl and information about the license
100 and exits.
101
103 /var/log/ledctl.log
104 Global log file, used by all instances of ledctl application.
105 To force logging to user defined file use -l option switch.
106 ~/.ledctl
108 User configuration file, shared between ledmon and all ledctl
109 application instances.
110 /etc/ledcfg.conf
112 Global configuration file, shared between ledmon and all ledctl
113 application instances.
114
116 The following example illustrates how to locate a single block device.
117 ledctl locate=/dev/sda
119 The following example illustrates how to off Locate LED for the same
121 block device.
122 ledctl locate_off=/dev/sda
124 The following example illustrates how to locate disks of a RAID device
126 and how to set rebuild pattern for two block devices at the same time.
127 This example uses both formats of device list.
128 ledctl locate=/dev/md127 rebuild={ /sys/block/sd[a-b] }
130 The following example illustrates how to off Status LED and Failure LED
132 for the given device(s).
133 ledctl off={ /dev/sda /dev/sdb }
135 The following example illustrates how to locate a three block devices.
137 This example uses first format of device list.
138 ledctl locate=/dev/sda,/dev/sdb,/dev/sdc
140
142 Copyright (c) 2009 Intel Corporation. All rights reserved.
143 This program is distributed under the terms of the GNU General Public
145 License as published by the Free Software Foundation. See the built-in
146 help for details on the License and the lack of warranty.
147
149 ledmon(8), ledctl.conf(5)
150
152 This manual page was written by Artur Wojcik <artur.wojcik@intel.com>.
153 It may be used by others.
154LEDCTL Version 0.1 September 2009 ledctl(8)