envconfig(8)envconfig(8)NAMEenvconfig - Configures the Environmental Monitoring daemon
SYNOPSIS
/usr/sbin/envconfig -c var=value
/usr/sbin/envconfig start | stop
/usr/sbin/envconfig -q
OPTIONS
Environmental Monitoring provides a means of detecting system threshold
conditions, that if exceeded, could result in a loss of data or damage
to the system itself. To detect and notify users of critical condi‐
tions, the envmond daemon is used. This utility, envconfig, is used to
customize the envmond daemon. This section describes the envconfig
options you can use to configure the daemon. Sets the variables that
specify how the system environment is monitored. These variables are
stored in the /etc/rc.config file and are read by the envmond daemon at
system start-up. If a variable is not set, the default value of that
variable is assumed. Specifies the state of Environmental Monitoring.
If this variable is set to zero (0), the Environmental Monitoring pack‐
age is not started during the system boot. If this variable is set to
1, and Environmental Monitoring is supported by that platform, it is
started during the system boot. The default value is 1. Specifies the
time (in minutes) that can elapse between the detection of a high tem‐
perature condition and the shutdown of the system. The default value
is 15 minutes. Specifies the threshold level that can be encountered
before the envmond daemon broadcasts a warning and suggested action.
The -c option with this value does not apply to computer systems
that feature multiple sensors for environmental monitoring (and
that use the hwmgr utility to set and evaluate sensors and to
apply actions). Instead, use the hwmgr utility with its -set
option to set the warning_threshold and fault_threshold sensor
attributes accordingly. Configures envmond to use either EVM
events (event mode) or hwmgr/sysconfig (poll method). Setting
ENVMON_MODE to “event” configures envmond to use event mode.
Unsetting or setting to “poll” configures envmond to use the
poll method (the default).
In event mode, threshold values cannot be set to individual sen‐
sors. EVM events will be generated only when hardware thresh‐
olds occur. If any sensors need to be monitored at a threshold
different from the hardware threshold, use the ENVMON_POLL_SEN‐
SORS variable.
The envmond daemon uses the poll method for sensors listed in
ENVMON_POLL_SENSORS and the event method for the rest of the
sensors. Specifies the frequency (in seconds) between queries
of the system sensors by the envmond daemon. The default value
is 60 seconds, except on systems that feature multiple sensors
for environmental monitoring. On those systems, the default
value in seconds is 5 times the number of sensors. For example,
for a system with 90 sensors, 90 X 5 equals 450 seconds. A good
rule is to round up to the next minute; for example 450/60
equals 7.5 minutes. Round that up to 8 minutes, which results in
8X60=480 seconds
Note
Attempts to query all or most of the sensors in a computer sys‐
tem that feature multiple sensors for environmental monitoring
(and that use the hwmgr utility to set and evaluate sensors and
to apply actions) may result in performance problems if insuffi‐
cient time is given between queries. The time required is based
on the number of sensors present in your machine. Use the fol‐
lowing command to determine the actual number of sensors in one
of these computer systems: # /usr/sbin/hwmgr -view hier |
/bin/grep sensor | /bin/wc -l
Uses the hwmgr utility to specify specific sensor thresholds to
be monitored, when used in conjunction with EVM event mode
(ENVMON_MODE=event). Use colons (:) to separate sensors in a
list. For example:
# envconfig-c ENVMON_POLL_SENSORS="58:59"
To set the warning threshold for sensor with ID 58 to 50.0
degrees Celsius:
# /sbin/hwmgr -set attr -id 58 -a warning_threshold=500
To set the fault threshold for sensor with ID 58 to 60.0 degrees
Celsius:
# /sbin/hwmgr -set attr -id 58 -a fault_threshold=600
To set the warning action for sensor with ID 58 to ignore:
# /sbin/hwmgr -set attr -id 58 -a warning_action=ignore
To set the fault action for sensor with ID 58, to noshutdown:
# /sbin/hwmgr -set attr -id 58 -a fault_action=noshutdown
Now envmond uses the poll method for sensors 58 and 59 and the
EVM event method for the other sensors. Specifies the path of a
user-defined script that you want the envmond daemon to execute
when a high threshold level is encountered. The envmond daemon
continues to check the environment after the script has executed
and proceeds as needed should the high threshold levels persist.
If you set this variable, the envmond daemon directs output from
the script to /dev/console. Output is not displayed on standard
output or written to a file as this is not the behavior of the
daemon. To display on standard output, explicitly specify the
logger command within the user defined script.
The -c option with this value does not apply to computer systems
that feature multiple sensors for environmental monitoring (and
that use the hwmgr utility to set and evaluate sensors and to
apply actions). Instead, use the hwmgr utility with its -set
option to set the warning_action and fault_action sensor
attributes for the appropriate actions. Specifies the path of a
user-defined script that you want the envmond daemon to execute
when a shutdown condition is encountered. The envmond daemon
executes this script instead of /sbin/shutdown. You must execute
/sbin/shutdown within your configured ENVMON_SHUTDOWN_SCRIPT to
shut down the system. If you do not specify anything for
ENVMON_SHUTDOWN_SCRIPT, envmond runs /sbin/shutdown by default
when a shutdown condition is encountered.
If you set this variable, the envmond daemon directs output from
the script to /dev/console. Output is not displayed on standard
output or written to a file as this is not the behavior of the
daemon. To display on standard output, explicitly specify the
logger command within the user defined script.
The -c option with this value does not apply to computer systems
that feature multiple sensors for environmental monitoring (and
that use the hwmgr utility to set and evaluate sensors and to
apply actions). Instead, use the hwmgr utility with its -set
option to set the warning_action and fault_action sensor
attributes for the appropriate actions. Turns the envmond dae‐
mon on or off after system start-up. Displays the values of
ENVMON_CONFIGURED, ENVMON_GRACE_PERIOD, ENVMON_HIGH_THRESH,
ENVMON_MONITOR_PERIOD, ENVMON_USER_SCRIPT, and ENVMON_SHUT‐
DOWN_SCRIPT as specified in the /etc/rc.config file. If a spec‐
ified entry is not found, the environmental variable is not dis‐
played.
DESCRIPTION
The envconfig utility is used to customize the envmond daemon. You
must have root privileges to use this utility. Using this utility, you
can: Specify whether or not Environmental Monitoring is turned on or
off at system start-up. Specify how much time can elapse between the
envmond daemon encountering a critical condition and the daemon initi‐
ating an orderly shutdown of the system. Specify how frequently the
envmond daemon queries the system for information. Start and stop the
envmond after Environmental Monitoring has been turned on at system
start-up. Display the settings of the environment variables as speci‐
fied in the /etc/rc.config file.
Note that the feature that you want to monitor must be supported on a
given platform. For example, some computer systems support reporting of
power supply and fan status, the current system temperature, and the
maximum allowed system temperature.
EXAMPLES
The following procedure describes how you test for and start the envi‐
ronmental monitoring subsystem In multiuser mode, check the status of
the environmental monitoring subsystem as follows: # /usr/sbin/envcon‐
fig -q ENVMON_CONFIGURED = 0 ENVMON_GRACE_PERIOD = 5 ENVMON_MONI‐
TOR_PERIOD = 1 ENVMON_HIGH_THRESH = ENVMON_USER_SCRIPT = ENVMON_SHUT‐
DOWN_SCRIPT =
If the value of ENVMON_CONFIGURED is 0, configure the envmond daemon
and reboot the system using either of the following methods: At the
command prompt, enter the following command: # /usr/sbin/envconfig -c
ENVMON_CONFIGURED=1 Use the rcmgr command as follows: # rcmgr set
ENVMON_CONFIGURED 1
This command will enable the envmond daemon and export the vari‐
able, creating the following two lines in the /etc/rc.config
file: ENVMON_CONFIGURED="1" export ENVMON_CONFIGURED
You can use the /usr/sbin/envconfig command to view the system environ‐
ment at any time. The envmond daemon will print warning messages in the
event of a power supply failure, abnormality, or high temperatures.
Error logs are logged in /var/adm/syslog.dated/current/daemon.log.
In the following example, the system shuts down in 10 minutes if the
temperature does not fall below the critical threshold.
/usr/sbin/envconfig -c ENVMON_GRACE_PERIOD=10
FILES
Databases that contains the values of the environment monitoring vari‐
ables. Note that you must use the rcmgr comand to update the rc.config*
files, particularly on clustered systems.
SEE ALSO
Commands: envmond(8), hwmgr(8), rcmgr(8)
Best Practice: Environmental Monitoring using the hwmgr Utility
envconfig(8)