torrus/doc/manpages/torrus_genddx.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_genddx.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19 #
  20 #
  21
  22 =head1 NAME
  23
  24 genddx - Generates SNMP discovery instructions file for
  25 B<devdiscover>
  26
  27 =head1 SYNOPSIS
  28
  29 B<torrus genddx> --host=I<HOSTNAME> | --hostfile=I<HOSTFILENAME> \
  30 [I<options...>]
  31
  32 =head1 DESCRIPTION
  33
  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.
  42
  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.
  47
  48 See L<torrus_ttproclist(@mansec_usercmd@)> for a more flexible and
  49 complex DDX generator.
  50
  51 More information is available in B<Torrus SNMP Discovery User Guide>.
  52
  53 =head1 OPTIONS
  54
  55 =over 4
  56
  57 =item B<--out>=I<OUTFILENAME>
  58
  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>.
  61
  62 =item B<--discout>=I<FILENAME>
  63
  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
  68 F<@sitexmldir@>.
  69
  70 =item B<--domain>=I<DOMAIN>
  71
  72 Sets the DNS domain name to I<DOMAIN>.
  73
  74 =item B<--version>=I<SNMPVERSION>
  75
  76 Sets discovery SNMP version to SNMPVERSION. Default value is C<2c>.
  77
  78 =item B<--community>=I<COMMUNITY>
  79
  80 Sets discovery SNMP read community value to string I<COMMUNITY>. Default
  81 is C<public>.
  82
  83 =item B<--port>=I<PORT>
  84
  85 Sets SNMP port to I<PORT>. Default is 161.
  86
  87 =item B<--retries>=I<NUMRETRIES>
  88
  89 Sets number of retries to I<NUMRETRIES>. Default value is 2.
  90
  91 =item B<--timeout>=I<TIMEOUT>
  92
  93 Sets SNMP timeout to I<TIMEOUT> seconds. Default value is 10.
  94
  95 =item B<--subtree>=I<SUBTREE>
  96
  97 Sets the subtree name to I<SUBTREE>. Default is C</Routers>.
  98
  99 =item B<--datadir>=I<DATADIR>
 100
 101 Sets the path of the directory where SNMP data is collected to I<DATADIR>.
 102 Default value is F<@defrrddir@>.
 103
 104 =item B<--holtwinters>
 105
 106 Enables Holt-Winters analysis.
 107
 108 =back
 109
 110 =head1 FILES
 111
 112 =over 4
 113
 114 =item F<@sitedir@/discovery/routers.ddx>
 115
 116 Default output file of genddx.
 117
 118 =item F<@sitexmldir@/routers.xml>
 119
 120 Default Torrus XML configuration file which will be written once the
 121 genddx output file is processed with devdiscover utility.
 122
 123 =back
 124
 125 =head1 SEE ALSO
 126
 127 L<torrus(@mansec_usercmd@)>, L<torrus_devdiscover(@mansec_usercmd@)>,
 128 L<torrus_ttproclist(@mansec_usercmd@)>
 129
 130 =head1 NOTES
 131
 132 See more documentation at Torrus home page: http://torrus.org
 133
 134 =head1 AUTHOR
 135
 136 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>