8.7. Integration of the WWW Interface into the Company Website

The WWW interface of Kerio Network Monitor enables access to particular pages or their parts using the special URL. Various charts or tables (e.g. chart of connection load, table of transferred data volume or view of current connections etc.) can be integrated into your own web site in this way.

General Format of URL

URL of pages from the WWW interface has, in general, this format:

http://netmon:81/directory/page

 ?parameter1=value&parameter2=value...

where:

  • netmon — DNS name or IP address of the computer, where Kerio Network Monitor runs.

    Note: Integration into another website must take into consideration if pages will be accessed from an internal network, from the Internet, or from both directions. The best way is to use the name of the server that has the aprropriate entries both in the internal and the public DNS.

  • 81 — port where the WWW interface of Kerio Network Monitor runs (see chapter 6.6)

  • directory — directory of the virtual Web server where the appropriate is stored

  • page — name of a page (see later)

  • parameter=value — name of a parameter and its value (see later). Parameters are optional — if some parameter is not introduced, the default value will be used. Unknown (non-existing) parameter will be ignored. Some pages don't require any parameters.

Note: Lower-case and upper-case letters in page names and parameter names should be preserved. Order of parameters doesn't matter.

All operations will be executed with the rights of anonymous user.

Current Connections

Current connections page can be displayed using the URL:

http://netmon:81/conn.html

The page doesn't have any configurable parameters.

Chart of Transferred Data Volume

The following URL displays the page with the chart of transferred data volume:

http://netmon:81/chart/form.html

 ?resolution=1&IP1=1.2.3.4&IP2=5.6.7.8

 &IP3=10.11.12.13&service=1

where:

  • resolution — time period from the following table:

    ValueMeaning
    01 minute
    15 minutes
    215 minutes
    31 hours
    46 hours
    51 day
    61 week
    71 month
    81 year

  • IP1, IP2, IP3 — IP addresses for which the transferred data volume will be displayed in the chart (ordered red, greed, blue). Instead of an IP address of a particular computer, the address 0.0.0.0 (sum of data volume for all computers) or 127.0.0.1 (loopback address; it will be replaced by the IP address of the computer, where the page was opened) can be entered.

  • service — monitored service:

    Value01234567
    MeaningAll servicesHTTPPOP3SMTPFTPTelnetIMAP4SSH

If the user wants to display an isolated chart (picture), he can use the following URL:

http://netmon:81/chart/image.png

All parameters described above remain valid.

Example:

http://netmon:81/chart/image.png

 ?resolution=3&IP1=0.0.0.0&IP2=127.0.0.1&service=1

This example shows an isolated chart for time period 1 hour, the transferred data volume for all computers will be highlighted in red color. The green color will represent the computer used for page viewing.

Table of Transferred Data Volume

The following URL shows the table of transferred data volume (Report) according to the specified parameters:

http://netmon:81/report/output.html

 ?interval=2&back=7&columnscount=7&columnswidth=1

 &sort=3&direction=3&service=0,

where:

  • interval — basis of column width, it is multiplied by the parameter columnwidth. The possible values are:

    Value012345
    Meaningminuteshoursdaysweeksmonthsyears
  • back — the beginning of the table will be moved “backwards” by the specified number of time periods. Value 0 means current time.

  • columnscount — number of columns in the table

  • columnswidth — width of column. This parameter multiplied by the interval parameter determines time interval covered by one column.

  • sort — table will be sorted by this value:

    Value123
    MeaningIP addresscomputer nametransferred data volume
  • direction — table will display data in this direction:

    Value123
    Meaningincoming (download)outgoing (upload)sum of both directions
  • service — data volume will be displayed for this services (see above — section Chart of transferred data volume)

Correct parameters settings will be demonstrated at the example.

http://netmon:81/report/output.html

 ?interval=2&back=1&columnscount=7

 &columnswidth=1&sort=3&direction=3&service=0

  • interval=2 — basis of column width will be one day

  • columnswidth=1 — column width (time period) will be 1 day

  • columnscount=7 — number of columns in table will be 7, the entire table will cover time period of 7 days (1 week)

  • back=1 — table moved backwards by one time period (i.e. 1 week). As a result, the table will cover time period “-2 weeks to -1 week”.

  • direction=3 — table will contain sum of incoming and outgoing data

  • service=0 — total volume of transferred data will be displayed (for all services)

Logs

Logs can be displayed using the URL:

http://netmon:81/log/output.html

 ?log=2&age=7&maxlines=1000&filter=text

where:

  • log — log file number according to the following table:

    Value234
    MeaningHTTP LogConnection LogMail Log
  • age — maximum age of log (in days)

  • maxlines — maximum number of output lines (if more lines satisfy the other conditions, only the most recent lines will be displayed)

  • filter — text to be searched. Only the lines containing this text will be displayed.