- re-enable return_fields specification
[plcapi.git] / PLC / Methods / AddConfFileToNodeGroup.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.NodeGroups import NodeGroup, NodeGroups
6 from PLC.Auth import Auth
7
8 class AddConfFileToNodeGroup(Method):
9     """
10     Adds a configuration file to the specified node group. If the node
11     group is already linked to the configuration file, no errors are
12     returned.
13
14     Returns 1 if successful, faults otherwise.
15     """
16
17     roles = ['admin']
18
19     accepts = [
20         Auth(),
21         ConfFile.fields['conf_file_id'],
22         Mixed(NodeGroup.fields['nodegroup_id'],
23               NodeGroup.fields['name'])
24         ]
25
26     returns = Parameter(int, '1 if successful')
27
28     event_type = 'AddTo'
29     object_type = 'ConfFile'
30     object_ids = []
31
32     def call(self, auth, conf_file_id, nodegroup_id_or_name):
33         # Get configuration file
34         conf_files = ConfFiles(self.api, [conf_file_id])
35         if not conf_files:
36             raise PLCInvalidArgument, "No such configuration file"
37         conf_file = conf_files[0]
38
39         # Get node
40         nodegroups = NodeGroups(self.api, [nodegroup_id_or_name])
41         if not nodegroups:
42             raise PLCInvalidArgument, "No such node group"
43         nodegroup = nodegroups[0]
44         
45         # Link configuration file to node
46         if nodegroup['nodegroup_id'] not in conf_file['nodegroup_ids']:
47             conf_file.add_nodegroup(nodegroup)
48
49         # Log affected objects
50         self.object_ids = [conf_file_id, nodegroup['nodegroup_id']]
51
52         return 1