Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

[2.8.9] - 2025-03-13

Fix

  • Correction in the functions set_banner_settings_for_a_site, set_dhcp_settings_for_a_site, set_n_t_p_settings_for_a_site, set_time_zone_for_a_site, set_d_n_s_settings_for_a_site, set_telemetry_settings_for_a_site, set_aaa_settings_for_a_site. #174

[2.8.8] - 2025-03-10

Fix

  • Modification of the data type in offset and limit. In the get_ap_profiles function of the wireless family.

[2.8.7] - 2025-03-05

Fix

  • Error correction in the user_and_roles module

[2.8.6] - 2025-02-27

Added

  • Add support of DNA Center versions (‘2.3.7.7’)

[2.8.5] - 2025-02-21

Fix

  • correction in the request validation structures. In the deploy_template functions in version 1 and 2. In 2.3.5.3, 2.3.7.6 and 2.3.7.9.

[2.8.4] - 2025-02-17

Fix

  • fix in create_webhook_destination, update_webhook_destination, get_webhook_destination functions. In versions 2.3.7.6 and 2.3.7.9.

[2.8.3] - 2025-01-23

Fix

  • Issues #188 and #189 have been resolved.

  • Alias have been adjusted for backward compatibility.

  • Some functions were changed in versions 2.3.7.6 and 2.3.7.9 to handle files.

Added

  • Cisco_IMC module added

[2.8.2] - 2025-01-15

Fix

  • A new alias function has been added to maintain compatibility with event_management in versions 2.3.7.6 and 2.3.7.9.

  • The new function is get_eventartifacts which was already present in previous versions but was changed to get_event_artifacts in 2.3.7.6 and 2.3.7.9.

  • issues #186

[2.8.1] - 2025-01-13

Fix

  • changing the api version in the configuration files

  • Resolved issue #174

  • removal of -v1 from reference urls in the documentation

  • Fixed a bug in site_design in the uploads_floor_image function in versions 2.3.7.6 and 2.3.7.9.

[2.8.0] - 2024-12-11

Added

  • Add support of DNA Center versions (‘2.3.7.9’)

  • Adds modules for v2_3_7_9

[2.7.7] - 2024-11-19

Bug fix

  • The get_templates_details function was added because it was named incorrectly.There was an “s” missing from the word templates.

[2.7.6] - 2024-11-12

ADD

  • authentication_management module added

[2.7.5] - 2024-11-11

ADD

  • The use of alias in the functions was implemented

  • The User Agent parameter was added

  • New Modules Such As (ai_endpoint_analytics, cisco_trusted_certificates, disaster_revery) were Added

2.7.4 - 2024-09-17

  • Add multipart parameter for file upload in site_design:uploads_floor_image.

2.7.3 - 2024-08-19

  • Refactor error message construction in ApiError class

  • Injection for requests.Session ### Fixed

  • Fixed a problem when exporting the environment variable verify

  • Update offset and limit parameter type to support int and str value

  • accept_cisco_ise_server_certificate_for_cisco_ise_server_integration accept empty payload {} to retry

  • Update memberToTags from list to object in updates_tag_membership

  • Update offset and limit parameter type to support int and str value

2.7.2 - 2024-08-09

  • Update User-Agent header in RestSession

  • Update requirements:

    • python = “^3.8”

    • requests = “^2.32.0”

    • readthedocs-sphinx-search = “^0.3.2” ### Fixed

  • Fix function names in 2.3.7.6 user_and_roles

    • From add_role_ap_i to add_role_api

    • From get_a_a_a_attribute_ap_i to get_aaa_attribute_api

    • From get_permissions_ap_i to get_permissions_api

    • From delete_role_ap_i to delete_role_api

    • From get_roles_ap_i to get_roles_api

    • From get_users_ap_i to get_users_api

    • From add_user_ap_i to add_user_api

    • From update_user_ap_i to update_user_api

    • From delete_user_ap_i to delete_user_api

    • From get_external_authentication_setting_ap_i to get_external_authentication_setting_api

    • From manage_external_authentication_setting_ap_i to manage_external_authentication_setting_api

    • From get_external_authentication_servers_ap_i to get_external_authentication_servers_api

    • From add_and_update_a_a_a_attribute_ap_i to add_and_update_aaa_attribute_api

    • From delete_a_a_a_attribute_ap_i to delete_aaa_attribute_api

    • From get_a_a_a_attribute_ap_i to get_aaa_attribute_api

