Blame doc/mrtg-nw-guide.txt

Packit 667938
MRTG-NW-GUIDE(1)                     mrtg                     MRTG-NW-GUIDE(1)
Packit 667938
Packit 667938
Packit 667938
Packit 667938
N?NA?AM?ME?E
Packit 667938
       mrtg-nw-guide - MRTG for NetWare
Packit 667938
Packit 667938
S?SY?YN?NO?OP?PS?SI?IS?S
Packit 667938
       This guide is intended to aid in the installation and configuration of
Packit 667938
       MRTG on a NetWare server.
Packit 667938
Packit 667938
O?OV?VE?ER?RV?VI?IE?EW?W
Packit 667938
       MRTG is a relative newcomer to the NetWare platform. Earlier versions
Packit 667938
       of NetWare could not run MRTG natively for several reasons:
Packit 667938
Packit 667938
       +?o   Absence of NetWare OS support in the MRTG package.
Packit 667938
Packit 667938
       +?o   A NetWare server commandline length limitation.
Packit 667938
Packit 667938
       +?o   Absence of the Rateup executable (Rateup.nlm).
Packit 667938
Packit 667938
       +?o   A standard installation method.
Packit 667938
Packit 667938
       +?o   Problems with NetWare's implementation of Perl.
Packit 667938
Packit 667938
       Support for the NetWare OS has now been fully added into MRTG,
Packit 667938
       beginning with MRTG release 2.12.2.
Packit 667938
Packit 667938
       Liberallly minded operating systems support a commandline length
Packit 667938
       approaching 1000 characters. In such environments it was an easy matter
Packit 667938
       to pass the sometimes high number of parameters used by MRTG's Rateup
Packit 667938
       executable directly on the commandline. Until NetWare 6.5, NetWare had
Packit 667938
       a commandline limit of 512 characters. This limitation was also removed
Packit 667938
       for NetWare 6.0 by Service Pack 5. For other NetWare versions and
Packit 667938
       earlier Service Packs, this limitation remains. To permit a 'standard'
Packit 667938
       interface for NetWare, the Rateup executable has been modified to also
Packit 667938
       read its parameters from a file, and the MRTG script has been modified
Packit 667938
       to support this method on a NetWare platform.  (See New Rateup Switch)
Packit 667938
Packit 667938
       A Rateup NLM is now available, along with the necessary scripts to
Packit 667938
       build it if required. See the  NetWare Support section of this document
Packit 667938
       for further details. Additionally, mrtg.pl has been revised because of
Packit 667938
       the unique (to NetWare) name of executables (NLM).
Packit 667938
Packit 667938
       The absence of a specific installation procedure has caused MRTG to
Packit 667938
       fail in the past because the Perl script could not find or load the
Packit 667938
       Rateup executable. The installation method supplied here will solve
Packit 667938
       this problem for now.
Packit 667938
Packit 667938
       The MRTG.pl script in the 2.12.2 (or later) version of MRTG has been
Packit 667938
       configured to suit all likely versions of NetWare able to use Perl5,
Packit 667938
       and bypasses all of the known problems with NetWare Perl running MRTG.
Packit 667938
Packit 667938
P?PR?RE?ER?RE?EQ?QU?UI?IS?SI?IT?TE?ES?S
Packit 667938
       You will need the following:
Packit 667938
Packit 667938
       +?o   Perl 5.8.0 for NetWare with latest Perl Updates (February, 2005 or
Packit 667938
           later; previous versions MAY work)
Packit 667938
Packit 667938
       +?o   NetWare 5.1 w/ SP8, NetWare 6.0 w/ SP5 or NetWare 6.5 w/ SP2.
Packit 667938
Packit 667938
       +?o   A copy of the MRTG Package (v2.12.2 at time of writting)
Packit 667938
Packit 667938
       +?o   Three .ncf files to execute the Perl scripts at the NetWare server
Packit 667938
           console.
Packit 667938
Packit 667938
       +?o   A copy of the Rateup NLM (Pre-built or compiled)
Packit 667938
Packit 667938
       +?o   Optionally, any NetWare supported Web Server (Netscape, Apache 1.3
Packit 667938
           or 2.0)
Packit 667938
Packit 667938
       For copies of the .ncf files and Rateup NLM, see NetWare Support in
Packit 667938
       this document.
Packit 667938
Packit 667938
I?IN?NS?ST?TA?AL?LL?LI?IN?NG?G M?MR?RT?TG?G
Packit 667938
       1.  Install the latest Perl 5.8.x release on your server. See the Perl
Packit 667938
           documentation for details.
