


mrtg                                                  CFGMAKER(1)



NNNNAAAAMMMMEEEE
     cfgmaker - Creates mrtg.cfg files (for mrtg-2.9.6)

SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
     cfgmaker [options] community@router [community@router ...]

OOOOPPPPTTTTIIIIOOOONNNNSSSS
      --ifref=nr        interface references by Interface Number (default)
      --ifref=ip                         ... by Ip Address
      --ifref=eth                        ... by Ethernet Number
      --ifref=descr                      ... by Interface Description
      --ifref=name                       ... by Interface Name
      --ifref=type                       ... by Interface Type

      --ifdesc=nr      interface description uses Interface Number (default)
      --ifdesc=ip                        ... uses Ip Address
      --ifdesc=eth                       ... uses Ethernet Number
      --ifdesc=descr                     ... uses Interface Description
      --ifdesc=name                      ... uses Interface Name
      --ifdesc=alias                     ... uses Interface Alias
      --ifdesc=type                      ... uses Interface Type

      --global "x: a"   add global config entries

      --no-down         do not look at admin or opr status of interfaces

      --descint         describe interface instead of just 'Traffic Analysis for'

      --subdirs=format  give each router its own subdirectory, naming each per
                        "format", in which HOSTNAME and SNMPNAME will be
                        replaced by the values of those items -- for instance,
                        --subdirs=HOSTNAME or --subdirs="HOSTNAME (SNMPNAME)"

      --noreversedns    do not reverse lookup ip numbers

      --help            brief help message
      --man             full documentation
      --version         print the version of cfgmaker

      --output=file     output filename default is STDOUT


DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     CCCCffffggggmmmmaaaakkkkeeeerrrr creates MRTG configuration files based on
     information pulled from a router or another SNMP manageable
     device.

     _c_o_m_m_u_n_i_t_y@@@@_r_o_u_t_e_r
         _C_o_m_m_u_n_i_t_y is the community name of the device you want
         to create a configuration for. The default community
         name is 'ppppuuuubbbblllliiiicccc'; you might want to try this first if
         you do not know the community name of a device. If you



2000-12-12              Last change: 2.9.6                      1






mrtg                                                  CFGMAKER(1)



         are using the wrong comunity name you will get no
         response from the device.

         _R_o_u_t_e_r is the DNS name or the IP number of an SNMP-
         managable device.  Following the name you can specify 6
         further options separated by colons.  The full syntax
         looks like this:

            B<router>[:[B<port>][:[B<timeout>][:[B<retries>][:[B<backoff>][:B<version>]]]]]

         Of special interest may be the last parameter, vvvveeeerrrrssssiiiioooonnnn.
         If you set this to '2' then your device will be queried
         with SNMP version 2 requests. This allows to poll the 64
         bit traffic counters in the device and will thus work
         much better with fast interfaces (no more counter
         overrun).

     --------hhhheeeellllpppp
         Print a brief help message and exit.

     --------mmmmaaaannnn
         Prints the manual page and exits.

     --------vvvveeeerrrrssssiiiioooonnnn
         Print the version of cfgmaker.  This should match the
         version of MRTG for which config files are being
         created.

     --------iiiiffffrrrreeeeffff nnnnrrrr|iiiipppp|eeeetttthhhh|ddddeeeessssccccrrrr|nnnnaaaammmmeeee
         Select the interface identification method.  Default is
         nnnnrrrr which identifies the router interfaces by their
         number.  Unfortunately the interface numbering scheme in
         an SNMP tree can change. Some routers change their
         numbering when new interfaces are added, others change
         thier numbering every full moon just for fun.

         To work around this sad problem MRTG can identify
         interfaces by 3 other properties. None of these works
         for all interfaces, but you should be able to find one
         which does fine for you. Note that especially ethernet
         addrsses can be problematic as some routers have the
         same ethernet address on most of their interface cards.

         Select iiiipppp to identify the interface by its IP number.
         Use eeeetttthhhh to use the ethernet address for identification.
         Or use ddddeeeessssccccrrrr to use the Interface description.

         If your chosen method does not allow unique interface
         identification on the device you are querying, ccccffffggggmmmmaaaakkkkeeeerrrr
         will tell you about it.





2000-12-12              Last change: 2.9.6                      2






