Added ability to search for vm/host projects & categories if connected to prism central

Author: grdavies-ntnx

docs/changelog.rst

@@ -7,6 +7,7 @@ A log of changes by version and date.
     :header: "Version", "Date", "Notes"
     :widths: 10, 10, 60
 
+    "1.1.14", "3/25/2021", "Added the ability to search for and return host/vm project & categories."
     "1.1.13", "3/23/2021", "Resolved code quality issues in client.py"
     "1.1.12", "3/23/2021", "Updated docsctings within for client.py"
     "1.1.11", "3/22/2021", "Added docstring for prism.Config.change_ui_admin_password"

ntnx_api/_version.py

@@ -3,5 +3,5 @@
 # 2) we can import it in setup.py for the same reason
 # 3) we can import it into your module module
 
-__version_info__ = ('1', '1', '13')
+__version_info__ = ('1', '1', '14')
 __version__ = '.'.join(__version_info__)

ntnx_api/prism.py

@@ -2293,7 +2293,7 @@ def get_all_uuids(self):
         logger.info('found cluster uuids: {0}'.format(self.clusters))
         return self.clusters
 
-    def get(self, clusteruuid=None):
+    def get(self, clusteruuid=None, refresh=False):
         """Retrieve data for a specific cluster
 
         :param clusteruuid: A cluster UUID to define the specific cluster to query. Only required to be used when the :class:`ntnx.client.ApiClient`
@@ -2307,6 +2307,11 @@ def get(self, clusteruuid=None):
         payload = None
         uri = '/cluster'
 
+        # Remove existing data for this cluster if it exists
+        if self.cluster.get(clusteruuid):
+            self.cluster.pop(clusteruuid)
+            logger.info('removing existing data from class dict cluster for cluster {0}'.format(clusteruuid))
+
         if clusteruuid:
             params['proxyClusterUuid'] = clusteruuid
 
@@ -2429,7 +2434,7 @@ def get(self, clusteruuid=None):
             'entities')
         return self.hosts[clusteruuid]
 
-    def search_uuid(self, uuid, clusteruuid=None):
+    def search_uuid(self, uuid, clusteruuid=None, refresh=False):
         """Retrieve data for a specific host, in a specific cluster by host uuid
 
         :param clusteruuid: A cluster UUID to define the specific cluster to query. Only required to be used when the :class:`ntnx.client.ApiClient`
@@ -2443,7 +2448,7 @@ def search_uuid(self, uuid, clusteruuid=None):
         """
         logger = logging.getLogger('ntnx_api.prism.Hosts.search_uuid')
         found = {}
-        if not self.hosts.get(clusteruuid):
+        if not self.hosts.get(clusteruuid) or refresh:
             self.get(clusteruuid)
 
         for entity in self.hosts.get(clusteruuid):
@@ -2453,21 +2458,23 @@ def search_uuid(self, uuid, clusteruuid=None):
 
         return found
 
-    def search_name(self, name, clusteruuid=None):
+    def search_name(self, name, clusteruuid=None, refresh=False):
         """Retrieve data for a specific host, in a specific cluster by host name
 
         :param clusteruuid: A cluster UUID to define the specific cluster to query. Only required to be used when the :class:`ntnx.client.ApiClient`
                             `connection_type` is set to `pc`.
         :type clusteruuid: str, optional
         :param name: A host name to search for.
         :type name: str, optional
+        :param refresh: Whether to refresh the class dataset (default=False).
+        :type refresh: bool, optional
 
         :returns: A dictionary describing the found host.
         :rtype: ResponseDict
         """
         logger = logging.getLogger('ntnx_api.prism.Hosts.search_name')
         found = {}
-        if not self.hosts.get(clusteruuid):
+        if not self.hosts.get(clusteruuid) or refresh:
             self.get(clusteruuid)
 
         for entity in self.hosts.get(clusteruuid):
@@ -2477,21 +2484,23 @@ def search_name(self, name, clusteruuid=None):
 
         return found
 
-    def search_ip(self, ip_address, clusteruuid=None):
+    def search_ip(self, ip_address, clusteruuid=None, refresh=False):
         """Retrieve data for a specific host, in a specific cluster by ip_address. The CVM, Hypervisor and IPMI IP addresses will be tested
 
         :param clusteruuid: A cluster UUID to define the specific cluster to query. Only required to be used when the :class:`ntnx.client.ApiClient`
                             `connection_type` is set to `pc`.
         :type clusteruuid: str, optional
         :param ip_address: A host name to search for.
         :type ip_address: str, optional
