Skip to main content

Sharepoint health monitor nagios plugin

Project description

Sharepoint HealthPlugin

Checks sharepoint HealthMonitor reports list and raise an alert if some is found.




sudo pip3 install sp-health --upgrade

Also is possible to use:

sudo python3 -m pip install sp-health --upgrade

On windows with python3.5:

pip install sp-health --upgrade

For proxies add:



Use the command line:

sphealth --help

usage: sphealth [-h] [-u [USER]] [-p [PASSWORD]] [-s [SITE_URL]]

optional arguments:
-h, --help            show this help message and exit
-u [USER], --user [USER]
                        Username for Ntlm auth like domain\user
-p [PASSWORD], --password [PASSWORD]
                        Password for Ntlm Auth like
-s [SITE_URL], --site [SITE_URL]
                        site url for sharepoint HealthMonitor, ex: http://site:9876

Example usage

Example use:

> sphealth -u domain\user -p pass -s http://spurl:9876
Information: http://spurl:9876 |alerts=9;1;2;0;

Example Command and service

Example host:

# we use CUSTOM MACRO for these Sharepoint SERVERS
# ADD _SPURLMON for each host
# Where _SPURLMON is the name of the root URL for Sharepoint Central Administration (without /HealthReports)
# Also add _SPUSER and _SPPASSWORD

define host
    host_name               HOSTXX1
    alias                   Sharepoint Host XX1
    parents                 SOMEDEVICE
    _SPURLMON           http://spurlfqdn:9876
    _SPUSER         domain\username
    _SPPASSWORD     somepassword
    address                 IP.ADD.RR.ESS
    use                         generic-host

Example group:

define hostgroup {
    hostgroup_name  sharepoint_servers
    alias                   Sharepoint servers
    members                 HOSTXX1,HOSTXX2

Example command:

define command{
    command_name  check_sphealth
    command_line  /usr/local/bin/sphealth -u '$ARG1$' -p '$ARG2$' -s '$ARG3$'

Example service:

define service {
    hostgroup_name          sharepoint_servers
    service_description     Sharepoint_HealthMonitor
    check_command           check_sphealth!$_HOSTSPUSER$!$_HOSTSPPASSWORD$!$_HOSTSPURLMON$
    notes                   Check the alerts from $_HOSTSPURLMON$ for sharepoint HealthMonitor
    use                     generic-service


  • Use hash passwords
  • Add Unit tests?


This command is installed and added in project:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sp-health, version 0.2.8
Filename, size File type Python version Upload date Hashes
Filename, size sp_health-0.2.8-py3-none-any.whl (7.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sp_health-0.2.8.tar.gz (5.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page