15dee3b888aa0bf38061930322e43fad43bcfa97
[plcapi.git] / PLC / Methods / GetConfFiles.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 class GetConfFiles(Method):
8     """
9     Returns an array of structs containing details about node
10     configuration files. If conf_file_ids is specified, only the
11     specified configuration files will be queried.
12     """
13
14     roles = ['admin']
15
16     accepts = [
17         PasswordAuth(),
18         [ConfFile.fields['conf_file_id']]
19         ]
20
21     returns = [ConfFile.fields]
22
23     def call(self, auth, conf_file_ids = None):
24         conf_files = ConfFiles(self.api, conf_file_ids).values()
25         conf_files = [dict(conf_file) for conf_file in conf_files]
26         return conf_files