checkman/if

   1 title: Traffic and status of network interfaces using 32 bit counters
   2 agents: snmp
   3 catalog: hw/network/generic
   4 license: GPL
   5 distribution: check_mk
   6 description:
   7  This check monitors the operational status, link speed, traffic, packet
   8  counts, discards and errors of network interfaces by using the information
   9  provided by the standard SNMP MIB {.1.3.6.1.2.1.2.2} ({IF-MIB::ifTable}).
  10  This MIB is usually supported by all SNMP devices, such as routers, switches,
  11  firewalls and even operating systems such as Windows and Linux.
  12
  13  Depending on the check parameters this check can go WARN or CRIT when the
  14  port status changes (i.e. is down), when the link speed changes (e.g. a
  15  port expected to be set to 1GBit/s operates only at 100MBit/s), when the
  16  absolute or procentual traffic of a port exceeds certain levels or if the
  17  rate of errors or discards exceeds configurable limits.
  18
  19  As of Check_MK version 1.1.9i1 this check supports averaging the in- and
  20  outgoing traffic over a configurable range of time by using an exponentially
  21  weighted moving average - just as Linux does for the CPU load averages.
  22  The averaging can be configured on a per host and per port base. This is
  23  done by adding a key {"average"} to the parameter dictionary with the number
  24  of minutes that the average should cover as its key. Port with averaging
  25  turned on output two additional performance values: the averaged traffic
  26  in bytes. If you have configured traffic levels, then those levels are
  27  applied to the averaged values.
  28
  29  Please note: if your devices supports SNMP v2c you rather should add
  30  them to {bulkwalk_hosts} and use the check {if64}. That is almost identical
  31  to {if}, but support 64-Bit counters and {ifAlias}.
  32
  33 item:
  34  There are three allowed ways to specify a port: {1}: the last component of
  35  the SNMP OID number (as string), the {ifDescr} of the port or the {ifAlias} of
  36  the port. If you are using the alias, you have to make sure that it is unique
  37  by configuring useful aliases in the switch. Check_MK does not check for uniqueness.
  38
  39 inventory:
  40  The inventory creates one service for each port that fulfills configurable conditions.
  41  Per default these are ports which are currently found {up} and are of types {6} (ethernetCsmacd),
  42  {32} (frameRelay) or {117} (gigabitEthernet).
  43
  44  {Grouping:} In some situations you do not want to monitor a single
  45  interface but a group of interfaces that together form a pool.
  46  The {if} check supports such pools by defining groups.
  47  You can specifiy the members of a group by their port type and the item name(s) of
  48  the single interfaces. The data of all members is accumulated and put together
  49  in a single grouped interface service.
  50
  51  You can specify the groups with the ruleset {if_groups}.
  52  Groups are defined as list of dictionaries.
  53
  54  The keys are:
  55
  56   {"name"}:   String. Name of the group within the service description
  57
  58   {"iftype"}: Integer. Interface port type as integer
  59
  60   {"include_items"}: List of Strings. Interface item name. This name depends
  61   on further settings like if_inventory_uses_alias or if_inventory_uses_description
  62
  63   {"single"}(optional): Bool. Interfaces in this group do not show up
  64   as single service if "single" is set to True (Default: False)
  65
  66   For example: if_groups = ([{"name" : "Group WLAN", "iftype" : 6, "single" : True}], ["lan"], ALL_HOSTS )
  67