==================
catalystcentersdk
==================
*Work with the CatalystCenter APIs in native Python!*
-------------------------------------------------------------------------------
**catalystcentersdk** is a *community developed* Python library for working with the CatalystCenter APIs. Our goal is to make working with CatalystCenter in Python a *native* and *natural* experience!
.. code-block:: python
from catalystcentersdk import api
# Create a CatalystCenterAPI connection object;
# it uses CatalystCenter sandbox URL, username and password, with CatalystCenter API version 2.3.5.3.
# and requests to verify the server's TLS certificate with verify=True.
catalyst = api.CatalystCenterAPI(username="devnetuser",
password="Cisco123!",
base_url="https://sandboxdnac.cisco.com:443",
version='2.3.7.9',
verify=True)
# Find all devices that have 'Switches and Hubs' in their family
devices = catalyst.devices.get_device_list(family='Switches and Hubs')
# Print all of demo devices
for device in devices.response:
print('{:20s}{}'.format(device.hostname, device.upTime))
# Find all tags
all_tags = catalyst.tag.get_tag(sort_by='name', order='des')
demo_tags = [tag for tag in all_tags.response if 'Demo' in tag.name ]
# Delete all of the demo tags
for tag in demo_tags:
catalyst.tag.delete_tag(tag.id)
# Create a new demo tag
demo_tag = catalyst.tag.create_tag(name='catalyst Demo')
task_demo_tag = catalyst.task.get_task_by_id(task_id=demo_tag.response.taskId)
if not task_demo_tag.response.isError:
# Retrieve created tag
created_tag = catalyst.tag.get_tag(name='catalyst Demo')
# Update tag
update_tag = catalyst.tag.update_tag(id=created_tag.response[0].id,
name='Updated ' + created_tag.response[0].name,
description='Catalyst demo tag')
print(catalyst.task.get_task_by_id(task_id=update_tag.response.taskId).response.progress)
# Retrieved updated
updated_tag = catalyst.tag.get_tag(name='Updated catalyst Demo')
print(updated_tag)
else:
# Get task error details
print('Unfortunately ', task_demo_tag.response.progress)
print('Reason: ', task_demo_tag.response.failureReason)
# Advance usage example using Custom Caller functions
# Define the get_global_credentials and create_netconf_credentials functions
# under the custom_caller wrapper.
# Call them with:
# catalyst.custom_caller.get_global_credentials('NETCONF')
# catalyst.custom_caller.create_netconf_credentials('65533')
def setup_custom():
catalyst.custom_caller.add_api('get_global_credentials',
lambda credential_type:
catalyst.custom_caller.call_api(
'GET',
'/dna/intent/api/v1/global-credential',
params={
'credentialSubType': credential_type
}).response
)
catalyst.custom_caller.add_api('create_netconf_credentials',
lambda port:
catalyst.custom_caller.call_api(
'POST',
'/dna/intent/api/v1/global-credential/netconf',
json=[{
"netconfPort": port
}])
)
# Add the custom API calls to the connection object under the custom_caller wrapper
setup_custom()
# Call the newly added functions
catalyst.custom_caller.create_netconf_credentials('65533')
print(catalyst.custom_caller.get_global_credentials('NETCONF'))
Introduction
------------
Check out the complete Introduction_
**catalystcentersdk handles all of this for you:**
+ Reads your CatalystCenter credentials from environment variables.
+ Reads your CatalystCenter API version from environment variable CATALYST_CENTER_VERSION.
+ Controls whether to verify the server's TLS certificate or not according to the verify parameter.
+ Reads your CatalystCenter debug from environment variable CATALYST_CENTER_DEBUG. Boolean.
+ Wraps and represents all CatalystCenter API calls as a simple hierarchical tree of
native-Python methods
+ If your Python IDE supports **auto-completion** (like `PyCharm_`), you can
navigate the available methods and object attributes right within your IDE
+ Represents all returned JSON objects as native Python objects - you can
access all of the object's attributes using native *dot.syntax*
+ **Automatic Rate-Limit Handling** Sending a lot of requests to CatalystCenter?
Don't worry; we have you covered. CatalystCenter will respond with a rate-limit
response, which will automatically be caught and "handled" for you.
+ **Refresh token** Each time the token becomes invalid, the SDK will generate a new valid token for you.
Installation
------------
Installing and upgrading catalystcentersdk is easy:
**Install via PIP**
.. code-block:: bash
$ pip install catalystcentersdk
**Upgrading to the latest Version**
.. code-block:: bash
$ pip install catalystcentersdk --upgrade
Compatibility matrix
--------------------
The following table shows the supported versions.
.. list-table::
:widths: 50 50
:header-rows: 1
* - Cisco CatalystCenter version
- Python "catalystcentersdk" version
* - 2.3.7.6
- 2.3.7.6.x
* - 2.3.7.7
- 2.3.7.9.4
* - 2.3.7.9
- 2.3.7.9.x
If your SDK is older please consider updating it first.
Documentation
-------------
**Excellent documentation is now available at:**
https://catalystcentersdk.readthedocs.io
Check out the Quickstart_ to dive in and begin using catalystcentersdk.
Release Notes
-------------
Please see the releases_ page for release notes on the incremental functionality and bug fixes incorporated into the published releases.
Questions, Support & Discussion
-------------------------------
catalystcentersdk is a *community developed* and *community supported* project. If you experience any issues using this package, please report them using the issues_ page.
Contribution
------------
catalystcentersdk_ is a community development projects. Feedback, thoughts, ideas, and code contributions are welcome! Please see the `Contributing`_ guide for more information.
Inspiration
------------
This library is inspired by the webexteamssdk_ library
Changelog
---------
All notable changes to this project will be documented in the CHANGELOG_ file.
The development team may make additional name changes as the library evolves with the Cisco CatalystCenter APIs.
*Copyright (c) 2024 Cisco Systems.*
.. _Introduction: https://catalystcentersdk.readthedocs.io/en/latest/api/intro.html
.. _catalystcentersdk.readthedocs.io: https://catalystcentersdk.readthedocs.io
.. _Quickstart: https://catalystcentersdk.readthedocs.io/en/latest/api/quickstart.html
.. _catalystcentersdk: https://github.com/cisco-en-programmability/catalystcentersdk
.. _issues: https://github.com/cisco-en-programmability/catalystcentersdk/issues
.. _pull requests: https://github.com/cisco-en-programmability/catalystcentersdk/pulls
.. _releases: https://github.com/cisco-en-programmability/catalystcentersdk/releases
.. _the repository: catalystcentersdk_
.. _pull request: `pull requests`_
.. _Contributing: https://github.com/cisco-en-programmability/catalystcentersdk/blob/master/docs/contributing.rst
.. _webexteamssdk: https://github.com/CiscoDevNet/webexteamssdk
.. _CHANGELOG: https://github.com/cisco-en-programmability/catalystcentersdk/blob/main/CHANGELOG.md
Raw data
{
"_id": null,
"home_page": "https://catalystcentersdk.readthedocs.io/en/latest/",
"name": "catalystcentersdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "Cisco, CatalystCenter, SDK",
"author": "Jose Bogarin Solano",
"author_email": "jbogarin@altus.cr",
"download_url": "https://files.pythonhosted.org/packages/9e/c3/d5a1e90d72b92bbb602ae915c1c49223438b79b72b2c65a47654ed4e6d9a/catalystcentersdk-2.3.7.9.4.tar.gz",
"platform": null,
"description": "==================\ncatalystcentersdk\n==================\n\n*Work with the CatalystCenter APIs in native Python!*\n\n-------------------------------------------------------------------------------\n\n**catalystcentersdk** is a *community developed* Python library for working with the CatalystCenter APIs. Our goal is to make working with CatalystCenter in Python a *native* and *natural* experience!\n\n.. code-block:: python\n\n from catalystcentersdk import api\n\n # Create a CatalystCenterAPI connection object;\n # it uses CatalystCenter sandbox URL, username and password, with CatalystCenter API version 2.3.5.3.\n # and requests to verify the server's TLS certificate with verify=True.\n catalyst = api.CatalystCenterAPI(username=\"devnetuser\",\n password=\"Cisco123!\",\n base_url=\"https://sandboxdnac.cisco.com:443\",\n version='2.3.7.9',\n verify=True)\n\n # Find all devices that have 'Switches and Hubs' in their family\n devices = catalyst.devices.get_device_list(family='Switches and Hubs')\n\n # Print all of demo devices\n for device in devices.response:\n print('{:20s}{}'.format(device.hostname, device.upTime))\n\n # Find all tags\n all_tags = catalyst.tag.get_tag(sort_by='name', order='des')\n demo_tags = [tag for tag in all_tags.response if 'Demo' in tag.name ]\n\n # Delete all of the demo tags\n for tag in demo_tags:\n catalyst.tag.delete_tag(tag.id)\n\n # Create a new demo tag\n demo_tag = catalyst.tag.create_tag(name='catalyst Demo')\n task_demo_tag = catalyst.task.get_task_by_id(task_id=demo_tag.response.taskId)\n\n if not task_demo_tag.response.isError:\n # Retrieve created tag\n created_tag = catalyst.tag.get_tag(name='catalyst Demo')\n\n # Update tag\n update_tag = catalyst.tag.update_tag(id=created_tag.response[0].id,\n name='Updated ' + created_tag.response[0].name,\n description='Catalyst demo tag')\n\n print(catalyst.task.get_task_by_id(task_id=update_tag.response.taskId).response.progress)\n\n # Retrieved updated\n updated_tag = catalyst.tag.get_tag(name='Updated catalyst Demo')\n print(updated_tag)\n else:\n # Get task error details\n print('Unfortunately ', task_demo_tag.response.progress)\n print('Reason: ', task_demo_tag.response.failureReason)\n\n # Advance usage example using Custom Caller functions\n # Define the get_global_credentials and create_netconf_credentials functions\n # under the custom_caller wrapper.\n # Call them with:\n # catalyst.custom_caller.get_global_credentials('NETCONF')\n # catalyst.custom_caller.create_netconf_credentials('65533')\n def setup_custom():\n catalyst.custom_caller.add_api('get_global_credentials',\n lambda credential_type:\n catalyst.custom_caller.call_api(\n 'GET',\n '/dna/intent/api/v1/global-credential',\n params={\n 'credentialSubType': credential_type\n }).response\n )\n catalyst.custom_caller.add_api('create_netconf_credentials',\n lambda port:\n catalyst.custom_caller.call_api(\n 'POST',\n '/dna/intent/api/v1/global-credential/netconf',\n json=[{\n \"netconfPort\": port\n }])\n )\n\n # Add the custom API calls to the connection object under the custom_caller wrapper\n setup_custom()\n # Call the newly added functions\n catalyst.custom_caller.create_netconf_credentials('65533')\n print(catalyst.custom_caller.get_global_credentials('NETCONF'))\n\n\nIntroduction\n------------\nCheck out the complete Introduction_\n\n**catalystcentersdk handles all of this for you:**\n\n+ Reads your CatalystCenter credentials from environment variables.\n\n+ Reads your CatalystCenter API version from environment variable CATALYST_CENTER_VERSION.\n\n+ Controls whether to verify the server's TLS certificate or not according to the verify parameter.\n\n+ Reads your CatalystCenter debug from environment variable CATALYST_CENTER_DEBUG. Boolean.\n\n+ Wraps and represents all CatalystCenter API calls as a simple hierarchical tree of\n native-Python methods\n\n+ If your Python IDE supports **auto-completion** (like `PyCharm_`), you can\n navigate the available methods and object attributes right within your IDE\n\n+ Represents all returned JSON objects as native Python objects - you can\n access all of the object's attributes using native *dot.syntax*\n\n+ **Automatic Rate-Limit Handling** Sending a lot of requests to CatalystCenter?\n Don't worry; we have you covered. CatalystCenter will respond with a rate-limit\n response, which will automatically be caught and \"handled\" for you.\n\n+ **Refresh token** Each time the token becomes invalid, the SDK will generate a new valid token for you.\n\nInstallation\n------------\n\nInstalling and upgrading catalystcentersdk is easy:\n\n**Install via PIP**\n\n.. code-block:: bash\n\n $ pip install catalystcentersdk\n\n**Upgrading to the latest Version**\n\n.. code-block:: bash\n\n $ pip install catalystcentersdk --upgrade\n\n\nCompatibility matrix\n--------------------\nThe following table shows the supported versions.\n\n.. list-table::\n :widths: 50 50\n :header-rows: 1\n\n * - Cisco CatalystCenter version\n - Python \"catalystcentersdk\" version\n * - 2.3.7.6\n - 2.3.7.6.x\n * - 2.3.7.7\n - 2.3.7.9.4\n * - 2.3.7.9\n - 2.3.7.9.x\n\n\n\nIf your SDK is older please consider updating it first.\n\nDocumentation\n-------------\n\n**Excellent documentation is now available at:**\nhttps://catalystcentersdk.readthedocs.io\n\nCheck out the Quickstart_ to dive in and begin using catalystcentersdk.\n\n\nRelease Notes\n-------------\n\nPlease see the releases_ page for release notes on the incremental functionality and bug fixes incorporated into the published releases.\n\n\nQuestions, Support & Discussion\n-------------------------------\n\ncatalystcentersdk is a *community developed* and *community supported* project. If you experience any issues using this package, please report them using the issues_ page.\n\n\nContribution\n------------\n\ncatalystcentersdk_ is a community development projects. Feedback, thoughts, ideas, and code contributions are welcome! Please see the `Contributing`_ guide for more information.\n\n\nInspiration\n------------\n\nThis library is inspired by the webexteamssdk_ library\n\n\nChangelog\n---------\n\nAll notable changes to this project will be documented in the CHANGELOG_ file.\n\nThe development team may make additional name changes as the library evolves with the Cisco CatalystCenter APIs.\n\n\n*Copyright (c) 2024 Cisco Systems.*\n\n.. _Introduction: https://catalystcentersdk.readthedocs.io/en/latest/api/intro.html\n.. _catalystcentersdk.readthedocs.io: https://catalystcentersdk.readthedocs.io\n.. _Quickstart: https://catalystcentersdk.readthedocs.io/en/latest/api/quickstart.html\n.. _catalystcentersdk: https://github.com/cisco-en-programmability/catalystcentersdk\n.. _issues: https://github.com/cisco-en-programmability/catalystcentersdk/issues\n.. _pull requests: https://github.com/cisco-en-programmability/catalystcentersdk/pulls\n.. _releases: https://github.com/cisco-en-programmability/catalystcentersdk/releases\n.. _the repository: catalystcentersdk_\n.. _pull request: `pull requests`_\n.. _Contributing: https://github.com/cisco-en-programmability/catalystcentersdk/blob/master/docs/contributing.rst\n.. _webexteamssdk: https://github.com/CiscoDevNet/webexteamssdk\n.. _CHANGELOG: https://github.com/cisco-en-programmability/catalystcentersdk/blob/main/CHANGELOG.md\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Cisco CatalystCenter Platform SDK",
"version": "2.3.7.9.4",
"project_urls": {
"Homepage": "https://catalystcentersdk.readthedocs.io/en/latest/",
"Repository": "https://github.com/cisco-en-programmability/catalystcentersdk"
},
"split_keywords": [
"cisco",
" catalystcenter",
" sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a9bfe28e0e9cbbb167bafb8a83e620e4418158f142cd67419006cc5d49582b8d",
"md5": "b05344f28cc71c444747eccb3a336f0b",
"sha256": "7288af2769c3c12caa1d4a9e3cdbfb254f06b85706fa352834bcd8f768395611"
},
"downloads": -1,
"filename": "catalystcentersdk-2.3.7.9.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b05344f28cc71c444747eccb3a336f0b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 2145737,
"upload_time": "2025-02-28T21:57:16",
"upload_time_iso_8601": "2025-02-28T21:57:16.378262Z",
"url": "https://files.pythonhosted.org/packages/a9/bf/e28e0e9cbbb167bafb8a83e620e4418158f142cd67419006cc5d49582b8d/catalystcentersdk-2.3.7.9.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9ec3d5a1e90d72b92bbb602ae915c1c49223438b79b72b2c65a47654ed4e6d9a",
"md5": "a00d4772936048618024def4b0aba244",
"sha256": "a430f2c710c73fd119e30b9bc6ad5786b118c710784447a7514121f7a782e1d8"
},
"downloads": -1,
"filename": "catalystcentersdk-2.3.7.9.4.tar.gz",
"has_sig": false,
"md5_digest": "a00d4772936048618024def4b0aba244",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 1087256,
"upload_time": "2025-02-28T21:57:22",
"upload_time_iso_8601": "2025-02-28T21:57:22.299469Z",
"url": "https://files.pythonhosted.org/packages/9e/c3/d5a1e90d72b92bbb602ae915c1c49223438b79b72b2c65a47654ed4e6d9a/catalystcentersdk-2.3.7.9.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-28 21:57:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cisco-en-programmability",
"github_project": "catalystcentersdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "catalystcentersdk"
}
JSON
