NAME¶

ledctl - Intel(R) LED control application for a storage enclosures.

SYNOPSIS¶

ledctl [OPTIONS] pattern_name=list_of_devices ...

DESCRIPTION¶

The ledctl is an user space application designed to control LEDs associated with each slot in an enclosure or a drive bay. The LEDs of devices listed in list_of_devices are set to the given pattern pattern_name and all other LEDs are turned off. User must have root privileges to use this application.

There are two types of systems: 2-LEDs systems (Activity LED, Status LED) and 3-LEDs systems (Activity LED, Locate LED, Fail LED).

The ledctl application supports LED management of the SAS/SATA and PCIe storages.

Supported protocols/methods for LED management are:

• SES-2 and SMP for SAS devices,
• LED messages over SGPIO for SATA,
• VMD and NPEM for PCIe.

SAF-TE protocol is not supported.

For SAS/SATA storages supporting controllers may transmit LED management information to the backplane controllers via the SGPIO interface. The SGPIO bus carries bit patterns, which translate into LED blink patterns in accordance with the International Blinking Pattern Interpretation (IBPI) of SFF-8489 specification for SGPIO. Please note some enclosures do not stick close to the SFF-8489 specification. It might happen that the enclosure processor will accept the IBPI pattern but it will blink LEDs not according to SFF-8489 specification or it has a limited number of patterns supported.

The ledctl application has been verified to work with Intel(R) storage controllers (i.e. Intel(R) AHCI controller and Intel(R) SAS controller). The application might work with storage controllers of other vendors (especially SCSI/SAS controllers). However, storage controllers of other vendors have not been tested.

The ledmon application has the highest priority when accessing LEDs. It means that some patterns set by ledctl may have no effect if ledmon is running (except Locate pattern).

The ledctl application is a part of Intel(R) Enclosure LED Utilities.

The ledctl utilizes the following documents as references:

• SGPIO (Serial GPIO) - SFF-8485
• IBPI (International Blinking Pattern Interpretation) - SFF-8489
• LED Enclosure management messages - AHCI specification rev 1.3, section 12.2.1.
• SAS (Serial Attached SCSI) - T10/1760-D
• SES-2 (SCSI Enclosure Services-2) - T10/1559-D
• SMP (Serial Management Protocol) - T10/1760-D
• NPEM (Native PCIe Enclosure Management) - PCIe base specification rev 4.0
• VMD (Intel(R) Volume Management Device) - Intel(R) VROC (VMD NVMe RAID) Quick

  Configuration Guide rev 1.2

OPTIONS¶

-l or --log=path

Sets a path to local log file. If this option is specified the global log file /var/log/ledctl.log is not used.

-h or --help

Prints this text out and exits.

-v or --version

Displays version of ledctl and information about the license and exits.

-L or --list-controllers

Prints information (system path and type) of all controllers detected by ledmon and exits.

-x or --listed-only

With this option ledctl will change state only on devices listed in CLI. The rest of devices will not be touched.

--quiet or --error or --warning or --info or --debug or --all

Verbose level - 'quiet' means no logging at all and 'all' means to log everything. The levels are given in order. If user specifies more then one verbose option the last option comes into effect. The default level is 'warning'. Verbose level also can be set by --log-level=level.

FILES¶

/var/log/ledctl.log

Global log file, used by all instances of ledctl application. To force logging to user defined file use -l option switch.

EXAMPLES¶

The following example illustrates how to locate a single block device.

    ledctl locate=/dev/sda

The following example illustrates how to turn Locate LED off for the same block device.

    ledctl locate_off=/dev/sda

The following example illustrates how to locate disks of a RAID device and how to set rebuild pattern for two block devices at the same time. This example uses both formats of device list.

     ledctl locate=/dev/md127 rebuild={ /sys/block/sd[a-b] }

The following example illustrates how to turn Status LED and Failure LED off for the given device(s).

     ledctl off={ /dev/sda /dev/sdb }

The following example illustrates how to locate a three block devices. This example uses the first format of device list.

     ledctl locate=/dev/sda,/dev/sdb,/dev/sdc

LICENSE¶

Copyright (c) 2009-2021 Intel Corporation.

This program is distributed under the terms of the GNU General Public License as published by the Free Software Foundation. See the built-in help for details on the License and the lack of warranty.

SEE ALSO¶

ledmon(8), ledmon.conf(5)

AUTHOR¶

This manual page was written by Artur Wojcik <artur.wojcik@intel.com>. It may be used by others.