pyCSM 1.0.7__tar.gz → 1.0.8__tar.gz

pycsm-1.0.8/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: pyCSM
+Version: 1.0.8
+Summary: CSM Python Client
+Author-email: Dominic Blea <dblea00@ibm.com>
+Maintainer-email: Dominic Blea <dblea00@ibm.com>
+License-Expression: Apache-2.0
+Keywords: IBM,CSM Storage
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: certifi>=2022.6.15
+Requires-Dist: requests>=2.28.0
+Requires-Dist: urllib3>=1.26.9
+Dynamic: license-file
+
+# CSM Python Client
+[![Build Status](https://travis.ibm.com/pyCSM/pyCSM.svg?token=S4B3H6Vzv2oQaoCcyYeT&branch=main)](https://github.ibm.com/pyCSM/pyCSM)
+[![Documentation Status](https://readthedocs.org/projects/pycsm/badge/?version=latest)](https://pycsm.readthedocs.io/en/latest/?badge=latest)
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5999/badge)](https://bestpractices.coreinfrastructure.org/projects/5999)
+
+This repository contains the IBM Python client for RESTful communication to an IBM Copy Services Manager server.  The Python client enables full management and monitoring of the replication and the components necessary for replication in a Copy Services Manager environment. 
+
+The repository provides two options for implementations.  
+- **Clients**      - The client classes are [session_client.py](pyCSM/clients/session_client.py), [hardware_client.py](pyCSM/clients/hardware_client.py), and [system_client.py](pyCSM/clients/system_client.py).  These classes are designed to automatically obtain and manage a token to CSM for communication.  A client class can be instantiated and then used to call the methods that perform the desired actions.   
+- **Services**     - The service classes are located under [session_service](pyCSM/services/session_service), [hardware_service](pyCSM/services/hardware_service), and [system_service](pyCSM/services/system_service) and can be used if the caller wishes to manage the connection and token themselves.  These are the same classes that are called from the client classes. 
+
+
+## Python Compatibility
+The content in this collection supports Python 3.6 and higher 
+
+## Installation 
+
+Communication to the Copy Services Manager server uses the RESTful interface and thus does not require an installation of client code.  
+Clone the repository, and then add it to your PYTHONPATH directory. The Python client is then ready for import and use.
+
+The pyCSM library can also be installed using pip.  
+```text
+pip install pyCSM
+```
+
+## Command Documentation
+All commands, their usage and their parameters are documented on [read the docs](https://pycsm.readthedocs.io/en/latest/).
+
+## Usage examples
+See documentation for examples on [read the docs](https://pycsm.readthedocs.io/en/latest/).
+
+## The CSM RESTful API
+Details on the CSM RESTful API used by this python library can be found in the [Knowledgecenter](https://www.ibm.com/docs/en/csm/6.3.2?topic=reference-csm-rest-api-documentation) for the product. 
+
+
+## Contributing
+To contribute to this library, please see [CONTRIBUTING.md](CONTRIBUTING.md) and submit a contributor license agreement for either an individual or corporation, to those listed as maintainers [here](MAINTAINERS.md).  
+
+See [cla-individual.doc](cla-individual.doc) or [cla-corporate.doc](cla-corporate.doc) for templates of the contributor license agreement.
+
+## License
+
+All source files must include a Copyright and License header. 
+```text
+#
+# (c) Copyright contributors to the pyCSM project
+#
+```
+
+This project is licensed under the Apache License 2.0. 
+Click here to obtain a copy of the [License](http://www.apache.org/licenses/LICENSE-2.0).  
+
+It is a permissive license whose main conditions require preservation of 
+copyright and license notices. Contributors provide an express grant of 
+patent rights. Licensed works, modifications, and larger works may be 
+distributed under different terms and without source code.  
+
+The examples are provided for tutorial purposes only. A complete handling 
+of error conditions has not been shown or attempted, and the programs have 
+not been submitted to formal IBM testing. The programs are distributed on an 
+'AS IS' basis without any warranties either expressed or implied.
+
+If you would like to see the detailed LICENSE click [here](LICENSE).

{pyCSM-1.0.7 → pycsm-1.0.8}/docs/conf.py

@@ -19,7 +19,7 @@ sys.path.insert(0, os.path.abspath('..'))
 # -- Project information -----------------------------------------------------
 
 project = 'pyCSM'
-copyright = '2022, dblea00'
+copyright = '2026, dblea00'
 author = 'dblea00'
 
 

{pyCSM-1.0.7 → pycsm-1.0.8}/pyCSM/clients/session_client.py

@@ -237,10 +237,10 @@ class sessionClient:
                                                      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 @@ class sessionClient:
                                                 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 @@ class sessionClient:
         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 @@ class sessionClient:
                                              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 @@ class sessionClient:
             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 @@ class sessionClient:
             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 @@ class sessionClient:
             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-1.0.7 → pycsm-1.0.8}/pyCSM/clients/system_client.py

@@ -510,5 +510,48 @@ class systemClient:
         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-1.0.7 → pycsm-1.0.8}/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-1.0.7 → pycsm-1.0.8}/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"])

{pyCSM-1.0.7 → pycsm-1.0.8}/pyCSM/services/session_service/schedule_service.py

@@ -193,3 +193,122 @@ def run_scheduled_task(url, tk, taskid, synchronous=False):
         "Content-Type": "application/x-www-form-urlencoded"
     }
     return requests.post(run_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"])
+
+
+def delete_task(url, tk, taskid):
+    """
+    This method is used to delete a schedualed task. 
+
+    Args:
+        url (str): Base url of csm server. ex. https://servername:port/CSM/web.
+        tk (str): Rest token for the CSM server.
+        taskid (str): ID of the schedule task to enable.
+
+    Returns:
+        JSON String representing the result of the command.
+        'I' = successful, 'W' = warning, 'E' = error.
+    """
+    delete_task_url = f"{url}/sessions/scheduledtasks/delete/{taskid}"
+
+    headers = {
+        "Accept-Language": properties["language"],
+        "X-Auth-Token": str(tk),
+        "Content-Type": "application/x-www-form-urlencoded"
+    }
+    return requests.post(delete_task_url, headers=headers, verify=properties["verify"], cert=properties["cert"])
+
+def cancel_task(url, tk, taskid):
+    """
+    Cancel a running schedualed task. 
+
+    Args:
+        url (str): Base url of csm server. ex. https://servername:port/CSM/web.
+        tk (str): Rest token for the CSM server.
+        taskid (str): ID of the schedule task to cancel.
+
+    Returns:
+        JSON String representing the result of the command.
+        'I' = successful, 'W' = warning, 'E' = error.
+    """
+    cancel_task_url = f"{url}/sessions/scheduledtasks/cancel/{taskid}"
+
+    headers = {
+        "Accept-Language": properties["language"],
+        "X-Auth-Token": str(tk),
+        "Content-Type": "application/x-www-form-urlencoded"
+    }
+    return requests.post(cancel_task_url, headers=headers, verify=properties["verify"], cert=properties["cert"])
+
+
+def run_task_now(url, tk, taskid, synchronous=False, step=0):
+    """
+    Run a scheduled task immediately at a specific step.
+
+    Args:
+        url (str): Base url of csm server. ex. https://servername:port/CSM/web.
+        tk (str): Rest token for the CSM server.
+        taskid (int/str): ID of the schedule task to run.
+        synchronous (bool): Whether to wait for the task to complete.
+        step (int): The specific step number to start from.
+
+    Returns:
+        Response object representing the result of the command.
+    """
+    
+    # Updated to match @Path("/scheduledtasks/{taskid}/{synchronous}/step/{step}")
+    run_task_now_url = f"{url}/scheduledtasks/{taskid}/{str(synchronous).lower()}/step/{step}"
+
+    headers = {
+        "Accept-Language": properties["language"],
+        "X-Auth-Token": str(tk),
+        "Content-Type": "application/json"
+    }
+    
+    return requests.post(run_task_now_url, headers=headers, verify=properties["verify"], cert=properties["cert"])

{pyCSM-1.0.7 → pycsm-1.0.8}/pyCSM/services/session_service/session_service.py

@@ -181,28 +181,6 @@ def get_available_commands(url, tk, name):
     return requests.get(getc_url, headers=headers, verify=properties["verify"], cert=properties["cert"])
 
 
-def get_session_options(url, tk, name):
-    """
-    Gets the options for the given session. The results returned
-    from this method will vary depending on the session type.
-
-    Args:
-        url (str): Base url of CSM server. ex. https://servername:port/CSM/web.
-        tk (str): Rest token for the CSM server.
-        name (str): The name of the session.
-
-    Returns:
-        JSON String representing the result of the command.
-    """
-    geto_url = f"{url}/sessions/{name}/options"
-    headers = {
-        "Accept-Language": properties["language"],
-        "X-Auth-Token": str(tk),
-        "Content-Type": "application/x-www-form-urlencoded"
-    }
-    return requests.get(geto_url, headers=headers, verify=properties["verify"], cert=properties["cert"])
-
-
 def modify_session_description(url, tk, name, desc):
     """
     Changes the description field for a given session.
@@ -273,7 +251,7 @@ def wait_for_state(url, tk, ses_name, state, minutes=5, debug=False):
         and "session_info": JSON string representing the response of the command
     """
     start_time = datetime.utcnow()
-    resp = get_session_info(url, tk, ses_name, verify=properties["verify"], cert=properties["cert"])
+    resp = get_session_info(url, tk, ses_name)
     time_passed = (datetime.utcnow() - start_time).total_seconds()
     while str(json.loads(resp.text)['state']) != state \
             and time_passed < minutes * 60:
@@ -617,3 +595,72 @@ def get_rolepair_info(url, tk, name, rolepair):
         "Content-Type": "application/x-www-form-urlencoded"
     }
     return requests.get(get_url, headers=headers, verify=properties["verify"], cert=properties["cert"])
+
+def get_session_options(url, tk, name):
+    """
+    Gets the options for the given session. The results returned from this method will vary depending on the session type.
+
+    Args:
+        url (str): Base url of CSM server. ex. https://servername:port/CSM/web.
+        tk (str): Rest token for the CSM server.
+        name (str): The name of the session.
+
+    Returns:
+        JSON String representing the result of the command.
+    """
+    get_url = f"{url}/sessions/{name}/options"
+    
+    headers = {
+        "Accept-Language": properties["language"],
+        "X-Auth-Token": str(tk),
+        "Content-Type": "application/json" 
+    }
+    
+    return requests.get(get_url, headers=headers, verify=properties["verify"], cert=properties.get("cert"))    
+
+def set_session_options(url, tk, name, options_str):
+    """
+    Sets Options for a given session.Call getOptions to get a list of the valid options for a session. The "type" field returned by getOptions is the name of the option to use in this restcall.
+
+    Args:
+        url (str): Base url of CSM server. ex. https://servername:port/CSM/web.
+        tk (str): Rest token for the CSM server.
+        name (str): The name of the session.
+        options (dict): JSON-serializable dictionary of options to set for the session.
+
+    Returns:
+        JSON String representing the result of the command.
+    
+    """
+    set_url = f"{url}/sessions/{name}/options"
+    headers = {
+        "Accept-Language": properties["language"],
+        "X-Auth-Token": str(tk),
+        "Content-Type": "application/x-www-form-urlencoded"
+    }
+
+    payload = options_str
+    if not isinstance(payload, str):
+        if isinstance(payload, dict):
+            if isinstance(payload.get("properties"), dict):
+                payload["properties"] = [payload["properties"]]
+            payload = [payload]
+        elif isinstance(payload, list):
+            fixed = []
+            for opt in payload:
+                if isinstance(opt, dict):
+                    props = opt.get("properties")
+                    if isinstance(props, dict):
+                        opt["properties"] = [props]
+                fixed.append(opt)
+            payload = fixed
+        else:
+            raise TypeError("options must be str|list|dict")
+
+        payload = json.dumps(payload)
+
+    params = {"options": payload}
+    return requests.put( set_url, headers=headers,data=params, verify=properties["verify"],cert=properties["cert"])
+
+
+