Changeset 1234

Timestamp:

Apr 3, 2017, 3:54:11 PM (8 years ago)

Author:

joergs

Message:

added queries 'listInstalled', 'isInstalled' and 'clientLastSeen'
Nagios NRPE compatible output for some queries
prepared for python3 (print function)

File:

• opsi/server/dass-opsi-tools/usr/bin/opsiclient (modified) (17 diffs)

opsi/server/dass-opsi-tools/usr/bin/opsiclient

@@ -5 +5 @@
 """ospi-client: performs operation for opsi clients on opsi server via JSON-RPC."""
 
+from __future__ import print_function
+
 __author__ = "Joerg Steffens"
-__copyright__ = "Copyright 2012-2015, dass IT GmbH"
+__copyright__ = "Copyright 2012-2017, dass IT GmbH"
 __license__ = "GPL"
-__version__ = "1.1"
+__version__ = "1.2"
 __email__ = "joerg.steffens@dass-it.de"
 
@@ -19 +21 @@
 
 import argparse
+from datetime import datetime, timedelta
+from dateutil import parser as dateparser
 import jsonrpc
 import logging
 import os
 from pprint import pprint, pformat
+import sys
 import time
 
@@ -29 +34 @@
 HelpEpilog="WARNING: python-json-rpc is known to have problems with HTTP proxies. In case of problems, make sure, the environment variables http_proxy and/or https_proxy are *not* set."
 
+class Nrpe:
+    OK = 0
+    WARNING = 1
+    CRITICAL = 2
+    UNKNOWN = 3
+    
+    def toString(self, status):
+        if status == self.OK:
+            return 'OK'
+        elif status == self.WARNING:
+            return 'WARNING'
+        elif status == self.CRITICAL:
+            return 'CRITICAL'
+        else:
+            return 'UNKNOWN'
+
+class Output(Nrpe):
+    def __init__(self, nagios=False):
+        self.nagios = nagios
+        self.result = Nrpe.UNKNOWN
+        self.message = ''
+
+    def setStatus(self, status, message = None):
+        self.result = status
+        if message is not None:
+            self.setMessage(message)
+
+    def setMessage(self, string):
+        self.message = string
+
+    def finalize(self):
+        if self.nagios:
+            print('{0} - {1}'.format(self.toString(self.result), self.message))
+            sys.exit(self.result)
+        else:
+            print('{0} - {1}'.format(self.toString(self.result), self.message))
+            return (self.result == Nrpe.OK)
+
 class OpsiRpc:
 
@@ -35 +78 @@
     ProductAttributesCopy = ['actionRequest','actionResult','installationStatus','packageVersion','productVersion']
 
-    def __init__(self, urlJsonRpc = UrlJsonRpcDefault, debug=False ):
+    def __init__(self, urlJsonRpc = UrlJsonRpcDefault, debug=False, nagios=False):
         self.logger=logging.getLogger(__name__)
         self.debug=debug
+        self.nagios=nagios
         self.urlJsonRpc=urlJsonRpc
         self.rpc=jsonrpc.ServiceProxy(self.urlJsonRpc)
@@ -44 +88 @@
 
     def list(self):
-        print( "\n".join( self.rpc.getClientIds_list() ) )
-        return True
+        try:
+            print( "\n".join( self.rpc.getClientIds_list() ) )
+        except jsonrpc.json.JSONDecodeException as e:
+            self.logger.debug( pformat(self.rpc.getClientIds_list()) )
+            self.logger.exception( "failed" )
+            return True
 
 
@@ -51 +99 @@
         return self.rpc.productOnClient_getObjects( [], { "productId": product, "installationStatus": "installed" } )
 
+    def getHardwareSerialNumber(self, src):
+        serialNumbers  = self.rpc.auditHardwareOnHost_getHashes( [], {"hostId":src, "hardwareClass":"BIOS", "serialNumber":"*"} )
+        serialNumbers += self.rpc.auditHardwareOnHost_getHashes( [], {"hostId":src, "hardwareClass":"CHASSIS", "serialNumber":"*"} )
+        result = set()
+        for i in serialNumbers:
+            if i['serialNumber']:
+                result.add(i['serialNumber'])
+        if len(result) == 1:
+            return result.pop()
+        elif len(result) > 1:
+            self.logger.warning("found more then one serial number")
+            return list(result)
 
     def listClients( self, product ):
         if product:
             for client in self.getClientsWithProduct( product ):
-                print client['clientId']
+                print(client['clientId'])
         else:
             return self.list()
@@ -65 +125 @@
     def info(self, src):
         if not self.exists( src ):
-            print "failed: opsi client", src, "does not exist"
+            print("failed: opsi client", src, "does not exist")
             return False
