[check_openmanage.git] / README

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

Files included in the tarball and zip archive:

  check_openmanage                      - The plugin
  check_openmanage.exe                  - Win32 standalone executable
  check_openmanage.8                    - Man page
  check_openmanage.pod                  - Man page source
  check_openmanage.php                  - PNP4Nagios template
  nagios-plugins-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
* Removable flash media (SD cards)

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