Merge pull request #5 from dell/release_1.4.0

shenda1 · web-flow · commit 5fe555d67d76 · 2022-06-21T15:39:06.000+05:30
Release version 1.4.0 for PyPowerFlex
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,5 +1,8 @@
 # PyPowerFlex Change Log
 
+## Version 1.4.0 - released on 28/06/22
+- Added configuration operations includes adding/removing of standby MDM, change cluster ownership, change cluster mode, modify performance profile, rename MDM, modify MDM's virtual interface and getting details of MDM cluster entities.
+
 ## Version 1.3.0 - released on 25/03/22
 - Added block provisioning operations includes managing protection domain and getting high level facts about this entity.
 
diff --git a/PyPowerFlex/base_client.py b/PyPowerFlex/base_client.py
@@ -84,6 +84,27 @@ def send_post_request(self, url, params=None, **url_params):
         self._logout()
         return r, response
 
+    def send_mdm_cluster_post_request(self, url, params=None, **url_params):
+        if params is None:
+            params = dict()
+        response = None
+        self._login()
+        request_url = self.base_url + url.format(**url_params)
+        r = requests.post(request_url,
+                          auth=(
+                              self.configuration.username,
+                              self.token.get()
+                          ),
+                          headers=self.headers,
+                          data=utils.prepare_params(params),
+                          verify=self.verify_certificate,
+                          timeout=self.configuration.timeout)
+
+        if r.content != b'':
+            response = r.json()
+        self._logout()
+        return r, response
+
     def _login(self):
         request_url = self.base_url + '/login'
 
@@ -125,6 +146,8 @@ class EntityRequest(Request):
     base_entity_url = '/instances/{entity}::{entity_id}'
     base_entity_list_or_create_url = '/types/{entity}/instances'
     base_relationship_url = base_entity_url + '/relationships/{related}'
+    base_object_url = '/instances/{entity}/action/{action}'
+    query_mdm_cluster_url = '/instances/{entity}/queryMdmCluster'
     entity_name = None
 
     @property
@@ -196,7 +219,8 @@ def get(self, entity_id=None, filter_fields=None, fields=None):
             response = utils.query_response_fields(response, fields)
         return response
 
-    def get_related(self, entity_id, related, filter_fields=None, fields=None):
+    def get_related(self, entity_id, related, filter_fields=None,
+                    fields=None):
         url_params = dict(
             entity=self.entity,
             entity_id=entity_id,
diff --git a/PyPowerFlex/objects/sdc.py b/PyPowerFlex/objects/sdc.py
@@ -72,7 +72,8 @@ def set_performance_profile(self, sdc_id, perf_profile):
             perfProfile=perf_profile
         )
 
