ipmi.py

'''
   Wrapper around IPMI for simple machine management
'''

import subprocess
from datetime import datetime
from dao import DAO

class lom_ipmi():
    '''
      Fluent API to build the IPMI command. Only a subset of the commands are used. 
    '''
    def __init__(self):
        self.interface = "ipmitools"
        self.intf_type = "lanplus"
        
       
    def _check_power(self, power_arg):
        '''
           Method to check if a correct power option has been given
        '''
        if power_arg in ["on", "off", "cycle"]:
            return True

    def _check_ip(self, ip):
        '''
           Method to check if an IP quad is valid
        '''
        try:
            if int(ip) > 0 and int(ip) < 254:
                return True
        except ValueError as ve:
            print (ve)

    def interface_type (self, intf_type="lanplus"):
        '''
           Set the interface type
        '''
        self.intf_type = intf_type
        return self

    def connection_auth(self, user, passwd):
        '''
           Sets up the connection parameters. 
        '''
        self.user = user
        self.passwd = passwd
        return self

    def command(self, cmd):
        '''
          Sets up the commands. 
          Currently limited to the power command. 
        '''
        if self._check_power(cmd):
            self.cmd = "chassis power " + cmd
        return self

    def host(self, config, ip):
        '''
           Checks the ip is valid and adds to the line
        '''
        if self._check_ip(ip):
            self.ip = config['base'] + str(ip)
        return self

    def run_command(self, config):
        '''
           Runs the command via a subprocess
        '''
        dao = DAO(config)
        try:
            dao.put_log(str(datetime.now()) + " " + self.build_command())
            p = subprocess.check_output(self.interface + " " + self.build_command(), shell=True, stderr=subprocess.STDOUT)
            dao.put_log(str(datetime.now()) + " " + p)
        except subprocess.CalledProcessError as cpe:
            dao.put_log(str(datetime.now()) + " " + cpe.cmd)
            dao.put_log(str(datetime.now()) + " " + cpe.output)

    def build_command(self):
        '''
           Builds the Command line
        '''
        if not self.ip:
            raise Exception("IP not given")

        if not self.cmd:
            raise Exception("Command not given")

        return ' '.join([" -U", self.user, "-P", self.passwd, "-vI", self.intf_type,
                     "-H", self.ip, self.cmd ])