Update to Version 1.0.8

## Version 1.0.8 (13/10/2025)
1. Updated common.py to include an optioal timeout parameter for web requests within the ClearPassAPILogin class. 
2. API code includes new, modified or deleted API that is implemented in Aruba ClearPass v6.12.6.
3. Updated Readme
4. Included new function within new Utils class to pull token from token file.
5. Updated __init__.py file

Author: jazzyj123

CONTRIBUTING.md

@@ -171,4 +171,4 @@ accepted.
 
 [airheads-link]: https://community.arubanetworks.com/t5/Developer-Community/bd-p/DeveloperCommunity
 [devhub-link]: https://developer.arubanetworks.com/aruba-cppm/docs
-[email-link]: mailto:aruba-automation@hpe.com
+[email-link]: mailto:aruba-automation@hpe.com

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Aruba, a Hewlett Packard Enterprise company
+Copyright (c) 2025 Aruba, a Hewlett Packard Enterprise company
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

PKG-INFO.txt

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyclearpass
-Version: 1.0.7
+Version: 1.0.8
 Summary: This package contains all of the API functions to work with the HPE Aruba Networking ClearPass API. This package been built based on version v6.12 but is always generated on the latest version available to download.  
 Project-URL: Homepage, https://github.com/aruba/pyclearpass
 Author-email: Aruba Automation <aruba-automation@hpe.com>

README.md

@@ -69,7 +69,7 @@ from pyclearpass import *
 ```
 
 Create a object to login into ClearPass. The login object needs to be passed to use any function within the ClearPass API.  
-Two examples below shows how to create the login object (either one can be used, but not both).
+Three examples below shows how to create the login object (either one can be used, but not both).
 
 1. Using client credentials
 
@@ -88,6 +88,17 @@ clientsecret="myclientsecretexample", clientid="myclientidexample", verify_ssl=F
 login = ClearPassAPILogin(server="https://yourserver.network.local:443/api",api_token="yoursecretapitoken", verify_ssl=False)
 ```
 
+3. Using the api token located in a file. You can generate an API token by clicking on the API client and then clicking 'Generate Access Token'. The Token file is expected in the following format and is expected to exist in the script execution folder. This is the preferred method to avoid having your credentials directly exposed in your script file. 
+
+```json 
+{"access_token":"your_token_here"}
+```
+The python file is expected in the following format
+```python
+token = Utils.get_token_from_file("token.json")
+login = ClearPassAPILogin(server="https://yourserver.network.local:443/api",api_token=token, verify_ssl=False)
+```
+
 Find an API you want to use, by prefixing  `Api`  in your IDE and Intellisense will show the available APIs available. Each of the top level API category names are available as a module. Once you have chosen a specific API module to use, for example ApiPolicyElements, it will show you the available methods if you suffix a . to the command - `ApiPolicyElements.`
 
 The example below prints a single the roles available within the ClearPass server.
@@ -133,9 +144,10 @@ or
 
 The examples below all exclude importing the module and creating the login variable. This is described directly below. Note, these are just a full examples, there are hundreds of API commands available within the SDK.
 
-## New Login Session (Mandatory)
+## Login
+### Mandatory Login Session Parameters
 
-The login variable only needs to be defined once in the script. Two examples are shown below to achieve this;
+The login variable only needs to be defined once in the script. Three examples are shown below to achieve this;
 
 1. Using client_credentials
 
@@ -156,6 +168,25 @@ from pyclearpass import *
 login = ClearPassAPILogin(server="https://yourserver.network.local:443/api",api_token="yoursecretapitoken", verify_ssl=False)
 ```
 
+3. Using the api token located in a file. You can generate an API token by clicking on the API client and then clicking 'Generate Access Token'. The Token file is expected in the following format and is expected to exist in the script execution folder. This is the preferred method to avoid having your credentials directly exposed in your script file. 
+
+```json 
+{"access_token":"your_token_here"}
+```
+The python file is expected in the following format
+```python
+token = Utils.get_token_from_file("token.json")
+login = ClearPassAPILogin(server="https://yourserver.network.local:443/api",api_token=token, verify_ssl=False)
+```
+### Optional Login Session Parameters
+ 
+You can also include a timeout on the within the ClearPassAPILogin class to define how long the web request should try before timing out.  An example is provided below of 10 seconds
+
+```python
+token = Utils.get_token_from_file("token.json")
+login = ClearPassAPILogin(server="https://yourserver.network.local:443/api",api_token=token, verify_ssl=False,timeout=10)
+```
+
 ## Get Local Server Configuration
 
 ```python
@@ -345,90 +376,3 @@ print(json.dumps(view_guest_device,indent=2))
 ```python
 print(ApiPolicyElements.delete_enforcement_policy_by_enforcement_policy_id(login,enforcement_policy_id='3058'))
 ```
