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
8 from PLC.Logger import logger
10 admin_only = ['key', 'session', 'boot_nonce']
12 class GetNodes(Method):
14 Returns an array of structs containing details about nodes. If
15 node_filter is specified and is an array of node identifiers or
16 hostnames, or a struct of node attributes, only nodes matching the
17 filter will be returned.
19 If return_fields is specified, only the specified details will be
20 returned. NOTE that if return_fields is unspecified, the complete
21 set of native fields are returned, which DOES NOT include tags at
24 Some fields may only be viewed by admins.
27 roles = ['admin', 'pi', 'user', 'tech', 'node', 'anonymous']
31 Mixed([Mixed(Node.fields['node_id'],
32 Node.fields['hostname'])],
33 Parameter(str, "hostname"),
34 Parameter(int, "node_id"),
36 Parameter([str], "List of fields to return", nullok=True),
39 returns = [Node.fields]
42 def call(self, auth, node_filter=None, return_fields=None):
44 # Must query at least slice_ids_whitelist
45 if return_fields is not None:
46 added_fields = (set(['slice_ids_whitelist', 'site_id'])
47 .difference(return_fields))
48 return_fields += added_fields
52 logger.info("incoming GetNodes, filter={}, return fields={}"
53 .format(node_filter, return_fields))
55 # Get node information
56 nodes = Nodes(self.api, node_filter, return_fields)
58 # Remove admin only fields
59 if not isinstance(self.caller, Person) or \
60 'admin' not in self.caller['roles']:
65 slice_ids.update(self.caller['slice_ids'])
66 if isinstance(self.caller, Node):
67 site_ids.update([self.caller['site_id']])
69 site_ids.update(self.caller['site_ids'])
71 # if node has whitelist, only return it if users is at
72 # the same site or user has a slice on the whitelist
74 if 'site_id' in node and \
75 site_ids.intersection([node['site_id']]):
77 if 'slice_ids_whitelist' in node and \
78 node['slice_ids_whitelist'] and \
79 not slice_ids.intersection(node['slice_ids_whitelist']):
82 # remove remaining admin only fields
84 for field in admin_only:
88 # remove added fields if not specified
91 for field in added_fields: