Refactoring: Moved more storage check parameters from unsorted.py to dedicated module...
[check_mk.git] / checkman / netapp_api_if
blobbd138a5b1a8ade527d8e121e8103037d50154198
1 title: State of network interfaces
2 agents: netapp
3 catalog: hw/storagehw/netapp
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 NetApp Filer.
10  Right now only the ethernet and virtual interfaces are checked.
12  For virtual interfaces the check raises a WARN if not all members of
13  this virtual interface have the same speed set.
15  Depending on the check parameters this check can go WARN or CRIT when the
16  port status changes (i.e. is down), when the link speed changes (e.g. a
17  port expected to be set to 1GBit/s operates only at 100MBit/s), when the
18  absolute or procentual traffic of a port exceeds certain levels or if the
19  rate of errors or discards exceeds configurable limits.
21  This check supports averaging the in- and outgoing traffic over a
22  configurable range of time by using an exponentially weighted moving average.
23  The averaging can be configured on a per host and per port base. This is
24  done by adding a key {"average"} to the parameter dictionary with the number
25  of minutes that the average should cover as its key. Port with averaging
26  turned on output two additional performance values: the averaged traffic
27  in bytes. If you have configured traffic levels, then those levels are
28  applied to the averaged values.
30  It might be a good idea to use the option "Use description as service name
31  for network interface checks", since there is no real interface index available
32  and can change over time.
34 item:
35  There are three allowed ways to specify a port: {1}: the index of the interface
36  (depends on the order of the data reported by the agent), the {ifDescr} of
37  the port or the {ifAlias} of the port. If you are using the alias, you have to
38  make sure that it is unique by configuring useful aliases in the switch.
39  Check_MK does not check for uniqueness.
41 inventory:
42  The inventory creates one service for each port that fulfills configurable conditions.
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.
51  You can specify the groups with the ruleset {if_groups}.
52  Groups are defined as list of dictionaries.
54  The keys are:
56   {"name"}:   String. Name of the group within the service description
58   {"iftype"}: Integer. Interface port type as integer
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
63   {"single"}(optional): Bool. Interfaces in this group do not show up
64   as single service if "single" is set to True (Default: False)
66   For example: if_groups = ([{"name" : "Group vFiler0", "iftype" : 6, "single" : True}], ["lan"], ALL_HOSTS )