.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' '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 >0, 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. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "ledmon.conf 5" .TH ledmon.conf 5 "May 2023" "LEDMON.CONF Version 0.97 " "Intel(R) Enclosure LED Utilities Config" .\" 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 ledmon.conf \- Configuration file for Intel(R) Enclosure LED Utilities. .SH DESCRIPTION .IX Header "DESCRIPTION" The ledmon configuration file allows you to use advanced settings and functions of Intel(R) Enclosure LED Utilities. The global location of the configuration file is \fI/etc/ledmon.conf\fR. Instead of a global configuration file, you can specify a local config file using the \fI\-c\fR option when running ledmon. .SS SYNTAX .IX Subsection "SYNTAX" One line should keep exactly one option and value in the configuration file in format: OPTION=VALUE. Any word that begins with a hash sign (\fB#\fR) starts a comment and that word together with the remainder of the line is ignored. Empty lines are allowed. Either single quotes (\fB'\fR) or double quotes (\fB"\fR) should not be used. .PP Values are considered as truth: enabled, true, yes, 1. .PP Values are considered as false: disabled, false, no, 0. .PP See also the examples section. .SS "List of configurable options:" .IX Subsection "List of configurable options:" \&\fBEXCLUDELIST\fR \- Ledmon will exclude scanning controllers listed on excludelist. When allowlist is also set in config file, the excludelist will be ignored. The controllers should be separated by comma (\fB,\fR) character. The \fBXBD Extended Regular Expressions\fR are supported. The deprecated name of \&\fBBLACKLIST\fR is supported for backwards compatibility. It will be removed in a future release. .PP \&\fBBLINK_ON_INIT\fR \- Related with RAID Initialization (resync), Verify (check) and Verify and Fix (repair) processes. If value is set to true \- status LEDs of all member drives will blink with proper pattern if RAID volume is under sync process. If value is set to false, processes like init or verifications will not be reported by LEDs. The default value is true. .PP \&\fBBLINK_ON_MIGR\fR \- RAID can be migrated between some levels or strip sizes and the flag is related with this processes. Also RAID Grow operation will be reported along with this flag. If value is set to true \- status LEDs of all member drives will blink with proper pattern if RAID volume is under reshape. If value is set to false, listed actions will not be reported by LEDs. The default value is true. .PP \&\fBINTERVAL\fR \- The value is given in seconds. Defines time interval between ledmon sysfs scan. The minimum is 5 seconds the maximum is not specified. The default value is 10 seconds. .PP \&\fBLOG_LEVEL\fR \- Corresponds with \fI\-\-log\-level\fR flag from ledmon. Log level QUIET means no logging at all and ALL means to log everything. The default log level is WARNING. Acceptable values are: quiet, error, warning, info, debug, all. Value also can be set by integer number \- 0 means 'quiet' and 5 means 'all'. .PP \&\fBLOG_PATH\fR \- Sets a path to local log file. If this option is specified the global log file \fI/var/log/ledmon.log\fR is not used. .PP \&\fBRAID_MEMBERS_ONLY\fR \- If flag is set to true ledmon will limit monitoring only to drives that are RAID members. The default value is false. .PP \&\fBREBUILD_BLINK_ON_ALL\fR \- Flag is related with RAID rebuild process. When value is set to false \- only the drive that the RAID is rebuilding to will be marked with appropriate LED pattern. If value is set to true all drives from RAID that is during rebuild will blink during this operation. .PP \&\fBALLOWLIST\fR \- Ledmon will limit changing LED state to controllers listed on allowlist. If any allowlist is set, only devices from list will be scanned by ledmon. The controllers should be separated by comma (\fB,\fR) character. The \fBXBD Extended Regular Expressions\fR are supported. The deprecated name of \&\fBWHITELIST\fR is supported for backwards compatibility. It will be removed in a future release. .SH EXAMPLES .IX Header "EXAMPLES" .SS "Excluding one controller from ledmon scans, changing log level and scans interval:" .IX Subsection "Excluding one controller from ledmon scans, changing log level and scans interval:" LOG_LEVEL=all .PP INTERVAL=5 .PP #Exclude disks from SATA controller .PP EXCLUDELIST=/sys/devices/pci0000:00/0000:00:17.0 .SS "Blink only on RAID members, blink on all disks during rebuild and ignore init phase:" .IX Subsection "Blink only on RAID members, blink on all disks during rebuild and ignore init phase:" RAID_MEMBERS_ONLY=true .PP BLINK_ON_INIT=false .PP REBUILD_BLINK_ON_ALL=true .SH LICENSE .IX Header "LICENSE" Copyright (c) 2009\-2017 Intel Corporation. .PP 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. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBledmon\fR\|(8), \fBledctl\fR\|(8) .SH AUTHOR .IX Header "AUTHOR" This manual page was written by Michal Zylowski . It may be used by others.