[check_openmanage.git] / README

README file for check_openmanage
================================

Files included in the tarball and zip archive:

  check_openmanage       - The plugin
  check_openmanage.3pm   - Man page
  check_openmanage.pod   - Man page source
  check_openmanage.php   - PNP4Nagios template
  check_openmanage.spec  - RPM spec file
  COPYING                - License information
  INSTALL                - Install HOWTO
  install.bat            - Windows install script
  install.sh             - Linux/UNIX install script
  README                 - This file


About this program
------------------

check_openmanage is a plugin for Nagios which checks the hardware
health of Dell PowerEdge and some PowerVault servers. It uses the Dell
OpenManage Server Administrator (OMSA) software, which must be running
on the monitored system. check_openmanage can be used remotely with
SNMP or locally with NRPE, check_by_ssh or similar, whichever suits
your needs and particular taste. The plugin checks the health of the
storage subsystem, power supplies, memory modules, temperature probes
etc., and gives an alert if any of the components are faulty or
operate outside normal parameters.

The plugin can give performance data with the '-p' or '--perfdata'
switch. Performance data collected include temperatures, fan speeds
and power usage (on servers that support it).

Storage components checked:

* Controllers
* Physical drives
* Logical drives
* Cache batteries
* Connectors (channels)
* Enclosures
* Enclosure fans
* Enclosure power supplies
* Enclosure temperature probes
* Enclosure management modules (EMMs)

Chassis components checked:

* Processors
* Memory modules
* Cooling fans
* Temperature probes
* Power supplies
* Batteries
* Voltage probes
* Power usage
* Chassis intrusion

Other:

* ESM Log health
* ESM Log content (default disabled)
* Alert Log (default disabled, not SNMP)

check_openmanage will identify blades and will not report "missing"
power supplies, cooling fans etc. on blades. It will also accept that
other components are "missing", unless for components that should be
present in all servers. For example, all servers should have at least
one temperature probe, but not all servers have logical drives
(depends on the type and configuration of the controller).

This nagios plugin is designed to be used by either NRPE or with
SNMP. It is written in perl. In NRPE mode, it uses omreport to display
status on various hardware components. In SNMP mode, it checks the
same components as with omreport. Output is parsed and reported in a
Nagios friendly way.

More information avilable online:

  http://folk.uio.no/trondham/software/check_openmanage.html
Commit	Line	Data
4078196b	1	README file for check_openmanage
	2	================================
	3
	4	Files included in the tarball and zip archive:
	5
	6	check_openmanage - The plugin
	7	check_openmanage.3pm - Man page
	8	check_openmanage.pod - Man page source
	9	check_openmanage.php - PNP4Nagios template
	10	check_openmanage.spec - RPM spec file
	11	COPYING - License information
	12	INSTALL - Install HOWTO
	13	install.bat - Windows install script
	14	install.sh - Linux/UNIX install script
	15	README - This file
	16
	17
	18	About this program
	19	------------------
	20
	21	check_openmanage is a plugin for Nagios which checks the hardware
	22	health of Dell PowerEdge and some PowerVault servers. It uses the Dell
	23	OpenManage Server Administrator (OMSA) software, which must be running
	24	on the monitored system. check_openmanage can be used remotely with
	25	SNMP or locally with NRPE, check_by_ssh or similar, whichever suits
	26	your needs and particular taste. The plugin checks the health of the
	27	storage subsystem, power supplies, memory modules, temperature probes
	28	etc., and gives an alert if any of the components are faulty or
	29	operate outside normal parameters.
	30
	31	The plugin can give performance data with the '-p' or '--perfdata'
	32	switch. Performance data collected include temperatures, fan speeds
	33	and power usage (on servers that support it).
	34
	35	Storage components checked:
	36
	37	* Controllers
	38	* Physical drives
	39	* Logical drives
	40	* Cache batteries
	41	* Connectors (channels)
	42	* Enclosures
	43	* Enclosure fans
	44	* Enclosure power supplies
	45	* Enclosure temperature probes
	46	* Enclosure management modules (EMMs)
	47
	48	Chassis components checked:
	49
	50	* Processors
	51	* Memory modules
	52	* Cooling fans
	53	* Temperature probes
	54	* Power supplies
	55	* Batteries
	56	* Voltage probes
	57	* Power usage
	58	* Chassis intrusion
	59
	60	Other:
	61
	62	* ESM Log health
	63	* ESM Log content (default disabled)
	64	* Alert Log (default disabled, not SNMP)
65
66	check_openmanage will identify blades and will not report "missing"
67	power supplies, cooling fans etc. on blades. It will also accept that
68	other components are "missing", unless for components that should be
69	present in all servers. For example, all servers should have at least
70	one temperature probe, but not all servers have logical drives
71	(depends on the type and configuration of the controller).
72
73	This nagios plugin is designed to be used by either NRPE or with
74	SNMP. It is written in perl. In NRPE mode, it uses omreport to display
75	status on various hardware components. In SNMP mode, it checks the
76	same components as with omreport. Output is parsed and reported in a
77	Nagios friendly way.
78
79	More information avilable online:
80
81	http://folk.uio.no/trondham/software/check_openmanage.html
82