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!

from catalystcentersdk import api

# Create a CatalystCenterAPI connection object;
# it uses CatalystCenter sandbox URL, username and password, with CatalystCenter API version 3.2.3.0.
# 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='3.2.3.0',
                        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='desc')
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'))

$ pip install catalystcentersdk

$ pip install catalystcentersdk --upgrade