f3fb19382f4377624ff74601a92b128c89de3122
[plcapi.git] / PLC / Methods / AddInitScript.py
1 # $Id$
2 from PLC.Faults import *
3 from PLC.Method import Method
4 from PLC.Parameter import Parameter, Mixed
5 from PLC.InitScripts import InitScript, InitScripts
6 from PLC.Auth import Auth
7
8 can_update = lambda (field, value): field not in \
9              ['initscript_id']
10
11 class AddInitScript(Method):
12     """
13     Adds a new initscript. Any fields specified in initscript_fields
14     are used, otherwise defaults are used.
15
16     Returns the new initscript_id (> 0) if successful, faults otherwise.
17     """
18
19     roles = ['admin']
20
21     initscript_fields = dict(filter(can_update, InitScript.fields.items()))
22
23     accepts = [
24         Auth(),
25         initscript_fields
26         ]
27
28     returns = Parameter(int, 'New initscript_id (> 0) if successful')
29
30
31     def call(self, auth, initscript_fields):
32         initscript_fields = dict(filter(can_update, initscript_fields.items()))
33         initscript = InitScript(self.api, initscript_fields)
34         initscript.sync()
35
36         self.event_objects = {'InitScript': [initscript['initscript_id']]}
37
38         return initscript['initscript_id']