PLC/Methods/GetInitScripts.py

   1 from PLC.Faults import *
   2 from PLC.Method import Method
   3 from PLC.Parameter import Parameter, Mixed
   4 from PLC.Filter import Filter
   5 from PLC.InitScripts import InitScript, InitScripts
   6 from PLC.Auth import Auth
   7
   8 class GetInitScripts(Method):
   9     """
  10     Returns an array of structs containing details about initscripts.
  11     If initscript_filter is specified and is an array of initscript
  12     identifiers, or a struct of initscript attributes, only initscripts
  13     matching the filter will be returned. If return_fields is specified,
  14     only the specified details will be returned.
  15     """
  16
  17     roles = ['admin', 'pi', 'user', 'tech', 'node']
  18
  19     accepts = [
  20         Auth(),
  21         Mixed([Mixed(InitScript.fields['initscript_id'],
  22                      InitScript.fields['name'])],
  23               Filter(InitScript.fields)),
  24         Parameter([str], "List of fields to return", nullok = True)
  25         ]
  26
  27     returns = [InitScript.fields]
  28
  29
  30     def call(self, auth, initscript_filter = None, return_fields = None):
  31         return InitScripts(self.api, initscript_filter, return_fields)