Packit 667938
Packit 667938
       2.  Create the following directories:
Packit 667938
Packit 667938
                    SYS:/Mrtg
Packit 667938
                    SYS:/Mrtg/bin
Packit 667938
                    SYS:/Mrtg/contrib    (Optional for this document)
Packit 667938
                    SYS:/Mrtg/doc        (Optional for this document)
Packit 667938
                    SYS:/Mrtg/html
Packit 667938
                    SYS:/Mrtg/html/images
Packit 667938
                    SYS:/Mrtg/html/work
Packit 667938
                    SYS:/Mrtg/lib
Packit 667938
                    SYS:/Mrtg/logs
Packit 667938
                    SYS:/Mrtg/translate
Packit 667938
Packit 667938
       3.  Copy from the MRTG package the following files:
Packit 667938
Packit 667938
            \bin\*        to  SYS:/Mrtg/bin              All files. See Note 1.
Packit 667938
Packit 667938
           Note 1: Add a .pl extension to the mrtg, cfgmaker and indexmaker
Packit 667938
           files.  The rateup.exe will NOT be needed on the NetWare server.
Packit 667938
Packit 667938
            \contrib\*    to  SYS:/Mrtg/contrib/         Include sub-directories
Packit 667938
            \doc\*        to  SYS:/Mrtg/doc/             All files
Packit 667938
            \images\*     to  SYS:/Mrtg/html/images/     All files
Packit 667938
            \translate\*  to  SYS:/Mrtg/translate/       All files. See Note 2.
Packit 667938
Packit 667938
           Note 2: For English-only language support, all \translate files
Packit 667938
           EXCEPT Locales_mrtg may be deleted.
Packit 667938
Packit 667938
            \lib\*        to  SYS:/Mrtg/lib              Include sub-directories. See Note 3.
Packit 667938
Packit 667938
           Note 3: This will create the SYS:/Mrtg/lib/mrtg2 and ./pod
Packit 667938
           directories.
Packit 667938
Packit 667938
       4.  Create copies of the three .ncf files and install them:
Packit 667938
Packit 667938
            *.ncf         to  SYS:/Mrtg/bin
Packit 667938
Packit 667938
           See NetWare Support in this document for details on how to create
Packit 667938
           copies of these files.
Packit 667938
Packit 667938
       5.  See Compiling Rateup.nlm"> in this document for details on
Packit 667938
           compiling the Rateup NLM yourself if desired.  A prebuit verion is
Packit 667938
           available in the .\mrtg\bin directory where it must remain.
Packit 667938
Packit 667938
C?CO?ON?NF?FI?IG?GU?UR?RI?IN?NG?G M?MR?RT?TG?G
Packit 667938
       +?o   Refer to Novell documentation on configuring and loading SNMP
Packit 667938
           support on your server if this is the device to be monitored.
Packit 667938
Packit 667938
       +?o   Edit sys:/mrtg/bin/MakeMrtgCfg.ncf:
Packit 667938
Packit 667938
           replace ccccc with the GET community name for the SNMP device
Packit 667938
           (typically 'public'),
Packit 667938
Packit 667938
           replace ddddd with the DNS name or IP address of the device to be
Packit 667938
           monitored.  e.g    public@www.myserver.com, public@10.202.65.180
Packit 667938
Packit 667938
           Note 1: These are NOT mail addresses, they just look like one!
Packit 667938
Packit 667938
           Note 2: If multiple devices are to be monitored, add their entries
Packit 667938
           to the same line:
Packit 667938
Packit 667938
           e.g  perl cfgmaker.pl public@www.myserver.com public@10.202.65.180
Packit 667938
           > sys:/mrtg/bin/mrtg.cfg
Packit 667938
Packit 667938
           In this "Getting Started", it is 'suggested' to only monitor a
Packit 667938
           single device.
Packit 667938
Packit 667938
       +?o   At the server console, run:
Packit 667938
Packit 667938
            sys:/mrtg/bin/MakeMrtgCfg.ncf
Packit 667938
Packit 667938
           This will create Mrtg.cfg in sys:/mrtg/bin.
Packit 667938
Packit 667938
       +?o   Edit the Mrtg.cfg configuration file created in the previous step.
Packit 667938
           Note the following:
Packit 667938
Packit 667938
           It was found, when testing MRTG on a NetWare 6.5 server using a NIC
Packit 667938
           Interface, that mrtg.cfg contained the following message:
Packit 667938
Packit 667938
            ### Interface 1 >> Descr: 'Intel(R)-8255x-based-Network-Connection'...
Packit 667938
            ### The following interface is commented out because:
