catalystwan 0.40.2.dev10__tar.gz → 0.41.0.dev0__tar.gz

{catalystwan-0.40.2.dev10 → catalystwan-0.41.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: catalystwan
-Version: 0.40.2.dev10
+Version: 0.41.0.dev0
 Summary: Cisco Catalyst WAN SDK for Python
 Author: kagorski
 Author-email: kagorski@cisco.com
@@ -509,6 +509,99 @@ session.api.templates.create(omp_vsmart)
 More details about how to use and how to add new: [Feature Templates README.md](https://github.com/cisco-open/cisco-catalyst-wan-sdk/blob/main/catalystwan/api/templates/README.md)
 </details>
 
+<details>
+    <summary> <b>Export Templates to CSV</b> <i>(click to expand)</i></summary>
+
+```python
+import os
+import json
+import logging
+import csv
+from typing import List
+from catalystwan.api.template_api import TemplatesAPI
+from catalystwan.session import create_manager_session
+from catalystwan.api.templates.device_template.device_template import DeviceTemplate
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+# Define vManage connection details
+url = "localhost"
+username = "username"
+password = "password"
+port = 443
+
+
+def save_csv_template(response: dict, template_name: str) -> None:
+    """Save the response data to a CSV file."""
+    try:
+        columns = [col["property"] for col in response.get("header", {}).get("columns", [])]
+        data = response.get("data", [])
+        if not columns or not data:
+            logging.warning(f"No data found for template '{template_name}'. Skipping CSV creation.")
+
+        csv_file = f"{template_name}.csv"
+        with open(csv_file, mode="w", newline="") as file:
+            writer = csv.DictWriter(file, fieldnames=columns)
+            writer.writeheader()
+            for row in data:
+                writer.writerow(row)
+        logging.info(f"CSV file '{csv_file}' has been created.")
+    except Exception as e:
+        logging.error(f"Failed to save CSV for template '{template_name}': {e}")
+
+
+def get_non_default_device_templates(session) -> List[DeviceTemplate]:
+    """Retrieve all non-default device templates."""
+    try:
+        device_templates = session.api.templates.get(DeviceTemplate).filter(factory_default=False)
+        logging.info(f"Retrieved {len(device_templates)} non-default device templates.")
+        return device_templates
+    except Exception as e:
+        logging.error(f"Failed to retrieve device templates: {e}")
+        return []
+
+
+def get_device_ids_attached(session, template: DeviceTemplate) -> bool:
+    """Retrieve device IDs attached to a template and save the configuration as a CSV."""
+    try:
+        # Fetch attached devices
+        response = session.get(f"dataservice/template/device/config/attached/{template.id}").json()
+        device_ids = [device["uuid"] for device in response.get("data", []) if device.get("uuid")]
+        # Prepare payload
+        payload = {
+            "deviceIds": device_ids,
+            "templateId": template.id,
+            "isEdited": False,
+            "isMasterEdited": False,
+        }
+
+        # Send POST request
+        response = session.post("dataservice/template/device/config/input/", json=payload)
+        response.raise_for_status()  # Raise an exception for HTTP errors
+
+        # Save the response as a CSV
+        save_csv_template(response.json(), template.name)
+        return True
+    except Exception as e:
+        logging.error(f"Error occurred while processing template '{template.name}': {e}")
+        return False
+
+
+def main():
+    """Main function to retrieve and process device templates."""
+    with create_manager_session(url=url, username=username, password=password, port=port) as session:
+        device_templates = get_non_default_device_templates(session)
+        for template in device_templates:
+            get_device_ids_attached(session, template)
+
+
+if __name__ == "__main__":
+    main()
+```
+The script will generate CSV files for each non-default device template in the current directory.
+</details>
+
 ### Note:
 To remove `InsecureRequestWarning`, you can include in your scripts (warning is suppressed when `catalystwan_devel` environment variable is set):
 ```Python

{catalystwan-0.40.2.dev10 → catalystwan-0.41.0.dev0}/README.md

@@ -480,6 +480,99 @@ session.api.templates.create(omp_vsmart)
 More details about how to use and how to add new: [Feature Templates README.md](https://github.com/cisco-open/cisco-catalyst-wan-sdk/blob/main/catalystwan/api/templates/README.md)
 </details>
 
+<details>
+    <summary> <b>Export Templates to CSV</b> <i>(click to expand)</i></summary>
+
+```python
+import os
+import json
+import logging
+import csv
+from typing import List
+from catalystwan.api.template_api import TemplatesAPI
+from catalystwan.session import create_manager_session
+from catalystwan.api.templates.device_template.device_template import DeviceTemplate
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+# Define vManage connection details
+url = "localhost"
+username = "username"
+password = "password"
+port = 443
+
+
+def save_csv_template(response: dict, template_name: str) -> None:
+    """Save the response data to a CSV file."""
+    try:
+        columns = [col["property"] for col in response.get("header", {}).get("columns", [])]
+        data = response.get("data", [])
+        if not columns or not data:
+            logging.warning(f"No data found for template '{template_name}'. Skipping CSV creation.")
+
+        csv_file = f"{template_name}.csv"
+        with open(csv_file, mode="w", newline="") as file:
+            writer = csv.DictWriter(file, fieldnames=columns)
+            writer.writeheader()
+            for row in data:
+                writer.writerow(row)
+        logging.info(f"CSV file '{csv_file}' has been created.")
+    except Exception as e:
+        logging.error(f"Failed to save CSV for template '{template_name}': {e}")
+
+
+def get_non_default_device_templates(session) -> List[DeviceTemplate]:
+    """Retrieve all non-default device templates."""
+    try:
+        device_templates = session.api.templates.get(DeviceTemplate).filter(factory_default=False)
+        logging.info(f"Retrieved {len(device_templates)} non-default device templates.")
+        return device_templates
+    except Exception as e:
+        logging.error(f"Failed to retrieve device templates: {e}")
+        return []
+
+
+def get_device_ids_attached(session, template: DeviceTemplate) -> bool:
+    """Retrieve device IDs attached to a template and save the configuration as a CSV."""
+    try:
+        # Fetch attached devices
+        response = session.get(f"dataservice/template/device/config/attached/{template.id}").json()
+        device_ids = [device["uuid"] for device in response.get("data", []) if device.get("uuid")]
+        # Prepare payload
+        payload = {
+            "deviceIds": device_ids,
+            "templateId": template.id,
+            "isEdited": False,
+            "isMasterEdited": False,
+        }
+
+        # Send POST request
+        response = session.post("dataservice/template/device/config/input/", json=payload)
+        response.raise_for_status()  # Raise an exception for HTTP errors
+
+        # Save the response as a CSV
+        save_csv_template(response.json(), template.name)
+        return True
+    except Exception as e:
+        logging.error(f"Error occurred while processing template '{template.name}': {e}")
+        return False
+
+
+def main():
+    """Main function to retrieve and process device templates."""
+    with create_manager_session(url=url, username=username, password=password, port=port) as session:
+        device_templates = get_non_default_device_templates(session)
+        for template in device_templates:
+            get_device_ids_attached(session, template)
+
+
+if __name__ == "__main__":
+    main()
+```
+The script will generate CSV files for each non-default device template in the current directory.
+</details>
+
 ### Note:
 To remove `InsecureRequestWarning`, you can include in your scripts (warning is suppressed when `catalystwan_devel` environment variable is set):
 ```Python

{catalystwan-0.40.2.dev10 → catalystwan-0.41.0.dev0}/catalystwan/apigw_auth.py

@@ -37,6 +37,7 @@ class ApiGwAuth(AuthBase, AuthProtocol):
     def __init__(self, login: ApiGwLogin, logger: Optional[logging.Logger] = None, verify: bool = False):
         self.login = login
         self.token = ""
+        self.org_registered: bool = False
         self.logger = logger or logging.getLogger(__name__)
         self.verify = verify
         self.session_count: int = 0
@@ -53,14 +54,25 @@ class ApiGwAuth(AuthBase, AuthProtocol):
         return request
 
     def handle_auth(self, request: PreparedRequest) -> None:
+        if not self.org_registered:
+            self.register(request)
         if self.token == "":
             self.authenticate(request)
 
     def authenticate(self, request: PreparedRequest):
+        base_url = self.get_base_url(request)
+        self.token = self.get_token(base_url, self.login, self.logger, self.verify, self.request_timeout)
+
+    def register(self, request: PreparedRequest):
+        base_url = self.get_base_url(request)
+        self.register_org(base_url, self.login, self.logger, self.verify, self.request_timeout)
+        self.org_registered = True
+
+    def get_base_url(self, request: PreparedRequest):
         assert request.url is not None
         url = urlparse(request.url)
         base_url = f"{url.scheme}://{url.netloc}"  # noqa: E231
-        self.token = self.get_token(base_url, self.login, self.logger, self.verify, self.request_timeout)
+        return base_url
 
     def build_digest_header(self, request: PreparedRequest) -> None:
         header = {
@@ -101,6 +113,35 @@ class ApiGwAuth(AuthBase, AuthProtocol):
                 raise CatalystwanException("Failed to get bearer token")
         return token
 
+    @staticmethod
+    def register_org(
+        base_url: str,
+        apigw_login: ApiGwLogin,
+        logger: Optional[logging.Logger] = None,
+        verify: bool = False,
+        timeout: int = 10,
+    ) -> None:
+        try:
+            payload = apigw_login.model_dump(include={"client_id", "client_secret", "org_name"})
+            response = post(
+                url=f"{base_url}/apigw/organization/registration",
+                json=payload,
+                verify=verify,
+                timeout=timeout,
+            )
+            if logger is not None:
+                logger.debug(auth_response_debug(response))
+
+            response.raise_for_status()
+
+        except HTTPError as ex:
+            raise CatalystwanException(
+                f"Problem with connecting to API GW organization registration endpoint, ({ex}).\
+                  Response: ({response.text})"
+            )
+        except Exception as ex:
+            raise CatalystwanException(f"Org registration to API-GW failed: {ex}")
+
     def logout(self, client: APIEndpointClient) -> None:
         return None
 

{catalystwan-0.40.2.dev10 → catalystwan-0.41.0.dev0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "catalystwan"
-version = "0.40.2dev10"
+version = "0.41.0.dev0"
 description = "Cisco Catalyst WAN SDK for Python"
 authors = ["kagorski <kagorski@cisco.com>"]
 readme = "README.md"