torrus/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 # $Id: torrus_action_snmptrap.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19 #
  20 #
  21
  22 =head1 NAME
  23
  24 action_snmptrap, action_snmpv1trap - Scripts for sending
  25 SNMP traps (version 2c and 1 respectively) from monitor action.
  26 C<action_snmpv1trap> is obsolete as the preferred SNMP version is 2c.
  27
  28 =head1 SYNOPSIS
  29
  30  <action name="snmptrap">
  31    <param name="action-type" value="exec" />
  32    <param name="command" value="$TORRUS_BIN/action_snmptrap" />
  33    <param name="launch-when" value="set, clear" />
  34  </action>
  35
  36 =head1 DESCRIPTION
  37
  38 This program is designed for usage from a monitor action only. It takes
  39 the arguments from environment variables, as described in action-type
  40 C<exec> in B<Torrus XML Configuration Guide>. In addition, some values
  41 may be supplied via command-line arguments (see section OPTIONS below).
  42
  43 Site-specific variables must be specified in the file
  44 F<snmptrap-siteconfig.pl>. Default values are installed by the first run
  45 of C<make install>. Subsequent
  46 runs of C<make install> do not override this file.
  47
  48 =head1 OPTIONS
  49
  50 =over 4
  51
  52 =item B<--host>=I<HOSTNAME>
  53
  54 Sets the hostname of the destination host.
  55
  56 =item B<--community>=I<COMMUNITY>
  57
  58 Sets the community string to use when sending the trap.
  59
  60 =item B<--port>=I<PORT>
  61
  62 Sets the destination UDP port.
  63
  64 =item B<--enterprise>=I<OID>
  65
  66 Sets the C<enterprise> field of the SNMPv1 trap to a given OID (see
  67 RFC 1157 for more details). This option is only available for
  68 C<action_snmpv1trap> and will be ignored for C<action_snmptrap>.
  69
  70 =item B<--severity>=I<SEVERITY>
  71
  72 Sets the optional severity SNMP variable to some integer value.
  73
  74 =back
  75
  76 =head1 FILES
  77
  78 =over 4
  79
  80 =item F<@siteconfdir@/snmptrap-siteconfig.pl>
  81
  82 Torrus site configuration script for SNMP traps.
  83
  84 =back
  85
  86 =head1 SEE ALSO
  87
  88 L<torrus(@mansec_usercmd@)>
  89
  90 =head1 NOTES
  91
  92 See more documentation at Torrus home page: http://torrus.org
  93
  94
  95 =head1 AUTHOR
  96
  97 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>