Saimon/list search zones (#162)

* Support listing and searching for zones

cterasdk/client/cteraclient.py

@@ -74,6 +74,7 @@ def _ctera_exec(self, baseurl, path, exec_type, name, param):
         obj.type = exec_type
         obj.name = name
         obj.param = param
+        print(toxmlstr(obj))
         function = Command(HTTPClient.post, self.http_client, geturi(baseurl, path), ContentType.textplain, toxmlstr(obj))
         return self._execute(function)
 

cterasdk/core/query.py

@@ -5,19 +5,19 @@
 from ..convert import tojsonstr
 
 
-def query(CTERAHost, path, param):
-    response = CTERAHost.db(path, 'query', param)
+def query(CTERAHost, path, name, param):
+    response = CTERAHost.execute(path, name, param) if name is not None else CTERAHost.db(path, 'query', param)
     return (response.hasMore, response.objects)
 
 
-def show(CTERAHost, path, param):
-    hasMore, objects = query(CTERAHost, path, param)
+def show(CTERAHost, path, name, param):
+    hasMore, objects = query(CTERAHost, path, name, param)
     print(tojsonstr(objects, no_log=False))
     return hasMore
 
 
-def iterator(CTERAHost, path, param):
-    function = Command(query, CTERAHost, path)
+def iterator(CTERAHost, path, param, name=None):
+    function = Command(query, CTERAHost, path, name)
     return Iterator(function, param)
 
 

cterasdk/core/zones.py

@@ -16,6 +16,8 @@ class Zones(BaseCommand):
     Portal Zones APIs
     """
 
+    name_attr = 'name'
+
     def get(self, name):
         """
         Get zone by name
@@ -39,6 +41,33 @@ def get(self, name):
         logging.getLogger().info('Zone found. %s', {'name': name, 'id': zone.zoneId})
         return zone
 
+    def list_zones(self, filters=None):
+        """
+        List Zones
+        :param list[],optional filters: List of additional filters, defaults to None
+
+        :return: Iterator for all Zones
+        :rtype: cterasdk.lib.iterator.Iterator
+        """
+        builder = query.QueryParamBuilder().include_classname().startFrom(0).countLimit(25)
+        filters = filters or []
+        for query_filter in filters:
+            builder.addFilter(query_filter)
+        builder.orFilter((len(filters) > 1))
+        param = builder.build()
+        return query.iterator(self._portal, '', param, 'getZonesDisplayInfo')
+
+    def search(self, name):
+        """
+        Search for Zones by name
+        :param str name: Search query
+
+        :return: Iterator for all matching Zones
+        :rtype: cterasdk.lib.iterator.Iterator
+        """
+        filters = [query.FilterBuilder(Zones.name_attr).like(name)]
+        return self.list_zones(filters)
+
     def add(self, name, policy_type=enum.PolicyType.SELECT, description=None):
         """
         Add a new zone

cterasdk/object/Portal.py

@@ -156,12 +156,12 @@ def put(self, path, value, use_file_url=False):
         return super().put(path, value, use_file_url=use_file_url)
 
     @authenticated
-    def query(self, path, param):
-        return query.query(self, path, param)
+    def query(self, path, name, param):
+        return query.query(self, path, name, param)
 
     @authenticated
-    def show_query(self, path, param):
-        return query.show(self, path, param)
+    def show_query(self, path, name, param):
+        return query.show(self, path, name, param)
 
     def iterator(self, path, param):
         return query.iterator(self, path, param)

docs/source/user_guides/Portal/GlobalAdmin.rst

@@ -960,6 +960,25 @@ Retrieve a Zone
 
    zone = admin.zones.get('ZN-001')
 
+List & Search Zones
+^^^^^^^^^^^^^^^^^^^
+
+.. automethod:: cterasdk.core.zones.Zones.list_zones
+   :noindex:
+
+.. code:: python
+
+   for zone in admin.zones.list_zones():
+       print(zone)
+
+.. automethod:: cterasdk.core.zones.Zones.search
+   :noindex:
+
+.. code:: python
+
+   for zone in admin.zones.search('ZN'):
+       print(zone)
+
 Create a Zone
 ^^^^^^^^^^^^^
 .. automethod:: cterasdk.core.zones.Zones.add