Licenses: Updated the list of licenses and added a PDF containing all license texts
[check_mk.git] / checkman / site_object_counts
blob12020c4aa42fbd68f74c1500d78607aa45cbe04f
1 title: Check_MK site objects
2 agents: linux
3 catalog: app/omd
4 license: GPL
5 distribution: check_mk
6 description:
7  This check collects information about the amount of different
8  host types or used check commands of Check_MK sites.
10  To make this check work please install the {{mk_site_object_counts}}
11  agent plugin and specify host tags or check commands within the
12  {{site_object_counts.cfg}} configration file. The following options
13  are available:
15  - {TAGS}: global host tags
17  - {SERVICE_CHECK_COMMANDS}: global check commands
19  - {SITES}: restriction to specified sites
21  - {TAGS_$SITENAME}: site specific host tags
23  - {SERVICE_CHECK_COMMANDS_$SITENAME}: site specific check commands
26  The agent plugin is executed if and only if OMD is installed and there's
27  a configuration file. Sites which provide an opened Livestatus socket
28  {/omd/sites/$SITENAME/tmp/run/live} are taken into account.
30  Without the restrictive option {SITES} all sites on that server are
31  considered which satisfy above conditions.
33  If more than one value is assigned they have to be separated by one space, eg.
35  - {TAGS=prod snmp}
37  - {SERVICE_CHECK_COMMANDS_sitename=kernel lnx_if}
40  {Example 1}
42  {TAGS=snmp}
44  {SERVICE_CHECK_COMMANDS=if}
46  With this configuration the agent plugin returns the amount of all SNMP hosts
47  and the amount of all interface services of the type {if} of all sites.
50  {Example 2}
52  {SITES=site_a site_b}
54  {TAGS=snmp}
56  {SERVICE_CHECK_COMMANDS=if}
58  With this configuration the agent plugin returns the amount of all SNMP hosts
59  and the amount of all interface services of the type {if} of the sites
60  {site_a} and {site_b}.
63  {Example 3}
65  {TAGS_site_a=snmp}
67  {SERVICE_CHECK_COMMANDS_site_a=if}
69  {TAGS_site_b=agent}
71  {SERVICE_CHECK_COMMANDS_site_b=lnx_if}
73  With this configuration the agent plugin returns
75  - the amount of all SNMP hosts and the amount of all interface services
76  of the type {if} of the site {site_a} and
78  - the amount of all agent-based hosts and the amount of all Linux interface
79  services of the type {lnx_if} of the site {site_b}.
82  {Example 4}
84  {TAGS=prod}
86  {SERVICE_CHECK_COMMANDS=omd_apache omd_status}
88  {TAGS_site_a=snmp}
90  {SERVICE_CHECK_COMMANDS_site_a=if}
92  {TAGS_site_b=agent}
94  {SERVICE_CHECK_COMMANDS_site_b=lnx_if}
96  With this configuration the agent plugin returns
98  - the amount of all productive hosts and services of type {omd_apache} and
99  {omd_status} of all sites.
101  - additionaly the amount of all SNMP hosts and the amount of all interface
102  services of the type {if} of the site {site_a} and
104  - additionaly the amount of all agent-based hosts and the amount of all
105  Linux interface services of the type {lnx_if} of the site {site_b}.
108  {Example 5}
110  {SITES=site_a site_b site_c}
112  {TAGS=prod}
114  {SERVICE_CHECK_COMMANDS=omd_apache omd_status}
116  {TAGS_site_a=snmp}
118  {SERVICE_CHECK_COMMANDS_site_a=if}
120  {TAGS_site_b=agent}
122  {SERVICE_CHECK_COMMANDS_site_b=lnx_if}
124  With this configuration the agent plugin returns
126  - the amount of all productive hosts and services of type {omd_apache} and
127  {omd_status} of the sites {site_a}, {site_b} and {site_c}.
129  - additionaly the amount of all SNMP hosts and the amount of all interface
130  services of the type {if} of the site {site_a} and
132  - additionaly the amount of all agent-based hosts and the amount of all
133  Linux interface services of the type {lnx_if} of the site {site_b}.
135  The check is cluster-aware and the check state is always OK.
137 inventory:
138  One service is created.