kcalarm.1m (2012 03)

k
kcalarm(1M) kcalarm(1M)
NAME
kcalarm - add, delete, or list kernel tunable alarms, as well as turn kernel tunable monitoring on and off.
SYNOPSIS
kcalarm
-a [-t threshold ][-e
<event> ]... [-i interval ][-c comment ] -n <notification> tunable
[tunable... ]
kcalarm
-d [-F][-t threshold ][
-e <event> ]... [-i interval ][-c comment][-n <notification> ]
[
-k key] tunable [tunable... ]
kcalarm
-s (on | off)[
-F][-t threshold ][-e <event> ]... [-i interval ][-c comment ][
-n
<notification> ][-k key] tunable [tunable... ]
kcalarm [
-l][-k key][tunable... ]
kcalarm
-m (on | off |
status)[-l]
<event>
= (initial | repeat |
return)
<notification>
= notification_target
:[data]:[port]
DESCRIPTION
kcalarm is used to manage kernel tunable alarms and monitors; alarms and monitors are implemented
in the kcmond(1M) daemon. Users can create, modify, delete, and list kernel tunable alarms. Alarms send
a notification though various notification targets when a kernel tunable crosses a specified percentage
threshold of its current setting.
Monitoring is the process of collecting historical tunable data. When this feature is turned on, historical
data is collected on the usage of supported tunables. This data is used by the
kcusage (see kcusage(1M))
command to generate usage tables (including top consumers) for supported kernel tunables and enables
graphs in the kcweb(1M) tool. Monitoring is turned on by default when the Kernel Configuration (
kcweb)
tool is installed.
Root permissions are required to execute
kcalarm when the -a, -d, -s
, and -m (on|off) options are
specified.
Operands
kcalarm recognizes the following operands
tunable Name of the kernel tunable. See kcusage(1M) for a list of tunables that can be moni-
tored. If the token "any" is used as the tunable, an alarm is created that monitors all
monitorable tunables, except
dbc_max_pct and ninode; this alarm sends notification
if any of them exceed the specified threshold.
The list of valid tunables can be found on the kcusage(1M) manpage.
If no options are provided, the
kcalarm will list alarms for the specified tunable(s), or for all tunables if
none are specified.
Options
kcalarm recognizes the following options
-a Add a kernel tunable alarm for the specified tunable(s). Separate alarms will be added
for each tunable named with the -a option. The -a option should be used with the -n
option, and with -t, -e, and -i if values other than the defaults are desired.
-d Delete a kernel tunable alarm for the specified tunable(s). If multiple alarms exist for a
single tunable, -k, -t, -e, -i, and -n options can be used to clarify the delete request.
The command will interactively confirm each delete request unless the -F (force) option
is specified.
-F Force the deletion or change of status of an alarm, without confirming the request. This
option is only valid with -d and -s options.
-t threshold This is a percentage of the current setting of the kernel tunable over which the alarm
should sound (i.e 75 indicates 75 percent of the value of the current setting). The default
is 80 percent. Only whole numbers are allowed.
-e ( initial | repeat | return )
Event type. This determines what type of event will trigger a notification when the thres-
hold is crossed. The three options are initial, repeat, and return.
HP-UX 11i Version 3: March 2012 − 1 − Hewlett-Packard Company 1