sensors_not_checked_in.py

#!/usr/bin/env python
#
#The MIT License (MIT)
#
# Copyright (c) 2015 Bit9 + Carbon Black
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
# -----------------------------------------------------------------------------
#
#  last updated 2015-11-13 by Jason McFarland jmcfarland@bit9.com
#

import sys
import optparse
import cbapi
import dateutil.parser
import datetime
import pytz

def build_cli_parser():
    parser = optparse.OptionParser(usage="%prog [options]", description="Dump sensor list")

    # for each supported output type, add an option
    #
    parser.add_option("-c", "--cburl", action="store", default=None, dest="url",
                      help="CB server's URL.  e.g., http://127.0.0.1 ")
    parser.add_option("-a", "--apitoken", action="store", default=None, dest="token",
                      help="API Token for Carbon Black server")
    parser.add_option("-n", "--no-ssl-verify", action="store_false", default=True, dest="ssl_verify",
                      help="Do not verify server SSL certificate.")
    parser.add_option("-f", "--format", action="store", default='plain', dest="format",
                      help="Output in pipe-delimited ('pipe'), plaintext ('plain') format or csv ('csv'); plain by default")
    parser.add_option("-g", "--group", action="store", default=None, dest="groupid",
                      help="Limit sensor listing to just those specified by the sensor group id provided")
    parser.add_option("-t", "--hours", action="store", default="6", dest="hours",
                      help="Number of hours since last checked in")
    return parser

def main(argv):
    parser = build_cli_parser()
    opts, args = parser.parse_args(argv)
    if not opts.url or not opts.token:
        print "Missing required param; run with --help for usage"
        sys.exit(-1)

    if not opts.format == 'plain' and not opts.format == 'pipe' and not opts.format == 'csv':
        print "Format must be one of [plain|pipe|csv]"
        sys.exit(-1)

    if not opts.hours:
        print "Defaulting to Sensors that have not checked in within the last 6 hours"
        hours = 6
    else:
        try:
            hours = int(opts.hours)
        except:
            print "Error: invalid hours parameter."
            sys.exit(-1)

    # build a cbapi object
    #
    cb = cbapi.CbApi(opts.url, token=opts.token, ssl_verify=opts.ssl_verify)

    # set up filters
    #
    filters = {}
    if opts.groupid is not None:
        filters['groupid'] = opts.groupid

    # enumerate sensors
    #
    sensors = cb.sensors(filters)

    now = datetime.datetime.now(pytz.utc)
    sensors_not_check_in = 0

    # output column headings as appropriate
    #
    if opts.format == 'pipe':
        print "%s|%s|%s|%s|%s" % ("sensor id", "group id", "computer name", "OS", "last checkin time")
    if opts.format == 'csv':
        print "%s,%s,%s,%s,%s" % ("sensor id", "group id", "computer name", "OS", "last checkin time")

    for sensor in sensors:
        sensortime = dateutil.parser.parse(sensor['last_checkin_time'])
        if sensortime < now - datetime.timedelta(hours=hours):
            sensors_not_check_in += 1
            if opts.format == 'plain':
               print "%-20s : %s" % ("computer name", sensor['computer_name'])
               print "----------------------------------------------"
               print "%-20s : %s" % ("sensor_group_id", sensor['group_id'])
               print "%-20s : %s" % ("sensor id", sensor['id'])
               print "%-20s : %s" % ("os", sensor['os_environment_display_string'])
               print "%-20s : %s" % ("last checkin time", sensor['last_checkin_time'])
               print
            elif opts.format == 'pipe':
               print "%s|%s|%s|%s|%s" % (sensor['id'], sensor['group_id'], sensor['computer_name'], sensor['os_environment_display_string'], sensor['last_checkin_time'])
            elif opts.format == 'csv':
               print '"%s","%s","%s","%s","%s"' % (sensor['id'], sensor['group_id'], sensor['computer_name'], sensor['os_environment_display_string'], sensor['last_checkin_time'])

    print
    print "Current time in UTC: " + str(now)
    print
    if hours == 1:
        print "Number of Sensors not checked in within %d hour: %d Sensors" % (hours, sensors_not_check_in)
    else:
        print "Number of Sensors not checked in within %d hours: %d Sensors" % (hours, sensors_not_check_in)
    print
if __name__ == "__main__":
    sys.exit(main(sys.argv[1:]))