2 # Thierry Parmentelat - INRIA
6 from PLC.Faults import *
7 from PLC.Method import Method
8 from PLC.Parameter import Parameter, Mixed
9 from PLC.Filter import Filter
10 from PLC.Auth import Auth
12 from PLC.InterfaceSettings import InterfaceSetting, InterfaceSettings
13 from PLC.Sites import Site, Sites
14 from PLC.Interfaces import Interface, Interfaces
16 class GetInterfaceSettings(Method):
18 Returns an array of structs containing details about
19 interfaces and related settings.
21 If interface_setting_filter is specified and is an array of
22 interface setting identifiers, only interface settings matching
23 the filter will be returned. If return_fields is specified, only
24 the specified details will be returned.
27 roles = ['admin', 'pi', 'user', 'node']
31 Mixed([InterfaceSetting.fields['interface_setting_id']],
32 Parameter(int,"Interface setting id"),
33 Filter(InterfaceSetting.fields)),
34 Parameter([str], "List of fields to return", nullok = True)
37 returns = [InterfaceSetting.fields]
40 def call(self, auth, interface_setting_filter = None, return_fields = None):
42 interface_settings = InterfaceSettings(self.api, interface_setting_filter, return_fields)
44 return interface_settings