-        print src + ":"
+        print(src + ":")
         host = self.rpc.host_getHashes( [], {"id":src} )[0]
-        print "  IP:", host["ipAddress"]
-        print "  MAC:", host["hardwareAddress"]
-        print "  inventory:", host["inventoryNumber"]
-        print "  last seen:", host["lastSeen"]
-        print "  notes:", host["notes"]
-        print "  depot:", self.clientGetDepot( src )
-
-        print "  products:"
+        print("  IP:", host["ipAddress"])
+        print("  MAC:", host["hardwareAddress"])
+        print("  inventory:", host["inventoryNumber"])
+        print("  serial number:", self.getHardwareSerialNumber(src))
+        print("  last seen:", host["lastSeen"])
+        print("  notes:", host["notes"])
+        print("  depot:", self.clientGetDepot(src))
+
+        print("  products:")
         products = self.getProductOnClient( src, [] )
         for i in products:
-            print "    " + i['productId'] + ":"
-            print "      " + i['installationStatus'], "(",
+            print("    " + i['productId'] + ":")
+            print("      " + i['installationStatus'], "(", end='')
             if i['actionRequest']:
-                print i['actionRequest'],
+                print(i['actionRequest'], end='')
                 if i['actionProgress']:
-                    print i['actionProgress'],
-            print ")"
-            print "      ",
+                    print(i['actionProgress'], end='')
+            print(")")
+            print("      ", end='')
             pprint( i, indent=8 )
         return True
@@ -159 +220 @@
     def copyClient( self, src, dst, ipAddress = None, hardwareAddress = None, depot = None, description = "", copyProperties = True ):
 
