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.Persons import Person, Persons
7 from PLC.Auth import Auth
9 class GetNodes(Method):
11 Returns an array of structs containing details about nodes. If
12 node_filter is specified and is an array of node identifiers or
13 hostnames, or a struct of node attributes, only nodes matching the
14 filter will be returned. If return_fields is specified, only the
15 specified details will be returned.
17 Some fields may only be viewed by admins.
20 roles = ['admin', 'pi', 'user', 'tech', 'node', 'anonymous']
24 Mixed([Mixed(Node.fields['node_id'],
25 Node.fields['hostname'])],
26 Parameter(str,"hostname"),
27 Parameter(int,"node_id"),
29 Parameter([str], "List of fields to return", nullok = True),
32 returns = [Node.fields]
35 def call(self, auth, node_filter = None, return_fields = None):
37 # Must query at least slice_ids_whitelist
38 if return_fields is not None:
39 added_fields = set(['slice_ids_whitelist', 'site_id']).difference(return_fields)
40 return_fields += added_fields
44 # Get node information
45 nodes = Nodes(self.api, node_filter, return_fields)
47 # Remove admin only fields
48 if not isinstance(self.caller, Person) or \
49 'admin' not in self.caller['roles']:
54 slice_ids.update(self.caller['slice_ids'])
55 if isinstance(self.caller, Node):
56 site_ids.update([self.caller['site_id']])
58 site_ids.update(self.caller['site_ids'])
60 # if node has whitelist, only return it if users is at
61 # the same site or user has a slice on the whitelist
63 if 'site_id' in node and \
64 site_ids.intersection([node['site_id']]):
66 if 'slice_ids_whitelist' in node and \
67 node['slice_ids_whitelist'] and \
68 not slice_ids.intersection(node['slice_ids_whitelist']):
71 # remove remaining admin only fields
73 for field in ['boot_nonce', 'key', 'session', 'root_person_ids']:
77 # remove added fields if not specified
80 for field in added_fields: