merge from trunk
[plcapi.git] / PLC / Methods / GetNodeNetworks.py
index fda60a3..150f87d 100644 (file)
@@ -1,25 +1,32 @@
 from PLC.Faults import *
 from PLC.Method import Method
 from PLC.Parameter import Parameter, Mixed
+from PLC.Filter import Filter
 from PLC.NodeNetworks import NodeNetwork, NodeNetworks
-from PLC.Auth import PasswordAuth
+from PLC.Auth import Auth
 
 class GetNodeNetworks(Method):
     """
-    Return an array of structs contain details about node network
-    interfaces. If nodenetwork_id_or_ip_list is specified, only
-    the specified node network interfaces will be queried.
+    Returns an array of structs containing details about node network
+    interfacess. If nodenetworks_filter is specified and is an array
+    of node network identifiers, or a struct of node network
+    fields and values, only node network interfaces matching the filter
+    will be returned.
+
+    If return_fields is given, only the specified details will be returned.
     """
 
-    roles = ['admin', 'pi', 'user', 'tech']
+    roles = ['admin', 'pi', 'user', 'tech', 'node', 'anonymous']
 
     accepts = [
-        PasswordAuth(),
-        [Mixed(NodeNetwork.fields['nodenetwork_id'],
-               NodeNetwork.fields['ip'])]
+        Auth(),
+        Mixed([NodeNetwork.fields['nodenetwork_id']],
+              Parameter (int, "nodenetwork id"),
+              Filter(NodeNetwork.fields)),
+        Parameter([str], "List of fields to return", nullok = True)
         ]
 
     returns = [NodeNetwork.fields]
-
-    def call(self, auth, nodenetwork_id_or_ip_list = None):
-        return NodeNetworks(self.api, nodenetwork_id_or_ip_list).values()
+    
+    def call(self, auth, nodenetwork_filter = None, return_fields = None):
+        return NodeNetworks(self.api, nodenetwork_filter, return_fields)