-        print "create/update", dst, "from template", src + ":",
+        print("create/update", dst, "from template", src + ":", end='')
         obj = {
           "id" : dst,
@@ -185 +246 @@
         if copyProperties:
             if self.debug:
-                print "copy product properties"
+                print("copy product properties")
             if not depot:
                 # get default Properties from Master Depot Server (OpsiConfigserver)
                 depot = self.getOpsiConfigserverId()
             self.copyProductPropertyState( src, dst, depot )
-        print "done"
+        print("done")
         return True
 
@@ -201 +262 @@
         for i in products_src:
             if self.debug: 
-                print i['productId']
+                print(i['productId'])
                 pprint( i )
             i['clientId'] = dst
@@ -230 +291 @@
                         use_default=True
             if self.debug:
-                print i['productId'], "-", i["propertyId"] + ": ", pformat(i["values"]),
+                print(i['productId'], "-", i["propertyId"] + ": ", pformat(i["values"]), end='')
                 if use_default:
-                    print "(use default)"
+                    print("(use default)")
                 else:
-                    print "(set, default:", default_value, ")"
+                    print("(set, default:", default_value, ")")
             if not use_default:
                 i['objectId'] = dst
@@ -269 +330 @@
         fd.write( '  Address  = "' + client['clientId'] + '"' + "\n" )
         # ipAddress: method host_getObjects [] '{"id":client['clientId']}'
-        #print "  # Address =", ipAddress
+        #print("  # Address =", ipAddress)
         fd.write( '  Password = "' + properties['filedaemon_full_password'] + '"' + "\n" )
         try:
@@ -348 +409 @@
             return True
 
+    def __getVersionString(self, product):
+        return '{productVersion}-{packageVersion}'.format(**product)
+
+    def getProductCurrentVersion(self, productId):
+        products = self.rpc.product_getHashes( [], { 'id': productId } )
+        if products:
+            return self.__getVersionString(products[0])
+        else:
+            return None
+
+    def __getClientId(self, d):
+        return d.get("clientId")
+
+    def listInstalled(self, productId):
+        productVersion = self.getProductCurrentVersion(productId)
+        self.logger.debug('version: {0}'.format(productVersion))
+        products = self.rpc.productOnClient_getHashes( [], { 'productId': productId } )
+        for i in sorted(products, key=self.__getClientId):
+            i['version'] = self.__getVersionString(i)
+            if i.get('installationStatus') == 'installed':
+                if productVersion != i['version']:
+                    i['proposedAction'] = 'update'
+                else:
+                    i['proposedAction'] = 'None'
+                print('{clientId}: {version} (proposed action={proposedAction})'.format(**i))
+            else:
+                i['proposedAction'] = 'install'
+                print('{clientId}: (proposed action={proposedAction})'.format(**i))
+                self.logger.debug('{clientId}: {actionRequest} {installationStatus} {version}'.format(**i))
+            #pprint( i, indent=8 )
+        return True
+
+    def isInstalled(self, clientId, productId):
+        """
+        CRITICAL: not installed
+        WARNING: installed, but not current version
+        OK: current version is installed
+        UNKNOWN: otherwise
+        """
+        output = Output(self.nagios)
+        if not self.exists(clientId):
+            output.setMessage("failed: opsi client {0} does not exist".format(clientId))
+            return output.finalize()
+        productVersion = self.getProductCurrentVersion(productId)
+        if not productVersion:
+            output.setMessage("failed: product {0} does not exist".format(productId))
+            return output.finalize()
+        self.logger.debug('version: {0}'.format(productVersion))
+        products = self.rpc.productOnClient_getHashes( [], { "clientId": clientId,'productId': productId } )
+        if len(products) != 1:
+            print("failed: opsi client ({0}) product ({1}) combination does not exist".format(clientId, productId))
+            return False            
+        for i in sorted(products, key=self.__getClientId):
+            i['version'] = self.__getVersionString(i)
+            if i.get('installationStatus') == 'installed':
+                if productVersion != i['version']:
+                    i['proposedAction'] = 'update'
+                    output.setStatus(Nrpe.WARNING)
+                else:
+                    i['proposedAction'] = 'None'
+                    output.setStatus(Nrpe.OK)
+                output.setMessage('{version} (proposed action={proposedAction})'.format(**i))
+            else:
+                i['proposedAction'] = 'install'
+                output.setStatus(Nrpe.CRITICAL, 'not installed (proposed action={proposedAction})'.format(**i))
+                self.logger.debug('{clientId}: {actionRequest} {installationStatus} {version}'.format(**i))
+        return output.finalize()
+
+
+    def clientLastSeen(self, clientId):
+        """
+        < 1 day: OK
+        < 2 days: WARNING
+        otherwise: CRITICAL
+        """
+        output = Output(self.nagios)
+        if not self.exists(clientId):
+            output.setMessage("failed: opsi client {0} does not exist".format(clientId))
+            return output.finalize()
+        host = self.rpc.host_getHashes( [], {"id":clientId} )[0]
+        lastSeen = dateparser.parse(host["lastSeen"])
+        output.setMessage(str(lastSeen))
+        diff = datetime.now() - lastSeen
+        output.setMessage('{0} ({1} ago)'.format(str(lastSeen), diff))
+        if diff < timedelta(1):
+            output.setStatus(Nrpe.OK)
+        elif diff < timedelta(2):
+            output.setStatus(Nrpe.WARNING)
+        else:
+            output.setStatus(Nrpe.CRITICAL)
+        return output.finalize()
+
 
 
@@ -358 +511 @@
 
     parser.add_argument( '--debug', action='store_true', help="enable debugging output" )
+    parser.add_argument('--nagios', action='store_true', help='output in Nagios NRPE format')
 
     parser_url = parser.add_mutually_exclusive_group(required=True)
@@ -395 +549 @@
     parser_info = subparsers.add_parser('info', help='print information about a opsi client' )
     parser_info.add_argument( 'src', help="opsi client" )
+    
+    parser_clientLastSeen = subparsers.add_parser('clientLastSeen', help='print information about a opsi client' )
+    parser_clientLastSeen.add_argument( 'client', help="opsi client" )
+
+    parser_listInstalled = subparsers.add_parser('listInstalled', help='check if product is installed on client')
+    parser_listInstalled.add_argument('product', help='opsi product')
+
+    parser_isInstalled = subparsers.add_parser('isInstalled', help='check if product is installed on client')
+    parser_isInstalled.add_argument('client', help='opsi client')
+    parser_isInstalled.add_argument('product', help='opsi product')
 
     parser_update = subparsers.add_parser('update', help='update/create a opsi client')
@@ -422 +586 @@
             parser.error( "argument --url is required" )
 
-    opsi=OpsiRpc( url, args.debug )
+    opsi=OpsiRpc(url, args.debug, args.nagios)
 
     result = True
@@ -443 +607 @@
         elif args.subcommand == "update": 
             result = opsi.updateClient( args.src, None, args.description, args.notes, args.inventory, args.mac, args.ip, args.depot )
-        else:
-            print "not yet implemented"
+        elif args.subcommand == 'listInstalled': 
+            result = opsi.listInstalled(args.product)
+        elif args.subcommand == 'isInstalled': 
+            result = opsi.isInstalled(args.client, args.product)
+        elif args.subcommand == 'clientLastSeen': 
+            result = opsi.clientLastSeen(args.client)
+        else:
+            print("not yet implemented")
     except IOError as e:
         result = False
         # connection refused
-        print "failed:", e
-
-    if args.debug: print result
+        print("failed:", e)
+
+    if args.debug: print(result)
 
     if result: