src/doc/manpages/torrus_action_snmptrap.pod.in

   1 #  Copyright (C) 2004  Stanislav Sinyagin
   2 #
   3 #  This program is free software; you can redistribute it and/or modify
   4 #  it under the terms of the GNU General Public License as published by
   5 #  the Free Software Foundation; either version 2 of the License, or
   6 #  (at your option) any later version.
   7 #
   8 #  This program is distributed in the hope that it will be useful,
   9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 #  GNU General Public License for more details.
  12 #
  13 #  You should have received a copy of the GNU General Public License
  14 #  along with this program; if not, write to the Free Software
  15 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  16
  17 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  18 #
  19 #
  20
  21 =head1 NAME
  22
  23 action_snmptrap, action_snmpv1trap - Scripts for sending
  24 SNMP traps (version 2c and 1 respectively) from monitor action.
  25 C<action_snmpv1trap> is obsolete as the preferred SNMP version is 2c.
  26
  27 =head1 SYNOPSIS
  28
  29  <action name="snmptrap">
  30    <param name="action-type" value="exec" />
  31    <param name="command" value="$TORRUS_BIN/action_snmptrap" />
  32    <param name="launch-when" value="set, clear" />
  33  </action>
  34
  35 =head1 DESCRIPTION
  36
  37 This program is designed for usage from a monitor action only. It takes
  38 the arguments from environment variables, as described in action-type
  39 C<exec> in B<Torrus XML Configuration Guide>. In addition, some values
  40 may be supplied via command-line arguments (see section OPTIONS below).
  41
  42 Site-specific variables must be specified in the file
  43 F<snmptrap-siteconfig.pl>. Default values are installed by the first run
  44 of C<make install>. Subsequent
  45 runs of C<make install> do not override this file.
  46
  47 =head1 OPTIONS
  48
  49 =over 4
  50
  51 =item B<--host>=I<HOSTNAME>
  52
  53 Sets the hostname of the destination host.
  54
  55 =item B<--community>=I<COMMUNITY>
  56
  57 Sets the community string to use when sending the trap.
  58
  59 =item B<--port>=I<PORT>
  60
  61 Sets the destination UDP port.
  62
  63 =item B<--enterprise>=I<OID>
  64
  65 Sets the C<enterprise> field of the SNMPv1 trap to a given OID (see
  66 RFC 1157 for more details). This option is only available for
  67 C<action_snmpv1trap> and will be ignored for C<action_snmptrap>.
  68
  69 =item B<--severity>=I<SEVERITY>
  70
  71 Sets the optional severity SNMP variable to some integer value.
  72
  73 =back
  74
  75 =head1 FILES
  76
  77 =over 4
  78
  79 =item F<@siteconfdir@/snmptrap-siteconfig.pl>
  80
  81 Torrus site configuration script for SNMP traps.
  82
  83 =back
  84
  85 =head1 SEE ALSO
  86
  87 L<torrus(@mansec_usercmd@)>
  88
  89 =head1 NOTES
  90
  91 See more documentation at Torrus home page: http://torrus.org
  92
  93
  94 =head1 AUTHOR
  95
  96 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>