Packit 667938
            ### * has a speed of 0 which makes no sense
Packit 667938
            #
Packit 667938
            ...
Packit 667938
Packit 667938
           If this occurs, edit MakeMrtgCfg.ncf and add the following
Packit 667938
           parameter as shown:
Packit 667938
Packit 667938
            perl sys:\mrtg\bin\cfgmaker.pl --zero-speed=nnn public@10.202.65.180 > sys:\mrtg\bin\Mrtg.cfg
Packit 667938
Packit 667938
           where n?nn?nn?n is the interface speed in bits per second. For a 100
Packit 667938
           Megabit LAN NIC, nnn = 10000000. It will be necessary to re-execute
Packit 667938
           the MakeMrtgCfg.ncf script before continuing with this section.
Packit 667938
Packit 667938
           Below line 16 (*** Global Defaults), add:
Packit 667938
Packit 667938
            HtmlDir:    e.g  HtmlDir:  sys:/mrtg/html
Packit 667938
            ImageDir:   e.g  ImageDir: sys:/mrtg/html/work
Packit 667938
            LogDir:     e.g  LogDir:   sys:/mrtg/logs
Packit 667938
            IconDir:    e.g  IconDir:  ./images
Packit 667938
Packit 667938
           Note 1. The HtmlDir entry specifies where MRTG will create its HTML
Packit 667938
           pages.
Packit 667938
Packit 667938
           Note 2. The ImageDir entry specifies where the created graphic
Packit 667938
           icons are placed.
Packit 667938
Packit 667938
           Note 3. The IconDir entry specifies where the supplied MRTG icons
Packit 667938
           are located.  It MUST be a relative path from HtmlDir or absolute
Packit 667938
           URL. The value shown is recommended.
Packit 667938
Packit 667938
       +?o   At the server console run:
Packit 667938
Packit 667938
            sys:/mrtg/bin/RunMrtg.ncf
Packit 667938
Packit 667938
           several times. By the third time it should run without showing
Packit 667938
           error messages on the console screen.
Packit 667938
Packit 667938
           This should create.
Packit 667938
Packit 667938
           - A HTML page in the (HtmlDir) directory for each monitored device,
Packit 667938
Packit 667938
           - A .dat file in the (ImageDir) directory for each monitored
Packit 667938
           device,
Packit 667938
Packit 667938
           - Several .png icons in the (ImageDir) directory,
Packit 667938
Packit 667938
           - Some log file entries in the (LogDir) directory.
Packit 667938
Packit 667938
           Note: If you experience a "Use of uninitialised value in split"
Packit 667938
           error, it will be necessary to create a 'Path' environment variable
Packit 667938
           at the server console; use the following example
Packit 667938
Packit 667938
            env path="SYS:\"  (The actual value is immaterial, as long as the var itself exists.)
Packit 667938
Packit 667938
       +?o   Edit sys:/mrtg/bin/MakeMrtgIndex.ncf. Change the indicated <path>
Packit 667938
           shown in the following example to match the value entered for
Packit 667938
           (HtmlDir).
Packit 667938
Packit 667938
            perl --noscreen sys:/mrtg/bin/indexmaker.pl sys:/mrtg/bin/Mrtg.cfg > <path>/index.html
Packit 667938
Packit 667938
       +?o   Create an index.html page linking the seperate device HTML page(s).
Packit 667938
           At the server console, run:
Packit 667938
Packit 667938
            sys:/mrtg/bin/MakeMrtgIndex.ncf
Packit 667938
Packit 667938
           This will create index.html in the (HtmlDir) directory.
Packit 667938
Packit 667938
       +?o   Optionally, configure a Web Server to permit access to the
Packit 667938
           directory specified in (HtmlDir) to view the MRTG graphs remotely,
Packit 667938
           at, for example:
Packit 667938
Packit 667938
            http://ip_or_dns/mrtg/index.html
Packit 667938
Packit 667938
           A sample configuration for an Apache Webserver is shown:
Packit 667938
Packit 667938
            Alias /mrtg/ "SYS:/mrtg/html/"
Packit 667938
            <Directory "SYS:/mrtg/html">
Packit 667938
                        AllowOverride None
Packit 667938
                        Order allow,deny
Packit 667938
                        Allow from all
Packit 667938
            </Directory>
Packit 667938
Packit 667938
       +?o   Set the property of the directory pointed to by (ImageDir), to
Packit 667938
           'Purge Immediate'.
Packit 667938
Packit 667938
       +?o   Finally, read the MRTG documentation for much more detailed
Packit 667938
           configuration/usage information.
