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.Nodes import Node, Nodes
6 from PLC.Auth import Auth
8 class GetNodes(Method):
10 Returns an array of structs containing details about nodes. If
11 node_filter is specified and is an array of node identifiers or
12 hostnames, or a struct of node attributes, only nodes matching the
13 filter will be returned. If return_fields is specified, only the
14 specified details will be returned.
16 Some fields may only be viewed by admins.
19 roles = ['admin', 'pi', 'user', 'tech']
23 Mixed([Mixed(Node.fields['node_id'],
24 Node.fields['hostname'])],
26 Parameter([str], "List of fields to return", nullok = True)
29 returns = [Node.fields]
31 def call(self, auth, node_filter = None, return_fields = None):
32 # Get node information
33 nodes = Nodes(self.api, node_filter, return_fields)
35 # Remove admin only fields
36 if 'admin' not in self.caller['roles']:
38 for field in ['boot_nonce', 'key', 'session', 'root_person_ids']: