Dev

.github/workflows/python-publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published] 
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

docs/conf.py

@@ -19,7 +19,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'pyCSM'
-copyright = '2022, dblea00'
+copyright = '2026, dblea00'
 author = 'dblea00'
 
 

docs/environment.yaml

@@ -5,7 +5,7 @@ channels:
   - conda-forge
   - defaults
 dependencies:
-  - sphinx==4.2.0
+  - sphinx==5.0.0
   - nbsphinx==0.8.1
   - pip:
     - sphinx_rtd_theme==1.0.0

docs/requirements.txt

@@ -1,5 +1,5 @@
 # File: docs/requirements.txt
 
 # Defining the exact version will make sure things don't break
-sphinx==4.2.0
+sphinx==5.0.0
 sphinx_rtd_theme==1.0.0

pyCSM/clients/session_client.py

@@ -237,10 +237,10 @@ def wait_for_state(self, ses_name, state, minutes, debug=False):
                                                      ses_name, state, minutes, debug)
         resp = result_dict["state_reached"]
         if resp.status_code == 401:
-            minutes = (datetime.utcnow() - start_time).total_seconds()
+            elapsed_minutes = int((datetime.utcnow() - start_time).total_seconds() / 60)
             self.tk = auth.get_token(self.base_url, self.username, self.password)
             return session_service.wait_for_state(self.base_url, self.tk, ses_name,
-                                                  state, minutes, debug)
+                                                  state, elapsed_minutes, debug)
         return result_dict
 
     def sgc_recover(self, ses_name, com_name, role, backup_id):
@@ -482,7 +482,7 @@ def add_copysets(self, name, copyset, roleorder=None):
                                                 roleorder)
         return resp
 
-    def remove_copysets(self, name, copysets, force=None, soft=None):
+    def remove_copysets(self, name, copysets, force=False, soft=False):
         """
         Removes Copy Sets from the given session.
 
@@ -517,7 +517,7 @@ def export_copysets(self, name, file_name):
         resp = copyset_service.export_copysets(self.base_url, self.tk, name, file_name)
         if resp.status_code == 401:
             self.tk = auth.get_token(self.base_url, self.username, self.password)
-            return copyset_service.export_copysets.export_cpyst(self.base_url, self.tk, name, file_name)
+            return copyset_service.export_copysets(self.base_url, self.tk, name, file_name)
         return resp
 
     def get_pair_info(self, name, rolepair):
@@ -538,7 +538,7 @@ def get_pair_info(self, name, rolepair):
                                              rolepair)
         if resp.status_code == 401:
             self.tk = auth.get_token(self.base_url, self.username, self.password)
-            return copyset_service.get_pair_info.export_cpyst(self.base_url, self.tk, name,
+            return copyset_service.get_pair_info(self.base_url, self.tk, name,
                                                               rolepair)
         return resp
 
@@ -554,11 +554,11 @@ def enable_scheduled_task_at_time(self, task_id, start_time):
             JSON String representing the result of the command.
             'I' = successful,'W' = warning, 'E' = error.
         """