Packit 667938
Packit 667938
       Welcome to MRTG!!
Packit 667938
Packit 667938
M?MA?AK?KE?E M?MR?RT?TG?G R?RU?UN?N A?AL?LL?L T?TH?HE?E T?TI?IM?ME?E
Packit 667938
       MRTG can be made to run periodically by at least two means:
Packit 667938
Packit 667938
       +?o   Using CRON Scheduling
Packit 667938
Packit 667938
       +?o   Running MRTG in Daemon Mode
Packit 667938
Packit 667938
   C?CR?RO?ON?N S?Sc?ch?he?ed?du?ul?li?in?ng?g
Packit 667938
       To use CRON scheduling, create a CRON Scheduler entry to execute the
Packit 667938
       RunMrtg.ncf file on a frequency appropriate for the server environment
Packit 667938
       and information desired. The following entry in the sys:\etc\crontab
Packit 667938
       file will execute MRTG every five minutes:
Packit 667938
Packit 667938
        0,5,10,15,20,25,30,35,40,45,50,55 * * * * sys:\mrtg\bin\runmrtg.ncf
Packit 667938
Packit 667938
       The CRON Scheduler (cron.nlm) can be started automatically by adding it
Packit 667938
       in AUTOEXEC.ncf or, manually loading it at the server console.
Packit 667938
Packit 667938
   M?MR?RT?TG?G i?in?n D?Da?ae?em?mo?on?n M?Mo?od?de?e
Packit 667938
       Refer to the MRTG-Reference document for information about the
Packit 667938
       'RunAsDaemon' option. Its use is outside the scope of this document.
Packit 667938
Packit 667938
T?TR?RO?OU?UB?BL?LE?ES?SH?HO?OO?OT?TI?IN?NG?G
Packit 667938
       Read the MRTG documents, Perl documents or, finally, submit questions
Packit 667938
       to the MRTG User forums.
Packit 667938
Packit 667938
       For NetWare specific issues, submit questions to the Perl forum at
Packit 667938
       news://developer-forums.novell.com/novell.devsup.perl (Novell Developer
Packit 667938
       Forums).
Packit 667938
Packit 667938
C?CO?OM?MP?PI?IL?LI?IN?NG?G R?RA?AT?TE?EU?UP?P.?.N?NL?LM?M
Packit 667938
       In addition to the rateup.c and Makefile.Netware supplied with the MRTG
Packit 667938
       release, you will also need:
Packit 667938
Packit 667938
       +?o   Metrowerks CodeWarrior with NetWare Support OR GCC Compiler (v3.0.3
Packit 667938
           or later) with NlmConv Utility
Packit 667938
Packit 667938
       +?o   Novell LibC NDK (February 2004 or later)
Packit 667938
Packit 667938
       +?o   GD Graphics Library (v2.0.33 or later)
Packit 667938
Packit 667938
       +?o   LibPNG Graphics Library (v1.2.8 or later)
Packit 667938
Packit 667938
       +?o   ZLib Library (v1.2.3 or later)
Packit 667938
Packit 667938
       +?o   The get_ver.awk script