-        r, response = self.send_post_request(self.base_action_url, action, sdc_id, params)
+        r, response = self.send_post_request(self.base_action_url, action,
+                                             sdc_id, params)
 
         if r.status_code != requests.codes.ok:
             msg = ('Failed to set Performance Profile on '
@@ -83,4 +84,4 @@ def set_performance_profile(self, sdc_id, perf_profile):
             LOG.error(msg)
             raise exceptions.PowerFlexClientException(msg)
 
-        return self.get(entity_id=sdc_id)
+        return self.get(entity_id=sdc_id)
diff --git a/PyPowerFlex/objects/system.py b/PyPowerFlex/objects/system.py
@@ -154,3 +154,263 @@ def snapshot_volumes(self,
             raise exceptions.PowerFlexClientException(msg)
 
         return response
+
+    def add_standby_mdm(self, mdm_ips, role, management_ips=None, port=None,
+                        mdm_name=None, allow_multiple_ips=None, clean=None,
+                        virtual_interface=None):
+        """
+        Add a standby MDM to the system.
+        :param mdm_ips: List of ip addresses assigned to new MDM. It can
+                        contain IPv4 addresses.
+        :type mdm_ips: list[str]
+        :param role: Role of the new MDM.
+        :type role: str
+        :param management_ips: List of IP addresses used to manage the MDM.
+                               It can contain IPv4 addresses.
+        :type management_ips: list[str]
+        :param port: Port of new MDM. Default: 9011
+        :type port: str
+        :param mdm_name: Name of the new MDM.
+        :type mdm_name: str
+        :param allow_multiple_ips: Allow the added node to have a different
+                                   number of IPs from the primary node.
+        :type allow_multiple_ips: str
+        :param clean: Clean a previous MDM configuration.
+        :type clean: str
+        :param virtual_interface: List of NIC interfaces that will be used
+                                  for virtual IP address.
+        :type virtual_interface: list[str]
+        :return: ID of new standby MDM.
+        :rtype: dict
+        """
+        action = 'addStandbyMdm'
+        params = dict(
+            ips=mdm_ips,
+            role=role,
+            managementIps=management_ips,
+            name=mdm_name,
+            port=port,
+            allowAsymmetricIps=allow_multiple_ips,
+            forceClean=clean,
+            virtIpIntfs=virtual_interface
+        )
+
+        r, response = self.send_post_request(self.base_object_url,
+                                             action=action,
+                                             entity=self.entity,
+                                             params=params)
+        if r.status_code != requests.codes.ok:
+            msg = ('Failed to add standBy MDM on PowerFlex {entity}. '
+                   'Error: {response}'.format(entity=self.entity,
+                                              response=response))
+            LOG.error(msg)
+            raise exceptions.PowerFlexClientException(msg)
+
+        return response
+
+    def remove_standby_mdm(self, mdm_id):
+        """
+        Remove a standby MDM from the system.
+        :param mdm_id: ID of MDM to be removed.
+        :type mdm_id: str
+        :return: None
+        """
+        action = 'removeStandbyMdm'
+        params = dict(
+            id=mdm_id
+        )
+
+        r, response = self.send_mdm_cluster_post_request(self.base_object_url,
+                                                         action=action,
+                                                         entity=self.entity,
+                                                         params=params)
+        if r.status_code != requests.codes.ok and response is not None:
+            msg = ('Failed to remove standBy MDM from PowerFlex {entity}. '
+                   'Error: {response}.'.format(entity=self.entity,
+                                               response=response))
+            LOG.error(msg)
+            raise exceptions.PowerFlexClientException(msg)
+
+        return True
+
+    def get_mdm_cluster_details(self):
+        """
+        Get the MDM cluster details
+        :return: MDM cluster details
+        :rtype: dict
+        """
+
+        r, response = self.send_post_request(self.query_mdm_cluster_url,
+                                             entity=self.entity)
+        if r.status_code != requests.codes.ok:
+            msg = ('Failed to get MDM cluster details on PowerFlex {entity}. '
+                   'Error: {response}'.format(entity=self.entity,
+                                              response=response))
+            LOG.error(msg)
+            raise exceptions.PowerFlexClientException(msg)
+
+        return response
+
+    def change_mdm_ownership(self, mdm_id):
+        """
+        Change MDM cluster ownership from current master MDM to different MDM.
+
+        :param mdm_id: ID of New Manager MDM
+        :type mdm_id: str
+        :return: None
+        :rtype: dict
+        """
+        action = 'changeMdmOwnership'
+        params = dict(
+            id=mdm_id
+        )
+
+        r, response = self.send_post_request(self.base_object_url,
+                                             action=action,
+                                             entity=self.entity,
+                                             params=params)
+        if r.status_code != requests.codes.ok:
+            msg = ('Failed to change ownership on PowerFlex {entity}. '
+                   'Error: {response}'.format(entity=self.entity,
+                                              response=response))
+            LOG.error(msg)
+            raise exceptions.PowerFlexClientException(msg)
+
+    def set_cluster_mdm_performance_profile(self, performance_profile):
+        """
+        Set the Cluster MDMs performance profile.
+
+        :param performance_profile: Define the performance profile of MDMs.
+        :type performance_profile: str
+        :return: None
+        :rtype: dict
+        """
+        action = 'setMdmPerformanceParameters'
+        params = dict(
+            perfProfile=performance_profile
+        )
+
+        r, response = self.send_post_request(self.base_object_url,
+                                             action=action,
+                                             entity=self.entity,
+                                             params=params)
+        if r.status_code != requests.codes.ok:
+            msg = ('Failed to set performance profile of MDMs on PowerFlex '
+                   '{entity}. Error: {response}'.format(entity=self.entity,
+                                                        response=response))
+            LOG.error(msg)
+            raise exceptions.PowerFlexClientException(msg)
+
+        return response
+
+    def rename_mdm(self, mdm_id, mdm_new_name):
+        """
+        Set the Cluster MDMs performance profile.
+
+        :param mdm_id: ID of MDM.
+        :type mdm_id: str
+        :param mdm_new_name: new name of MDM.
+        :type mdm_new_name: str
+        :return: None
+        :rtype: dict
+        """
+        action = 'renameMdm'
+        params = dict(
+            id=mdm_id,
+            newName=mdm_new_name
+        )
+
+        r, response = self.send_post_request(self.base_object_url,
+                                             action=action,
+                                             entity=self.entity,
+                                             params=params)
+        if r.status_code != requests.codes.ok:
+            msg = ('Failed to rename the MDM on PowerFlex {entity}. Error: '
+                   '{response}'.format(entity=self.entity, response=response))
+            LOG.error(msg)
+            raise exceptions.PowerFlexClientException(msg)
+
+        return response
+
+    def modify_virtual_ip_interface(self, mdm_id, virtual_ip_interfaces=None,
+                                    clear_interfaces=None):
+        """
+        Set the Cluster MDMs performance profile.
+
+        :param mdm_id: ID of MDM.
+        :type mdm_id: str
+        :param virtual_ip_interfaces: List of interface names to be used for
+                                      the MDM virtual IPs.
+        :type virtual_ip_interfaces: list[str]
+        :param clear_interfaces: Clear all virtual IP interfaces.
+        :type mdm_id: str
+        :return: None
+        :rtype: dict
+        """
+        action = 'modifyVirtualIpInterfaces'
+        if virtual_ip_interfaces is not None:
+            params = dict(
+                id=mdm_id,
+                virtIpIntfs=virtual_ip_interfaces
+            )
+        else:
+            params = dict(
+                id=mdm_id,
+                clear=clear_interfaces
+            )
+
+        r, response = self.send_post_request(self.base_object_url,
+                                             action=action,
+                                             entity=self.entity,
+                                             params=params)
+        if r.status_code != requests.codes.ok:
+            msg = ('Failed to modify virtual IP interface on PowerFlex '
+                   '{entity}. Error: {response}'.format(entity=self.entity,
+                                                        response=response))
+            LOG.error(msg)
+            raise exceptions.PowerFlexClientException(msg)
+
+        return response
+
+    def switch_cluster_mode(self, cluster_mode, add_secondary=None,
+                            remove_secondary=None, add_tb=None, remove_tb=None):
+        """
+        Switch cluster mode.
+
+        :param cluster_mode: New mode of MDM cluster
+        :type cluster_mode: str
+        :param add_secondary: List of secondary MDM IDs that will be part of
+                              the cluster. A maximum of two IDs are allowed.
+        :type add_secondary: list[str]
+        :param remove_secondary: List of secondary MDM IDs that will be removed
+                                 from the cluster.
+        :type remove_secondary: list[str]
+        :param add_tb: List of TieBreaker MDM IDs that will be part of the
+                       cluster.
+        :type add_tb: list[str]
+        :param remove_tb: List of TieBreaker MDM IDs that will be removed
+                          from the cluster.
+        :type remove_tb: list[str]
+        :return: None
+        """
+        action = 'switchClusterMode'
+        params = dict(
+            mode=cluster_mode,
+            addSlaveMdmIdList=add_secondary,
+            addTBIdList=add_tb,
+            removeSlaveMdmIdList=remove_secondary,
+            removeTBIdList=remove_tb
+        )
+
+        r, response = self.send_mdm_cluster_post_request(self.base_object_url,
+                                                         action=action,
+                                                         entity=self.entity,
+                                                         params=params)
+        if r.status_code != requests.codes.ok and response is not None:
+            msg = ('Failed to switch MDM cluster mode PowerFlex {entity}. '
+                   'Error: {response}.'.format(entity=self.entity,
+                                               response=response))
+            LOG.error(msg)
+            raise exceptions.PowerFlexClientException(msg)
+
+        return True
diff --git a/PyPowerFlex/objects/volume.py b/PyPowerFlex/objects/volume.py
@@ -455,7 +455,7 @@ def set_retention_period(self, snap_id, retention_period):
         :type retention_period: str
         :return: dict
         """
-        
+
         action = 'setSnapshotSecurity'
 
         params = dict(
@@ -478,7 +478,6 @@ def set_retention_period(self, snap_id, retention_period):
 
         return self.get(entity_id=snap_id)
 
-
     def set_volume_access_mode_limit(self, volume_id, access_mode_limit):
         """
         Set the highest mapping access mode allowed for a volume.
diff --git a/setup.py b/setup.py
@@ -17,7 +17,7 @@
 
 setup(
     name='PyPowerFlex',
-    version='1.3.0',
+    version='1.4.0',
     description='Python library for Dell PowerFlex',
     author='Ansible Team at Dell',
     author_email='ansible.team@dell.com',
diff --git a/tests/test_system.py b/tests/test_system.py