2.7.1 - 2024-05-31

Fixed

  • Updated package version retrieval method from pkg_resources to importlib.metadata.

2.7.0 - 2024-05-31

Added

  • Add support of DNA Center versions (‘2.3.7.6’)

  • Adds modules for v2_3_7_6 ### Changed

  • The future library was removed

  • The past library was removed

  • Changed basestring to str

  • Requirements updated ### Fixed

  • Fix headers in create_webhook_destination and update_webhook_destination

2.6.11 - 2023-01-10

Fixed

  • Configuration template import template - check_type error #142 - Fixing required schema.

  • Updating request version. Issue #132

2.6.10 - 2023-11-10

Fixed

  • Fixed params in 2.3.5.3 claim_a_device_to_a_site from interfaceName to ipInterfaceName

  • Fixed params in 2.3.5.3 claim_a_device_to_a_site from vlanID to vlanId

2.6.9 - 2023-09-20

Changed

  • AP port assignment API not working with DNAC APIs of 2.3.3.0 #126, Documetion bug, extra-space in enum.

2.6.8 - 2023-09-12

Changed

  • 2_3_3_0 sda sevice add_vn method update.

2.6.7 - 2023-08-25

Changed

  • Update readthedocs settings

2.6.6 - 2023-07-10

Changed

  • Change requests-toolbelt minimum version #101

2.6.5 - 2023-05-29

Changed

  • user_and_roles::Unable to use user and roles module. #112

2.6.4 - 2023-05-25

