|
Packit |
7e09eb |
#
|
|
Packit |
7e09eb |
# Intel(R) Enclosure LED Utilities
|
|
Packit |
7e09eb |
# Copyright (C) 2009-2019 Intel Corporation.
|
|
Packit |
7e09eb |
#
|
|
Packit |
7e09eb |
# This program is free software; you can redistribute it and/or modify it
|
|
Packit |
7e09eb |
# under the terms and conditions of the GNU General Public License,
|
|
Packit |
7e09eb |
# version 2, as published by the Free Software Foundation.
|
|
Packit |
7e09eb |
#
|
|
Packit |
7e09eb |
# This program is distributed in the hope it will be useful, but WITHOUT
|
|
Packit |
7e09eb |
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
Packit |
7e09eb |
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
|
Packit |
7e09eb |
# more details.
|
|
Packit |
7e09eb |
#
|
|
Packit |
7e09eb |
# You should have received a copy of the GNU General Public License along with
|
|
Packit |
7e09eb |
# this program; if not, write to the Free Software Foundation, Inc.,
|
|
Packit |
7e09eb |
# 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
|
|
Packit |
7e09eb |
#
|
|
Packit |
7e09eb |
=head1 NAME
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
ledmon - Intel(R) LED monitor service for storage enclosures.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=head1 SYNOPSIS
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
B<ledmon> [I<OPTIONS>]
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=head1 DESCRIPTION
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
The ledmon application is a daemon process used to monitor a state of
|
|
Packit |
7e09eb |
software RAID devices (md only) or a state of block devices. The state
|
|
Packit |
7e09eb |
is visualizing on LEDs associated to each slot in an enclosure or a
|
|
Packit |
7e09eb |
drive bay. There are two types of system: 2-LEDs system (Activity LED,
|
|
Packit |
7e09eb |
Status LED) and 3-LEDs system (Activity LED, Locate LED, Fail
|
|
Packit |
7e09eb |
LED). This application has the highest priority when accessing the
|
|
Packit |
7e09eb |
LEDs.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
The ledmon application uses SGPIO and SES-2 protocol to control
|
|
Packit |
7e09eb |
LEDs. The program implements IBPI patterns of SFF-8489 specification
|
|
Packit |
7e09eb |
for SGPIO. Please note some enclosures do not stick close to SFF-8489
|
|
Packit |
7e09eb |
specification. It might happen that enclosure processor will accept
|
|
Packit |
7e09eb |
IBPI pattern but it will blink LEDs not according to SFF-8489
|
|
Packit |
7e09eb |
specification or it has limited number of patterns supported.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
LED management (AHCI) and SAF-TE protocols are not supported.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
There's no method provided to specify which RAID volume should be monitored
|
|
Packit |
7e09eb |
and which not. The ledmon application monitors all RAID devices and visualizes
|
|
Packit |
7e09eb |
their state.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
The ledmon application has been verified to work with Intel(R) storage
|
|
Packit |
7e09eb |
controllers (i.e. Intel(R) AHCI controller and Intel(R) SAS controller).
|
|
Packit |
7e09eb |
The application might work with storage controllers of other vendors
|
|
Packit |
7e09eb |
(especially SAS/SCSI controllers). However storage controllers of other
|
|
Packit |
7e09eb |
vendors have not been tested.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
The ledmon application is part of Intel(R) Enclosure LED Utilities. Only
|
|
Packit |
7e09eb |
single instance of the application is allowed.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=head1 OPTIONS
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=over 8
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=item B<-c> or B<--config>=I<path>
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
Sets a path to local configuration file. If this option is specified the
|
|
Packit |
7e09eb |
global configuration file and user configuration file has no effect.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=item B<-l> or B<--log>=I<path>
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
Sets a path to local log file. If this option is specified the global log
|
|
Packit |
7e09eb |
file F is not used.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=item B<-t> or B<--interval>=I<seconds>
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
Sets time interval between scans of sysfs. The value is given in seconds.
|
|
Packit |
7e09eb |
The minimum is 5 seconds the maximum is not specified.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=item B<--quiet> or B<--error> or B<--warning> or B<--info> or B<--debug> or B<--all>
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
Verbose level - 'quiet' means no logging at all and 'all' means to log
|
|
Packit |
7e09eb |
everything. The levels are given in order. If user specifies more then one
|
|
Packit |
7e09eb |
verbose option the last option comes into effect. The default level is
|
|
Packit |
7e09eb |
'warning'. Verbose level also can be set by B<--log-level>=I<level>.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=item B<--foreground>
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
Run process foreground instead of a daemon. This option is useful in
|
|
Packit |
7e09eb |
systemd service file. Another use case of this option is debugging with
|
|
Packit |
7e09eb |
elevated B<--log-level>=I<level>.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=item B<-h> or B<--help>
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
Prints this text out and exits.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=item B<-v> or B<--version>
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
Displays version of ledmon and information about the license and exits.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=back
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=head1 FILES
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=over 8
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=item F
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
Global log file, used by ledmon application. To force logging to user defined
|
|
Packit |
7e09eb |
file use I<-l> option switch.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=item F</etc/ledmon.conf>
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
Global configuration file, shared between ledmon and all ledctl application
|
|
Packit |
7e09eb |
instances. Local configuration file can be used by running ledmon with I<-c>
|
|
Packit |
7e09eb |
switch.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=back
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=head1 LICENSE
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
Copyright (c) 2009-2017 Intel Corporation.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
This program is distributed under the terms of the GNU General Public License
|
|
Packit |
7e09eb |
as published by the Free Software Foundation. See the build-in help for details
|
|
Packit |
7e09eb |
on the License and the lack of warranty.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=head1 BUGS
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
The ledmon application does not recognize PFA state (Predicted Failure Analysis),
|
|
Packit |
7e09eb |
hence the PFA pattern from SFF-8489 specification is not visualized.
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=head1 SEE ALSO
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
ledctl(8), ledmon.conf(5)
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
=head1 AUTHOR
|
|
Packit |
7e09eb |
|
|
Packit |
7e09eb |
This manual page was written by Artur Wojcik <artur.wojcik@intel.com>. It may
|
|
Packit |
7e09eb |
be used by others.
|