Licenses: Updated the list of licenses and added a PDF containing all license texts
[check_mk.git] / checkman / lnx_if
blob29a74f7f350d54e15518c57ce050ed7281ff68bf
1 title: State of network interfaces of Linux hosts
2 agents: linux
3 catalog: os/networking
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 of a Linux host using
9  data sent by the Check_MK agent. This check replaces the old checks
10  {netctr}, {netif.link} and {netif.counters} that have been in use up to
11  and including version 1.1.10. As opposed to the old checks {lnx_if} is
12  fully compatible with {if} and {if64} and shares all of its features,
13  including Perf-O-Meter, averaging, flexible configuration and NagVis
14  weathermaps.
16  Please note that the agent does only send information about the current
17  link speed setting and link status if {ethtool} is installed and supported
18  by the NIC.
20  Depending on the check parameters this check can go WARN or CRIT when the
21  port status changes (i.e. is down), when the link speed changes (e.g. a
22  port expected to be set to 1GBit/s operates only at 100MBit/s), when the
23  absolute or procentual traffic of a port exceeds certain levels or if the
24  rate of errors or discards exceeds configurable limits.
26  This check supports averaging the in- and
27  outgoing traffic over a configurable range of time by using an exponentially
28  weighted moving average - just as Linux does for the CPU load averages.
29  The averaging can be configured on a per host and per port base. This is
30  done by adding a key {"average"} to the parameter dictionary with the number
31  of minutes that the average should cover as its key. Port with averaging
32  turned on output two additional performance values: the averaged traffic
33  in bytes. If you have configured traffic levels, then those levels are
34  applied to the averaged values.
36 item:
37  There are three allowed ways to specify a port: {1}: the last component of
38  the SNMP OID number (as string), the {ifDescr} of the port or the {ifAlias} of
39  the port. If you are using the alias, you have to make sure that it is unique
40  by configuring useful aliases in the switch. Check_MK does not check for uniqueness.
42 inventory:
43  The inventory creates one service for each port that fulfills configurable conditions.
44  Per default these are ports which are currently found {up} and are of types {6} (ethernetCsmacd),
45  {32} (frameRelay) or {117} (gigabitEthernet).
47  {Grouping:} In some situations you do not want to monitor a single
48  interface but a group of interfaces that together form a pool.
49  The {if} check supports such pools by defining groups.
50  You can specifiy the members of a group by their port type and the item name(s) of
51  the single interfaces. The data of all members is accumulated and put together
52  in a single grouped interface service.
54  You can specify the groups with the ruleset {if_groups}.
55  Groups are defined as list of dictionaries.
57  The keys are:
59   {"name"}:   String. Name of the group within the service description
61   {"iftype"}: Integer. Interface port type as integer
63   {"include_items"}: List of Strings. Interface item name. This name depends
64   on further settings like if_inventory_uses_alias or if_inventory_uses_description
66   {"single"}(optional): Bool. Interfaces in this group do not show up
67   as single service if "single" is set to True (Default: False)
69   For example: if_groups = ([{"name" : "Group WLAN", "iftype" : 6, "single" : True}], ["lan"], ALL_HOSTS )