mrtg                                                  CFGMAKER(1)



     --------iiiiffffddddeeeesssscccc nnnnrrrr|iiiipppp|eeeetttthhhh|ddddeeeessssccccrrrr|nnnnaaaammmmeeee|ttttyyyyppppeeee|aaaalllliiiiaaaassss
         Select what to use as the description of the interface.
         The description appears in the Title[] property for the
         target as well as the text header in the HTML code
         defined in the target's PageTop[].  Default is to use nnnnrrrr
         which is just the interface number which isn't always
         useful to the viewer of the graphs.

         There are 6 other properties which could be used.  Use
         iiiipppp if you want to use the interface's IP-address.  Use
         eeeetttthhhh if you want to use the interface's ethernet address.
         If you want a better description, you can use either
         ddddeeeessssccccrrrr, nnnnaaaammmmeeee or aaaalllliiiiaaaassss.  Exactly what each of these do
         varies between different equipment so you might need to
         experiment.  For instance, for a serial interface on a
         Cisco router running IOS using nnnnaaaammmmeeee might result in "S0"
         being the interface description , ddddeeeessssccccrrrr might result in
         "Serial0" and aaaalllliiiiaaaassss might result in "Link to HQ"
         (provided that is what is used as the interface's
         "description" in the router's configuration).

         Finally, if you want to describe the interface by it's
         type (i.e "ethernetCSMA", "propPointtoPoint" etc) you
         can use ttttyyyyppppeeee.  This is roughly equivalent to the
         --------ddddeeeesssscccciiiinnnntttt option above.

     --------gggglllloooobbbbaaaallll """"_b_l_a_: _a_b_c""""
         Use this to add global options to the generated config
         file.  You can call --------gggglllloooobbbbaaaallll several times to add
         multiple options.

          --global "workdir: /home/mrtg"

         If you want some default Options you might want to put

          --global "options[_]: growright,bits"


     --------nnnnoooorrrreeeevvvveeeerrrrsssseeeeddddnnnnssss
         Do not try to reverse lookup IP numbers ... a must for
         DNS free environments.

     --------nnnnoooo----ddddoooowwwwnnnn
         Normally cfgmaker will not include interfaces which are
         marked anything but administratively and operationally
         UP. With this switch you get them all.

     --------ssssuuuubbbbddddiiiirrrrssss _f_o_r_m_a_t
         Give each router its own subdirectory for the HTML and
         graphics (or .rrd) files.  The directory name is the
         given _f_o_r_m_a_t string with a couple of pattern
         replacements.  The string "HOSTNAME" will be replaced by



2000-12-12              Last change: 2.9.6                      3






mrtg                                                  CFGMAKER(1)



         the hostname of the router (however you specified it on
         the ccccffffggggmmmmaaaakkkkeeeerrrr commandline -- it may be an actual hostname
         or just an IP address), and "SNMPNAME" will be replaced
         with the device's idea of its own name (the same name
         that appears on the right side of the "Title" lines).
         For instance, a call like:

          cfgmaker --subdirs=HOSTNAME__SNMPNAME public@10.10.0.18

         would result in the generation of lines looking
         something like:

          Directory[10.10.0.18_1]: 10.10.0.18__fp2200-bothrip-1.3


EEEEXXXXAAAAMMMMPPPPLLLLEEEE
     This example creates a config file for _r_o_u_t_e_r_._p_l_a_c_e_._x_y_z:
     the router has the community name _p_u_b_l_i_c.  Interfaces get
     identified by their IP number.  Two global options get added
     to the config file.  The config file gets redirected to
     _m_r_t_g_._c_o_n_f.  The '\' signs at the end of the line mean that
     this command should be written on a single line.

      cfgmaker --global "WorkDir: /home/tobi"           \
               --global "Options[_]: growright,bits"    \
               --ifref=ip                               \
               public@router.place.xyz > mrtg.cfg


SSSSEEEEEEEE AAAALLLLSSSSOOOO
     the reference manpage

AAAAUUUUTTTTHHHHOOOORRRR
     Tobias Oetiker <tobi@oetiker.ch>

LLLLIIIICCCCEEEENNNNSSSSEEEE
     GNU General Public License

CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
     Cfgmaker is Copyright 2000 by Tobias Oetiker
     <tobi@oetiker.ch>














2000-12-12              Last change: 2.9.6                      4



