Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

torrus_snmpfailures(8) [debian man page]

TORRUS_SNMPFAILURES(8)						      torrus						    TORRUS_SNMPFAILURES(8)

NAME

       snmpfailures - Displays SNMP collector failures.

SYNOPSIS

       torrus snmpfailures --tree=TREENAME [options...]

OPTIONS

       --details
	   In addition to failure counters, list the failed SNMP hosts and the time stamps of failure events.

       --help
	   Displays a help message.

DESCRIPTION

       This utility prints the SNMP collector failure information in JSON format.  Without --details option, it prints only the failure counters.

       Upon collector startup or after the tree re-compilation, the failure counters are reset to zero.

       The output is very convenient for further automatic processing in any scripting language.

       The top level of the output is a JSON object with the following name/value pairs:

       total_unreachable: NUMBER
	   Displays the number SNMP hosts that are currently unreachable.  The number adds up across multiple collector instances for a given
	   tree.  If a host becomes reachable again, the number is decreased.

       total_deleted: NUMBER
	   Displays the number SNMP hosts that are completely removed from SNMP collection for the life cycle of the collector process. This
	   happens when a host is unreachable for too long time and the collector gives up to reach it again.  The number adds up across multiple
	   collector instances for a given tree.

       total_mib_errors: NUMBER
	   Displays the number of MIB errors (noSuchObject, noSuchInstance, and endOfMibView) during the collector life cycle.	The number adds up
	   across multiple collector instances for a given tree.

       detail_unreachable: OBJECT, detail_deleted: OBJECT
	   If the option --details is specified, these objects contain the host names and timestamps of the failures.  The keys are
	   contactenations of SNMP host, UDP port, and SNMP community separated by "|".  The values are objects representing the UNIX timestamp
	   and a human-readable time string.

       detail_mib_errors: OBJECT
	   If the option --details is specified, this object displays the MIB error details: for each SNMP host, it lists the datasource leaves
	   which had these errors and the event timestamps.

EXAMPLES

       The following example illustrates an SNMP host unreachable:

	torrus failures --tree=main --details
	{
	   "detail_deleted" : {},
	   "detail_mib_errors" : {},
	   "detail_unreachable" : {
	      "217.101.101.101|161|public" : {
		 "time" : "Fri Jul 23 14:15:10 2010",
		 "timestamp" : 1279887310
	      }
	   },
	   "total_deleted" : 0,
	   "total_mib_errors" : 0,
	   "total_unreachable" : 1
	}

       The following example illustrates a MIB error:

	torrus failures --tree=main --details
	{
	   "detail_deleted" : {},
	   "detail_mib_errors" : {
	      "217.101.102.102|161|public" : {
		 "count" : 1,
		 "nodes" : {
		    "/Routers/CMTS3/Temperature_Sensors/sensor_01" : {
		       "time" : "Fri Jul 23 15:26:14 2010",
		       "timestamp" : 1279891574
		    }
		 }
	      }
	   },
	   "detail_unreachable" : {},
	   "total_deleted" : 0,
	   "total_mib_errors" : 1,
	   "total_unreachable" : 0
	}

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_SNMPFAILURES(8)

Check Out this Related Man Page

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)
Man Page