NAME

encled - SCSI Enclosure indicators (SES LED) control

SYNOPSIS

encled [--help] [enslosure/slot|disk name|ALL] [locate|fault|off]

DESCRIPTION

Encled uses information in sysfs from ses.ko module to enumerate and control enclosure indication for disks.
SES is SCSI Enclosure Services, specialized protocol between enclosure (backplane) and HBA (controller). It allows to enable/disable indication on hot-swap slots for disks.

INDICATION TYPES

There is two types of indication: fault and locate. Third indication (activity) unavailable for control from host. If one indicator is enabled, other is automatically disabled. Keywords used: 'fault', 'locate' and 'off'.

ENUMERATION

Enclosure enumeration is based on /sys/class/enclosure, and slot number is reconstructed from 'Slot' name of enclosure. Usually it looks like this: 6:0:23:0/14, where: 6:0:23:0 is enclosure address, and '/14' is 14th slot. Note: Enumeration in encled may differ from sas2ircu or labels on the actual backplane. Don't rely on the slot numbers!

DISK NAME

There is two ways to indicate disk in encled: by using drive name (/dev/sdaz) or by using slot number (6:0:24:0/20). Special word 'all' is reserved for controlling all indication (command 'encled all off' clears all indication).

EXAMPLES

encled /dev/sda fault - enable fault indication for /dev/sda
encled /dev/sdfa locate - enable locate indication for /dev/sdfa
encled /dev/sdz off - clear indication for /dev/sdz
encled /dev/sdg - view status of indication for /dev/sdg
encled 3:0:23:0/1 fault - enable fault indication for the Slot 1 in enclosure 3:0:23:0
encled 3:0:23:0/2 locate - enable locate indication for the Slot 2 in enclosure 3:0:23:0
encled 3:0:23:0/3 off - clear inication for the Slot 3 in enclosure 3:0:23:0
encled 3:0:23:0/4 - view status of indication for the Slot 4 in enclosure 3:0:23:0
encled all fault - enable fault inidcation for all slots in all enclosures
encled - view status of all slots in all enclosures.
Example of the output:
ENCLOSURE/SLOT DEV FAULT_LED LOCATION_LED
----------------------------------------------------
6:0:23:0/1 sdd fault_off locate_off
6:0:23:0/2 sde fault_off locate_off
6:0:23:0/3 sdf fault_off LOCATE_ON
6:0:23:0/4 sdg FAULT_ON locate_off

NOTES

Encled supports only enclosure based devices (SAS/SATA). Desktop SATA controllers (AHCI), and direct-attach disks in SCSI are not supported.
Older name for encled was sdled.

AUTHOR

Written by George Shuklin

REPORTING BUGS

Report bugs to https://github.com/amarao/sdled

COPYRIGHT

Copyright © 2012-2015 George Shuklin
This software is distributed under the GPL version 2 or 3. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.