-        resp = copyset_service.enable_scheduled_task_at_time(self.base_url, self.tk, task_id,
+        resp = schedule_service.enable_scheduled_task_at_time(self.base_url, self.tk, task_id,
                                                              start_time)
         if resp.status_code == 401:
             self.tk = auth.get_token(self.base_url, self.username, self.password)
-            return copyset_service.enable_scheduled_task_at_time(self.base_url, self.tk, task_id,
+            return schedule_service.enable_scheduled_task_at_time(self.base_url, self.tk, task_id,
                                                                  start_time)
         return resp
 
@@ -574,11 +574,11 @@ def run_scheduled_task_at_time(self, task_id, start_time):
             JSON String representing the result of the command.
             'I' = successful,'W' = warning, 'E' = error.
         """
-        resp = copyset_service.run_scheduled_task_at_time(self.base_url, self.tk, task_id,
+        resp = schedule_service.run_scheduled_task_at_time(self.base_url, self.tk, task_id,
                                                           start_time)
         if resp.status_code == 401:
             self.tk = auth.get_token(self.base_url, self.username, self.password)
-            return copyset_service.run_scheduled_task_at_time(self.base_url, self.tk, task_id,
+            return schedule_service.run_scheduled_task_at_time(self.base_url, self.tk, task_id,
                                                               start_time)
         return resp
 
@@ -769,3 +769,57 @@ def get_rolepair_info(self, name, rolepair):
             return session_service.get_rolepair_info(self.base_url, self.tk,
                                                      name, rolepair)
         return resp
+
+    def delete_task(self, taskid):
+        """
+        Delete a scheduled task. 
+        Args:
+            taskid (str): ID of the schedule task to enable.
+
+        Returns:
+            JSON String representing the result of the command.
+            'I' = successful, 'W' = warning, 'E' = error.
+        """
+        resp = schedule_service.delete_task(self.base_url, self.tk, taskid)
+        if resp.status_code == 401:
+            self.tk = auth.get_token(self.base_url, self.username, self.password)
+            return schedule_service.delete_task(self.base_url, self.tk, taskid)
+
+        return resp
+
+    def cancel_task(self, taskid):
+        """
+        Cancel a running scheduled task. 
+        Args:
+            taskid (str): ID of the schedule task to cancel.
+
+        Returns:
+            JSON String representing the result of the command.
+            'I' = successful, 'W' = warning, 'E' = error.
+        """
+        resp = schedule_service.cancel_task(self.base_url, self.tk, taskid)
+        if resp.status_code == 401:
+            self.tk = auth.get_token(self.base_url, self.username, self.password)
+            return schedule_service.cancel_task(self.base_url, self.tk, taskid)
+
+        return resp
+
+    def run_task_now(self, taskid, synchronous=False, step=0):
+        """
+        Run a scheduled task immediately at a specific step.
+
+
+        Returns:
+            JSON String representing the result of the command.
+            'I' = successful, 'W' = warning, 'E' = error.
+        """
+
+        resp = schedule_service.cancel_task(self.base_url, self.tk, taskid)
+        if resp.status_code == 401:
+            self.tk = auth.get_token(self.base_url, self.username, self.password)
+            resp = schedule_service.cancel_task(self.base_url, self.tk, taskid)
+
+        run_resp = schedule_service.run_task_now(url=self.base_url, tk=self.tk, taskid=taskid, step=step, synchronous=synchronous)
+
+        return run_resp
+

pyCSM/clients/system_client.py

@@ -510,5 +510,48 @@ def set_property(self, file, property_name, value):
         resp = system_service.set_property(self.base_url, self.tk, file, property_name, value)
         if resp.status_code == 401:
             self.tk = auth.get_token(self.base_url, self.username, self.password)
-            return system_service.remove_active_or_standby_server(self.base_url, self.tk, file, property_name, value)
+            return system_service.remove_active_or_standby_server(self.base_url, self.tk, file)
         return resp
+
+    def put_email_notifications_enabled(self, enabled):
+        """
+        Enables or disables email alert notifications on the server.
+
+        Returns:
+            JSON String representing the result of the command.
+            'I' = successful, 'W' = warning, 'E' = error.
+        """
+        resp = system_service.put_email_notifications_enabled(self.base_url, self.tk, enabled)
+        if resp.status_code == 401:
+            self.tk = auth.get_token(self.base_url, self.username, self.password)
+            return system_service.put_email_notifications_enabled(self.base_url, self.tk, enabled)
+        return resp
+
+    def get_email_recipients(self):
+        """
+        Get a summary of the volume usage on the server
+
+        Returns:
+            JSON String representing the result of the command.
+            'I' = successful, 'W' = warning, 'E' = error.
+        """
+        resp = system_service.get_email_recipients(self.base_url, self.tk)
+        if resp.status_code == 401:
+            self.tk = auth.get_token(self.base_url, self.username, self.password)
+            return system_service.get_email_recipients(self.base_url, self.tk)
+        return resp
+
+    def add_email_recipients(self, addresses, alert_type, session_names):
+        """
+        Enables or disables email alert notifications on the server.
+
+        Returns:
+            JSON String representing the result of the command.
+            'I' = successful, 'W' = warning, 'E' = error.
+        """
+        resp = system_service.add_email_recipients(self.base_url, self.tk, addresses, alert_type, session_names )
+        if resp.status_code == 401:
+            self.tk = auth.get_token(self.base_url, self.username, self.password)
+            return system_service.add_email_recipients(self.base_url, self.tk, addresses, alert_type, session_names)
+        return resp
+

pyCSM/services/hardware_service/hardware_service.py

@@ -524,58 +524,6 @@ def add_zos_cert(url, tk, file_path):
 
     return requests.post(post_url, headers=headers, files=files, verify=properties["verify"], cert=properties["cert"])
 
-
-def add_zos_device(url, tk, device_id):
-    """
-    This method will add a storage system through the zoshost connection.
-
-    Args:
-        url (str): Base url of CSM server. ex. https://servername:port/CSM/web.
-        tk (str): Rest token for the CSM server.
-        device_id (str): Storage system name in the format "DS8000:BOX:2107.KXZ91".
-
-    Returns:
-        JSON String representing the result of the command.
-        'I' = successful, 'W' = warning, 'E' = error.
-    """
-    put_url = f"{url}/storagedevices/zosdevice"
-    headers = {
-        "Accept-Language": properties["language"],
-        "X-Auth-Token": str(tk),
-        "Content-Type": "application/x-www-form-urlencoded"
-    }
-
-    params = {
-        "deviceid": device_id
-    }
-
-    return requests.put(put_url, headers=headers, data=params, verify=properties["verify"], cert=properties["cert"])
-
-
-def get_zos_host(url, tk):
-    """
-    This method will get the information for all zos host connections.
-
-    Args:
-        url (str): Base url of CSM server. ex. https://servername:port/CSM/web.
-        tk (str): Rest token for the CSM server.
-
-    Returns:
-        JSON String representing the result of the command.
-        'I' = successful, 'W' = warning, 'E' = error.
-    """
-    get_url = f"{url}/storagedevices/zoshost"
-    headers = {
-        "Accept-Language": properties["language"],
-        "X-Auth-Token": str(tk),
-        "Content-Type": "application/x-www-form-urlencoded"
-    }
-    return requests.get(get_url, headers=headers,  verify=properties["verify"], cert=properties["cert"])
-
-
-
-
-
 def add_zos_device(url, tk, device_id):
     """
     This method will add a storage system through the zoshost connection.

pyCSM/services/session_service/copyset_service.py

@@ -172,50 +172,3 @@ def get_pair_info(url, tk, name, rolepair):
     }
     return requests.get(get_url, headers=headers, verify=properties["verify"], cert=properties["cert"])
 
-
-def enable_scheduled_task_at_time(url, tk, task_id, start_time):
-    """
-    Enable the task at the given time
-
-    Args:
-        url (str): Base url of csm server. ex. https://servername:port/CSM/web.
-        tk (str): Rest token for the CSM server.
-        task_id (int): ID of the schedule task to enable
-        start_time (str): Time to enable the task.
-        Format of yyyy-MM-dd'T'HH-mm.
-
-    Returns:
-        JSON String representing the result of the command.
-        'I' = successful,'W' = warning, 'E' = error.
-    """
-    post_url = f"{url}/sessions/scheduledtasks/enable/{task_id}/{start_time}"
-    headers = {
-        "Accept-Language": properties["language"],
-        "X-Auth-Token": str(tk),
-        "Content-Type": "application/x-www-form-urlencoded"
-    }
-    return requests.post(post_url, headers=headers, verify=properties["verify"], cert=properties["cert"])
-
-
-def run_scheduled_task_at_time(url, tk, task_id, start_time):
-    """
-    Run a scheduled task immediately.
-
-    Args:
-        url (str): Base url of csm server. ex. https://servername:port/CSM/web.
-        tk (str): Rest token for the CSM server.
-        task_id (int): ID of the schedule task to enable
-        start_time (str): Time to enable the task.
-        Format of yyyy-MM-dd'T'HH-mm.
-
-    Returns:
-        JSON String representing the result of the command.
-        'I' = successful,'W' = warning, 'E' = error.
-    """
-    post_url = f"{url}/sessions/scheduledtasks/{task_id}/runat/{start_time}"
-    headers = {
-        "Accept-Language": properties["language"],
-        "X-Auth-Token": str(tk),
-        "Content-Type": "application/x-www-form-urlencoded"
-    }
-    return requests.post(post_url, headers=headers, verify=properties["verify"], cert=properties["cert"])