1ledmon(8) Intel(R) Enclosure LED Monitor Service ledmon(8)
2
3
4
6 ledmon - Intel(R) LED monitor service for storage enclosures.
7
9 ledmon [OPTIONS]
10
12 The ledmon application is a daemon process used to monitor a state of
13 software RAID devices (md only) or a state of block devices. The state
14 is visualizing on LEDs associated to each slot in an enclosure or a
15 drive bay. There are two types of system: 2-LEDs system (Activity LED,
16 Status LED) and 3-LEDs system (Activity LED, Locate LED, Fail LED).
17 This application has the highest priority when accessing the LEDs.
18
19 The ledmon application supports LED management of the SAS/SATA and PCIe
20 storages.
21
22 Supported protocols/methods for LED management are:
23
24 • SES-2 and SMP for SAS devices,
25
26 • LED messages over SGPIO for SATA,
27
28 • VMD and NPEM for PCIe.
29
30 SAF-TE protocol is not supported.
31
32 For SAS/SATA storages supporting controllers may transmit LED
33 management information to the backplane controllers via the SGPIO
34 interface. The SGPIO bus carries bit patterns, which translate into LED
35 blink patterns in accordance with the International Blinking Pattern
36 Interpretation (IBPI) of SFF-8489 specification for SGPIO. Please note
37 some enclosures do not stick close to the SFF-8489 specification. It
38 might happen that the enclosure processor will accept the IBPI pattern
39 but it will blink LEDs not according to SFF-8489 specification or it
40 has a limited number of patterns supported.
41
42 For more information about communication methods please consult the
43 appropriate Specifications.
44
45 There's no method provided to specify which RAID volume should be
46 monitored and which not. The ledmon application monitors all RAID
47 devices and visualizes their state.
48
49 The ledmon application has been verified to work with Intel(R) storage
50 controllers (i.e. Intel(R) AHCI controller and Intel(R) SAS
51 controller). The application might work with storage controllers of
52 other vendors (especially SAS/SCSI controllers). However storage
53 controllers of other vendors have not been tested.
54
55 The ledmon application is part of Intel(R) Enclosure LED Utilities.
56 Only single instance of the application is allowed.
57
58 The ledmon utilizes the following documents as references:
59
60 • SGPIO (Serial GPIO) - SFF-8485
61
62 • IBPI (International Blinking Pattern Interpretation) - SFF-8489
63
64 • LED Enclosure management messages - AHCI specification rev 1.3,
65 section 12.2.1.
66
67 • SAS (Serial Attached SCSI) - T10/1760-D
68
69 • SES-2 (SCSI Enclosure Services-2) - T10/1559-D
70
71 • SMP (Serial Management Protocol) - T10/1760-D
72
73 • NPEM (Native PCIe Enclosure Management) - PCIe base specification
74 rev 4.0
75
76 • VMD (Intel(R) Volume Management Device) - Intel(R) VROC (VMD NVMe
77 RAID) Quick Configuration Guide rev 1.2
78
80 -c or --config=path
81 Sets a path to local configuration file. If this option is
82 specified the global configuration file and user configuration
83 file has no effect.
84
85 -l or --log=path
86 Sets a path to local log file. If this option is specified the
87 global log file /var/log/ledmon.log is not used.
88
89 -t or --interval=seconds
90 Sets time interval between scans of sysfs. The value is given
91 in seconds. The minimum is 5 seconds the maximum is not
92 specified.
93
94 --quiet or --error or --warning or --info or --debug or --all
95 Verbose level - 'quiet' means no logging at all and 'all' means
96 to log everything. The levels are given in order. If user
97 specifies more then one verbose option the last option comes
98 into effect. The default level is 'warning'. Verbose level also
99 can be set by --log-level=level.
100
101 --foreground
102 Run process foreground instead of a daemon. This option is
103 useful in systemd service file. Another use case of this option
104 is debugging with elevated --log-level=level.
105
106 -h or --help
107 Prints this text out and exits.
108
109 -v or --version
110 Displays version of ledmon and information about the license
111 and exits.
112
114 /var/log/ledmon.log
115 Global log file, used by ledmon application. To force logging
116 to user defined file use -l option switch.
117
118 /etc/ledmon.conf
119 Global configuration file, shared between ledmon and all ledctl
120 application instances. Local configuration file can be used by
121 running ledmon with -c switch.
122
124 Copyright (c) 2009-2022 Intel Corporation.
125
126 This program is distributed under the terms of the GNU General Public
127 License as published by the Free Software Foundation. See the build-in
128 help for details on the License and the lack of warranty.
129
131 The ledmon application does not recognize PFA state (Predicted Failure
132 Analysis), hence the PFA pattern from SFF-8489 specification is not
133 visualized.
134
136 ledctl(8), ledmon.conf(5)
137
139 This manual page was written by Artur Wojcik <artur.wojcik@intel.com>.
140 It may be used by others.
141
142
143
144LEDMON Version 0.97 May 2023 ledmon(8)