.\" $OpenBSD: sensorsd.conf.5,v 1.15 2007/06/05 04:10:56 jmc Exp $ .\" .\" Copyright (c) 2003 Henning Brauer .\" Copyright (c) 2005 Matthew Gream .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. .\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" .Dd $Mdocdate: June 5 2007 $ .Dt SENSORSD.CONF 5 .Os .Sh NAME .Nm sensorsd.conf .Nd configuration file for sensorsd .Sh SYNOPSIS .Nm sensorsd.conf .Sh DESCRIPTION The .Nm file is read by .Xr sensorsd 8 to configure hardware sensor monitoring. Each valid sensor registered in the system is matched by at most one entry in .Nm , which may specify high and low limits, and whether sensor status changes provided by the driver should be ignored. If the limits are crossed or if the status provided by the driver changes, .Xr sensorsd 8 's alert functionality is triggered and a command, if specified, is executed. .Pp .Nm follows the syntax of configuration databases as documented in .Xr getcap 3 . Sensors may be specified by their full .Va hw.sensors .Xr sysctl 8 variable name or by type, with the full name taking precedence. For example, if an entry .Dq hw.sensors.lm0.temp1 is not found, then an entry for .Dq temp will instead be looked for. .Pp The following attributes may be used: .Pp .Bl -tag -width "commandXX" -offset indent -compact .It Li command Specify a command to be executed if limits are crossed. .It Li high Specify an upper limit. .It Li low Specify a lower limit. .It Li istatus Ignore status provided by the driver. .El .Pp The values for temperature sensors can be given in degrees Celsius or Fahrenheit, for voltage sensors in volts, and fan speed sensors take a unit-less number representing RPM. .Pp Sensors that provide status (such as from .Xr bio 4 , .Xr esm 4 , or .Xr ipmi 4 ) do not require boundary values specified (that otherwise will be ignored) and simply trigger on status transitions. .Pp The command is executed on transitions out of, and back into, given limits. Tokens in the command are substituted as follows: .Pp .Bl -tag -width Ds -offset indent -compact .It %x the xname of the device the sensor sits on .It %t the type of sensor .It %n the sensor number .It %2 the sensor's current value .It %3 the sensor's low limit .It %4 the sensor's high limit .El .Pp By default, .Xr sensorsd 8 monitors status changes on all sensors that keep their state. This behaviour may be altered by using the .Dq istatus attribute to ignore status changes of sensors of a certain type or individual sensors. .Sh FILES .Bl -tag -width "/etc/sensorsd.conf" .It /etc/sensorsd.conf Configuration file for .Xr sensorsd 8 . .El .Sh EXAMPLES In the following configuration file, if hw.sensors.ipmi0.temp0 goes above 80C, the command .Pa /etc/sensorsd/log_warning will be executed, with the sensor type, number and current value passed to it. Alerts will be sent if hw.sensors.ipmi0.temp1 goes above 170F; if hw.sensors.lm0.volt3 goes below 4.8V or above 5.2V; if the speed of the fan attached to hw.sensors.lm0.fan1 goes below 1000RPM or above 8000RPM; if any RAID volume drive goes into a state other than .Dq OK , such as drive failure, rebuild, or a complete failure, the command .Pa /etc/sensorsd/drive will be executed, with the sensor number passed to it; however, no alerts will be generated for status changes on timedelta sensors. For all other sensors whose drivers automatically provide sensor status updates, alerts will be generated each time those sensors undergo status transitions. .Bd -literal -offset indent # Comments are allowed hw.sensors.ipmi0.temp0:high=80C:command=/etc/sensorsd/log_warning %t %n %2 hw.sensors.ipmi0.temp1:high=170F hw.sensors.lm0.volt3:low=4.8V:high=5.2V hw.sensors.lm0.fan1:low=1000:high=8000 drive:command=/etc/sensorsd/drive %n timedelta:istatus #ignore status changes for timedelta .Ed .Sh SEE ALSO .Xr getcap 3 , .Xr bio 4 , .Xr esm 4 , .Xr ipmi 4 , .Xr sensorsd 8 , .Xr sysctl 8 .Sh HISTORY The .Nm file format first appeared in .Ox 3.5 .