Refactoring: Moved more storage check parameters from unsorted.py to dedicated module...
[check_mk.git] / checkman / domino_tasks
blob67bfb813500b24f1d94b623bbd1e513f77eac012
1 title: IBM Lotus Domino: Count of Tasks
2 agents: snmp
3 catalog: app/lotusnotes
4 license: GPL
5 distribution: check_mk
6 description:
7  This check uses snmp to extract the list of currently running tasks
8  on IBMs Lotus Domino Servers. It monitors the number of tasks
9  matching a certain name or regular expression and checks it against
10  warning and critical upper and lower levels.
12 item:
13  A user definable service description.  The description must be unique
14  within each host.  Changing the description will make Nagios think that it
15  is another service.
17 inventory:
18  Since Check_MK cannot know which tasks should be monitored, an inventory
19  needs some configuration. The configuration is done via {inv_domino_tasks}.
20  The structure of this variable is a list of seven-tuples. It is similar but not
21  completely the same as the configuration of manual checks. The seven
22  components of each entry are: {(1)} a service description, {(2)} a pattern
23  (just as the first parameter of the check), {(3)} the boolean value {None}
24  and {(4)} - {(7)} the warning and critical levels for the number of processes.
26  During inventory Check_MK tries to match all entries on each
27  process found on the target host. If an entry matches, a new check will
28  be created according to the entry (if it's not already existing).
30  The {service description} may contain one or more occurances of {%s}. In this
31  case, the pattern must be a regular expression prefixed with ~. For each
32  {%s} in the description, the expression has to contain one "group". A group
33  is a subexpression enclosed in brackets, for example {(.*)} or
34  {([a-zA-Z]+)} or {(...)}. When the inventory finds a task
35  matching the pattern, it will substitute all such groups with the actual values when
36  creating the check. In this way one rule can create several checks on a host.
38  If the pattern contains more groups than occurrences of {%s} in the service
39  description, only the first matching subexpressions are used for the service
40  descriptions. The matched substrings corresponding to the remaining groups
41  are nevertheless copied into the regular expression.
43  As an alternative to {%s} you may also use {%1}, {%2}, etc.
44  These expressions will be replaced by the first, second, ... matching group, allowing
45  you to reorder things.
47  Wildcards not enclosed by brackets are simply copied verbatim to the created
48  checks. Please refer to the examples for more details.
50  The {user specification} must be the boolean value {None} because the check
51  uses the inventory function of the {ps} check, where this key is required.
53  The {warning and critical levels} are simply copied to the created
54  checks.
56  Inventory allows optional host specification.  You can prepend a list of
57  host names or a list of tag names and {ALL_HOSTS} to some of all rules of
58  the inventory specification. That way you can make the inventory apply some
59  rules only to certain hosts.