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