5ae37fbdeb14af765851177aa31ffe91c369d1bf
[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 Auth
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
22     accepts = [
23         Auth(),
24         ConfFile.fields['conf_file_id'],
25         conf_file_fields
26         ]
27
28     returns = Parameter(int, '1 if successful')
29
30     def call(self, auth, conf_file_id, conf_file_fields):
31         conf_file_fields = dict(filter(can_update, conf_file_fields.items()))
32
33         conf_files = ConfFiles(self.api, [conf_file_id])
34         if not conf_files:
35             raise PLCInvalidArgument, "No such configuration file"
36
37         conf_file = conf_files[0]
38         conf_file.update(conf_file_fields)
39         conf_file.sync()
40         self.event_objects = {'ConfFile': [conf_file['conf_file_id']]}
41
42         return 1