Packit 667938
Packit 667938
       +?o   A copy of the GNU build tools.    (See
Packit 667938
           http://sourceforge.net/projects/gnuwin32/)
Packit 667938
Packit 667938
       The auxiliary libraries can be obtained from:
Packit 667938
Packit 667938
       GD Graphics Library.   (See http://www.boutell.com/gd/ )
Packit 667938
Packit 667938
       PNG Graphics Library.   (See http://libpng.sourceforge.net/ )
Packit 667938
Packit 667938
       zLib Compression Library.   (See http://www.gzip.org/zlib/ )
Packit 667938
Packit 667938
       Edit the Makefile.Netware file as required to match your installation
Packit 667938
       paths; search the file for the key word 'Edit'.
Packit 667938
Packit 667938
N?NE?ET?TW?WA?AR?RE?E S?SU?UP?PP?PO?OR?RT?T
Packit 667938
       For copies of the NCF and get_ver.awk scripts, see Appendix.
Packit 667938
Packit 667938
       For NetWare specific issues, submit questions to the Perl forum at
Packit 667938
       news://developer-forums.novell.com/novell.devsup.perl (Novell Developer
Packit 667938
       Forums).
Packit 667938
Packit 667938
       To move the MRTG application to a volume other than SYS: you will need
Packit 667938
       to edit the NCF scripts provided plus the MRTG[.pl] script itself in
Packit 667938
       two places.
Packit 667938
Packit 667938
N?NE?EW?W R?RA?AT?TE?EU?UP?P S?SW?WI?IT?TC?CH?H
Packit 667938
       The MRTG[.pl] script, when used on a NetWare platform, uses
Packit 667938
       Rateup[.nlm] with the new commandline switch:
Packit 667938
Packit 667938
            RATEUP -f filename
Packit 667938
Packit 667938
       where the filename parameter can include a leading path element.
Packit 667938
Packit 667938
       The file format is exactly the same as that used on the commandline by
Packit 667938
       other operating systems, including the leading path and name of the
Packit 667938
       Rateup NLM.
Packit 667938
Packit 667938
A?AP?PP?PE?EN?ND?DI?IX?X
Packit 667938
       The Appendix includes 'copies' of the following files:
Packit 667938
Packit 667938
       +?o   The NCF files used during MRTG configuration,
Packit 667938
Packit 667938
       To create copies of these files, simply 'cut and paste' into your
Packit 667938
       favourite 't?te?ex?xt?t e?ed?di?it?to?or?r' and save under their respective names. You
Packit 667938
       should remove the leading space from each line.
Packit 667938
Packit 667938
       _?M_?a_?k_?e_?M_?r_?t_?g_?C_?f_?g_?._?N_?C_?F
Packit 667938
Packit 667938
        # MakeMrtgCfg.NCF
Packit 667938
        # Purpose : Create the MRTG Configuration File
Packit 667938
        # Changed :  5/05/2005  New
Packit 667938
        # Located : SYS:MRTG\BIN
Packit 667938
        # Set For :
Packit 667938
        # Params  :
Packit 667938
Packit 667938
        # Edit this file and:
Packit 667938
Packit 667938
        # Replace ccccc with your device GET SNMP Community Name - If unsure try 'public'.
Packit 667938
        # Replace ddddd with your device IP (n.n.n.n) or domain name.
Packit 667938
Packit 667938
        perl --noscreen sys:\mrtg\bin\cfgmaker.pl ccccc@ddddd > sys:\mrtg\bin\Mrtg.cfg
Packit 667938
Packit 667938
        #
Packit 667938
        # End of MakeMrtgCfg.NCF
Packit 667938
Packit 667938
       _?R_?u_?n_?M_?r_?t_?g_?._?N_?C_?F
Packit 667938
Packit 667938
        # RunMrtg.NCF
Packit 667938
        # Purpose : Run the MRTG Application
Packit 667938
        # Changed :  5/05/2005  New
Packit 667938
        # Located : SYS:MRTG\BIN
Packit 667938
        # Set For :
Packit 667938
        # Params  :
Packit 667938
Packit 667938
        # The paths are as per the examples recommended in "Getting Started".
Packit 667938
Packit 667938
        perl --noscreen sys:\mrtg\bin\mrtg.pl sys:\mrtg\bin\mrtg.cfg
Packit 667938
Packit 667938
        #
Packit 667938
        # End of RunMrtg.NCF
Packit 667938
Packit 667938
       _?M_?a_?k_?e_?M_?r_?t_?g_?I_?n_?d_?e_?x_?._?N_?C_?F
Packit 667938
Packit 667938
        # MakeMrtgIndex.NCF
Packit 667938
        # Purpose : Create the HTML Index File for MRTG HTML data pages
Packit 667938
        # Changed :  5/05/2005  New
Packit 667938
        # Located : SYS:MRTG\BIN
Packit 667938
        # Set For :
Packit 667938
        # Params  :
Packit 667938
Packit 667938
        # Note: Edit this file and change the redirected output to the location
Packit 667938
        #       specified for HtmlDir or WorkDir. The sys:\apache2\htdocs\mrtg\index.html
Packit 667938
        #       is based on the examples in "Getting Started".
Packit 667938
Packit 667938
        perl --noscreen sys:\mrtg\bin\indexmaker.pl sys:\mrtg\bin\Mrtg.cfg > sys:\mrtg\html\index.html
Packit 667938
Packit 667938
        #
Packit 667938
        # End of MakeMrtgIndex.NCF
Packit 667938
Packit 667938
L?LI?IC?CE?EN?NS?SE?E
Packit 667938
       GNU General Public License
Packit 667938
Packit 667938
C?CR?RE?ED?DI?IT?TS?S
Packit 667938
       The MRTG for NetWare exists largely through the efforts of Guenter
Packit 667938
       Knauf and feedback from beta testers.
Packit 667938
Packit 667938
A?AU?UT?TH?HO?OR?R
Packit 667938
       Norm W..
Packit 667938
Packit 667938
Packit 667938
Packit 667938
2.17.7                            2018-07-13                  MRTG-NW-GUIDE(1)