f68e0fecf6ef0e9ee98a23181080086dd8d24269
[plcapi.git] / PLC / Methods / UpdateConfFile.py
1 from PLC.Faults import *
2 from PLC.Method import Method
3 from PLC.Parameter import Parameter, Mixed
4 from PLC.ConfFiles import ConfFile, ConfFiles
5 from PLC.Auth import PasswordAuth
6
7 can_update = lambda (field, value): field not in \
8              ['conf_file_id', 'node_ids', 'nodegroup_ids']
9
10 class UpdateConfFile(Method):
11     """
12     Updates a node configuration file. Only the fields specified in
13     conf_file_fields are updated, all other fields are left untouched.
14
15     Returns 1 if successful, faults otherwise.
16     """
17
18     roles = ['admin']
19
20     conf_file_fields = dict(filter(can_update, ConfFile.fields.items()))
21     for field in conf_file_fields.values():
22         field.optional = True
23
24     accepts = [
25         PasswordAuth(),
26         ConfFile.fields['conf_file_id'],
27         conf_file_fields
28         ]
29
30     returns = Parameter(int, '1 if successful')
31
32     def call(self, auth, conf_file_id, conf_file_fields):
33         conf_file_fields = dict(filter(can_update, conf_file_fields.items()))
34
35         conf_files = ConfFiles(self.api, [conf_file_id]).values()
36         if not conf_files:
37             raise PLCInvalidArgument, "No such configuration file"
38
39         conf_file = conf_files[0]
40         conf_file.update(conf_file_fields)
41         conf_file.sync()
42
43         return 1