1 from PLC.Method import Method
2 from PLC.Parameter import Parameter, Mixed
3 from PLC.Filter import Filter
4 from PLC.Auth import Auth
5 from PLC.Persons import Person, Persons
6 from PLC.Sites import Site, Sites
7 from PLC.Slices import Slice, Slices
9 class GetSlices(Method):
11 Returns an array of structs containing details about slices. If
12 slice_filter is specified and is an array of slice identifiers or
13 slice names, or a struct of slice attributes, only slices matching
14 the filter will be returned. If return_fields is specified, only the
15 specified details will be returned.
17 Users may only query slices of which they are members. PIs may
18 query any of the slices at their sites. Admins and nodes may query
19 any slice. If a slice that cannot be queried is specified in
20 slice_filter, details about that slice will not be returned.
23 roles = ['admin', 'pi', 'user', 'node']
27 Mixed([Mixed(Slice.fields['slice_id'],
28 Slice.fields['name'])],
29 Parameter(str,"name"),
30 Parameter(int,"slice_id"),
31 Filter(Slice.fields)),
32 Parameter([str], "List of fields to return", nullok = True)
35 returns = [Slice.fields]
37 def call(self, auth, slice_filter = None, return_fields = None):
38 # If we are not admin, make sure to return only viewable
40 if isinstance(self.caller, Person) and \
41 'admin' not in self.caller['roles']:
42 # Get slices that we are able to view
43 valid_slice_ids = self.caller['slice_ids']
44 if 'pi' in self.caller['roles'] and self.caller['site_ids']:
45 sites = Sites(self.api, self.caller['site_ids'])
47 valid_slice_ids += site['slice_ids']
49 if not valid_slice_ids:
52 if slice_filter is None:
53 slice_filter = valid_slice_ids
55 # Must query at least slice_id (see below)
56 if return_fields is not None and 'slice_id' not in return_fields:
57 return_fields.append('slice_id')
62 slices = Slices(self.api, slice_filter, return_fields)
64 # Filter out slices that are not viewable
65 if isinstance(self.caller, Person) and \
66 'admin' not in self.caller['roles']:
67 slices = filter(lambda slice: slice['slice_id'] in valid_slice_ids, slices)
69 # Remove slice_id if not specified
72 if 'slice_id' in slice: