PLC/Methods/GetInterfaceSettings.py

   1 #
   2 # Thierry Parmentelat - INRIA
   3 #
   4 # $Revision$
   5 #
   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.Persons import Person, Persons
  11 from PLC.Auth import Auth
  12
  13 from PLC.InterfaceSettings import InterfaceSetting, InterfaceSettings
  14 from PLC.Sites import Site, Sites
  15 from PLC.Interfaces import Interface, Interfaces
  16
  17 class GetInterfaceSettings(Method):
  18     """
  19     Returns an array of structs containing details about
  20     interfaces and related settings.
  21
  22     If interface_setting_filter is specified and is an array of
  23     interface setting identifiers, only interface settings matching
  24     the filter will be returned. If return_fields is specified, only
  25     the specified details will be returned.
  26     """
  27
  28     roles = ['admin', 'pi', 'user', 'node']
  29
  30     accepts = [
  31         Auth(),
  32         Mixed([InterfaceSetting.fields['interface_setting_id']],
  33               Parameter(int,"Interface setting id"),
  34               Filter(InterfaceSetting.fields)),
  35         Parameter([str], "List of fields to return", nullok = True)
  36         ]
  37
  38     returns = [InterfaceSetting.fields]
  39
  40
  41     def call(self, auth, interface_setting_filter = None, return_fields = None):
  42
  43         interface_settings = InterfaceSettings(self.api, interface_setting_filter, return_fields)
  44
  45         return interface_settings