Skip to main content

Cisco DNA Center Platform SDK

Project description

Work with the DNA Center APIs in native Python!


dnacentersdk is a community developed Python library for working with the DNA Center APIs. Our goal is to make working with DNA Center in Python a native and natural experience!

from dnacentersdk import api

# Create a DNACenterAPI connection object;
# it uses DNA Center sandbox URL, username and password, with DNA Center API version 2.3.5.3.
# and requests to verify the server's TLS certificate with verify=True.
dnac = api.DNACenterAPI(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 = dnac.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 = dnac.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:
    dnac.tag.delete_tag(tag.id)

# Create a new demo tag
demo_tag = dnac.tag.create_tag(name='dna Demo')
task_demo_tag = dnac.task.get_task_by_id(task_id=demo_tag.response.taskId)

if not task_demo_tag.response.isError:
    # Retrieve created tag
    created_tag = dnac.tag.get_tag(name='dna Demo')

    # Update tag
    update_tag = dnac.tag.update_tag(id=created_tag.response[0].id,
                                     name='Updated ' + created_tag.response[0].name,
                                     description='DNA demo tag')

    print(dnac.task.get_task_by_id(task_id=update_tag.response.taskId).response.progress)

    # Retrieved updated
    updated_tag = dnac.tag.get_tag(name='Updated dna 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:
#     dnac.custom_caller.get_global_credentials('NETCONF')
#     dnac.custom_caller.create_netconf_credentials('65533')
def setup_custom():
    dnac.custom_caller.add_api('get_global_credentials',
                            lambda credential_type:
                                dnac.custom_caller.call_api(
                                    'GET',
                                    '/dna/intent/api/v1/global-credential',
                                    params={
                                        'credentialSubType': credential_type
                                    }).response
                            )
    dnac.custom_caller.add_api('create_netconf_credentials',
                            lambda port:
                                dnac.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
dnac.custom_caller.create_netconf_credentials('65533')
print(dnac.custom_caller.get_global_credentials('NETCONF'))

Introduction

Check out the complete Introduction

dnacentersdk handles all of this for you:

  • Reads your DNA Center credentials from environment variables.

  • Reads your DNA Center API version from environment variable DNA_CENTER_VERSION.

  • Controls whether to verify the server’s TLS certificate or not according to the verify parameter.

  • Reads your DNA Center debug from environment variable DNA_CENTER_DEBUG. Boolean.

  • Wraps and represents all DNA Center 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 DNA Center? Don’t worry; we have you covered. DNA Center 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 dnacentersdk is easy:

Install via PIP

$ pip install dnacentersdk

Upgrading to the latest Version

$ pip install dnacentersdk --upgrade

Compatibility matrix

The following table shows the supported versions.

Cisco DNA Center version

Python “dnacentersdk” version

2.2.2.3

2.3.3

2.2.3.3

2.4.11

2.3.3.0

2.5.6

2.3.5.3

2.6.11

2.3.7.6

2.7.7

2.3.7.7

2.8.6

2.3.7.9

2.8.12

If your SDK is older please consider updating it first.

Documentation

Excellent documentation is now available at: https://dnacentersdk.readthedocs.io

Check out the Quickstart to dive in and begin using dnacentersdk.

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

dnacentersdk is a community developed and community supported project. If you experience any issues using this package, please report them using the issues page.

Contribution

dnacentersdk 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 DNA Center APIs.

Copyright (c) 2019-2021 Cisco Systems.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dnacentersdk-2.8.12.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

dnacentersdk-2.8.12-py3-none-any.whl (3.7 MB view details)

Uploaded Python 3

File details

Details for the file dnacentersdk-2.8.12.tar.gz.

File metadata

  • Download URL: dnacentersdk-2.8.12.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Darwin/24.1.0

File hashes

Hashes for dnacentersdk-2.8.12.tar.gz
Algorithm Hash digest
SHA256 a84fd079e021e1f14e07deb3dd655950357a0802ee1a4ede3c71862097e620e1
MD5 8ec0ff989f0ed5265b6d17c219f8dc5a
BLAKE2b-256 f9e37cd2ccb28b8b4fe53b46f8b0869fff62651f1133700d6ab000096a66f8af

See more details on using hashes here.

File details

Details for the file dnacentersdk-2.8.12-py3-none-any.whl.

File metadata

  • Download URL: dnacentersdk-2.8.12-py3-none-any.whl
  • Upload date:
  • Size: 3.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Darwin/24.1.0

File hashes

Hashes for dnacentersdk-2.8.12-py3-none-any.whl
Algorithm Hash digest
SHA256 d983f0edd50db5c3ea40ba38ee9ca797d7e4d4e7f67e474b6979dc94fb8ba862
MD5 44873b09ca65d689a9f5c952b5767e42
BLAKE2b-256 fa001967ff94f51d5814fd822de9e55109ec6ff536b5af7ce1a06db6af6ced30

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page