Merge from trunk

[plcapi.git] / trunk / PLC / Methods / AddInitScript.py

diff --git a/trunk/PLC/Methods/AddInitScript.py b/trunk/PLC/Methods/AddInitScript.py
new file mode 100644 (file)
index 0000000..8c247cb
--- /dev/null
+++ b/trunk/PLC/Methods/AddInitScript.py
@@ -0,0 +1,37 @@
+from PLC.Faults import *
+from PLC.Method import Method
+from PLC.Parameter import Parameter, Mixed
+from PLC.InitScripts import InitScript, InitScripts
+from PLC.Auth import Auth
+
+can_update = lambda (field, value): field not in \
+             ['initscript_id']
+
+class AddInitScript(Method):
+    """
+    Adds a new initscript. Any fields specified in initscript_fields
+    are used, otherwise defaults are used.
+
+    Returns the new initscript_id (> 0) if successful, faults otherwise.
+    """
+
+    roles = ['admin']
+
+    initscript_fields = dict(filter(can_update, InitScript.fields.items()))
+
+    accepts = [
+        Auth(),
+        initscript_fields
+        ]
+
+    returns = Parameter(int, 'New initscript_id (> 0) if successful')
+
+
+    def call(self, auth, initscript_fields):
+        initscript_fields = dict(filter(can_update, initscript_fields.items()))
+        initscript = InitScript(self.api, initscript_fields)
+        initscript.sync()
+
+       self.event_objects = {'InitScript': [initscript['initscript_id']]}
+
+        return initscript['initscript_id']