1 # Copyright (C) 2004 Stanislav Sinyagin
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.
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.
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.
17 # $Id: torrus_genddx.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $
18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
24 genddx - Generates SNMP discovery instructions file for
29 B<torrus genddx> --host=I<HOSTNAME> | --hostfile=I<HOSTFILENAME> \
34 B<genddx> generates the SNMP discovery instructions file, which may
35 be later used as input for the B<devdiscover> utility to produce the
36 corresponding Torrus XML configuration file. The hostname(s) of router(s) to
37 be included in SNMP discovery must be specified either using the
38 B<--host> (for a single router) or B<--hostfile> option. In the latter
39 case the file I<HOSTFILENAME> must contain a space-separated list of router
40 hostnames. Hostnames may have the form C<host:devname> where C<devname> is
41 a symbolic device name.
43 This utility is designed to be used only once, in order to generate
44 the discovery XML canvas, for futher manual editing. It generates only
45 basic set of parameters, and there are much more of those that you may
46 use to customize the discovery process.
48 See L<torrus_ttproclist(@mansec_usercmd@)> for a more flexible and
49 complex DDX generator.
51 More information is available in B<Torrus SNMP Discovery User Guide>.
57 =item B<--out>=I<OUTFILENAME>
59 Sets the output file to I<OUTFILENAME>. Default is F<routers.ddx>. Without
60 absolute path, the file will be placed in F<@sitedir@/discovery>.
62 =item B<--discout>=I<FILENAME>
64 Sets the discovery output file to I<FILENAME>. This will be the filename of
65 the Torrus XML configuration file once the output file of the B<genddx>
66 is processed by the B<devdiscover> utility. Default value is
67 F<routers.xml>. Without absolute path, the file would be resided in
70 =item B<--domain>=I<DOMAIN>
72 Sets the DNS domain name to I<DOMAIN>.
74 =item B<--version>=I<SNMPVERSION>
76 Sets discovery SNMP version to SNMPVERSION. Default value is C<2c>.
78 =item B<--community>=I<COMMUNITY>
80 Sets discovery SNMP read community value to string I<COMMUNITY>. Default
83 =item B<--port>=I<PORT>
85 Sets SNMP port to I<PORT>. Default is 161.
87 =item B<--retries>=I<NUMRETRIES>
89 Sets number of retries to I<NUMRETRIES>. Default value is 2.
91 =item B<--timeout>=I<TIMEOUT>
93 Sets SNMP timeout to I<TIMEOUT> seconds. Default value is 10.
95 =item B<--subtree>=I<SUBTREE>
97 Sets the subtree name to I<SUBTREE>. Default is C</Routers>.
99 =item B<--datadir>=I<DATADIR>
101 Sets the path of the directory where SNMP data is collected to I<DATADIR>.
102 Default value is F<@defrrddir@>.
104 =item B<--holtwinters>
106 Enables Holt-Winters analysis.
114 =item F<@sitedir@/discovery/routers.ddx>
116 Default output file of genddx.
118 =item F<@sitexmldir@/routers.xml>
120 Default Torrus XML configuration file which will be written once the
121 genddx output file is processed with devdiscover utility.
127 L<torrus(@mansec_usercmd@)>, L<torrus_devdiscover(@mansec_usercmd@)>,
128 L<torrus_ttproclist(@mansec_usercmd@)>
132 See more documentation at Torrus home page: http://torrus.org
136 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>