expects the 'interfaces' key in GetSlivers - review logs to always mention module

[nodemanager.git] / api_calls.py

diff --git a/api_calls.py b/api_calls.py
index e99a559..5b99a08 100644 (file)
--- a/api_calls.py
+++ b/api_calls.py
@@ -1,3 +1,6 @@
+# $Id$
+# $URL$
+
 """Sliver manager API.
 
 This module exposes an XMLRPC interface that allows PlanetLab users to
@@ -29,7 +32,7 @@ import accounts
 import logger
 
 # TODO: These try/excepts are a hack to allow doc/DocBookLocal.py to 
-# import this file in order to extrac the documentation from each 
+# import this file in order to extract the documentation from each 
 # exported function.  A better approach will involve more extensive code
 # splitting, I think.
 try: import database
@@ -116,11 +119,29 @@ def Ticket(ticket):
         name = data['slivers'][0]['name']
         if data != None:
             deliver_ticket(data)
-        logger.log('Ticket delivered for %s' % name)
+        logger.log('api_calls: Ticket delivered for %s' % name)
         Create(database.db.get(name))
     except Exception, err:
         raise xmlrpclib.Fault(102, 'Ticket error: ' + str(err))
 
+@export_to_docbook(roles=['self'], 
+                   accepts=[Parameter(str, 'A ticket returned from GetSlivers()')], 
+                   returns=Parameter(int, '1 if successful'))
+@export_to_api(1)
+def AdminTicket(ticket):
+    """Admin interface to create slivers based on ticket returned by GetSlivers().
+    """
+    try:
+        data, = xmlrpclib.loads(ticket)[0]
+        name = data['slivers'][0]['name']
+        if data != None:
+            deliver_ticket(data)
+        logger.log('api_calls: Admin Ticket delivered for %s' % name)
+        Create(database.db.get(name))
+    except Exception, err:
+        raise xmlrpclib.Fault(102, 'Ticket error: ' + str(err))
+
+
 @export_to_docbook(roles=['self'],
                    accepts=[], 
                    returns={'sliver_name' : Parameter(int, 'the associated xid')})
@@ -141,6 +162,7 @@ def GetSSHKeys():
             keydict[rec['name']] = rec['keys']
     return keydict
 
+
 @export_to_docbook(roles=['nm-controller', 'self'], 
                     accepts=[Parameter(str, 'A sliver/slice name.')], 
                    returns=Parameter(int, '1 if successful'))
@@ -148,7 +170,12 @@ def GetSSHKeys():
 def Create(sliver_name):
     """Create a non-PLC-instantiated sliver"""
     rec = sliver_name
-    if rec['instantiation'] == 'delegated': accounts.get(rec['name']).ensure_created(rec)
+    if rec['instantiation'] == 'delegated': 
+        accounts.get(rec['name']).ensure_created(rec)
+        logger.log("api_calls: Create %s"%rec['name'])
+    else: 
+        raise Exception, "Only PLC can create non delegated slivers."
+
 
 @export_to_docbook(roles=['nm-controller', 'self'], 
                     accepts=[Parameter(str, 'A sliver/slice name.')], 
@@ -157,16 +184,23 @@ def Create(sliver_name):
 def Destroy(sliver_name):
     """Destroy a non-PLC-instantiated sliver"""
     rec = sliver_name 
-    if rec['instantiation'] == 'delegated': accounts.get(rec['name']).ensure_destroyed()
+    if rec['instantiation'] == 'delegated': 
+        accounts.get(rec['name']).ensure_destroyed()
+        logger.log("api_calls: Destroy %s"%rec['name'])
+    else: 
+        raise Exception, "Only PLC can destroy non delegated slivers."
+
 
 @export_to_docbook(roles=['nm-controller', 'self'], 
                     accepts=[Parameter(str, 'A sliver/slice name.')], 
                    returns=Parameter(int, '1 if successful'))
 @export_to_api(1)
 def Start(sliver_name):
-    """Run start scripts belonging to the specified sliver"""
+    """Configure and start sliver."""
     rec = sliver_name
-    accounts.get(rec['name']).start()
+    accounts.get(rec['name']).start(rec)
+    logger.log("api_calls: Start %s"%rec['name'])
+
 
 @export_to_docbook(roles=['nm-controller', 'self'], 
                     accepts=[Parameter(str, 'A sliver/slice name.')], 
@@ -176,17 +210,20 @@ def Stop(sliver_name):
     """Kill all processes belonging to the specified sliver"""
     rec = sliver_name
     accounts.get(rec['name']).stop()
+    logger.log("api_calls: Stop %s"%rec['name'])
+
 
 @export_to_docbook(roles=['nm-controller', 'self'], 
                     accepts=[Parameter(str, 'A sliver/slice name.')], 
                    returns=Parameter(int, '1 if successful'))
-
 @export_to_api(1)
 def ReCreate(sliver_name):
     """Stop, Destroy, Create, Start sliver in order to reinstall it."""
-    Stop(sliver_name)
-    Destroy(sliver_name)
-    Create(sliver_name)
+    rec = sliver_name
+    accounts.get(rec['name']).stop()
+    accounts.get(rec['name']).ensure_created(rec)
+    accounts.get(rec['name']).start(rec)
+    logger.log("api_calls: ReCreate %s"%rec['name'])
 
 @export_to_docbook(roles=['nm-controller', 'self'], 
                     accepts=[Parameter(str, 'A sliver/slice name.')], 
@@ -197,24 +234,23 @@ def GetEffectiveRSpec(sliver_name):
     rec = sliver_name
     return rec.get('_rspec', {}).copy()
 
+
 @export_to_docbook(roles=['nm-controller', 'self'], 
                     accepts=[Parameter(str, 'A sliver/slice name.')], 
-                    returns={
-                            "resource name" : Parameter(int, "amount")
-                        }
-                  )
+                    returns={"resource name" : Parameter(int, "amount")})
 @export_to_api(1)
 def GetRSpec(sliver_name):
     """Return the RSpec allocated to the specified sliver, excluding loans"""
     rec = sliver_name
     return rec.get('rspec', {}).copy()
 
+
 @export_to_docbook(roles=['nm-controller', 'self'], 
                     accepts=[Parameter(str, 'A sliver/slice name.')], 
                     returns=[Mixed(Parameter(str, 'recipient slice name'),
                              Parameter(str, 'resource name'),
-                             Parameter(int, 'resource amount'))] 
-                  )
+                             Parameter(int, 'resource amount'))])
+
 @export_to_api(1)
 def GetLoans(sliver_name):
     """Return the list of loans made by the specified sliver"""
@@ -246,3 +282,11 @@ def SetLoans(sliver_name, loans):
     if not validate_loans(loans): raise xmlrpclib.Fault(102, 'Invalid argument: the second argument must be a well-formed loan specification')
     rec['_loans'] = loans
     database.db.sync()
+
+@export_to_docbook(roles=['nm-controller', 'self'], 
+                         returns=Parameter(dict, 'Record dictionary'))
+@export_to_api(0)
+def GetRecord(sliver_name):
+    """Return sliver record"""
+    rec = sliver_name
+    return rec