-
-## Create a new Enforcement Policy with staged initial rules and then a loop to create additional rules.
-
-```python
-newEnforcementPolicy= {
-  "name": "MPSK Demo",
-  "description": "MPSK Enforcement",
-  "enforcement_type": "RADIUS",
-  "default_enforcement_profile": "Deny Device",
-  "rule_eval_algo": "first-applicable",
-  "rules": ''}
-
-newEnforcementPolicyRules =({"rules":[]})
-
-initialrule = {
-            "enforcement_profile_names": [
-                "Sample Enforcement Policy"
-            ],
-            "condition": [
-                {
-                    "type": "Connection",
-                    "name": "AP-Name",
-                    "oper": "BEGINS_WITH",
-                    "value": "APDemo"
-                }
-            ]
-        }
-newEnforcementPolicyRules["rules"].append(initialrule)
-
-for id in range(9,11):
-    randompsk = random.randint(8000000,9000000)
-    epf ={
-            "enforcement_profile_names": [
-                "Sample Enforcement Policy"
-
-            ],
-            "condition": [
-                {
-                    "type": "Connection",
-                    "name": "AP-Name",
-                    "oper": "BEGINS_WITH",
-                    "value": "APNo"+str(id)
-                }
-            ]
-        }
-    
-    newEnforcementPolicyRules["rules"].append(epf) 
- 
-newEnforcementPolicy["rules"] = newEnforcementPolicyRules["rules"]
-print(ApiPolicyElements.new_enforcement_policy(login,body=newEnforcementPolicy))
-```
-
-> 📘 
-> 
-> You may find it easier to initially pull a working Enforcement Policy with minimal rules before trying to create a new one from scratch. 
-> 
-> For example, the rule evaluation in the GUI shows as 'First applicable', however in the back-end it is shown as 'first-applicable'. This example is a working policy. It is demonstrated with a loop which could read an entry in a CSV file if adapted.
-
-## Update an existing Enforcement Policy, retaining the original items and using a loop to add additional items
-
-```python
-epol = ApiPolicyElements.get_enforcement_policy_name_by_name(login, name="MPSK Enforcement")
-OriginalRules = epol["rules"]
-CombinedRules =({"rules":[]})
-for item in range(len(OriginalRules)):
-    CombinedRules["rules"].append(OriginalRules[item])
-
-for no in range(9,11):
-    rule ={
-            "enforcement_profile_names": [
-                "Sample Enforcement Policy"
-
-            ],
-            "condition": [
-                {
-                    "type": "Connection",
-                    "name": "AP-Name",
-                    "oper": "BEGINS_WITH",
-                    "value": "APNo"+str(no)
-                }
-            ]
-        }
-    
-    CombinedRules["rules"].append(rule)  
-
-ApiPolicyElements.update_enforcement_policy_name_by_name(login,name="MPSK Enforcement",body=CombinedRules)
-```

RELEASE-NOTES.md

@@ -40,4 +40,10 @@ This document contains high level documented changes to the pyclearpass package.
 2. Added response content-type to methods in other api files where required. 
 
 ## Version 1.0.7 (08/11/2024)
-1. Updated common.py to convert dict to json when creating parameterised urls within the _generate_parameterised_url method. 
+1. Updated common.py to convert dict to json when creating parameterised urls within the _generate_parameterised_url method. 
+
+## Version 1.0.8 (13/10/2025)
+1. Updated common.py to include an optioal timeout parameter for web requests within the ClearPassAPILogin class. 
+2. API code includes new, modified or deleted API that is implemented in Aruba ClearPass v6.12.6.
+3. Updated Readme
+4. Included new function within new Utils class to pull token from token file.

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 [project]
 name = "pyclearpass"
-version = "1.0.7"
+version = "1.0.8"
 authors = [{ name="Aruba Automation", email="aruba-automation@hpe.com" }]
 dependencies = ["requests >=2.24","urllib3 >=1.25.10"]
 description = "HPE Aruba Networking ClearPass SDK has been developed in Python v3.9 to utilise the full functionality of the HPE Aruba Networking ClearPass REST API environment. Each available REST API command is available for use in this module."

setup.py

@@ -8,7 +8,7 @@
     author_email='aruba-automation@hpe.com',
     packages=['pyclearpass'],
     install_requires=['requests >=2.24','urllib3 >=1.25.10'],
-    version='1.0.7',
+    version='1.0.8',
     license='MIT',
     description='HPE Aruba Networking ClearPass SDK has been developed in Python v3.9 to utilise the full functionality of the HPE Aruba Networking ClearPass REST API environment. Each available REST API command is available for use in this package.',
     long_description=open('README.md').read(),