Installation
Prev   Next

Installation

Installation Steps

  1. Unpack the archive in your directory

  2. Within the distribution directory, run: 

        ./configure
    make install

    If needed, --prefix (default is /usr/local/nmstools) and --localstatedir (default is PREFIX/var) may be changed. Futher in this manual, we refer to $NMSTOOLS_HOME as the value of --prefix, and $NMSTOOLS_DATA as the value of --localstatedir. These and other variables are defined and exported in $NMSTOOLS_HOME/bin/envvars.sh.

  3. Edit $NMSTOOLS_HOME/etc/devlogin.conf. Configuration options are:

    DEVLOGIN=login
    Username for telnet access
    DEVPASSWD=password
    Password for telnet access
    DEVENPASSWD=enable password
    Enable password. Not needed if the same as login password
    DEVNOTACACS=backuplogin
    Backup login in case if TACACS server is unreacheable
    DEVNOTACACSPW=password
    Backup password
    DEVNOTACACSEPW=enable password
    Backup enable password. Not needed if the same as login password
    DEVDOMAINNAME=domain
    All IOS devices should have a DNS entry, so that hostname.domain would give a fully-qualified device name.

  4. Edit $NMSTOOLS_HOME/etc/atm.conf. Set the option PNNISEEDNODE to one of your ATM switches. See atm_getpnnitopo.pl manual for more details.

  5. Edit $NMSTOOLS_HOME/etc/mpls.conf. Set the option ISISSEEDNODE to one of your MPLS routers. See mpls_getisistopo.pl manual for more details.

  6. Edit $NMSTOOLS_HOME/etc/ospf.conf. Set the option SEEDNODES to one or more OSPF router names separated by commas. See ospf_getnodelist.pl manual for more details.

  7. On the next run of make install, the contents of $NMSTOOLS_HOME/etc/ are not overwritten, thus all local settings are preserved.

Installation in Details

After copying the distribution files into the installation directory, Makefile replaces special template entries of the form %%VARIABLE%% with the values derived from installation options:
TemplateReplaced withDefault valueDescription
%%NMSTOOLS_HOME%%${prefix}/usr/local/nmstoolsInstallation Directory for NMS Tools
%%NMSTOOLS_DATA%%${localstatedir}/usr/local/nmstools/varData produced by the tools
%%NMSTOOLS_HTML%%${localstatedir}/htdocs/usr/local/nmstools/var/htdocsHTML and other web-accessed files generated
%%PERL%%Local site Perl binary Perl executable location

Apache HTTPD Setup

The file $NMSTOOLS_HOME/lib/httpd.conf needs to be included into HTTPD confoguration, as follows: 

# Include NMSTOOLS definitions
Include /usr/local/nmstools/lib/httpd.conf

The contents of $NMSTOOLS_HOME/lib/httpd.conf define the aliases and the ability to see the contents of the directories, as follows: 


Alias /nmstools "%%NMSTOOLS_HTML%%"
ScriptAlias /cgi-bin/nmstools "%%NMSTOOLS_HOME%%/cgi-bin"

<Directory "%%NMSTOOLS_HTML%%">
    Options Indexes
    AllowOverride None
</Directory>

Documentation

This very documentation is written in accordance to DocBook XML standard. Docbook sources are located in doc/docbook directory.

DocBook XSL Stylesheets are used for transforming the DocBook sources into HTML. The Makefile in doc/ directory creates HTML files in doc/html/, in two forms: a single file called nmstools-singlefile.html, and a set of chunked HTML files, one per section, starting with index.html. At the moment of writing, two versions of XSL stylesheets are tested: 1.47-exp and 1.45.

In the main distribution directory, make install puts all HTML documentation files into $NMSTOOLS_HTML/doc directory.
Prev Up Next
Requirements Home Tools reference