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_devdiscover.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $
18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
24 devdiscover - Performs SNMP discovery and generates Torrus XML
29 B<torrus devdiscover> [--in=I<XMLFILE>] [I<options...>] [I<XMLFILES>]
33 B<devdiscover> performs SNMP discovery using the I<XMLFILE>
34 for the discovery instructions. It generates a corresponding
35 Torrus XML configuration file. See B<Torrus SNMP Discovery User Guide> for
38 The generic input file, or device discovery XML (DDX), may be generated
39 by the B<genddx> utility, and then edited and maintained manually.
40 Multiple input files may be specified by several instances of I<--in>
41 option, or simply as arguments.
43 Input file name is searched in the current directory, and then in
44 F<@sitedir@/discovery/>.
52 Creates C<data-dir> directories.
54 =item B<--limit>=I<REGEXP>
56 Limits the discovery to the output files matching the regular expression
59 =item B<--forcebundle>
61 With this option enabled, C<devdiscover> will write the bundle
62 file even if some of the bundle members were not created because of errors.
64 =item B<--fallback>=I<INTEGER>
66 Requires B<--forcebundle>. In case if an SNMP device is not available,
67 the bundle file will include an older version of the XML output file,
68 provided that it exists and it is not older than the specified number of days.
70 =item B<--threads>=I<INTEGER>
72 If the threads are enabled in the local Perl, this option determins
73 how many parallel discovery threads are to be executed.
74 The discovery jobs are distributed per output files, thus it makes
75 sence to use threads only when there are many output files defined in
81 Prints extra information.
85 Prints debugging information.
89 Prints SNMP protocol details
97 =item F<@siteconfdir@/devdiscover-siteconfig.pl>
99 B<devdiscover> site configuration file.
105 L<torrus(@mansec_usercmd@)>, L<torrus_genddx>(@mansec_usercmd@)
109 See I<Torrus SNMP Discovery User Guide> for more details at Torrus home
110 page: http://torrus.org
114 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>