Refactoring: Moved more storage check parameters from unsorted.py to dedicated module...
[check_mk.git] / checkman / mcdata_fcport
blob5d0c5d36fd8e5288230105fa09fdd4464e2fa4c8
1 title: McData FibreChannel Switches: Traffic and Status of Ports
2 agents: snmp
3 catalog: hw/storagehw/mcdata
4 license: GPL
5 distribution: check_mk
6 description:
7  This check monitors the operational status, link speed, traffic, frame
8  counts, C3 discards and CRC errors of FibreChannel port of McData FC switches.
10  This check uses the internal logic of the {if}/{if64} check, so at some places
11  the naming conventions are a bit unusual (instead of frames, the check speaks
12  of packages, for example). The advantage of this approach is, on the other
13  hand, that this check makes use of all interesting features if {if}, such
14  as averaging, nice PNP templates, Perf-O-Meters and other stuff.
16  Depending on the check parameters this check can go WARN or CRIT when the
17  port status changes (i.e. is down), when the link speed changes (e.g. a
18  port expected to be set to 2GBit/s operates only at 1GBit/s), when the
19  absolute or procentual traffic of a port exceeds certain levels or if the
20  rate of errors or discards exceeds configurable limits.
22  This check supports averaging the in- and outgoing traffic over a configurable
23  range of time by using an exponentially weighted moving average - just as
24  Linux does for the CPU load averages.  The averaging can be configured on
25  a per host and per port base. This is done by adding a key {"average"}
26  to the parameter dictionary with the number of minutes that the average
27  should cover as its key. Port with averaging turned on output two additional
28  performance values: the averaged traffic in bytes. If you have configured
29  traffic levels, then those levels are applied to the averaged values.
31 item:
32  The port index as two digit string, for example {"03"} or {"24"}. The first
33  port has the number {"01"}.
35 inventory:
36  The inventory creates one service for each port that fulfills configurable conditions.
37  Per default these are ports which are currently found {up} and are of types {6} (ethernetCsmacd),
38  {32} (frameRelay) or {117} (gigabitEthernet). This check announces the port
39  type of {6} for the FC ports. This is not exactly correct but makes the inventory
40  find the FC ports without further configuration.
42  {Grouping:} In some situations you do not want to monitor a single
43  interface but a group of interfaces that together form a pool.
44  The {if} check supports such pools by defining groups.
45  You can specifiy the members of a group by their port type and the item name(s) of
46  the single interfaces. The data of all members is accumulated and put together
47  in a single grouped interface service.
49  You can specify the groups with the ruleset {if_groups}.
50  Groups are defined as list of dictionaries.
52  The keys are:
54   {"name"}:   String. Name of the group within the service description
56   {"iftype"}: Integer. Interface port type as integer
58   {"include_items"}: List of Strings. Interface item name. This name depends
59   on further settings like if_inventory_uses_alias or if_inventory_uses_description
61   {"single"}(optional): Bool. Interfaces in this group do not show up
62   as single service if "single" is set to True (Default: False)
64   For example: if_groups = ([{"name" : "Group WLAN", "iftype" : 6, "single" : True}], ["lan"], ALL_HOSTS )