lnvgy-sw-lxce-nagios-plugin

Project Notes

=========================================================================
Readme and Installation Tips
Lenovo XClarity Essentials Plug-in for Nagios
Software
=========================================================================
Lenovo XClarity Essential Plug-in for Nagios is a plugin for Nagios that
retrieves health status from Lenovo ThinkSystem. It provides complete
hardware-level visibility including detailed inventory, health status
(both overall and component-level health status) for supported devices.
It also has the capability to discovering all the Lenovo ThinkSystem
server in a network subsystem or in range of network IP address either
one time discovery (Active discovery) or SNMP cold trap based discovery
(Passive Discovery). It can be configured to receive the system alerts
via SNMP cold trap, and also send emails to users when there is a change
to the health status of managed systems, based on those alerts.

=========================================================================
CONTENTS
=========================================================================
1. Introduction
2. System Requirements
3. Installation
4. Configuration
5. Uninstallation
6. Trademarks and Disclaimers

=============================================================================
1. Introduction
=============================================================================
“lnvgy-sw-lxce-nagios-plugin” is a Nagios plug-in that supports collecting health
status of the following components of Lenovo ThinkSystem:
• System health
• Power Supply
• Temperature
• Fans (Cooling Devices)
• Voltage
• CPU
• Storage
• Memory
Both Nagios Core and Check_MK(omd) are supported by “lnvgy-sw-lxce-nagios-plugin”,
“lnvgy-sw-lxce-nagios-plugin” also has the capability to discover all the Lenovo
ThinkSystem servers in a network subsystem and in range of network IP address
(Active discovery) and SNMP power-on based discovery (Passive discovery, only
support Nagios)

=============================================================================
2. System Requirements
=============================================================================
2.1 Hardware Requirements
Supported Lenovo ThinkSystem servers are shown as below. Please refer to
Lenovo support website for latest list.
Support List:
Lenovo ThinkSystem SR630 Server
Lenovo ThinkSystem SR550 Server
Lenovo ThinkSystem SR530 Server
Lenovo ThinkSystem SR650 Server
Lenovo ThinkSystem SR850 Server
Lenovo ThinkSystem ST550 Server
Lenovo ThinkSystem SR950 Server
Lenovo ThinkSystem SD530 Server
Lenovo ThinkSystem SN550 Server
Lenovo ThinkSystem SN850 Server
Lenovo ThinkSystem SN590 Server

2.2 Software Requirements
2.2.1 OS supported
• RHEL 6/7
• Ubuntu 16
2.2.2 Nagios Core version
• Nagios Core 3.x
• Nagios Core 4.x
2.2.3 Nagios plug-in release binaries
• For RHEL: lnvgy-sw-lxce-nagios-plugin-1.0-1.x86_64.rpm
• For Ubuntu: lnvgy-sw-lxce-nagios-plugin-1.0.deb
2.2.4 Selinux
• Selinux service need to be shut down

=============================================================================
3. Installation
=============================================================================
3.1 Pre-requirements
For Nagios
• Nagios Core
• Python2.7 or Python3.5
• net-snmp-utils
• python modules: cryptograph
For Check_MK
• Check_MK(omd)

3.2 Install
"lnvgy-sw-lxce-nagios-plugin" can be downloaded from
exchange.nagios.org and installed on supported servers.

• Install the rpm:
# rpm -ivh lnvgy-sw-lxce-nagios-plugin-1.0-1.x86_64.rpm
Preparing... ########### [100%]
Updating / installing...
lnvgy-sw-lxce-nagios-plugin-1.0-1 ########### [100%]
lnvgy-sw-lxce-nagios-plugin has been installed in /opt/lenovo/

• Install the deb:
# dpkg -i lnvgy-sw-lxce-nagios-plugin-1.0.deb
Selecting previously unselected package lnvgy-sw-lxce-nagios-plugin.
(Reading database ... 98342 files and directories currently installed.)
Preparing to unpack lnvgy-sw-lxce-nagios-plugin-1.0-1_amd64.deb ...
Unpacking lnvgy-sw-lxce-nagios-plugin (1.0) ...
Setting up lnvgy-sw-lxce-nagios-plugin (1.0) ...
lnvgy-sw-lxce-nagios-plugin has been installed in /opt/lenovo/

