tpiccioli
/
ansible-roles
forked from ISTI-ansible-roles/ansible-roles
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
ansible-roles/nagios/files/check_dell_warranty.py

754 lines
28 KiB
Python
Raw Blame History

#!/usr/bin/env python
'''
Nagios plug-in to pull the Dell service tag and check it
against Dell's web site to see how many days remain. By default it
issues a warning when there is less than thirty days remaining and critical
when there is less than ten days remaining. These values can be adjusted
using the command line, see --help.
Version: 4.1
Created: 2009-02-12
Author: Erinn Looney-Triggs
Revised: 2013-05-13
Revised by: Erinn Looney-Triggs, Justin Ellison, Harald Jensas
https://gitorious.org/smarmy/check_dell_warranty/source/b6438fbef45ba22be3bf0aa2e0aa2e444a384813:
'''
#=============================================================================
# TODO: omreport md enclosures, cap the threads, tests, more I suppose
#
# Revision history:
# 2013-05-13 4.1: Catch SSL exceptions from requests module.
#
# 2013-04-09 4.0: Moved to using api.dell.com and changed out urllib2 in
# preference to the requests library.
#
# 2012-10-08 3.0.2: Add support for hyphen dates
#
# 2012-10-07 3.0.1: Dell dropped the counter for days left from their site,
# this is now calculated internally. Add patch for European style dates
# with periods between that numbers.
#
# 2012-09-05 3.0: Use Net-SNMP bindings for python allowing SNMPv3 support. Add
# debugging output using -V, Small cleanups.
#
# 2012-08-23 2.2.3: Merge in patch from Colin Panisset to dedup serials before
# mutex is created
#
# 2012-07-30 2.2.2: Make regex slightly more robust on scrape.
#
# 2012-07-03 2.2.1: Fix version number mismatch, fix urllib exception catch,
# thanks go to Sven Odermatt for finding that.
#
# 2012-01-08 2.2.0: Fix to work with new website, had to add cookie handeling
# to prod the site correctly to allow scrapping of the information.
#
# 2010-07-19 2.1.2: Patch to again fix Dell's web page changes, thanks
# to Jim Browne http://blog.jbrowne.com/ as well as a patch to work against
# OM 5.3
#
# 2010-04-13 2.1.1: Change to deal with Dell's change to their web site
# dropping the warranty extension field.
#
# 2009-12-17 2.1: Change format back to % to be compatible with python 2.4
# and older.
#
# 2009-11-16 2.0: Fix formatting issues, change some variable names, fix
# a file open exception issue, Dell changed the interface so updated to
# work with that, new option --short for short output.
#
# 2009-08-07 1.9: Add smbios as a way to get the serial number.
# Move away from old string formatting to new string formatting.
#
# 2009-08-04 1.8: Improved the parsing of Dell's website, output is now much
# more complete (read larger) and includes all warranties. Thresholds are
# measured against the warranty with the greatest number of days remaining.
# This fixes the bug with doubled or even tripled warranty days being
# reported.
#
# 2009-07-24 1.7: SNMP support, DRAC - Remote Access Controller, CMC -
# Chassis Management Controller and MD/PV Disk Enclosure support.
#
# 2009-07-09 1.6: Threads!
#
# 2009-06-25 1.5: Changed optparse to handle multiple serial numbers. Changed
# the rest of the program to be able to handle multiple serial numbers. Added
# a de-duper for serial numbers just in case you get two of the same from
# the command line or as is the case with Dell blades, two of the same
# from omreport. So this ought to handle blades, though I don't have
# any to test against.
#
# 2009-06-05 1.4 Changed optparse to display %default in help output. Pretty
# up the help output with <ARG> instead of variable names. Add description
# top optparse. Will now use prefer omreport to dmidecode for systems
# that have omreport installed and in $PATH. Note, that you do not have to be
# root to run omreport and get the service tag.
#
# 2009-05-29 1.3 Display output for all warranties for a system. Add up the
# number of days left to give an accurate count of the time remaining. Fix
# basic check for Dell's database being down. Fixed regex to be non-greedy.
# Start and end dates for warranty now takes all warranties into account.
# Date output is now yyyy-mm-dd because that is more international.
#
# 2009-05-28 1.2 Added service tag to output for nagios. Fixed some typos.
# Added command-line option for specifying a serial number. This gets
# rid of the sudo dependency as well as the newer python dependency
# allowing it to run on older RHEL distros. justin@techadvise.com
#
# 2009-05-27 1.1 Fixed string conversions to do int comparisons properly.
# Remove import csv as I am not using that yet. Add a license to the file.
#
# License:
# 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.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# 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 <http://www.gnu.org/licenses/>.
#
#=============================================================================
import datetime
import logging
import os
import subprocess
import sys
__author__ = 'Erinn Looney-Triggs'
__credits__ = ['Erinn Looney-Triggs', 'Justin Ellison', 'Harald Jensas' ]
__license__ = 'GPL 3.0'
__maintainer__ = 'Erinn Looney-Triggs'
__email__ = 'erinn.looneytriggs@gmail.com'
__version__ = '4.1'
__date__ = '2009-02-12'
__revised__ = '2013-05-13'
__status__ = 'Production'
#Nagios exit codes in English
UNKNOWN = 3
CRITICAL = 2
WARNING = 1
OK = 0
try:
import requests
except ImportError:
print ('Python Requests module (http://docs.python-requests.org/) '
'is required for this to work.')
sys.exit(CRITICAL)
def extract_mtk_community():
'''
Get SNMP community string from /etc/mtk.conf
'''
mtk_conf_file = '/etc/mtk.conf'
logger.debug('Obtaining serial number via {0}.'.format(mtk_conf_file))
if os.path.isfile(mtk_conf_file):
try:
for line in open(mtk_conf_file, 'r'):
token = line.split('=')
if token[0] == 'community_string':
community_string = token[1].strip()
except IOError:
print 'Unable to open {0}, exiting!'.format(mtk_conf_file)
sys.exit(UNKNOWN)
else:
print ('The {0} file does not exist, '
'exiting!').format(mtk_conf_file)
sys.exit(UNKNOWN)
return community_string
def extract_service_tag():
'''Extracts the serial number from the localhost using (in order of
precedence) omreport, libsmbios, or dmidecode. This function takes
no arguments but expects omreport, libsmbios or dmidecode to exist
and also expects dmidecode to accept -s system-serial-number
(RHEL5 or later).
'''
dmidecode = which('dmidecode')
libsmbios = False
omreport = which('omreport')
service_tags = []
#Test for the libsmbios module
try:
logger.debug('Attempting to load libsmbios_c.')
import libsmbios_c
except ImportError:
logger.debug('Unable to load libsmbios_c continuing.')
pass
else:
libsmbios = True
if omreport:
logger.debug('Obtaining serial number via OpenManage.')
import re
try:
process = subprocess.Popen([omreport, "chassis", "info",
"-fmt", "xml"],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
except OSError:
print 'Error: {0} exiting!'.format(sys.exc_info)
sys.exit(WARNING)
text = process.stdout.read()
pattern = '''<ServiceTag>(\S+)</ServiceTag>'''
regex = re.compile(pattern, re.X)
service_tags = regex.findall(text)
elif libsmbios:
logger.debug('Obtaining serial number via libsmbios_c.')
#You have to be root to extract the serial number via this method
if os.geteuid() != 0:
print ('{0} must be run as root in order to access '
'libsmbios, exiting!').format(sys.argv[0])
sys.exit(WARNING)
service_tags.append(libsmbios_c.system_info.get_service_tag())
elif dmidecode:
logger.debug('Obtaining serial number via dmidecode.')
#Gather the information from dmidecode
sudo = which('sudo')
if not sudo:
print 'Sudo is not available, exiting!'
sys.exit(WARNING)
try:
process = subprocess.Popen([sudo, dmidecode, "-s",
"system-serial-number"],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
except OSError:
print 'Error: {0} exiting!'.format(sys.exc_info)
sys.exit(WARNING)
service_tags.append(process.stdout.read().strip())
else:
print ('Omreport, libsmbios and dmidecode are not available in '
'$PATH, exiting!')
sys.exit(WARNING)
return service_tags
def extract_service_tag_snmp( options ):
'''
Extracts the serial number from the a remote host using SNMP.
This function takes the following arguments: hostname, community,
and mtk. The mtk argument will make the plug-in read the SNMP
community string from /etc/mtk.conf. (/etc/mtk.conf is used by
the mtk-nagios plugin.
(mtk-nagios plug-in: http://www.hpccommunity.org/sysmgmt/)
'''
try:
import netsnmp
except ImportError:
print "Unable to load netsnmp python module, aborting!"
sys.exit(UNKNOWN)
service_tags = []
hostname = options.hostname
port = options.port
version = options.version
logger.debug('Obtaining serial number via SNMP '
'version: {0}.'.format(version))
if version == 3:
sec_level = options.secLevel
sec_name = options.secName
priv_protocol = options.privProtocol
priv_password = options.privPassword
auth_protocol = options.authProtocol
auth_password = options.authPassword
session = netsnmp.Session(DestHost=hostname, Version=version,
SecLevel=sec_level, SecName=sec_name,
AuthProto=auth_protocol,
AuthPass=auth_password,
PrivProto=priv_protocol,
PrivPass=priv_password,
RemotePort = port,
)
elif version == 2 or version == 1:
community = options.community
session = netsnmp.Session(DestHost=hostname, Version=version,
Community=community, RemotePort=port)
else:
print 'Unknown SNMP version {0}, exiting!'.format(version)
def _autodetect_dell_device(session):
logger.debug('Beginning auto detection of system type.')
var = netsnmp.VarList(netsnmp.Varbind('SNMPv2-SMI::enterprises',
'.674.'))
session.getnext(var)
tag = var.varbinds.pop().tag
if tag.find('enterprises.674.10892.1.') != -1:
sys_type = 'omsa' #OMSA answered.
elif tag.find('enterprises.674.10892.2.') != -1:
sys_type = 'RAC' #Blade CMC or Server DRAC answered.
elif tag.find('enterprises.674.10895.') != -1:
sys_type = 'powerconnect' #PowerConnect switch answered.
else:
print ('snmpgetnext Failed:{0} System type or system '
'unknown!').format(tag)
sys.exit(WARNING)
logger.debug('System type is: {0}'.format(sys_type))
return sys_type
system_type = _autodetect_dell_device(session)
#System is server with OMSA, will check for External DAS enclosure
#and get service tag.
if system_type == 'omsa':
#Is External DAS Storage Enclosure connected?
var = netsnmp.VarList(netsnmp.Varbind('SNMPv2-SMI::enterprises',
'.674.10893.1.20.130.3.1.1'))
enclosure_ids = session.walk(var)
logger.debug('Enclosure IDs: {0}'.format(enclosure_ids))
for enclosure_id in enclosure_ids:
#For backwards compatibility with OM 5.3
if not enclosure_id:
continue
var = netsnmp.VarList(netsnmp.Varbind('SNMPv2-SMI::enterprises',
'.674.10893.1.20.130.3.1.16.{0}'.format(enclosure_id)))
enclosure_type = session.get(var)[0]
logger.debug('Enclosure type: {0}'.format(enclosure_type))
if enclosure_type != '1': #Enclosure type 1 is integrated backplane.
#Get storage enclosure Service Tag.
var = netsnmp.VarList(netsnmp.Varbind('SNMPv2-SMI::enterprises',
'.674.10893.1.20.130.3.1.8.{0}'.format(enclosure_id)))
enclosure_serial_number = session.get(var)[0]
logger.debug('Enclosure Serial Number obtained: {0}'
.format(enclosure_serial_number))
service_tags.append(enclosure_serial_number)
#Get system Service Tag.
var = netsnmp.VarList(netsnmp.Varbind('SNMPv2-SMI::enterprises',
'.674.10892.1.300.10.1.11.1'))
serial_number = session.get(var)[0]
elif system_type == 'RAC':
var = netsnmp.VarList(netsnmp.Varbind('SNMPv2-SMI::enterprises',
'.674.10892.2.1.1.11.0'))
serial_number = session.get(var)[0]
logger.debug('RAC serial number obtained: {0}'.format(serial_number))
elif system_type == 'powerconnect':
var = netsnmp.VarList(netsnmp.Varbind('SNMPv2-SMI::enterprises',
'.674.10895.3000.1.2.100'
'.8.1.4.1'))
serial_number = session.get(var)[0]
logger.debug('PowerConnect serial number obtained: {0}'
.format(serial_number))
service_tags.append(serial_number)
logger.debug('Service_tags obtained: {0}'.format(service_tags))
return service_tags
#
# #Get enclosure type.
# # 1: Internal
# # 2: DellTM PowerVaultTM 200S (PowerVault 201S)
# # 3: Dell PowerVault 210S (PowerVault 211S)
# # 4: Dell PowerVault 220S (PowerVault 221S)
# # 5: Dell PowerVault 660F
# # 6: Dell PowerVault 224F
# # 7: Dell PowerVault 660F/PowerVault 224F
# # 8: Dell MD1000
# # 9: Dell MD1120
def get_warranty_https(service_tag_list, timeout):
'''
Obtains the warranty information from Dell's website. This function
expects a list containing one or more serial numbers to be checked
against Dell's database.
'''
url = 'https://api.dell.com/support/v2/assetinfo/warranty/tags.json'
#Additional API keys, just in case:
#d676cf6e1e0ceb8fd14e8cb69acd812d
#849e027f476027a394edd656eaef4842
#apikey = '1adecee8a60444738f280aad1cd87d0e'
apikey = '849e027f476027a394edd656eaef4842'
service_tags = ''
if len(service_tag_list) == 1:
service_tags = service_tag_list[0]
else:
for service_tag in service_tag_list:
service_tags += service_tag + '|'
#Because we can't have a trailing '|'
service_tags = service_tags.rstrip('|')
logger.debug('Requesting service tags: {0}'.format(service_tags))
payload = {'svctags': service_tags, 'apikey': apikey}
try:
response = requests.get(url, params=payload, verify=False,
timeout=timeout)
except requests.exceptions.SSLError:
print 'Unable to verify SSL certificate for url: {0}'.format(url)
sys.exit(UNKNOWN)
try:
#Throw an exception for anything but 200 response code
response.raise_for_status()
except requests.exceptions.HTTPError:
print 'Unable to contact url: {0}.format(url)'
sys.exit(UNKNOWN)
logger.debug('Requesting warranty information from Dell url: '
'{0}'.format(response.url))
result = response.json()
logger.debug('Raw output received: \n {0}'.format(result))
#We test for any faults assserted by the api.
check_faults(result)
return result
def check_faults(response):
'''
This function checks the json content for faults that are rasied by Dell's
API. Any faults results in immediate termination with status UNKNOWN.
'''
logger.debug('Testing for faults in json response.')
fault = (response['GetAssetWarrantyResponse']['GetAssetWarrantyResult']
['Faults'])
logger.debug('Raw fault return: {0}'.format(fault))
if fault:
logger.debug('Fault found.')
code = fault['FaultException']['Code']
message = fault['FaultException']['Message']
print ('API fault code: "{0}" encountered, message: "{1}". '
'Exiting!'.format(code, message))
sys.exit(UNKNOWN)
logger.debug('No faults found.')
return None
def build_warranty_line(warranty, full_line, days, short_output):
'''
This function takes a warranty object and parses the salient information
out. It then calculates the number of days remaining in the warranty
period, and builds a line for Nagios outputting.
'''
logger.debug('Warranty contains')
description = warranty['ServiceLevelDescription']
end_date = warranty['EndDate']
start_date = warranty['StartDate']
provider = warranty['ServiceProvider']
logger.debug('Found: Start date: {0}, End Date: {1},Description: {2}, '
'Provider: {3}'.format(start_date, end_date, description,
provider))
#Because we need ot be able to calculate the time left as well as
#better formatting.
start_date = convert_date(start_date)
end_date = convert_date(end_date)
days_left = (end_date - datetime.date.today()).days
#Because no one cares about egative numbers of days.
if days_left < 0:
days_left = 0
logger.debug('Number of days left in warranty: '
'{0}'.format(days_left))
if short_output:
full_line = "%s, End: %s, Days left: %i" %(full_line, str(end_date.strftime('%m/%d/%Y')), days_left)
else:
full_line = "%s, Warranty: %s, Start: %s, End: %s, Days left: %i" %(full_line, description, str(start_date.strftime('%m/%d/%Y')),
str(end_date.strftime('%m/%d/%Y')), days_left)
days.append(int(days_left))
return full_line, days
def convert_date(date):
'''
This function converts the date as returned by the Dell API into a
datetime object. Dell's API format is as follows: 2010-07-01T01:00:00
'''
#Split on 'T' grab the date then split it out on '-'
year, month, day = date.split('T')[0].split('-')
return datetime.date(int(year), int(month), int(day))
def process_asset(asset, full_line, days, short_output):
'''
This function processes a json asset returned from Dell's API and
builds a line appropriate for Nagios output, as well as the service
tag for the line and the number of days remaining for each warranty
as a list.
'''
logger.debug('Raw asset being processed: {0}'.format(asset))
service_tag = asset['ServiceTag']
warranty = asset['Warranties']['Warranty']
if ( type(warranty) == type([]) ) and len(warranty) > 0:
warranty = warranty[0]
full_line, days = build_warranty_line(warranty, full_line,
days, short_output)
return service_tag, full_line, days
def parse_exit(result, short_output):
critical = 0
days = []
warning = 0
full_line = r'%s: Service Tag: %s'
logger.debug('Beginning to parse results and construct exit line '
'and code.')
assets = (result['GetAssetWarrantyResponse']['GetAssetWarrantyResult']
['Response']['DellAsset'])
logger.debug('Assets obtained: {0}'.format(assets))
#Check if there are multiple assets being provided
if isinstance(assets, list):
logger.debug('Multiple assets being processed.')
for asset in assets:
service_tag, full_line, days = process_asset(asset, full_line,
days, short_output)
#There is only one asset
else:
logger.debug('A single asset is being processed.')
asset = assets
service_tag, full_line, days = process_asset(asset, full_line,
days, short_output)
#Put the days remaining in ascending order
days.sort()
logger.debug('Days remaining on warranties: {0}'.format(days))
if days[-1] < options.critical_days:
state = 'CRITICAL'
critical += 1
elif days[-1] < options.warning_days:
state = 'WARNING'
warning += 1
else:
state = 'OK'
print full_line % (state, service_tag),
if critical:
sys.exit(CRITICAL)
elif warning:
sys.exit(WARNING)
else:
sys.exit(OK)
return None #Should never get here
def sigalarm_handler(signum, frame):
'''
Handler for an alarm situation.
'''
print ('{0} timed out after {1} seconds, '
'signum:{2}, frame: {3}').format(sys.argv[0], options.timeout,
signum, frame)
sys.exit(CRITICAL)
return None
def which(program):
'''This is the equivalent of the 'which' BASH built-in with a check to
make sure the program that is found is executable.
'''
def is_exe(file_path):
'''Tests that a file exists and is executable.
'''
return os.path.exists(file_path) and os.access(file_path, os.X_OK)
file_path = os.path.split(program)[0]
if file_path:
if is_exe(program):
return program
else:
for path in os.environ["PATH"].split(os.pathsep):
exe_file = os.path.join(path, program)
if is_exe(exe_file):
return exe_file
return None
if __name__ == '__main__':
import optparse
import signal
parser = optparse.OptionParser(description='''Nagios plug-in to pull the
Dell service tag and check it against Dell's web site to see how many
days remain. By default it issues a warning when there is less than
thirty days remaining and critical when there is less than ten days
remaining. These values can be adjusted using the command line, see --help.
''',
prog="check_dell_warranty",
version="%prog Version: {0}".format(__version__))
parser.add_option('-a', dest='authProtocol', action='store',
help=('Set the default authentication protocol for '
'SNMPv3 (MD5 or SHA).'))
parser.add_option('-A', dest='authPassword',
help=('Set the SNMPv3 authentication protocol password.')
)
parser.add_option('-C', '--community', action='store',
dest='community', type='string',default='public',
help=('SNMP Community String to use. '
'(Default: %default)'))
parser.add_option('-c', '--critical', dest='critical_days', default=10,
help=('Number of days under which to return critical '
'(Default: %default).'), type='int', metavar='<ARG>')
parser.add_option('-H', '--hostname', action='store', type='string',
dest='hostname',
help='Specify the host name of the SNMP agent')
parser.add_option('-l', dest='secLevel', default='noAuthNoPriv',
action='store',
help=('Set the SNMPv3 security level, (noAuthNoPriv'
'|authNoPriv|authPriv) (Default: noAuthNoPriv)'))
parser.add_option('--mtk', action='store_true', dest='mtk_installed',
default=False,
help=('Get SNMP Community String from /etc/mtk.conf if '
'mtk-nagios plugin is installed. NOTE: This option '
'will make the mtk.conf community string take '
'precedence over anything entered at the '
'command line (Default: %default)'))
parser.add_option('-p', '--port', dest='port', default=161,
help=('Set the SNMP port to be connected to '
'(Default:161).'), type='int')
parser.add_option('-s', '--service_tag', dest='service_tag',
help=('Dell Service Tag of system, to enter more than '
'one use multiple flags (Default: auto-detected)'),
action='append', metavar='<ARG>')
parser.add_option('-S', '--short', dest='short_output',
action='store_true', default = False,
help=('Display short output: only the status, '
'service tag, end date and days left for each '
'warranty.'))
parser.add_option('-t', '--timeout', dest='timeout', default=10,
help=('Set the timeout for the program to run '
'(Default: %default seconds)'), type='int',
metavar='<ARG>')
parser.add_option('-u', dest='secName', action='store',
help='Set the SNMPv3 security name (user name).')
parser.add_option('-v', dest='version', default=3, action='store',
help=('Specify the SNMP version (1, 2, 3) Default: 3'),
type='int'
)
parser.add_option('-V', dest='verbose', action='store_true',
default=False, help =('Give verbose output (Default: '
'Off)')
)
parser.add_option('-w', '--warning', dest='warning_days', default=30,
help=('Number of days under which to return a warning '
'(Default: %default)'), type='int', metavar='<ARG>' )
parser.add_option('-x', dest='privProtocol', action='store',
help='Set the SNMPv3 privacy protocol (DES or AES).')
parser.add_option('-X', dest='privPassword', action='store',
help='Set the SNMPv3 privacy pass phrase.')
(options, args) = parser.parse_args()
##Configure logging
logger = logging.getLogger("check_dell_warranty")
handler = logging.StreamHandler()
if options.verbose:
sys.stderr.write('Switching on debug mode.\n')
handler.setLevel(logging.DEBUG)
logger.setLevel(logging.DEBUG)
##Set the logging format, time, log level name, and the message
formatter = logging.Formatter('%(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)
signal.signal(signal.SIGALRM, sigalarm_handler)
signal.alarm(options.timeout)
if options.service_tag:
SERVICE_TAGS = options.service_tag
elif options.hostname or options.mtk_installed:
SERVICE_TAGS = extract_service_tag_snmp(options)
else:
SERVICE_TAGS = extract_service_tag()
RESULT = get_warranty_https(SERVICE_TAGS, options.timeout)
signal.alarm(0)
parse_exit(RESULT, options.short_output)
Reference in New Issue View Git Blame Copy Permalink