.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ledctl 8"
.TH ledctl 8 "February 2012" "LEDCTL Version 0.32" "Intel(R) Enclosure LED Control Application"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
ledctl \- Intel(R) LED control application for a storage enclosures.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBledctl\fR [\fI\s-1OPTIONS\s0\fR] \fIpattern_name\fR=\fIlist_of_devices\fR ...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The ledctl is user space application design to control LEDs associated with each
slot in an enclosure or a drive bay. There are two types of system: 2\-LEDs
system (Activity \s-1LED\s0, Status \s-1LED\s0) and 3\-LEDs system (Activity \s-1LED\s0, Locate \s-1LED\s0,
Fail \s-1LED\s0). User must have root privileges to use this application.
.PP
The ledctl application uses \s-1SGPIO\s0 and \s-1SES\-2\s0 protocol to control LEDs.
The program implements \s-1IBPI\s0 patterns of \s-1SFF\-8489\s0 specification for \s-1SGPIO\s0.
Please note some enclosures do not stick close to \s-1SFF\-8489\s0 specification.
It might happen that enclosure processor will accept an \s-1IBPI\s0 pattern but it will
blink the LEDs not according to \s-1SFF\-8489\s0 specification or it has limited number
of patterns supported.
.PP
\&\s-1LED\s0 management (\s-1AHCI\s0) and SAF-TE protocols are not supported.
.PP
The ledctl application has been verified to work with Intel(R) storage
controllers (i.e. Intel(R) \s-1AHCI\s0 controller). The application might work with
storage controllers of other vendors (especially \s-1SCSI/SAS\s0
controllers). However storage controllers of other vendors have not been
tested.
.PP
The ledmon application has the highest priority when accessing LEDs then other
programs. It means some patterns set by ledctl may have no effect
(except Locate pattern).
.PP
The ledctl application is part of Intel(R) Enclosure \s-1LED\s0 Utilities.
.SS "Pattern Names"
.IX Subsection "Pattern Names"
The ledctl application accepts the following names for \fIpattern_name\fR argument
according to \s-1SFF\-8489\s0 specification.
.IP "\fBlocate\fR" 8
.IX Item "locate"
Turns Locate \s-1LED\s0 associated with the given device(s) or empty slot(s) on.
.IP "\fBlocate_off\fR" 8
.IX Item "locate_off"
Only turns Locate \s-1LED\s0 off.
.IP "\fBnormal\fR" 8
.IX Item "normal"
Turns Status \s-1LED\s0, Failure \s-1LED\s0 and Locate \s-1LED\s0 off.
.IP "\fBoff\fR" 8
.IX Item "off"
Only turns Status \s-1LED\s0 and Failure \s-1LED\s0 off.
.IP "\fBica\fR or \fBdegraded\fR" 8
.IX Item "ica or degraded"
Visualizes \*(L"In a Critical Array\*(R" pattern.
.IP "\fBrebuild\fR or \fBrebuild_p\fR" 8
.IX Item "rebuild or rebuild_p"
Visualizes \*(L"Rebuild\*(R" pattern.
.IP "\fBifa\fR or \fBfailed_array\fR" 8
.IX Item "ifa or failed_array"
Visualizes \*(L"In a Failed Array\*(R" pattern.
.IP "\fBhotspare\fR" 8
.IX Item "hotspare"
Visualizes \*(L"Hotspare\*(R" pattern.
.IP "\fBpfa\fR" 8
.IX Item "pfa"
Visualizes \*(L"Predicted Failure Analysis\*(R" pattern.
.IP "\fBfailure\fR or \fBdisk_failed\fR" 8
.IX Item "failure or disk_failed"
Visualizes \*(L"Failure\*(R" pattern.
.SS "List of Devices"
.IX Subsection "List of Devices"
The application accepts a list of devices in two formats. The first
format is a list with comma separated elements. The second format is a\ list in curly braces and elements are separated by space. See examples
section bellow for details.
.PP
A device is a path to file in /dev directory or in /sys/block directory.
It may identify a block device, a \s-1RAID\s0 device or a container device.
In case of \s-1RAID\s0 device or container device a state will be set for all
block devices associated, respectively.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-c\fR or \fB\-\-config\fR=\fIpath\fR" 8
.IX Item "-c or --config=path"
Sets a path to local configuration file. If this option is specified the
global configuration file and user configuration file has no effect.
.IP "\fB\-l\fR or \fB\-\-log\fR=\fIpath\fR" 8
.IX Item "-l or --log=path"
Sets a path to local log file. If this option is specified the global log
file \fI/var/log/ledctl.log\fR is not used.
.IP "\fB\-\-quiet\fR" 8
.IX Item "--quiet"
Turns off all messages send to \f(CW\*(C`stdout\*(C'\fR or \f(CW\*(C`stderr\*(C'\fR out. The messages
will be still logged to local file and syslog facility.
.IP "\fB\-h\fR or \fB\-\-help\fR" 8
.IX Item "-h or --help"
Prints this text out and exits.
.IP "\fB\-v\fR or \fB\-\-version\fR" 8
.IX Item "-v or --version"
Displays version of ledctl and information about the license and exits.
.SH "FILES"
.IX Header "FILES"
.IP "\fI/var/log/ledctl.log\fR" 8
.IX Item "/var/log/ledctl.log"
Global log file, used by all instances of ledctl application. To force logging
to user defined file use \fI\-l\fR option switch.
.IP "\fI~/.ledctl\fR" 8
.IX Item "~/.ledctl"
User configuration file, shared between ledmon and all ledctl application
instances.
.IP "\fI/etc/ledcfg.conf\fR" 8
.IX Item "/etc/ledcfg.conf"
Global configuration file, shared between ledmon and all ledctl application
instances.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
The following example illustrates how to locate a single block device.
.PP
.Vb 1
\&    ledctl locate=/dev/sda
.Ve
.PP
The following example illustrates how to off Locate \s-1LED\s0 for the same block
device.
.PP
.Vb 1
\&    ledctl locate_off=/dev/sda
.Ve
.PP
The following example illustrates how to locate disks of a \s-1RAID\s0 device and
how to set rebuild pattern for two block devices at the same time. This example
uses both formats of device list.
.PP
.Vb 1
\&     ledctl locate=/dev/md127 rebuild={ /sys/block/sd[a\-b] }
.Ve
.PP
The following example illustrates how to off Status \s-1LED\s0 and Failure \s-1LED\s0 for
the given device(s).
.PP
.Vb 1
\&     ledctl off={ /dev/sda /dev/sdb }
.Ve
.PP
The following example illustrates how to locate a three block devices. This
example uses first format of device list.
.PP
.Vb 1
\&     ledctl locate=/dev/sda,/dev/sdb,/dev/sdc
.Ve
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (c) 2009 Intel Corporation.
.PP
This program is distributed under the terms of the \s-1GNU\s0 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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIledmon\fR\|(8), \fIledctl.conf\fR\|(5)
.SH "AUTHOR"
.IX Header "AUTHOR"
This manual page was written by Artur Wojcik <artur.wojcik@intel.com>. It may
be used by others.