Changed

  • SDK implementation for API Add Edge Device to Sda fabric on DNAC Version 2.3.3.0 inconsistent with previous DNAC versions implementation #90

  • Documentatin links updated.

  • EoX turns to Eox

  • SDK function for version 2.3.3.x (v2_3_3_0 /device_onboarding_pnp.py) input requirment does not match with API schema from dnac, #103

  • Function name changed to assign_device_credential_to_site in DNAC2.3.5.0(dnacentersdk/api/v2_3_5_3/network_settings.py) #107

  • Function names changed in v2.3.5.0 libs all function got added with 2 though no change in DNAC APIs #106

  • 2.3.3.0 LAN Automation function names are incorrect #105

  • Function name changed in 2.3.3.0 from update_ssid_to_ip_pool_mapping to update_ssid_to_ip_pool_mapping2 #104

  • SDK function for version 2.3.3.x (v2_3_3_0 /device_onboarding_pnp.py) input requirment does not match with API schema from dnac, #103

  • Poor naming of function: v2_3_5_3/authentication_management.py : authentication_ap_i( #102

2.6.3 - 2023-04-28

Changed

  • SDK implementation for API Add Edge Device to Sda fabric on DNAC Version 2.3.3.0 inconsistent with previous DNAC versions implementation #90

  • Actual error message was not being used in case of exceptions #98

  • SDA :: add_default_authentication_profile #97

  • DNA_CENTER_VERIFY not being imported correctly from the environment #92, now you can export this as:

    export DNA_CENTER_VERIFY=false
export DNA_CENTER_VERIFY=true

    2.6.2 - 2023-04-25

    Changed

  • Add issue family on 2.3.3.0

2.6.1 - 2023-04-12

Changed

  • Remove some families bug in 2.3.3.0

  • Correct families names in 2.3.5.3

  • Removing duplicate params

2.6.0 - 2023-04-12

Added

  • Add support of DNA Center versions (‘2.3.5.3’)

  • Adds modules for v2_3_5_3

2.5.6 - 2023-01-10

Added

  • Compatibility matrix added in readme.rst

Fixed

  • Offset and limit now support str and int

    • dnacentersdk.api.v2_3_3_0.application_policy

    • dnacentersdk.api.v2_3_3_0.applications

    • dnacentersdk.api.v2_3_3_0.compliance

    • dnacentersdk.api.v2_3_3_0.configuration_templates

    • dnacentersdk.api.v2_3_3_0.device_onboarding_pnp

    • dnacentersdk.api.v2_3_3_0.device_replacement

    • dnacentersdk.api.v2_3_3_0.devices

    • dnacentersdk.api.v2_3_3_0.discovery

    • dnacentersdk.api.v2_3_3_0.event_management

    • dnacentersdk.api.v2_3_3_0.health_and_performance

    • dnacentersdk.api.v2_3_3_0.lan_automation

    • dnacentersdk.api.v2_3_3_0.licenses

    • dnacentersdk.api.v2_3_3_0.network_settings

    • dnacentersdk.api.v2_3_3_0.path_trace

    • dnacentersdk.api.v2_3_3_0.site_design

    • dnacentersdk.api.v2_3_3_0.sites

    • dnacentersdk.api.v2_3_3_0.software_image_management_swim

    • dnacentersdk.api.v2_3_3_0.tag

    • dnacentersdk.api.v2_3_3_0.task

2.5.5 - 2022-11-17

Fixed

  • Removed enum in dnacentersdk.api.v2_3_3_0.sda.add_default_authentication_profile:

    • authenticateTemplateName

  • Added Dict_of_str function call in custom_caller headers

2.5.4 - 2022-08-11

Added

  • New function on fabric_wireless for v2_3_3_0.

    • add_ssid_to_ip_pool_mapping

2.5.3 - 2022-08-09

Fixed

  • virtualNetwork on sda.adds_border_device parameter comes from array to object.

  • Parameters borderWithExternalConnectivity and connectedToInternet on sda.adds_border_device comes from boolean to string.

2.5.2 - 2022-07-29

Fixed

  • Removed enum in sda.adds_border_device:

    • externalDomainRoutingProtocolName

  • Removed enum in sda.add_multicast_in_sda_fabric:

    • multicastMethod

  • Removed enum in site_design.provision_nfv:

    • linkType

  • Removed enum in sda.add_transit_peer_network:

    • routingProtocolName

  • Removed enum in network_settings.update_network and network_settings.create_network:

    • ipAddress

    • sharedSecret

    • domainName

    • primaryIpAddress

    • secondaryIpAddress

    • network

    • servers

2.5.1 - 2022-07-12

Fixed

  • Fixed enum in network_global.create_global_pool:

    • IpAddressSpace

2.5.0 - 2022-06-20

Added

  • Add support of DNA Center versions (‘2.3.3.0’)

  • Adds modules for v2_3_3_0

2.4.11 - 2022-06-15

Fixed

  • Improved the way of reading the following env variables:

    • wait_on_rate_limit

    • verify

    • debug

2.4.10 - 2022-05-12

Added

  • Add following parameters to delete_ip_pool_from_sda_virtual_network and get_ip_pool_from_sda_virtual_network:

    • site_name_hierarchy

2.4.9 - 2022-04-20

Added

  • Add following parameters to claim_a_device_to_a_site:

    • gateway

    • imageId

    • ipInterfaceName

    • rfProfile

    • staticIP

    • subnetMask

    • vlanId

2.4.8 - 2022-03-23

Added

  • Add DownloadResponse class that wraps the urllib3.response.HTTPResponse.

  • Add filename optional parameter to the following functions:

    • dnacentersdk.api.v1_2_10.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v1_3_0.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v1_3_1.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v1_3_3.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v2_1_1.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v2_1_2.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v2_1_2.reports.Reports.download_report_content

    • dnacentersdk.api.v2_2_2_3.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v2_2_2_3.reports.Reports.download_report_content

    • dnacentersdk.api.v2_2_3_3.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v2_2_3_3.reports.Reports.download_report_content

Changed

  • Change the response of the following funtions from urllib3.response.HTTPResponse to a wrapper DownloadResponse.

    • dnacentersdk.api.v1_2_10.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v1_3_0.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v1_3_1.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v1_3_3.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v2_1_1.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v2_1_2.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v2_1_2.reports.Reports.download_report_content

    • dnacentersdk.api.v2_2_2_3.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v2_2_2_3.reports.Reports.download_report_content

    • dnacentersdk.api.v2_2_3_3.file.File.download_a_file_by_fileid

    • dnacentersdk.api.v2_2_3_3.reports.Reports.download_report_content

2.4.7 - 2022-03-22

Added

  • Add rfProfile parameter for request body struct of claim_a_device_to_a_site.

2.4.6 - 2022-03-14

Changed

  • Update the type of the externalConnectivitySettingsfrom object to list in sda.adds_border_device

  • interfaceName is now part of the structure of externalConnectivitySettings in sda.adds_border_device

  • externalAutonomouSystemNumber is now part of the structure of externalConnectivitySettings in sda.adds_border_device

  • l3Handoff is now part of the structure of externalConnectivitySettings in sda.adds_border_device

  • Update the type of the l3Handofffrom object to list in sda.adds_border_device

  • virtualNetwork is now part of the structure of l3Handoff in sda.adds_border_device

  • virtualNetworkName is now part of the structure of virtualNetwork in sda.adds_border_device

  • vlanId is now part of the structure of virtualNetwork in sda.adds_border_device

  • Update models validators of Cisco DNA Center API v2.2.3.3 files for the following functions:

    • sda.adds_border_device

2.4.5 - 2022-02-01

Changed

  • Adds parameter id to devices.sync_devices for Cisco DNA Center API v2.2.3.3

  • Update response documentation of Cisco DNA Center API v2.2.3.3 files

    • fabric_wireless.add_ssid_to_ip_pool_mapping

    • fabric_wireless.update_ssid_to_ip_pool_mapping

    • fabric_wireless.add_w_l_c_to_fabric_domain

    • wireless.ap_provision

    • wireless.create_update_dynamic_interface

  • Update models validators of Cisco DNA Center API v2.2.3.3 files for the following functions:

    • devices.sync_devices

2.4.4 - 2022-01-31

Changed

  • Update response documentation of Cisco DNA Center API v2.2.3.3 files

    • application_policy.get_applications

    • device_onboarding_pnp.get_device_list

  • Adds parameters payload and active_validation to the following functions for Cisco DNA Center API v2.2.3.3:

    • site_design.create_floormap

    • site_design.update_floormap

  • Update models validators of Cisco DNA Center API v2.2.3.3 files for the following functions:

    • site_design.create_floormap

    • site_design.update_floormap

    • application_policy.create_application

Fixed

  • Removed an extra parameter in the call of VERIFY_STRING_ENVIRONMENT_VARIABLE

Added

  • Adds parameters hostname, imageInfo and configInfo to device_onboarding_pnp.pnp_device_claim_to_site

2.4.3 - 2022-01-19

Fixed

  • DNACenterAPI constructor allows for optional arguments #37

Changed

  • Update requirements

  • Adds env variables support for import before/after importing DNACenterAPI

  • Adds tests for env variables before/after DNACenterAPI import

2.4.2 - 2021-12-14

Fixed

  • Fix add_members_to_the_tag and retrieves_all_network_devices json schemas. ### Updated

  • Update json schemas for models/validators and tests/models/models/validators

2.4.1 - 2021-12-01

Changed

  • Update to match checksum

2.4.0 - 2021-12-01

Added

  • Add support of DNA Center versions (‘2.2.3.3’)

  • Add retrieves_all_network_devices funtion

Changed

  • Included support for DNAC 2.2.3.3 files

  • Update function names:

    • Rename devices.add_device2 to devices.add_device

    • Rename devices.is_valid_add_device2 to devices.is_valid_add_device in tests

    • Rename devices.test_add_device2 to devices.test_add_device in tests

    • Rename devices.add_device2_default_val to devices.add_device_default_val in tests

  • Update missing dnac 2.2.3.3 files

2.3.3 - 2021-11-24

Changed

  • Changes to configuration_templates functions:

    • Add payload and active_validation parameters to clone_given_template function

    • Change type from dict to list for parameter templates in create_project

    • Change type from dict to list for parameter templates in update_project

    • Change type from (list, dict) to basesting for parameter payload in imports_the_projects_provided

    • Change type from object to list for parameter resourceParams in preview_template

    • Removed active_validation parameter in imports_the_projects_provided function

  • Changes to sda functions:

    • Add isGuestVirtualNetwork parameter to add_virtual_network_with_scalable_groups function

    • Add isGuestVirtualNetwork parameter to update_virtual_network_with_scalable_groups function

2.3.2 - 2021-09-14

Changed

  • Disable verify=False warnings of urllib3

2.3.1 - 2021-08-10

Fixed

  • Fix devices param definition & schemas [aba32f3]

  • Remove unnecesary path_params [25c4e99]

2.3.0 - 2021-08-09

Added

  • Add support of DNA Center versions (‘2.2.2.3’)

  • Adds modules for v2_2_2_3

Changed

  • Updates download_report_content of v2_2_1 function to handle response body and save it as a file.

  • Updates exceptions.py file to check if self.details is dict before attempting access

  • Updates restsession.py to handle downloads using Content-Disposition header rather than custom fileName header

2.2.5 - 2021-08-05

Changed

  • Fixes #34 by:

    • Removing enum that contain descriptions rather than actual values.

    • Adding primaryIpAddress and secondaryIpAddress for v2_2_1 the "format": "ipv4" JSON schema property.

  • Removes minus char from docstrings.

  • Adds check_type conditions for ‘X-Auth-Token’ for v2_2_1 operations.

2.2.4 - 2021-06-08

Fixed

  • Fixes download_a_file_by_fileid and import_local_software_image for v2_2_1

2.2.3 - 2021-06-08

Changed

  • Update project dependencies & settings

  • Update LICENSE

  • Update tests (lint, mock server order, validators)

  • Update docs for v2_2_1

  • Fix functions args for 2_2_1

  • Update LICENSE reference

  • Removed unused code in dnacentersdk/generator_containers.py

  • Remove description from validators

  • Update comments & args’ types

  • Patch changes some parameters in v2_2_1 that were causing NameError

  • Patch adds one function that was missing from previous release

  • Patch adds models/validators for v2_2_1 with new ids

2.2.2 - 2021-05-10

Added

  • Add support of DNA Center versions (‘2.2.1’)

Changed

  • Updates requirements files

2.0.2 - 2020-11-01

Added

  • Add support of DNA Center versions (‘2.1.2’)

  • Included sphinx_search in Pipfile

  • Included sphinx_search in requirements-dev.txt

  • Requirements-docs.txt

  • Added requirements.lock

Changed

  • Migrated to poetry for publishing and managing the project

  • Generated requirements.txt from poetry export

Removed

  • Removed requirements.lock

2.0.0 - 2020-07-17

Added

  • Add support of DNA Center versions (‘1.3.1’, ‘1.3.3’, ‘2.1.1’)

  • Included setuptools_scm in the requirements

Changed

  • Changed repo URLs to current repository

  • Changed versioneer style from pep440 to pep440-post

  • Changed setup from versioneer to setuptools_scm

  • Changed version management to include patch (major, minor, patch)

Fixed

  • Fixed link to github organization

  • Fixed dict limit error with python < 3.7

  • Fixed (json **kwargs) handling

Removed

  • Removed Webex Teams Space Community reference from README

  • Removed Token refresh when changing base_url

1.3.0 - 2019-08-19

Added

  • Add support for multiple versions of DNA Center (‘1.2.10’, ‘1.3.0’)

Fixed

  • Fix code example in README

  • Fix error in setter in api/__init__.py

  • Fix errors for readthedocs

1.2.10 - 2019-07-18

Added

  • Add support for DNA Center version 1.2.10