+        :param refresh: Whether to refresh the class dataset (default=False).
+        :type refresh: bool, optional
 
         :returns: A dictionary describing the found host.
         :rtype: ResponseDict
         """
         logger = logging.getLogger('ntnx_api.prism.Hosts.search_ip')
         found = {}
-        if not self.hosts.get(clusteruuid):
+        if not self.hosts.get(clusteruuid) or refresh:
             self.get(clusteruuid)
 
         for entity in self.hosts.get(clusteruuid):
@@ -2501,6 +2510,51 @@ def search_ip(self, ip_address, clusteruuid=None):
 
         return found
 
+    def get_project(self, uuid, clusteruuid=None, refresh=False):
+        """Retrieve the project assigned to the specified host if connected to a prism central
+
+        :param clusteruuid: A cluster UUID to define the specific cluster to query. Only required to be used when the :class:`ntnx.client.ApiClient`
+                            `connection_type` is set to `pc`.
+        :type clusteruuid: str, optional
+        :param uuid: The UUID of a host.
+        :type uuid: str
+        :param refresh: Whether to refresh the class dataset (default=False).
+        :type refresh: bool, optional
+
+        :returns: A string containing the project name.
+        :rtype: str
+        """
+        logger = logging.getLogger('ntnx_api.prism.Hosts.get_project')
+        project = ''
+        if self.api_client.connection_type == 'pc':
+            metadata = self.search_uuid(uuid=uuid, clusteruuid=clusteruuid, refresh=refresh).get('vm_metadata')
+            if metadata.get('project_reference').get('kind') == 'project':
+                project = metadata.get('project_reference').get('name')
+        return project
+
+    def get_categories(self, uuid, clusteruuid=None, refresh=False):
+        """Retrieve the categories assigned to the specified host if connected to a prism central
+
+        :param clusteruuid: A cluster UUID to define the specific cluster to query. Only required to be used when the :class:`ntnx.client.ApiClient`
+                            `connection_type` is set to `pc`.
+        :type clusteruuid: str, optional
+        :param uuid: The UUID of a host.
+        :type uuid: str
+        :param refresh: Whether to refresh the class dataset (default=False).
+        :type refresh: bool, optional
+
+        :returns: A dictionary with all .
+        :rtype: ResponseDict
+        """
+        logger = logging.getLogger('ntnx_api.prism.Hosts.get_categories')
+        categories = []
+        if self.api_client.connection_type == 'pc':
+            metadata = self.search_uuid(uuid=uuid, clusteruuid=clusteruuid, refresh=refresh).get('categories')
+            if metadata.get('project_reference').get('kind') == 'project':
+                for key, value in metadata.get('categories').items():
+                    categories[key] = value
+        return categories
+
 
 class Vms(object):
     """A class to represent a Nutanix Clusters Virtual Machines
@@ -2548,6 +2602,8 @@ def search_uuid(self, uuid, clusteruuid=None, refresh=False):
         :type clusteruuid: str, optional
         :param uuid: A vm uuid to search for.
         :type uuid: str, optional
+        :param refresh: Whether to refresh the class VM dataset (default=False).
+        :type refresh: bool, optional
 
         :returns: A dictionary describing the found vm.
         :rtype: ResponseDict
@@ -2572,6 +2628,8 @@ def search_name(self, name, clusteruuid=None, refresh=False):
         :type clusteruuid: str, optional
         :param name: A vm name to search for.
         :type name: str, optional
+        :param refresh: Whether to refresh the class VM dataset (default=False).
+        :type refresh: bool, optional
 
         :returns: A dictionary describing the found vm.
         :rtype: ResponseDict
@@ -2588,6 +2646,51 @@ def search_name(self, name, clusteruuid=None, refresh=False):
 
         return found
 
+    def get_project(self, uuid, clusteruuid=None, refresh=False):
+        """Retrieve the project assigned to the specified VM if connected to a prism central
+
+        :param clusteruuid: A cluster UUID to define the specific cluster to query. Only required to be used when the :class:`ntnx.client.ApiClient`
+                            `connection_type` is set to `pc`.
+        :type clusteruuid: str, optional
+        :param uuid: The UUID of a VM.
+        :type uuid: str
+        :param refresh: Whether to refresh the class VM dataset (default=False).
+        :type refresh: bool, optional
+
+        :returns: A string containing the project name.
+        :rtype: str
+        """
+        logger = logging.getLogger('ntnx_api.prism.Vms.get_project')
+        project = ''
+        if self.api_client.connection_type == 'pc':
+            metadata = self.search_uuid(uuid=uuid, clusteruuid=clusteruuid, refresh=refresh).get('vm_metadata')
+            if metadata.get('project_reference').get('kind') == 'project':
+                project = metadata.get('project_reference').get('name')
+        return project
+
+    def get_categories(self, uuid, clusteruuid=None, refresh=False):
+        """Retrieve the categories assigned to the specified VM if connected to a prism central
+
+        :param clusteruuid: A cluster UUID to define the specific cluster to query. Only required to be used when the :class:`ntnx.client.ApiClient`
+                            `connection_type` is set to `pc`.
+        :type clusteruuid: str, optional
+        :param uuid: The UUID of a VM.
+        :type uuid: str
+        :param refresh: Whether to refresh the class VM dataset (default=False).
+        :type refresh: bool, optional
+
+        :returns: A dictionary with all .
+        :rtype: ResponseDict
+        """
+        logger = logging.getLogger('ntnx_api.prism.Vms.get_categories')
+        categories = []
+        if self.api_client.connection_type == 'pc':
+            metadata = self.search_uuid(uuid=uuid, clusteruuid=clusteruuid, refresh=refresh).get('categories')
+            if metadata.get('project_reference').get('kind') == 'project':
+                for key, value in metadata.get('categories').items():
+                    categories[key] = value
+        return categories
+
 
 class Images(object):
     """A class to represent a Nutanix Clusters Images