PLC/Methods/GetInitScripts.py

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