plc.py

   1 #
   2 # plc.py
   3 #
   4 # Helper functions that minipulate the PLC api.
   5 #
   6 # Faiyaz Ahmed <faiyaza@cs.princeton.edu
   7 #
   8 # $Id: plc.py,v 1.18 2007/08/29 17:26:50 soltesz Exp $
   9 #
  10
  11 import xml, xmlrpclib
  12 import logging
  13 import auth
  14 import time
  15 from config import config,XMLRPC_SERVER
  16
  17 logger = logging.getLogger("monitor")
  18
  19 #XMLRPC_SERVER = config.XMLRPC_SERVER
  20
  21 config = config()
  22 api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False, allow_none=True)
  23
  24 def getAPI(url):
  25         api = xmlrpclib.Server(url, verbose=False, allow_none=True)
  26         return api
  27
  28 class PLC:
  29         def __init__(self, auth, url):
  30                 self.auth = auth
  31                 self.url = url
  32                 self.api = xmlrpclib.Server(self.url, verbose=False, allow_none=True)
  33
  34         def __getattr__(self, name):
  35                 method = getattr(self.api, name)
  36                 if method is None:
  37                         raise AssertionError("method does not exist")
  38
  39                 return lambda *params : method(self.auth, *params)
  40
  41         def __repr__(self):
  42                 return self.api.__repr__()
  43
  44 '''
  45 Returns list of nodes in dbg as reported by PLC
  46 '''
  47 def nodesDbg():
  48         dbgNodes = []
  49         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
  50         anon = {'AuthMethod': "anonymous"}
  51         for node in api.GetNodes(anon, {"boot_state":"dbg"},["hostname"]):
  52                 dbgNodes.append(node['hostname'])
  53         logger.info("%s nodes in debug according to PLC." %len(dbgNodes))
  54         return dbgNodes
  55
  56
  57 '''
  58 Returns loginbase for given nodename
  59 '''
  60 def siteId(nodename):
  61         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
  62         anon = {'AuthMethod': "anonymous"}
  63         site_id = api.GetNodes (anon, {"hostname": nodename}, ['site_id'])
  64         if len(site_id) == 1:
  65                 loginbase = api.GetSites (anon, site_id[0], ["login_base"])
  66                 return loginbase[0]['login_base']
  67
  68 '''
  69 Returns list of slices for a site.
  70 '''
  71 def slices(loginbase):
  72         siteslices = []
  73         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
  74         sliceids = api.GetSites (auth.auth, {"login_base" : loginbase}, ["slice_ids"])[0]['slice_ids']
  75         for slice in api.GetSlices(auth.auth, {"slice_id" : sliceids}, ["name"]):
  76                 siteslices.append(slice['name'])
  77         return siteslices
  78
  79 '''
  80 Returns dict of PCU info of a given node.
  81 '''
  82 def getpcu(nodename):
  83         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
  84         anon = {'AuthMethod': "anonymous"}
  85         nodeinfo = api.GetNodes(auth.auth, {"hostname": nodename}, ["pcu_ids", "ports"])[0]
  86         if nodeinfo['pcu_ids']:
  87                 sitepcu = api.GetPCUs(auth.auth, nodeinfo['pcu_ids'])[0]
  88                 sitepcu[nodename] = nodeinfo["ports"][0]
  89                 return sitepcu
  90         else:
  91                 logger.info("%s doesn't have PCU" % nodename)
  92                 return False
  93
  94 def GetPCUs(filter=None, fields=None):
  95         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False, allow_none=True)
  96         pcu_list = api.GetPCUs(auth.auth, filter, fields)
  97         return pcu_list
  98
  99 '''
 100 Returns all site nodes for site id (loginbase).
 101 '''
 102 def getSiteNodes(loginbase, fields=None):
 103         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
 104         nodelist = []
 105         anon = {'AuthMethod': "anonymous"}
 106         try:
 107                 nodeids = api.GetSites(anon, {"login_base": loginbase}, fields)[0]['node_ids']
 108                 for node in api.GetNodes(anon, {"node_id": nodeids}, ['hostname']):
 109                         nodelist.append(node['hostname'])
 110         except Exception, exc:
 111                 logger.info("getSiteNodes:  %s" % exc)
 112                 print "getSiteNodes:  %s" % exc
 113         return nodelist
 114
 115 def getPersons(filter=None, fields=None):
 116         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False, allow_none=True)
 117         persons = []
 118         try:
 119                 persons = api.GetPersons(auth.auth, filter, fields)
 120         except Exception, exc:
 121                 print "getPersons:  %s" % exc
 122                 logger.info("getPersons:  %s" % exc)
 123         return persons
 124
 125 def getSites(filter=None, fields=None):
 126         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False, allow_none=True)
 127         sites = []
 128         anon = {'AuthMethod': "anonymous"}
 129         try:
 130                 sites = api.GetSites(anon, filter, fields)
 131         except Exception, exc:
 132                 print "getSites:  %s" % exc
 133                 logger.info("getSites:  %s" % exc)
 134         return sites
 135
 136 def getSiteNodes2(loginbase):
 137         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
 138         nodelist = []
 139         anon = {'AuthMethod': "anonymous"}
 140         try:
 141                 nodeids = api.GetSites(anon, {"login_base": loginbase})[0]['node_ids']
 142                 nodelist += getNodes({'node_id':nodeids})
 143         except Exception, exc:
 144                 logger.info("getSiteNodes2:  %s" % exc)
 145         return nodelist
 146
 147 def getNodeNetworks(filter=None):
 148         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False, allow_none=True)
 149         nodenetworks = api.GetNodeNetworks(auth.auth, filter, None)
 150         return nodenetworks
 151
 152 def getNodes(filter=None, fields=None):
 153         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False, allow_none=True)
 154         nodes = api.GetNodes(auth.auth, filter, fields)
 155                         #['boot_state', 'hostname',
 156                         #'site_id', 'date_created', 'node_id', 'version', 'nodenetwork_ids',
 157                         #'last_updated', 'peer_node_id', 'ssh_rsa_key' ])
 158         return nodes
 159
 160 '''
 161 Sets boot state of a node.
 162 '''
 163 def nodeBootState(nodename, state):
 164         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
 165         try:
 166                 return api.UpdateNode(auth.auth, nodename, {'boot_state': state})
 167         except Exception, exc:
 168                 logger.info("nodeBootState:  %s" % exc)
 169
 170 def updateNodeKey(nodename, key):
 171         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
 172         try:
 173                 return api.UpdateNode(auth.auth, nodename, {'key': key})
 174         except Exception, exc:
 175                 logger.info("updateNodeKey:  %s" % exc)
 176
 177 '''
 178 Sends Ping Of Death to node.
 179 '''
 180 def nodePOD(nodename):
 181         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
 182         logger.info("Sending POD to %s" % nodename)
 183         try:
 184                 if not config.debug:
 185                         return api.RebootNode(auth.auth, nodename)
 186         except Exception, exc:
 187                         logger.info("nodePOD:  %s" % exc)
 188
 189 '''
 190 Freeze all site slices.
 191 '''
 192 def suspendSlices(nodename):
 193         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
 194         for slice in slices(siteId(nodename)):
 195                 logger.info("Suspending slice %s" % slice)
 196                 try:
 197                         if not config.debug:
 198                                 api.AddSliceAttribute(auth.auth, slice, "enabled", "0")
 199                 except Exception, exc:
 200                         logger.info("suspendSlices:  %s" % exc)
 201
 202 def enableSlices(nodename):
 203         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False, allow_none=True)
 204         for slice in slices(siteId(nodename)):
 205                 logger.info("Enabling slices %s" % slice)
 206                 try:
 207                         if not config.debug:
 208                                 slice_list = api.GetSlices(auth.auth, {'name': slice}, None)
 209                                 if len(slice_list) == 0:
 210                                         return
 211                                 slice_id = slice_list[0]['slice_id']
 212                                 l_attr = api.GetSliceAttributes(auth.auth, {'slice_id': slice_id}, None)
 213                                 for attr in l_attr:
 214                                         if "enabled" == attr['name'] and attr['value'] == "0":
 215                                                 logger.info("Deleted enable=0 attribute from slice %s" % slice)
 216                                                 api.DeleteSliceAttribute(auth.auth, attr['slice_attribute_id'])
 217                 except Exception, exc:
 218                         logger.info("enableSlices: %s" % exc)
 219                         print "exception: %s" % exc
 220
 221 #I'm commenting this because this really should be a manual process.
 222 #'''
 223 #Enable suspended site slices.
 224 #'''
 225 #def enableSlices(nodename, slicelist):
 226 #       api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
 227 #       for slice in  slices(siteId(nodename)):
 228 #               logger.info("Suspending slice %s" % slice)
 229 #               api.SliceAttributeAdd(auth.auth, slice, "plc_slice_state", {"state" : "suspended"})
 230 #
 231 def enableSliceCreation(nodename):
 232         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False, allow_none=True)
 233         try:
 234                 loginbase = siteId(nodename)
 235                 logger.info("Enabling slice creation for site %s" % loginbase)
 236                 if not config.debug:
 237                         logger.info("\tcalling UpdateSite(%s, enabled=True)" % loginbase)
 238                         api.UpdateSite(auth.auth, loginbase, {'enabled': True})
 239         except Exception, exc:
 240                 print "ERROR: enableSliceCreation:  %s" % exc
 241                 logger.info("ERROR: enableSliceCreation:  %s" % exc)
 242
 243 '''
 244 Removes ability to create slices. Returns previous max_slices
 245 '''
 246 def removeSliceCreation(nodename):
 247         api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
 248         try:
 249                 loginbase = siteId(nodename)
 250                 #numslices = api.GetSites(auth.auth, {"login_base": loginbase},
 251                 #               ["max_slices"])[0]['max_slices']
 252                 logger.info("Removing slice creation for site %s" % loginbase)
 253                 if not config.debug:
 254                         #api.UpdateSite(auth.auth, loginbase, {'max_slices': 0})
 255                         api.UpdateSite(auth.auth, loginbase, {'enabled': False})
 256         except Exception, exc:
 257                 logger.info("removeSliceCreation:  %s" % exc)
 258
 259 '''
 260 QED
 261 '''
 262 #def enableSliceCreation(nodename, maxslices):
 263 #       api = xmlrpclib.Server(XMLRPC_SERVER, verbose=False)
 264 #       anon = {'AuthMethod': "anonymous"}
 265 #       siteid = api.AnonAdmQuerySite (anon, {"node_hostname": nodename})
 266 #       if len(siteid) == 1:
 267 #               logger.info("Enabling slice creation for site %s" % siteId(nodename))
 268 #               try:
 269 #                       if not config.debug:
 270 #                               api.AdmUpdateSite(auth.auth, siteid[0], {"max_slices" : maxslices})
 271 #               except Exception, exc:
 272 #                       logger.info("API:  %s" % exc)
 273 #       else:
 274 #               logger.debug("Cant find site for %s.  Cannot enable creation." % nodename)
 275
 276 def main():
 277         logger.setLevel(logging.DEBUG)
 278         ch = logging.StreamHandler()
 279         ch.setLevel(logging.DEBUG)
 280         formatter = logging.Formatter('logger - %(message)s')
 281         ch.setFormatter(formatter)
 282         logger.addHandler(ch)
 283         #print getpcu("kupl2.ittc.ku.edu")
 284         #print getpcu("planetlab1.cse.msu.edu")
 285         #print getpcu("alice.cs.princeton.edu")
 286         #print nodesDbg()
 287         #nodeBootState("alice.cs.princeton.edu", "boot")
 288         #freezeSite("alice.cs.princeton.edu")
 289         print removeSliceCreation("alice.cs.princeton.edu")
 290         #enableSliceCreation("alice.cs.princeton.edu", 1024)
 291         #print getSiteNodes("princeton")
 292         #print siteId("alice.cs.princeton.edu")
 293         #print nodePOD("alice.cs.princeton.edu")
 294         #print slices("princeton")
 295
 296 if __name__=="__main__":
 297         import reboot
 298         main()