- re-enable return_fields specification
[plcapi.git] / PLC / Methods / DeleteConfFileFromNodeGroup.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 DeleteConfFileFromNodeGroup(Method):
9     """
10     Deletes a configuration file from the specified nodegroup. If the nodegroup
11     is not linked to the configuration file, no errors are returned.
12
13     Returns 1 if successful, faults otherwise.
14     """
15
16     roles = ['admin']
17
18     accepts = [
19         Auth(),
20         ConfFile.fields['conf_file_id'],
21         Mixed(NodeGroup.fields['nodegroup_id'],
22               NodeGroup.fields['name'])
23         ]
24
25     returns = Parameter(int, '1 if successful')
26
27     event_type = 'DeleteFrom'
28     object_type = 'ConfFile'
29     object_ids = []
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 nodegroup
39         nodegroups = NodeGroups(self.api, [nodegroup_id_or_name])
40         if not nodegroups:
41                 raise PLCInvalidArgument, "No such nodegroup"
42         nodegroup = nodegroups[0]
43         
44         # Link configuration file to nodegroup
45         if nodegroup['nodegroup_id'] in conf_file['nodegroup_ids']:
46             conf_file.remove_nodegroup(nodegroup)
47
48         # Log affected objects
49         self.object_ids = [conf_file_id, nodegroup['nodegroup_id']]
50
51         return 1