Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

torrus_genddx(8) [debian 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)

Check Out this Related Man Page

TORRUS_DEVDISCOVER(8)						      torrus						     TORRUS_DEVDISCOVER(8)

NAME

       devdiscover - Performs SNMP discovery and generates Torrus XML configuration file.

SYNOPSIS

       torrus devdiscover [--in=XMLFILE] [options...] [XMLFILES]

DESCRIPTION

       devdiscover performs SNMP discovery using the XMLFILE for the discovery instructions. It generates a corresponding Torrus XML configuration
       file. See Torrus SNMP Discovery User Guide for details.

       The generic input file, or device discovery XML (DDX), may be generated by the genddx utility, and then edited and maintained manually.
       Multiple input files may be specified by several instances of --in option, or simply as arguments.

       Input file name is searched in the current directory, and then in /etc/torrus/discovery/.

OPTIONS

       --mkdir
	   Creates "data-dir" directories.

       --limit=REGEXP
	   Limits the discovery to the output files matching the regular expression REGEXP.

       --forcebundle
	   With this option enabled, "devdiscover" will write the bundle file even if some of the bundle members were not created because of
	   errors.

       --fallback=INTEGER
	   Requires --forcebundle. In case if an SNMP device is not available, the bundle file will include an older version of the XML output
	   file, provided that it exists and it is not older than the specified number of days.

       --threads=INTEGER
	   If the threads are enabled in the local Perl, this option determins how many parallel discovery threads are to be executed.	The
	   discovery jobs are distributed per output files, thus it makes sence to use threads only when there are many output files defined in a
	   single DDX file.

       --verbose
	   Prints extra information.

       --debug
	   Prints debugging information.

       --snmpdebug
	   Prints SNMP protocol details

FILES

       /etc/torrus/conf/devdiscover-siteconfig.pl
	   devdiscover site configuration file.

SEE ALSO

       torrus(8), torrus_genddx(8)

NOTES

       See Torrus SNMP Discovery User Guide for more details at Torrus home page: http://torrus.org

AUTHOR

       Stanislav Sinyagin <ssinyagin@yahoo.com>

torrus 2.03							    2013-07-26						     TORRUS_DEVDISCOVER(8)
Man Page