phpMrtgAdmin Documentation

Contents

1. Version info
2. Local documentation
3. Requirements
4. Introduction
5. Download
6. Installation
7. Usage
   1. Sheets
   2. Systems
   3. Types of interfaces
   4. Sorting
   5. Searching
   6. Displayable information
   7. Options
8. Subsidiary
   1. Calculator
   2. Log-viewer
9. Credits

Version info

Current version of phpMrtgAdmin is 1.06

Local documentation

• INSTALL
• LICENSE
• CHANGELOG
• TODO

Requirements

• MRTG 2.11.1 or newer
• Apache
• PHP 4.3.9 or newer
• PEAR packages: Core PEAR, Net::IPv4, Pager, PHP::Compat (the last package is used for compatibality with different versions of PHP)
• any web-browser

Download

The latest version of the phpMrtgAdmin is always available here.

Go to the link above, download the tool and follow the instructions described below.

Introduction

phpMrtgAdmin is the flexible PHP-based web-tool for monitoring of MRTG-created graphs.

The main features of phpMrtgAdmin are:

1. no any databases
2. customizable web-interface based on using of templates
3. presentation of dynamically changed of MRTG data set
4. show log-file as HTML and CSV-files
5. calculate traffic volume for time period

Dynamically generated pages can be consider as a slight imperfection of tool because of the each page generated once again.

Installation

For the installation see the INSTALL document.

Usage

There is full description about usage of phpMrtgAdmin.

The main idea of the phpMrtgAdmin is flexible presentation of routers information generated by Tobi Oetiker's MRTG.

Usually MRTG generates many html, log and graph files collected in the one place or structured by the routers. Although Tobi Oetiker proposes his RRD-tool for combine set of graphs, nevertheless growing number of interfaces per router did not allow to combine ones.

There are several criteria to select/sort/search/presenting of interfaces:

• Select by routers
• Select by interfaces
• Sort by part information got from interface
• Search by part information got from interface
• Display by part information got from interface
• Optional parameters controlling of web-pages behavour (title, page template, refresh period)

Sheets

Sheet list is the list of all pages that You create.

Systems (Routers)

Here You can select router (hardware system) to presentation.

Types of interfaces

There is the same list of interfaces and their groups used by MRTG cfgmaker and partially described by Tobi Oetiker at Predefined Filter Variables.

This is an integer specifying the interface type as per the SNMP standards and as reported by the polled device. A complete list of interface types would be impractical for this document , but there are a number predefined varables below. Normally, cfgmaker puts in the target's PageTop this iftype value within paranthesis after the name of the interface type. (e.g ``propPointToPointSerial (22)'').

Here You can select some interfaces one-by-one from the list or selecting groups of interfaces (use CTRL + MOUSE CLICK to multiple select). There are two select modes:

• Inclusive - select is accumulative
• Exclusive - next select clears previous select

Sorting

Here is the sorting criteria of interfaces:

• Interface number (html_if_title_desc)
• SNMP name
• SNMP description
• SNMP alias
• Interface type
• IP
• No sorting (as is)

If You use one of the sorting criteria You can define sorting order as ascending or descending

Searching

Searching criteria are the same as Sorting except No sorting. if You define searching string it will be made search of interfaces matching to searching string.

Searching string is the simpified regular expression such as DOS file system patterns * and ?. The reason of this clear -- avoid possible program errors due to human mistakes (all knows how to clear regexps)

Available patterns:

• ? -- one symbol or empty
• * -- several symbols or empty
• %s -- white space
• %a -- alphabetical only
• %d -- cifers only
• %% -- % (percent symbol)

Examples:

Search by alias containing as part alpha
*alpha*

Search by SNMP name
Fa1/*
The last example will show only interfaces Fa1/0, Fa1/0.1 etc
but not Fa0/0 or Fa2/0 etc

Search by SNMP name
Fa1/0 Fa1/1
This example shows only Fa1/0 and Fa1/1 interfaces

Displayable information

Displayable information (use CTRL + MOUSE CLICK to multiple select):

• Images
• Actual info (current, average, maximum bytes)
• Interface number (html_if_title_desc)
• SNMP name
• SNMP description
• SNMP alias
• Interface type
• IP

Options

Options define the text viewable at the top of page, html-template in use and refresh period in minutes

By default (if sheet title is not defined), the title is Interfaces of XXX, where XXX is the router (hardware system) as described at the section Systems (Routers).

Template is the symbolic name of pre-installed template for presentation of interfaces. There are two templates named as Default and Vertical. Difference between them is horizontal and vertical orientation of information. The good idea to use Default template for testing and Vertical for final presentation.

Refresh (or update) period is the amount of minutes of pages's refresh.

Period for out-of-date information might be useful for temporary turned off routers but later turned on.
"Period for out-of-date information" for temporary suppress display of old and out-of-date information. By default, this parameter sets to 5 minutes. It means that if routers data files are not modified during 5 minutes they will not be visible within this sheet. Available values are 5, 10, 15, 20, 30, 60, 120 minutes. The special never value means "become never out of date" in other words these data are visible always.

Subsidiary

Calculator

This window allows to calculate incoming and outgoing traffic

Log-viewer

This window allows to see log file

Credits

- Ildar N. Shaimordanov < phpmrtgadmin [AT] users [DOT] sourceforge [DOT] net >