mv-pycentral 1.4.3__py3-none-any.whl

mv_pycentral-1.4.3.dist-info/METADATA

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: mv-pycentral
+Version: 1.4.3
+Summary: Aruba Central Python Package
+Home-page: https://github.com/Moviri/mv-pycentral
+Author: aruba-automation
+Author-email: dynatrace_extensions@moviri.com
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: System Administrators
+Classifier: Topic :: System :: Networking
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests==2.32.5
+Requires-Dist: PyYAML==6.0.3
+Requires-Dist: urllib3==2.6.3
+Requires-Dist: certifi==2026.1.4
+Provides-Extra: colorlog
+Requires-Dist: colorlog; extra == "colorlog"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# pycentral
+#### Aruba Central Python Package Index SDK
+
+Aruba Central is an unified cloud-based network management and configuration platform for campus, branch, remote and data center networks. There are various needs for automation and programmability like automating repetitive tasks, configuring multiple devices, monitoring and more. This python package is to programmatically interact with Aruba Central via REST APIs.
+
+### How To Install
+In order to run the workflow scripts, please complete the steps below:
+1. install virtual env (refer https://docs.python.org/3/library/venv.html). Make sure python version 3 is installed in system.
+    ```
+    $ python3 -m venv centralenv
+    ```
+
+2. Activate the virtual env
+    ```
+    $ source centralenv/bin/activate
+    in Windows:
+    $ centralenv/Scripts/activate.bat
+    ```
+
+3. Install the **pycentral** package
+    ```
+    (centralenv)$ pip3 install pycentral
+    ```
+
+    To install package with *extras* `colorLog` which will display log in color
+    ```
+    (centralenv)$ pip3 install pycentral[colorLog]
+    ```
+
+Now you can start making your script based on modules in pycentral or use different workflows from the subpackage `workflows`.
+
+## Executing Scripts
+
+1. Gathering variables required for the package base class `ArubaCentralBase`.
+
+    * **base_url** OR **cluster_name**: You can find the base URL or cluster name of the Central account's API Gateway from the table <a href="https://www.arubanetworks.com/techdocs/central/latest/content/nms/api/domain_url.htm" target="_blank">here</a>. The base URL or cluster name is based on the geographical Central cluster in which the account is registered.
+
+   * **access_token**: You can create an API access token for Aruba Central from -
+      * <a href="https://developer.arubanetworks.com/aruba-central/docs/api-gateway-obtaining-access-tokens#obtain-access-token-via-web-ui" target="_blank">Aruba Central UI</a>
+      * <a href="https://developer.arubanetworks.com/aruba-central/docs/api-oauth-access-token" target="_blank">OAuth APIs</a>
+
+    * Optional variables - You need to provide the below variables if you want to use PyCentral's ability to generate access tokens from Aruba Central with the help of OAuth APIs.
+      * **username** and **password**: Aruba Central user's *username* and *password*. The access token generated by the OAUTH APIs will have the same role/privileges as the provided Aruba Central user.
+  
+      * **client_id** and **client_secret**: Obtain client_id and client_secret variables by creating an API Gateway client in Aruba Central. Refer the following <a href="https://developer.arubanetworks.com/aruba-central/docs/api-gateway-creating-application-token" target="_blank">documentation</a> for more details.
+    
+      * **customer_id**: Obtain the **customer_id** by clicking on the figure icon on top right corner of Aruba Central WebUI.
+
+    ![Customer ID](https://github.com/aruba/pycentral/raw/master/pictures/customer-id.png)
+
+
+2. Providing input variables to the Python scripts. One of the following options can be used.
+    * Provide variables directly to Aruba Central Base class in dictionary format.
+
+        Access token approach:
+        ```python
+        central_info = {
+            "base_url": "<api-gateway-domain-url>",
+            "token": {
+                "access_token": "<api-gateway-access-token>"
+            }
+        }
+        ```
+
+        OAUTH APIs approach with capability to generate new access token:
+        ```python
+            central_info = {
+                "username": "<aruba-central-account-username>",
+                "password": "<aruba-central-account-password>",
+                "client_id": "<api-gateway-client-id>",
+                "client_secret": "<api-gateway-client-secret>",
+                "customer_id": "<aruba-central-customer-id>",
+                "base_url": "<api-gateway-domain-url>"
+            }
+        ```
+        Alternatively, you can use **cluster_name** instead of **base_url** in the above mentioned dictionaries. You can find the list of clusters that are supported in the <a href="https://github.com/aruba/pycentral/blob/master/pycentral/constants.py" target="_blank">constants.py file</a>. If you would like to add support for other Central clusters, you can do so by adding it in the constants.py. 
+        Refer the sample scripts in *step3* and *step4* for examples.
+
+    * **OR** Provide the required variables using JSON/YAML file. Refer to the sample input files to understand how the files have to be structured -
+      * <a href="https://github.com/aruba/pycentral/blob/master/sample_scripts/input_token_only.yaml" target="_blank">sample_scripts/input_token_only.yaml</a>
+      * <a href="https://github.com/aruba/pycentral/blob/master/sample_scripts/input_credentials.yaml" target="_blank">sample_scripts/input_credentials.yaml</a> 
+      * <a href="https://github.com/aruba/pycentral/blob/master/sample_scripts/sample_scripts/input_token_only_cluster.yaml" target="_blank">sample_scripts/input_token_only_cluster_name.yaml</a>
+      * <a href="https://github.com/aruba/pycentral/blob/master/sample_scripts/sample_scripts/input_credentials_cluster_name.yaml" target="_blank">sample_scripts/input_credentials_cluster_name.yaml</a>
+
+        More sample input files can be found in the <a href="https://github.com/aruba/pycentral/blob/master/sample_scripts/sample_scripts/" target="_blank">sample_scripts folder</a>. Use `pycentral.workflows_utils.get_conn_from_file()` function which accepts name of the file and returns
+        the `ArubaCentralBase` instance object.
+
+3. **Making API call using pycentral base**: Using the base class `ArubaCentralBase`, any Aruba Central supported REST API calls can be made. Refer the following sample script <a href="https://github.com/aruba/pycentral/blob/master/sample_scripts/pycentral_base_sample.py" target="_blank">sample_scripts/pycentral_base_sample.py</a>
+
+    Obtain the HTTP Request related information from Aruba Central Swagger documentation or <a href="https://developer.arubanetworks.com/aruba-central/reference" target="_blank">API references</a> page in Aruba Developer Hub.
+
+4. **Making API call using pycentral modules**: Some API endpoints supported by Aruba Central are implemented as modules in the Python package. Refer the following sample script using modules <a href="https://github.com/aruba/pycentral/blob/master/sample_scripts/pycentral_module_sample.py" target="_blank">sample_scripts/pycentral_module_sample.py</a>
+
+    To obtain a list of implemented modules and its documentation refer the <a href="https://pycentral.readthedocs.io/en/latest/" target="_blank">pycentral module documentation</a>
+
+5. **Workflows**: Workflows are used to achieve an automation use-case which generally involves multiple API calls or dealing with scale and repetitive tasks with ease. Check out the <a href="https://github.com/aruba/central-python-workflows" target="_blank"> central-python-workflows </a> repository to check out workflows that utilize the Pycentral library.
+
+## Documentation:
+* **Python package documentation:** 
+* <a href="https://pycentral.readthedocs.io/en/latest/" target="_blank">pycentral module documentation</a>
+* **Use-Cases and Workflows:**
+  - <a href="https://developer.arubanetworks.com/aruba-central/docs/python-getting-started" target="_blank">Aruba Developer Hub</a>
+  - <a href="https://github.com/aruba/central-python-workflows" target="_blank">central-python-workflows</a>
+
+## Note:
+ The package takes one of the two approaches to gain access to Aruba Central APIs.
+
+  * **OAUTH APIs:** By taking OAUTH approach to generate new access_token, the python package will cache the tokens locally for re-use. Caching tokens locally, helps preventing creation of new access_token every time the script is run. In addition, when the access_token is expired the script will attempt to use the supplied credentials and attempt to refresh the expired token.
+
+    Override the `ArubaCentralBase.storeToken()` and `ArubaCentralBase.loadToken()` function definitions to change this behavior of caching in local file(JSON) and manage tokens more securely.
+
+ * **Access Token**: This process is more secure. By providing only the *access_token* instead of credentials, the package will not cache the tokens. But loses the ability to handle expired token and to generate new access tokens.
+
+## How to contribute
+Please see the accompanying <a href="https://github.com/aruba/pycentral/blob/master/CONTRIBUTIONS.md" target="_blank">CONTRIBUTIONS.md</a> file for guidelines on how to contribute to this repository.
+
+## Troubleshooting Issues
+If you encounter module import errors, make sure that the package has been installed correctly.
+
+Additionally, please read the <a href="https://github.com/aruba/pycentral/blob/master/RELEASE-NOTES.md" target="_blank">RELEASE-NOTES.md</a> file for the current release information and known issues.

mv_pycentral-1.4.3.dist-info/RECORD

@@ -0,0 +1,24 @@
+mv_pycentral-1.4.3.dist-info/licenses/LICENSE,sha256=Vc02m3OWcayZ8L-vkBhCWxFQVXpC-pvghgXdo1Sld2Q,1100
+pycentral/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pycentral/audit_logs.py,sha256=Y8jifJBuqo6xM6kajMWjH5gIJdOFyb9MT4SFnMPXTDg,8170
+pycentral/base.py,sha256=4jxXITEqLeExwiovpswSbaRgXBBORo-gxVHryNcz8FA,27768
+pycentral/base_utils.py,sha256=cBKjSp9xc4_bIrAYSUpcjlCxvJbbuiuhdEKZ0RaYnjU,9372
+pycentral/configuration.py,sha256=O1ChMXHrfirGBnMA0tcwvk8Ehoz8oYkThJdaI26_KzU,54622
+pycentral/constants.py,sha256=dirF47_FN6IZJtRkiLq4z8HBn0dWn3SSOylRvB_VUGE,2165
+pycentral/device_inventory.py,sha256=ZZqM0l3X_Cws9GMGVjQEvfT8S086JOBzLKgYq086Nf8,11268
+pycentral/firmware_management.py,sha256=6s0JzYz_k-GxazRVydf_UKrjMtbGq1kPIiLXwiytFYM,12354
+pycentral/licensing.py,sha256=muWRQ4FKOGOBwAuyp0hBBIkm4BfwrL7CyJv43p6RSBk,21314
+pycentral/monitoring.py,sha256=XySHMOvgvXT_-fH6sS7s3JZqTc2CIRpBmUZVwlygdP8,12946
+pycentral/msp.py,sha256=JSn5B5PSisjLe-aRDnG-EVU0sVHpm-JCQdtwX2P1_VA,38361
+pycentral/rapids.py,sha256=rUCZMfXaAgLYfxI-je8_RQ-IWVGvsKzq2AUGGRM2HIw,23062
+pycentral/refresh_api_token.py,sha256=7Djr2WKyaz2BhZXi885PnAf8x-91FZYRCZSqXMsKr3Q,2815
+pycentral/topology.py,sha256=gb7uy_qaUyEzvL1sfDlPpE-tGb5hHH3tdwDKCqiYfSY,5986
+pycentral/url_utils.py,sha256=DhESmMxmb_1_r91_hBHSsaAlmpsE_-ox4eHDhJKjbjY,8729
+pycentral/user_management.py,sha256=WTbFTpriNCHcet97hqGpNB1UBs5lNDAGZQ2ha0hMi5c,17963
+pycentral/visualrf.py,sha256=1rYS9AGyAptYXOde1v2neU3nNo3wZTnSPxKSYCmURUg,14313
+pycentral/workflows/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pycentral/workflows/workflows_utils.py,sha256=a5_rznJR2D0YmZDVDNi4tqST1hAU_tBHiaNiOdbMzp0,6060
+mv_pycentral-1.4.3.dist-info/METADATA,sha256=xERkp5FM3kcGJ9-8RKyJN5u8yKz_ynsYJzWVnqRfpV0,9973
+mv_pycentral-1.4.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+mv_pycentral-1.4.3.dist-info/top_level.txt,sha256=rZLDkAQ0eJxDByJpX0JZMeeSDpniOf5Ih9C995YfcZc,10
+mv_pycentral-1.4.3.dist-info/RECORD,,

mv_pycentral-1.4.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mv_pycentral-1.4.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mv_pycentral-1.4.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+pycentral

pycentral/audit_logs.py

@@ -0,0 +1,182 @@
+# MIT License
+#
+# Copyright (c) 2020 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pycentral.url_utils import AuditUrl, urlJoin
+from pycentral.base_utils import console_logger
+
+urls = AuditUrl()
+
+
+class Audit:
+    """Get the audit logs and event logs with the functions in this class."""
+
+    def get_traillogs(self, conn, limit=100, offset=0, username=None,
+                      start_time=None, end_time=None, description=None,
+                      target=None, classification=None, customer_name=None,
+                      ip_address=None, app_id=None):
+        """Get audit logs, sort by time in in reverse chronological order.
+        This API returns the first 10,000 results only. Please use filter
+        in the API for more relevant results. MSP Customer Would see logs
+        of MSP's and tenants as well.
+
+        :param conn: Instance of class:`pycentral.ArubaCentralBase` to make an\
+            API call.
+        :type conn: class:`pycentral.ArubaCentralBase`
+        :param limit: Maximum number of audit events to be returned, defaults\
+            to 100
+        :type limit: int, optional
+        :param offset: Number of items to be skipped before returning the \
+            data, useful for pagination, defaults to 0
+        :type offset: int, optional
+        :param username: Filter audit logs by User Name, defaults to None
+        :type username: str, optional
+        :param start_time: Filter audit logs by Time Range. Start time of the\
+            audit logs should be provided in epoch seconds, defaults to None
+        :type start_time: int, optional
+        :param end_time: Filter audit logs by Time Range. End time of the \
+            audit logs should be provided in epoch seconds, defaults to None
+        :type end_time: int, optional
+        :param description: Filter audit logs by Description, defaults to \
+            None
+        :type description: str, optional
+        :param target: Filter audit logs by target, defaults to None
+        :type target: str, optional
+        :param classification: Filter audit logs by Classification, defaults \
+            to None
+        :type classification: str, optional
+        :param customer_name: Filter audit logs by Customer NameFilter audit \
+            logs by Customer Name, defaults to None
+        :type customer_name: str, optional
+        :param ip_address: Filter audit logs by IP Address, defaults to None
+        :type ip_address: str, optional
+        :param app_id: Filter audit logs by app_id, defaults to None
+        :type app_id: str, optional
+        :return: HTTP Response as provided by 'command' function in \
+            class:`pycentral.ArubaCentralBase`
+        :rtype: dict
+        """
+        path = urls.TRAIL_LOG["GET_ALL"]
+        params = {"limit": limit, "offset": offset}
+        if username:
+            params["username"] = username
+        if start_time:
+            params["start_time"] = start_time
+        if end_time:
+            params["end_time"] = end_time
+        if description:
+            params["description"] = description
+        if target:
+            params["target"] = target
+        if classification:
+            params["classification"] = classification
+        if customer_name:
+            params["customer_name"] = customer_name
+        if ip_address:
+            params["ip_address"] = ip_address
+        if app_id:
+            params["app_id"] = app_id
+        resp = conn.command(apiMethod="GET", apiPath=path, apiParams=params)
+        return resp
+
+    def get_traillogs_detail(self, conn, id):
+        """Get details of an audit log
+
+        :param conn: Instance of class:`pycentral.ArubaCentralBase` to make an\
+            API call.
+        :type conn: class:`pycentral.ArubaCentralBase`
+        :param id: ID of audit event
+        :type id: str
+        :return: HTTP Response as provided by 'command' function in \
+            class:`pycentral.ArubaCentralBase`
+        :rtype: dict
+        """
+        path = urlJoin(urls.TRAIL_LOG["GET"], id)
+        resp = conn.command(apiMethod="GET", apiPath=path)
+        return resp
+
+    def get_eventlogs(self, conn, limit=100, offset=0, group_name=None,
+                      device_id=None, classification=None, start_time=None,
+                      end_time=None):
+        """Get audit events for all groups, sort by time in in reverse\
+            chronological order.This API returns the first 10,000 results\
+            only. Please use filter in the API for more relevant results.
+
+        :param conn: Instance of class:`pycentral.ArubaCentralBase` to make an\
+            API call.
+        :type conn: class:`pycentral.ArubaCentralBase`
+        :param limit: Maximum number of audit events to be returned, defaults\
+            to 100
+        :type limit: int, optional
+        :param offset: Number of items to be skipped before returning the\
+            data, useful for pagination, defaults to 0
+        :type offset: int, optional
+        :param group_name: Filter audit events by Group Name, defaults to None
+        :type group_name: str, optional
+        :param device_id: Filter audit events by Target / Device ID. Device ID\
+            for AP is VC Name and Serial Number
+            for Switches, defaults to None
+        :type device_id: str, optional
+        :param classification: Filter audit events by classification, defaults\
+            to None
+        :type classification: str, optional
+        :param start_time: Filter audit logs by Time Range. Start time of the\
+            audit logs should be provided
+            in epoch seconds, defaults to None
+        :type start_time: int, optional
+        :param end_time: Filter audit logs by Time Range. End time of the\
+            audit logs should be provided in epoch
+            seconds, defaults to None
+        :type end_time: int, optional
+        :return: HTTP Response as provided by 'command' function in\
+            class:`pycentral.ArubaCentralBase`
+        :rtype: dict
+        """
+        path = urls.EVENT_LOG["GET_ALL"]
+        params = {"limit": limit, "offset": offset}
+        if group_name:
+            params["group_name"] = group_name
+        if device_id:
+            params["device_id"] = device_id
+        if classification:
+            params["classification"] = classification
+        if start_time:
+            params["start_time"] = start_time
+        if end_time:
+            params["end_time"] = end_time
+        resp = conn.command(apiMethod="GET", apiPath=path, apiParams=params)
+        return resp
+
+    def get_eventlogs_detail(self, conn, id):
+        """Get details of an audit event/log
+
+        :param conn: Instance of class:`pycentral.ArubaCentralBase` to make an\
+            API call.
+        :type conn: class:`pycentral.ArubaCentralBase`
+        :param id: ID of audit event
+        :type id: str
+        :return: HTTP Response as provided by 'command' function in\
+            class:`pycentral.ArubaCentralBase`
+        :rtype: dict
+        """
+        path = urlJoin(urls.EVENT_LOG["GET"], id)
+        resp = conn.command(apiMethod="GET", apiPath=path)
+        return resp