Torrus plugin for M-net Telekommunikations

Status: Release candidate; Last modified: 7-AUG-2010

Introduction

This plugin is aiming the automation requirements at M-net Telekommunikations (www.m-net.de).

The interface descriptions of the form ``key1=val1;key2=val2;...'' are interpreted by the plugin and corresponding actions are performed.

Installation

Follow the Torrus installation guide for the main software installation.

Unpack the plugin distribution package in some directory:

  gzip -dc tp-m-net-1.X.tar.gz | tar xvf -

Then run the Torrus plugin installation utility:

  torrus install_plugin tp-m-net-1.X

No restarting is needed.

Usage

Out of the interface description string of format ``key1=val1;key2=val2;...'' the following key values are interpreted:

bw

Indicates the interface bandwidth in bits/second. Scale suffixes (T, G, M, K) are supported (i.e. 5G is equal to 5.0e9). The limits are used in graph display and also for setting up threshold monitors. The following interface parameters are set to the correspomding numbers: bandwidth-limit-in, bandwidth-limit-out, upper-limit, mnet-bw, monitor-vars. If the <bw> parameter is missing in the interface description, the physical interface speed is used.

Every key-and-value pair is also reflected in interface parameters mnet-attr-KEY.

Discovery parameters:

M_net::manage

The plugin processes only hosts which have this parameter set to yes.

M_net::skip-interfaces

Comma-separated list of interface names (their correspomnding subtree names). These interfaces are skipped from plugin processing.

M_net::nodeid-prefix-key

Defines a key that is used for nodeid prefix instead of default value if//%nodeid-device%//InterfaceName//. If the interface contains the specified key and value, the nodeid prefix is replaced with KEY//VALUE//.

Selectors

The M-net selectors extend the functionality of RFC2863_IF_MIB selectors. The selectors of the type M_net act upon the device interfaces in the same manner as the RFC2863_IF_MIB selectors. The only difference is that the selector attributes are the keys used in interface descriptions.

The selector attributes may have optional numeric postfix, in order to match several attribute extpressions.

The following example sets up the monitors on all interfaces which have ct=UPSTREAM or ct=BB and st=act. It also illustrates how 2 levels of threshold monitoring can be set up for input and output bandwidth usage:

  <param name="M_net::manage" value="yes"/>
  <param name="selectors" value="mymon"/>
  <param name="mymon-selector-type" value="M_net"/>
  <param name="mymon-selector-expr"  value="{ct1},{ct2},OR,{st},AND"/>
  <param name="mymon-ct1"  value="^UPSTREAM$"/>
  <param name="mymon-ct2"  value="^BB$"/>
  <param name="mymon-st"  value="^act$"/>
  <param name="mymon-selector-actions">
     InBytesMonitor, OutBytesMonitor
  </param>
  <param name="mymon-InBytesMonitor-arg" 
     value="mnet-bwoctets-1,mnet-bwoctets-2"/>
  <param name="mymon-OutBytesMonitor-arg" 
     value="mnet-bwoctets-1,mnet-bwoctets-2"/>

Monitors

The M_net plugin also delivers the file m-net/m-net-monitors.xml which can be included into the configuration. The file defines the monitors and actions and two tokensets warnings and critical.

Development of this plugin was sponsored by M-net Telekommunikations GmbH.


Author

Copyright (c) 2010 Stanislav Sinyagin <ssinyagin@yahoo.com>