3.3 File organization
“lnvgy-sw-lxce-nagios-plugin” will be installed in /opt/lenovo/, and
below is the file structure:
|-- README.txt
|
|-- install.py
|
|-- template
| |
| |-- active_temp.cfg
| |
| |-- passive_temp.cfg
|
|-- tools
| |
| |-- active_discovery.py
| |
| |-- check_mk_plugin.py
| |
| |-- nagios_cmk_base.py
| |
| |-- nagios_plugin.py
| |
| |-- parser_discovery_cfg.py
| |
| |-- __init__.py
| |
| |-- libexec
| | |
| | |-- alerthandle.py
| | |
| | |-- check_lenovo_xcc.py
| | |
| | |-- traphandle.py
| |
| |-- common_lib
| | |
| | |-- common_lib.py
| | |
| | |-- wato_import.py
| | |
| | |-- __init__.py
| |

=============================================================================
4. Configuration
=============================================================================
4.1 Get help messages
To get the help messages of “lnvgy-sw-lxce-nagios-plugin”, navigate to
/opt/lenovo/lnvgy-sw-lxce-nagios-plugin/, and run the following script:
# install.py –h
Also the soft link ‘lnvgy-sw-lxce-nagios-plugin’ was generated in /usr/bin/
which point to install.py, and you can run it in anywhere.
All the available “lnvgy-sw-lxce-nagios-plugin” options are displayed:

usage: install.py [-h] [-c] [-f CONFIGFILE] [-b PASSIVE_CONFIG]
[-i IMPORTHOST] [-a] [-p]

This program is designed to install Lenovo ThinkSystem plugin to Nagios or
Check_MK, and do some basic configuration.

optional arguments:
-h, --help show this help message and exit
-c, --check_mk Automatic installation for check_mk (Vanilla Nagios
is default option)
-f CONFIGFILE, --configfile CONFIGFILE
Config file for active discovery, the template file is
/opt/lenovo/lnvgy-sw-lxce-nagios-plugin/template/active_temp
.cfg
-b PASSIVE_CONFIG, --passive_config PASSIVE_CONFIG
Config file for passive discovery, the template file
is /opt/lenovo/lnvgy-sw-lxce-nagios-plugin/template/passive_
temp.cfg. (This parameter is only supported by Nagios)
-i IMPORTHOST, --importhost IMPORTHOST
Import ThinkSystem machine via the config file, the
template file is same with '-f'. Unlike '-f', it
doesn't require discovery, but adds all the host to
Nagios/Check_MK config file
-a, --activediscovery
Only run active discovery
-p, --passivediscovery
Only run passive discovery. (This parameter is only
supported by Nagios)

Visit the website at https://exchange.nagios.org/directory/Plugins/Hardware
/Server-Hardware/Lenovo/

4.2 For Nagios Core
1) Modify configure file for discovery. Navigate to
“/opt/lenovo/lnvgy-sw-lxce-nagios-plugin/template”, edit files
active_temp.cfg and passive_temp.cfg according to the instructions.
2) Run command ‘lnvgy-sw-lxce-nagios-plugin’.
Note: In order to monitor Lenovo ThinkSystem servers by passive discovery,
the monitoring server will be configured to receives the power-on trap
generated by Lenovo ThinkSystem servers.

4.3 For Check_MK
1) Modify configure file for discovery. Navigate to
“/opt/lenovo/lnvgy-sw-lxce-nagios-plugin/template”, edit file
active_temp.cfg according to the instructions.
2) Run command ‘lnvgy-sw-lxce-nagios-plugin -c’.

=============================================================================
5. Uninstallation
=============================================================================
1) For RHEL
# rpm -e lnvgy-sw-lxce-nagios-plugin
2) For Ubuntu
# dpkg -r lnvgy-sw-lxce-nagios-plugin

=============================================================================
6. Trademarks, License and Disclaimers
=============================================================================
* The following are registered trademarks of Lenovo.
o Lenovo
o The Lenovo Logo
* Intel is a registered trademark of Intel Corporation.
* Microsoft and Windows are registered trademarks of Microsoft Corporation.

Copyright 2018-present Lenovo

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

LENOVO PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.

Some jurisdictions do not allow disclaimer of express or implied warranties
in certain transactions, therefore, this statement may not apply to you. This
information could include technical inaccuracies or typographical errors.
Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. Lenovo may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.

BY FURNISHING THIS DOCUMENT, LENOVO GRANTS NO LICENSES TO ANY PATENTS OR COPYRIGHTS.