torrus/doc/manpages/torrus_devdiscover.pod.in

   1 #  Copyright (C) 2004  Stanislav Sinyagin
   2 #
   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.
   7 #
   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.
  12 #
  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.
  16
  17 # $Id: torrus_devdiscover.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19 #
  20 #
  21
  22 =head1 NAME
  23
  24 devdiscover - Performs SNMP discovery and generates Torrus XML
  25 configuration file.
  26
  27 =head1 SYNOPSIS
  28
  29 B<torrus devdiscover> [--in=I<XMLFILE>] [I<options...>] [I<XMLFILES>]
  30
  31 =head1 DESCRIPTION
  32
  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
  36 details.
  37
  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.
  42
  43 Input file name is searched in the current directory, and then in
  44 F<@sitedir@/discovery/>.
  45
  46 =head1 OPTIONS
  47
  48 =over 4
  49
  50 =item B<--mkdir>
  51
  52 Creates C<data-dir> directories.
  53
  54 =item B<--limit>=I<REGEXP>
  55
  56 Limits the discovery to the output files matching the regular expression
  57 I<REGEXP>.
  58
  59 =item B<--forcebundle>
  60
  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.
  63
  64 =item B<--fallback>=I<INTEGER>
  65
  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.
  69
  70 =item B<--threads>=I<INTEGER>
  71
  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
  76 a single DDX file.
  77
  78
  79 =item B<--verbose>
  80
  81 Prints extra information.
  82
  83 =item B<--debug>
  84
  85 Prints debugging information.
  86
  87 =item B<--snmpdebug>
  88
  89 Prints SNMP protocol details
  90
  91 =back
  92
  93 =head1 FILES
  94
  95 =over 4
  96
  97 =item F<@siteconfdir@/devdiscover-siteconfig.pl>
  98
  99 B<devdiscover> site configuration file.
 100
 101 =back
 102
 103 =head1 SEE ALSO
 104
 105 L<torrus(@mansec_usercmd@)>, L<torrus_genddx>(@mansec_usercmd@)
 106
 107 =head1 NOTES
 108
 109 See I<Torrus SNMP Discovery User Guide> for more details at Torrus home
 110 page: http://torrus.org
 111
 112 =head1 AUTHOR
 113
 114 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>