from PLC.Persons import Person, Persons
from PLC.Auth import Auth
+admin_only = ['key', 'session', 'boot_nonce' ]
+
class v43GetNodes(Method):
"""
Returns an array of structs containing details about nodes. If
node_filter is specified and is an array of node identifiers or
hostnames, or a struct of node attributes, only nodes matching the
- filter will be returned. If return_fields is specified, only the
- specified details will be returned.
+ filter will be returned.
+
+ If return_fields is specified, only the specified details will be
+ returned. NOTE that if return_fields is unspecified, the complete
+ set of native fields are returned, which DOES NOT include tags at
+ this time.
Some fields may only be viewed by admins.
"""
# remove remaining admin only fields
for node in nodes:
- for field in ['boot_nonce', 'key', 'session', 'root_person_ids']:
+ for field in admin_only:
if field in node:
del node[field]
node_fields['nodenetwork_ids']=Parameter([int], "Legacy version of interface_ids")
class v42GetNodes(v43GetNodes):
- # XXX is there a way to inherit the doc from v43GetNodes?
"""
- Returns an array of structs containing details about nodes. If
- node_filter is specified and is an array of node identifiers or
- hostnames, or a struct of node attributes, only nodes matching the
- filter will be returned. If return_fields is specified, only the
- specified details will be returned.
-
- Some fields may only be viewed by admins.
+ Legacy wrapper for v43GetNodes.
"""
accepts = [
def call(self, auth, node_filter = None, return_fields = None):
# convert nodenetwork_ids -> interface_ids
- if node_filter <> None and \
- node_filter.has_key('nodenetwork_ids') and \
- not node_filter.has_key('interface_ids'):
- node_filter['interface_ids']=node_filter['nodenetwork_ids']
+ if isinstance(node_filter, dict):
+ if node_filter.has_key('nodenetwork_ids'):
+ interface_ids = node_filter.pop('nodenetwork_ids')
+ if not node_filter.has_key('interface_ids'):
+ node_filter['interface_ids']=interface_ids
+
+ if isinstance(return_fields, list):
+ if 'nodenetwork_ids' in return_fields:
+ return_fields.remove('nodenetwork_ids')
+ if 'interface_ids' not in return_fields:
+ return_fields.append('interface_ids')
nodes = v43GetNodes.call(self,auth,node_filter,return_fields)
- # add in a interface_ids -> nodenetwork_ids
+ # if interface_ids are present, then create a nodenetwork_ids mapping
for node in nodes:
if node.has_key('interface_ids'):
node['nodenetwork_ids']=node['interface_ids']
return nodes
-GetNodes = v42GetNodes
+class GetNodes(v42GetNodes):
+ """
+ Returns an array of structs containing details about nodes. If
+ node_filter is specified and is an array of node identifiers or
+ hostnames, or a struct of node attributes, only nodes matching the
+ filter will be returned. If return_fields is specified, only the
+ specified details will be returned.
+
+ Some fields may only be viewed by admins.
+ """
+ pass