torrus_action_snmptrap(7) [debian man page]

TORRUS_ACTION_SNMPTRAP(7)					      torrus						 TORRUS_ACTION_SNMPTRAP(7)

NAME

       action_snmptrap, action_snmpv1trap - Scripts for sending SNMP traps (version 2c and 1 respectively) from monitor action.
       "action_snmpv1trap" is obsolete as the preferred SNMP version is 2c.

SYNOPSIS

	<action name="snmptrap">
	  <param name="action-type" value="exec" />
	  <param name="command" value="$TORRUS_BIN/action_snmptrap" />
	  <param name="launch-when" value="set, clear" />
	</action>

DESCRIPTION

       This program is designed for usage from a monitor action only. It takes the arguments from environment variables, as described in action-
       type "exec" in Torrus XML Configuration Guide. In addition, some values may be supplied via command-line arguments (see section OPTIONS
       below).

       Site-specific variables must be specified in the file snmptrap-siteconfig.pl. Default values are installed by the first run of "make
       install". Subsequent runs of "make install" do not override this file.

OPTIONS

       --host=HOSTNAME
	   Sets the hostname of the destination host.

       --community=COMMUNITY
	   Sets the community string to use when sending the trap.

       --port=PORT
	   Sets the destination UDP port.

       --enterprise=OID
	   Sets the "enterprise" field of the SNMPv1 trap to a given OID (see RFC 1157 for more details). This option is only available for
	   "action_snmpv1trap" and will be ignored for "action_snmptrap".

       --severity=SEVERITY
	   Sets the optional severity SNMP variable to some integer value.

FILES

       /etc/torrus/conf/snmptrap-siteconfig.pl
	   Torrus site configuration script for SNMP traps.

SEE ALSO

       torrus(8)

NOTES

       See more documentation at Torrus home page: http://torrus.org

AUTHOR

       Stanislav Sinyagin <ssinyagin@yahoo.com>

torrus 2.03							    2013-07-26						 TORRUS_ACTION_SNMPTRAP(7)

TORRUS_GENDDX(8)						      torrus							  TORRUS_GENDDX(8)

NAME

       genddx - Generates SNMP discovery instructions file for devdiscover

SYNOPSIS

       torrus genddx --host=HOSTNAME | --hostfile=HOSTFILENAME  [options...]

DESCRIPTION

       genddx generates the SNMP discovery instructions file, which may be later used as input for the devdiscover utility to produce the
       corresponding Torrus XML configuration file. The hostname(s) of router(s) to be included in SNMP discovery must be specified either using
       the --host (for a single router) or --hostfile option.  In the latter case the file HOSTFILENAME must contain a space-separated list of
       router hostnames. Hostnames may have the form "host:devname" where "devname" is a symbolic device name.

       This utility is designed to be used only once, in order to generate the discovery XML canvas, for futher manual editing. It generates only
       basic set of parameters, and there are much more of those that you may use to customize the discovery process.

       See torrus_ttproclist(8) for a more flexible and complex DDX generator.

       More information is available in Torrus SNMP Discovery User Guide.

OPTIONS

       --out=OUTFILENAME
	   Sets the output file to OUTFILENAME. Default is routers.ddx. Without absolute path, the file will be placed in /etc/torrus/discovery.

       --discout=FILENAME
	   Sets the discovery output file to FILENAME. This will be the filename of the Torrus XML configuration file once the output file of the
	   genddx is processed by the devdiscover utility. Default value is routers.xml. Without absolute path, the file would be resided in
	   /etc/torrus/xmlconfig.

       --domain=DOMAIN
	   Sets the DNS domain name to DOMAIN.

       --version=SNMPVERSION
	   Sets discovery SNMP version to SNMPVERSION. Default value is "2c".

       --community=COMMUNITY
	   Sets discovery SNMP read community value to string COMMUNITY. Default is "public".

       --port=PORT
	   Sets SNMP port to PORT. Default is 161.

       --retries=NUMRETRIES
	   Sets number of retries to NUMRETRIES. Default value is 2.

       --timeout=TIMEOUT
	   Sets SNMP timeout to TIMEOUT seconds. Default value is 10.

       --subtree=SUBTREE
	   Sets the subtree name to SUBTREE. Default is "/Routers".

       --datadir=DATADIR
	   Sets the path of the directory where SNMP data is collected to DATADIR.  Default value is /var/lib/torrus/collector_rrd.

       --holtwinters
	   Enables Holt-Winters analysis.

FILES

       /etc/torrus/discovery/routers.ddx
	   Default output file of genddx.

       /etc/torrus/xmlconfig/routers.xml
	   Default Torrus XML configuration file which will be written once the genddx output file is processed with devdiscover utility.

SEE ALSO

       torrus(8), torrus_devdiscover(8), torrus_ttproclist(8)

NOTES

       See more documentation at Torrus home page: http://torrus.org

AUTHOR

       Stanislav Sinyagin <ssinyagin@yahoo.com>

torrus 2.03							    2013-07-26							  TORRUS_GENDDX(8)