iteration 4 & last:
[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
31     def call(self, auth, conf_file_id, nodegroup_id_or_name):
32         # Get configuration file
33         conf_files = ConfFiles(self.api, [conf_file_id])
34         if not conf_files:
35             raise PLCInvalidArgument, "No such configuration file"
36         conf_file = conf_files[0]
37
38         # Get node
39         nodegroups = NodeGroups(self.api, [nodegroup_id_or_name])
40         if not nodegroups:
41             raise PLCInvalidArgument, "No such node group"
42         nodegroup = nodegroups[0]
43         
44         # Link configuration file to node
45         if nodegroup['nodegroup_id'] not in conf_file['nodegroup_ids']:
46             conf_file.add_nodegroup(nodegroup)
47
48         # Log affected objects
49         self.object_ids = [conf_file_id, nodegroup['nodegroup_id']]
50
51         return 1